diff --git a/gen-esign/esignature.rest.swagger-v2.1.json b/gen-esign/esignature.rest.swagger-v2.1.json index 9bed72a..58c3448 100644 --- a/gen-esign/esignature.rest.swagger-v2.1.json +++ b/gen-esign/esignature.rest.swagger-v2.1.json @@ -43,7 +43,7 @@ "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/Services" + "$ref": "#/definitions/serviceInformation" } }, "400": { @@ -76,7 +76,7 @@ "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/Resources" + "$ref": "#/definitions/resourceInformation" } }, "400": { @@ -100,18 +100,11 @@ "Accounts" ], "summary": "Creates new accounts.", - "description": "Creates new DocuSign accounts.\nYou can use this method to create\na single account\nor up to 100 accounts at a time.\n\nWhen creating a single account,\nthe body of the request is a\n[`newAccountDefinition`][newAccountDefinition]\nobject.\n\nIf the request succeeds.\nit returns a\n201 (Created) code.\nThe response returns the new account ID, password and the default user\ninformation for each newly created account.\n\n\nWhen creating multiple accounts,\nthe body of the request is a\n`newAccountRequests`\nobject,\nwhich contains one or more \n[`newAccountDefinition`][newAccountDefinition]\nobjects.\nYou can create up to 100 new accounts\nat a time this way.\n\nThe body for a multi-account\ncreation request\nlooks like this in JSON:\n\n```\n{\n \"newAccountRequests\": [\n {\n \"accountName\": \"accountone\",\n . . .\n },\n {\n \"accountName\": \"accounttwo\",\n . . .\n }\n ]\n}\n```\n\nA multi-account request\nlooks like this in XML:\n\n```\n\n \n \n . . .\n \n \n . . .\n \n \n\n```\n\nA multi-account creation request\nmay succeed (report a 201 code)\neven if some accounts could not be created.\nIn this case, the `errorDetails` property\nin the response contains specific information\nabout the failure.\n\n\n### Account Settings\n\nThe `accountSettings` property\nis a [name/value][nameValue]\nlist that can contain the following settings:\n\n| Name | Type | Authorization Required | Description | \n| :------------------------------------------------- | :------ | :---------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | \n| adoptSigConfig | Boolean | Admin | When **true**, the Signature Adoption Configuration page is available to account administrators. | \n| allowAccessCodeFormat | Boolean | Admin | When **true**, the Access Code Format page is available to account administrators. | \n| allowAccountManagementGranular | Boolean | Admin | When **true**, the Delegated Administration functionality is available to account. | \n| allowBulkSend | Boolean | Admin | When **true**, the account can set if the bulk send feature can be used. | \n| allowCDWithdraw | Boolean | Admin | When **true**, signers can withdraw their consent to use electronic signatures. | \n| allowConnectSendFinishLater | Boolean | Reserved | Reserved for DocuSign. | \n| allowDataDownload | Boolean | Admin | When **true**, the account can download envelope data. | \n| allowEnvelopeCorrect | Boolean | Admin | When **true**, the account allows in process envelopes to be corrected. | \n| allowEnvelopePublishReporting | Boolean | Admin | When **true**, the account can access the Envelope Publish section in Classic DocuSign Experience Account Administration. | \n| allowExpressSignerCertificate | Boolean | Admin | When **true**, senders are allowed to use the DocuSign Express digital signatures. | \n| allowExternalSignaturePad | Boolean | Admin | When **true**, an external signature pad can be used for signing. The signature pad type is set by the externalSignaturePadType property. | \n| allowInPerson | Boolean | SysAdmin | When **true**, the account allows In Person Signing. | \n| allowMarkup | Boolean | Admin | When **true**, the document markup feature is enabled for the account. | \n| allowMemberTimezone | Boolean | Admin | When **true**, account users can set their own time zones. | \n| allowMergeFields | Boolean | Admin | When **true**, the account can use merge fields in conjunction with DocuSign for Salesforce. | \n| allowMultipleSignerAttachments | Boolean | Admin | When **true**, multiple signer attachments are allowed for an envelope. | \n| allowOfflineSigning | Boolean | Admin | When **true**, the account can use Offline Signing and envelopes signed using offline signing on mobile devices are synchronized with this account. This option and the inSessionEnabled option must both be enabled (**true**) for a caller to use offline signing. | \n| allowOpenTrustSignerCertificate | Boolean | Admin | When **true**, senders are allowed to use the OpenTrust digital signatures. | \n| allowPaymentProcessing | Boolean | Admin | When **true**, the account can access the Payment Processing set up page. | \n| allowPersonalSignerCertificate | Boolean | Admin | When **true**, the account can specify that signers must use personal signer certificates during signing. | \n| allowPrivateSigningGroups | Boolean | SysAdmin Read Only | Reserved for DocuSign. This currently returns false in a response. This setting is only shown in the response when listing account settings. | \n| allowReminders | Boolean | Admin | When **true**, the reminder and expiration functionality is available when sending envelops. | \n| allowSafeBioPharmaSignerCertificate | Boolean | Admin | When **true**, senders are allowed to use the SAFE BioPharma digital signatures. | \n| allowSharedTabs | Boolean | Admin | When **true**, the account allows users to share custom tabs (fields).
This setting is only shown when getting account settings. It cannot be modified. | \n| allowSignDocumentFromHomePage | Boolean | Admin | When **true**, the Sign a Document Now button is available on the Home tab. | \n| allowSignatureStamps | Boolean | Reserved | Reserved for DocuSign. | \n| allowSignerReassign | Boolean | Admin | When **true**, the account allows signers to reassign an envelope. | \n| allowSignerReassignOverride | Boolean | Admin | When **true**, the sender has the option override the default account setting for reassigning recipients. | \n| allowSigningGroups | Boolean | SysAdmin Read Only | When **true**, the account can use signing groups. This setting is only shown in the response when listing account settings. | \n| allowTabOrder | Boolean | Admin | When **true**, the Tab Order field is available for use when creating tabs. | \n| allowWorkspaceComments | Boolean | Reserved | Reserved for DocuSign. | \n| allowWorkspaceCreate | Boolean | Admin | When **true**, account users can create DocuSign Rooms. | \n| attachCompletedEnvelope | Boolean | SysAdmin | When **true**, envelope documents are included as a PDF file attachment for signing completed emails. | \n| authenticationCheck | String | Admin | Sets when authentication checks are applied for recipient envelope access. This setting only applies to the following ID checks: This setting takes one of the following options: | \n| autoNavRule | String | Admin | The auto-navigation rule for the account. Enumeration values are: | \n| bulkSend | Boolean | Admin | When **true**, the account allows bulk sending of envelopes. | \n| canSelfBrandSend | Boolean | SysAdmin | When **true**, account administrators can self-brand their sending console through the DocuSign Console. | \n| canSelfBrandSign | Boolean | SysAdmin | When **true**, account administrators can self-brand their signing console through the DocuSign Console. | \n| conditionalFieldsEnabled | Boolean | Admin | When **true**, conditional fields can be used by the account. | \n| consumerDisclosureFrequency | enum | Admin | Possible values are: | \n| dataFieldRegexEnabled | Boolean | Admin | When **true**, the Regex field is available for tabs with that property. | \n| dataFieldSizeEnabled | Boolean | Admin | When **true**, the maximum number of characters field is available for tabs with that property. | \n| dataPopulationScope | String | Admin | Specifies how data is shared for tabs with the same tabLabel. There are two possible values: This setting applies to the following tab types: Changing this setting affects envelopes that have been sent but not completed. | \n| disableMobilePushNotifications | Boolean | Admin | When **true**, mobile push notifications are disabled on the account. | \n| disableMobileSending | Boolean | Admin | When **true**, sending from mobile applications is disabled. | \n| disableMultipleSessions | Boolean | Admin | When **true**, account users cannot be logged into multiple sessions at once. | \n| disableUploadSignature | Boolean | Admin | When **true**, signers cannot use the upload signature/initials image option when signing a document. | \n| documentConversionRestrictions | String | Admin | Sets the account document upload restriction for non-account administrators. There are three possible values: | \n| enableAutoNav | Boolean | SysAdmin or EnableAutoNavByDSAdmin is set | When **true**, the auto-navigation is enabled for the account. | \n| enableCalculatedFields | Boolean | Admin & AllowExpression is set | When **true**, this account can use the Calculated Fields feature. | \n| enableDSPro | Boolean | SysAdmin | When **true**, this account can send and manage envelopes from the DocuSign Desktop Client. | \n| enableEnvelopeStampingByAccountAdmin | Boolean | SysAdmin or account has EnableEnvelopeStampingByDSAdmin set | When **true**, senders for this account can choose to have the envelope ID stamped in the document margins. | \n| enablePaymentProcessing | Boolean | Admin & AllowPaymentProcessing is set. | When **true**, Payment Processing is enabled for the account. | \n| enablePowerForm | Boolean | SysAdmin | When **true**, PowerForm access is enabled for the account. | \n| enablePowerFormDirect | Boolean | Admin | When **true**, direct PowerForms are enabled for the account. | \n| enableRecipientDomainValidation | Boolean | Admin | When **true**, validation on recipient email domains for DocuSign Access feature is enabled. | \n| enableRequireSignOnPaper | Boolean | Admin | When **true**, the account can use the requireSignOnPaper option. | \n| enableReservedDomain | Boolean | SysAdmin | When **true**, an account administrator can reserve web domain and users. | \n| enableSMSAuthentication | Boolean | Admin | When **true**, the account can use SMS authentication. | \n| enableSendToAgent | Boolean | SysAdmin | When **true**, this account can use the Agent Recipient Type. | \n| enableSendToIntermediary | Boolean | Admin & AllowSendToIntermediary is set | When **true**, this account can use the Intermediary Recipient Type. | \n| enableSendToManage | Boolean | Admin | When **true**, this account can use the Editor Recipient Type. | \n| enableSequentialSigningAPI | Boolean | SysAdmin | When **true**, the account can define the routing order of recipients for envelopes sent using the DocuSign API. | \n| enableSequentialSigningUI | Boolean | SysAdmin | When **true**, the account can define the routing order of recipients for envelopes sent using the DocuSign console. | \n| enableSignOnPaper | Boolean | Admin | When **true**, a user can allow signers to use the sign on paper option. | \n| enableSignOnPaperOverride | Boolean | Admin | When **true**, a user can override the default account setting for the sign on paper option. | \n| enableSignerAttachments | Boolean | Admin | When **true**, a user can request attachments from a signer. | \n| enableTransactionPoint | Boolean | SysAdmin | When **true**, Transaction Point is enabled for this account. | \n| enableVaulting | Boolean | SysAdmin | When **true**, this account can use electronic vaulting for documents. | \n| enableWorkspaces | Boolean | Admin | When **true**, DocuSign Rooms is enabled for the account. | \n| envelopeIntegrationAllowed | String | SysAdmin | Shows the envelope integration rule for the account.
Enumeration values are: NotAllowed, Full, IntegrationSendOnly. | \n| envelopeIntegrationEnabled | Boolean | Admin & EnvelopeIntegrationAllowed is set | When **true**, envelope integration is enabled for the account. | \n| envelopeStamplingDefaultValue | Boolean | (GET only) | When **true**, envelopes sent by this account automatically have the envelope ID stamped in the margins, unless the sender selects not to have them stamped. | \n| externalSignaturePadType | String | Admin | Sets the type of signature pad that can be used. Possible values are: | \n| faxOutEnabled | Boolean | Admin | When **true**, the account can use the fax out feature. | \n| idCheckExpire | String | Admin | Indicates when a user's authentication expires. Possible values are: | \n| idCheckExpireDays | Integer | Admin | The number of days before a user's authentication expires. Valid only if the `IDCheckExpire` value is Variable. | \n| idCheckRequired | String | Admin | Indicates if authentication is required by envelope signers. Possible values are: | \n| inPersonIDCheckQuestion | String | Admin | The default question used by the In Person signing host for an In Person signing session. | \n| inSessionEnabled | Boolean | Admin | When **true**, the account can use In Session (embedded) and offline signing. This option and the allowOfflineSigning option must both be enabled (**true**) for a caller to use offline signing. | \n| inSessionSuppressEmails | Boolean | Admin | When **true**, emails are not sent to the embedded recipients on an envelope for the account. | \n| maximumSigningGroups | String | SysAdmin Read Only | The maximum number of signing groups an account can have. The default value for this is 50. This setting is only shown in the response when listing account settings. | \n| maximumUsersPerSigningGroup | String | SysAdmin Read Only | The maximum number of members in a signing group. The default value for this is 50. This setting is only shown in the response when listing account settings. | \n| mobileSessionTimeout | String | Admin | Sets the amount of idle activity time, in minutes, before a mobile user is automatically logged off of the system. If the setting is 0, then DocuSign mobile application users are never automatically logged off the system. The minimum setting is 1 minute and the maximum setting is 120 minutes.
This setting only applies to the DocuSign for iOS v2.8.2 or later mobile app. | \n| phoneAuthRecipientMayProvidePhoneNumber | Boolean | Admin | When **true**, senders can select to allow the recipient to provide a phone number for the Phone Authentication process. | \n| pkiSignDownloadedPDFDocs | String | Admin | The policy for adding a digital certificate to downloaded, printed and emailed documents. Possible values are: | \n| recipientsCanSignOffline | Boolean | Admin | When **true**, envelopes signed using offline signing on mobile devices are synchronized with this account. | \n| requireDeclineReason | Boolean | Admin | When **true**, recipients that decline to sign an envelope must provide a reason. | \n| requireSignerCertificateType | String | Admin | Sets which Digital Signature certificate is required when sending envelopes. There are three possible values: | \n| rsaVeridAccountName | String | Admin | The RSA account name.
Modifying this value might inadvertently disrupt your ID Check capability. Ensure you have the correct value before changing this. | \n| rsaVeridPassword | String | Admin | The password used with the RSA account.
Modifying this value might inadvertently disrupt your ID Check capability. Ensure you have the correct value before changing this. | \n| rsaVeridRuleset | String | Admin | The RSA rule set used with the account.
Modifying this value might inadvertently disrupt your ID Check capability. Ensure you have the correct value before changing this. | \n| rsaVeridUserId | String | Admin | The user ID for the RSA account.
Modifying this value might inadvertently disrupt your ID Check capability. Ensure you have the correct value before changing this. | \n| savingCustomTabsEnabled | Boolean | Admin | When **true**, account users can save custom tabs. | \n| selfSignedRecipientEmailDocument | String | Admin | Sets how self-signed documents are presented to the email recipients. Possible values are: | \n| selfSignedRecipientEmailDocumentRights | Boolean | Admin | When **true**, account administrators can set the selfSignedRecipientEmailDocument option. | \n| selfSignedRecipientEmailDocumentUserOverride | Boolean | Admin | When **true** the selfSignedRecipientEmailDocument userSetting can be set for an individual user. The userSetting will override the account setting. | \n| selfSignedRecipientEmailDocumentUserOverrideRights | Boolean | Admin | When **true**, account administrators can set the selfSignedRecipientEmailDocumentOverride option. | \n| sendToCertifiedDeliveryEnabled | Boolean | Admin | When **true**, the Certified Deliveries Recipient type can be used by the account. | \n| senderMustAuthenticateSigning | Boolean | Admin | When **true**, a sender that is also a recipient of an envelope must follow the authentication requirements for the envelope. | \n| sessionTimeout | Integer | Admin | The amount of idle activity time, in minutes, before a user is automatically logged out of the system. The minimum setting is 20 minutes and the maximum setting is 120 minutes. | \n| setRecipEmailLang | Boolean | Admin | When **true**, senders can set the email languages for each recipient. | \n| setRecipSignLang | Boolean | Admin | When **true**, senders can set the signing language used for each recipient. | \n| sharedCustomTabsEnabled | Boolean | Admin | When **true**, saved custom tabs can be shared with account users. | \n| signDateFormat | String | Admin | The date/time format applied to Date Signed fields for the account. | \n| signTimeShowAmPm | Boolean | Admin | When **true**, AM or PM is shown as part of the time for signDateFormat. | \n| signerAttachCertificateToEnvelopePDF | Boolean | AccountAdmin & account is selected in AccountSigningSettings| When **true**, the Certificate of Completion is included in the envelope documents PDF when it is downloaded. | \n| signerAttachConcat | Boolean | Admin | When **true**, signer attachments are added to the parent document that the attachment tab is located on, instead of the default behavior that creates a new document in the envelope for every signer attachment. | \n| signerCanCreateAccount | Boolean | AccountAdmin & account is selected in AccountSigningSettings| When **true**, the signer without a DocuSign account can create a DocuSign account after signing. | \n| signerCanSignOnMobile | Boolean | AccountAdmin & account is selected in AccountSigningSettings| When **true**, signers can use the DocuSign mobile signing user interface. | \n| signerInSessionUseEnvelopeCompleteEmail | Boolean | Admin | When **true**, an envelope complete email is sent to an In Session (embedded) or offline signer after DocuSign processes the envelope. | \n| signerLoginRequirements | String | Admin | Sets the Login requirements for the signer. There are four options: If you use Direct PowerForms or captive/embedded signers, the \"Account required\" settings are bypassed for those signers. If your workflow requires that the signer have an account, you should not use those methods. | \n| signerMustHaveAccount | Boolean | AccountAdmin & account is selected in AccountSigningSettings| When **true**, senders can only send an envelope to a recipient that has a DocuSign account. | \n| signerMustLoginToSign | Boolean | AccountAdmin & account is selected in AccountSigningSettings| When **true**, an envelope signer must log in to the DocuSign console to sign an envelope. | \n| signerShowSecureFieldInitialValues | Boolean | AccountAdmin & account is selected in AccountSigningSettings| When **true**, the initial value of all SecureFields is written to the document when sent. | \n| tabDataLabelEnabled | Boolean | Admin | When **true**, senders can change the default tabLabel for tabs. | \n| tabLockingEnabled | Boolean | Admin | When **true**, the locked option is available for tabs with that property. | \n| tabTextFormattingEnabled | Boolean | Admin | When **true**, the formatting options (font type, font size, font color, bold, italic, and underline) are available for tabs with those properties. | \n| universalSignatureOptIn | Boolean | Reserved | Reserved for DocuSign. | \n| universalSignatureOptOut | Boolean | Reserved | Reserved for DocuSign. | \n| useAccountLevelEmail | Boolean | AccountAdmin & account is selected in AccountSigningSettings| When **true**, the content of notification emails is determined at the account level. | \n| useConsumerDisclosure | Boolean | Admin | When **true**, the account can use supplemental documents. | \n| usesAPI | Boolean | SysAdmin | When **true**, the account can use the DocuSign API. | \n\n\n\n\n\n[newAccountDefinition]: #/definitions/newAccountDefinition\n[nameValue]: #/definitions/nameValue\n", + "description": "Creates new DocuSign accounts.\nYou can use this method to create\na single account\nor up to 100 accounts at a time.\n\n**Note**: This method is restricted to partner integrations. You must work with DocuSign Professional Services or DocuSign Business Development, who will provide you with the Distributor Code and Distributor Password that you need to include in the request body.\n\nYou must include the `X-DocuSign-Authentication` header.\n\nExample:\n\n`{{integratorKey}}`\n\nWhen creating a single account,\nthe body of the request is a\n[`newAccountRequest`][newAccountRequest]\nobject.\n\nExample:\n\n```\n{\n\t\"newAccountRequest\": [\n\t\t{\n\t\t\t\"accountName\":\"Test Account\",\n\t\t\t\"distributorCode\":\"MY_DIST_CODE\",\n\t\t\t\"distributorPassword\":\"MY_DIST_PWD\",\n\t\t\t\"initialUser\":{\n\t\t\t\t\"email\":\"user@emaildomain.com\",\n\t\t\t\t\"firstName\":\"John\",\n\t\t\t\t\"middleName\": \"Harry\",\n\t\t\t\t\"lastName\":\"Doe\",\n\t\t\t\t\"suffixName\": \"\",\n\t\t\t\t\"userName\": \"John Doe\",\n\t\t\t\t\"jobTitle\": \"Engineer\",\n\t\t\t\t\"company\": \"Test Company\"\n\t\t\t},\n\t\t\t\"addressInformation\":{\n\t\t\t\t\"address1\": \"1234 Main Street\",\n\t\t\t\t\"address2\": \"Suite 100\",\n\t\t\t\t\"city\": \"Seattle\",\n\t\t\t\t\"state\": \"WA\",\n\t\t\t\t\"postalCode\": \"98101\",\n\t\t\t\t\"country\": \"US\",\n\t\t\t\t\"phone\": \"1234567890\",\n\t\t\t\t\"fax\": \"1234567891\"\n\t\t\t},\n\t\t\t\"planInformation\":{\n\t\t\t\t\"planId\":\"37085696-xxxx-xxxx-xxxx-7ea067752959\"\n\t\t\t},\n\t\t\t\"referralInformation\":{\n\t\t\t\t\"includedSeats\": \"1\",\n\t\t\t\t\"referralCode\": \"code\",\n\t\t\t\t\"referrerName\": \"name\"\n\t\t\t}\n\t\t}\n\t]\n}\n\n```\nIf the request succeeds,\nit returns a\n201 (Created) HTTP response code.\nThe response returns the new account ID, password, and the default user\ninformation for each newly created account.\n\n\nWhen creating multiple accounts,\nthe body of the request is a\n`newAccountRequests`\nobject,\nwhich contains one or more \n[`newAccountDefinition`][newAccountDefinition]\nobjects.\nYou can create up to 100 new accounts\nat a time this way.\n\nThe body for a multi-account\ncreation request\nlooks like this in JSON:\n\n```\n{\n \"newAccountRequests\": [\n {\n \"accountName\": \"accountone\",\n . . .\n },\n {\n \"accountName\": \"accounttwo\",\n . . .\n }\n ]\n}\n```\n\nA multi-account request\nlooks like this in XML:\n\n```\n\n \n \n . . .\n \n \n . . .\n \n \n\n```\n\nA multi-account creation request\nmay succeed (report a 201 code)\neven if some accounts could not be created.\nIn this case, the `errorDetails` property\nin the response contains specific information\nabout the failure.\n\n\n\n[newAccountDefinition]: #/definitions/newAccountDefinition\n[nameValue]: #/definitions/nameValue\n[newAccountRequest]: #/definitions/newAccountRequest\n", "operationId": "Accounts_PostAccounts", "consumes": [], "produces": [], "parameters": [ - { - "name": "preview_billing_plan", - "in": "query", - "description": "When set to **true**, creates the account using a preview billing plan.", - "required": false, - "type": "string" - }, { "name": "newAccountDefinition", "in": "body", @@ -165,7 +158,7 @@ { "name": "include_account_settings", "in": "query", - "description": "When set to **true**, includes account settings (defined by the [`accountSettings`](https://developers.docusign.com/esign-rest-api/reference/Accounts/Accounts/create/#account-settings) property) in the response. If you omit this parameter, the default behavior is **false**.", + "description": "When set to **true**, includes account settings\nin the response. If you omit this parameter, the default behavior is **false**.", "required": false, "type": "string" } @@ -174,7 +167,7 @@ "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/Accounts" + "$ref": "#/definitions/accountInformation" } }, "400": { @@ -336,7 +329,7 @@ "Invoices" ], "summary": "Retrieves a billing invoice.", - "description": "Retrieves the specified invoice. \n\n###### Note: If the `pdfAvailable` property in the response is set to *true*, you can download a PDF version of the invoice. To download the PDF, make the call again and change the value of the `Accept` property in the header to `Accept: application/pdf`.\n\nPrivileges required: account administrator\n\nThe response returns a list of charges and information about the charges. Quantities are usually shown as 'unlimited' or an integer. Amounts are shown in the currency set for the account.\n\n**Response**\nThe following table provides a description of the different `chargeName` property values. The information will grow as more chargeable items are added to the system.\n\n| chargeName | Description |\n| --- | --- |\n| id_check | ID Check Charge |\n| in_person_signing | In Person Signing charge |\n| envelopes Included | Sent Envelopes for the account |\n| age_verify | Age verification check |\n| ofac | OFAC Check |\n| id_confirm | ID confirmation check |\n| student_authentication | STAN PIN authentication check |\n| wet_sign_fax | Pages for returning signed documents by fax |\n| attachment_fax | Pages for returning attachments by fax |\n| phone_authentication | Phone authentication charge |\n| powerforms | PowerForm envelopes sent |\n| signer_payments | Payment processing charge |\n| outbound_fax | Send by fax charge |\n| bulk_recipient_envelopes | Bulk Recipient Envelopes sent |\n| sms_authentications | SMS authentication charge |\n| saml_authentications | SAML authentication charge |\n| express_signer_certificate | DocuSign Express Certificate charge |\n| personal_signer_certificate | Personal Signer Certificate charge |\n| safe_certificate | SAFE BioPharma Signer Certificate charge |\n| seats | Included active seats charge |\n| open_trust_certificate | OpenTrust Signer Certificate charge | ", + "description": "Retrieves the specified invoice.\n\n**Note**: If the `pdfAvailable` property in the response is set to *true*, you can download a PDF version of the invoice. To download the PDF, make the call again and change the value of the `Accept` property in the header to `Accept: application/pdf`.\n\nPrivileges required: account administrator\n\nThe response returns a list of charges and information about the charges. Quantities are usually shown as 'unlimited' or an integer. Amounts are shown in the currency set for the account.\n\n**Response**\nThe following table provides a description of the different `chargeName` property values. The information will grow as more chargeable items are added to the system.\n\n| chargeName | Description |\n| --- | --- |\n| id_check | ID Check Charge |\n| in_person_signing | In Person Signing charge |\n| envelopes Included | Sent Envelopes for the account |\n| age_verify | Age verification check |\n| ofac | OFAC Check |\n| id_confirm | ID confirmation check |\n| student_authentication | STAN PIN authentication check |\n| wet_sign_fax | Pages for returning signed documents by fax |\n| attachment_fax | Pages for returning attachments by fax |\n| phone_authentication | Phone authentication charge |\n| powerforms | PowerForm envelopes sent |\n| signer_payments | Payment processing charge |\n| outbound_fax | Send by fax charge |\n| bulk_recipient_envelopes | Bulk Recipient Envelopes sent |\n| sms_authentications | SMS authentication charge |\n| saml_authentications | SAML authentication charge |\n| express_signer_certificate | DocuSign Express Certificate charge |\n| personal_signer_certificate | Personal Signer Certificate charge |\n| safe_certificate | SAFE BioPharma Signer Certificate charge |\n| seats | Included active seats charge |\n| open_trust_certificate | OpenTrust Signer Certificate charge |", "operationId": "BillingInvoices_GetBillingInvoice", "consumes": [], "produces": [], @@ -360,7 +353,7 @@ "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/Invoices" + "$ref": "#/definitions/billingInvoice" } }, "400": { @@ -477,7 +470,7 @@ "Payments" ], "summary": "Posts a payment to a past due invoice.", - "description": "Posts a payment to a past due invoice.\n\nThis method can only be used if the `paymentAllowed` value for a past due invoice is true. This can be determined calling [Billing::listInvoicesPastDue](https://developers.docusign.com/esign-rest-api/reference/Billing/Invoices/listPastDue).\n\nThe response returns information for a single payment, if a payment ID was used in the endpoint, or a list of payments. If the from date or to date queries or payment ID are not used, the response returns payment information for the last 365 days. If the request was for a single payment ID, the `nextUri` and `previousUri` properties are not returned.\n\nPrivileges required: account administrator\n", + "description": "Posts a payment to a past due invoice.\n\nThis method can only be used if the `paymentAllowed` value for a past due invoice is true. This can be determined calling [Billing::listInvoicesPastDue](https://developers.docusign.com/docs/esign-rest-api/reference/Billing/Invoices/listPastDue).\n\nThe response returns information for a single payment, if a payment ID was used in the endpoint, or a list of payments. If the from date or to date queries or payment ID are not used, the response returns payment information for the last 365 days. If the request was for a single payment ID, the `nextUri` and `previousUri` properties are not returned.\n\nPrivileges required: account administrator\n", "operationId": "BillingPayments_PostPayment", "consumes": [], "produces": [], @@ -551,7 +544,7 @@ "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/Payments" + "$ref": "#/definitions/billingPaymentItem" } }, "400": { @@ -575,7 +568,7 @@ "BillingPlans" ], "summary": "Get Account Billing Plan", - "description": "Retrieves the billing plan information for the specified account, including the current billing plan, successor plans, billing address, and billing credit card.\n\nBy default the successor plan and credit card information is included in the response. You can exclude this information from the response by adding the appropriate optional query string and setting it to **false**.\n\nResponse\n\nThe response returns the billing plan information, including the currency code, for the plan. The `billingPlan` and `succesorPlans` property values are the same as those shown in the [Billing::getBillingPlan](https://developers.docusign.com/esign-rest-api/reference/Billing/BillingPlans/get) reference. the `billingAddress` and `creditCardInformation` property values are the same as those shown in the [Billing::updatePlan](https://developers.docusign.com/esign-rest-api/reference/Billing/BillingPlans/update) reference.\n\n**Note**: When credit card number information displays, a mask is applied to the response so that only the last 4 digits of the card number are visible.\n", + "description": "Retrieves the billing plan information for the specified account, including the current billing plan, successor plans, billing address, and billing credit card.\n\nBy default the successor plan and credit card information is included in the response. You can exclude this information from the response by adding the appropriate optional query string and setting it to **false**.\n\nResponse\n\nThe response returns the billing plan information, including the currency code, for the plan. The `billingPlan` and `succesorPlans` property values are the same as those shown in the [Billing::getBillingPlan](https://developers.docusign.com/docs/esign-rest-api/reference/Billing/BillingPlans/get) reference. the `billingAddress` and `creditCardInformation` property values are the same as those shown in the [Billing::updatePlan](https://developers.docusign.com/docs/esign-rest-api/reference/Billing/BillingPlans/update) reference.\n\n**Note**: When credit card number information displays, a mask is applied to the response so that only the last 4 digits of the card number are visible.\n", "operationId": "BillingPlan_GetBillingPlan", "consumes": [], "produces": [], @@ -613,7 +606,7 @@ "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/BillingPlans" + "$ref": "#/definitions/accountBillingPlanResponse" } }, "400": { @@ -633,7 +626,7 @@ "tags": [ "BillingPlans" ], - "summary": "Updates the account billing plan.", + "summary": "Updates an account billing plan.", "description": "Updates the billing plan information, billing address, and credit card information for the specified account.", "operationId": "BillingPlan_PutBillingPlan", "consumes": [], @@ -726,6 +719,94 @@ }, "parameters": [] }, + "/v2.1/accounts/{accountId}/billing_plan/downgrade": { + "get": { + "tags": [ + "BillingPlans" + ], + "summary": "Returns downgrade plan information for the specified account.", + "operationId": "BillingPlan_GetDowngradeRequestBillingInfo", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "The external account number (int) or account ID GUID.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/downgradRequestBillingInfoResponse" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "getDowngradeRequestBillingInfo", + "x-ds-method": "getDowngradeRequestBillingInfo", + "x-ds-service": "Uncategorized", + "description": "", + "x-ds-in-sdk": true + }, + "put": { + "tags": [ + "BillingPlans" + ], + "summary": "Queues downgrade billing plan request for an account.", + "operationId": "BillingPlan_PutDowngradeAccountBillingPlan", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "The external account number (int) or account ID GUID.", + "required": true, + "type": "string" + }, + { + "name": "downgradeBillingPlanInformation", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/downgradeBillingPlanInformation" + }, + "description": "" + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/downgradePlanUpdateResponse" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "updateDowngradeAccountBillingPlan", + "x-ds-method": "updateDowngradeAccountBillingPlan", + "x-ds-service": "Uncategorized", + "description": "", + "x-ds-in-sdk": true + }, + "parameters": [] + }, "/v2.1/accounts/{accountId}/billing_plan/purchased_envelopes": { "put": { "tags": [ @@ -801,7 +882,7 @@ { "name": "include_logos", "in": "query", - "description": "When **true**, the URIs for the logos associated with the brand are included in the response.", + "description": "When set to **true**, returns the logos associated with the brand.", "required": false, "type": "string" } @@ -1085,7 +1166,7 @@ "tags": [ "AccountBrands" ], - "summary": "Export a brand.", + "summary": "Exports a brand.", "operationId": "BrandExport_GetBrandExportFile", "consumes": [], "produces": [], @@ -1410,7 +1491,9 @@ ], "summary": "Updates a branding resource file.", "operationId": "BrandResources_PutBrandResources", - "consumes": [], + "consumes": [ + "multipart/form-data" + ], "produces": [], "parameters": [ { @@ -1433,6 +1516,13 @@ "required": true, "type": "string", "description": "The type of brand resource file that you are updating. Valid values are:\n\n- `sending`\n- `signing`\n- `email`\n- `signing_captive`" + }, + { + "name": "file.xml", + "in": "formData", + "description": "Brand resource XML file.", + "required": true, + "type": "file" } ], "responses": { @@ -1458,14 +1548,13 @@ }, "parameters": [] }, - "/v2.1/accounts/{accountId}/bulk_envelopes": { + "/v2.1/accounts/{accountId}/bulk_send_batch": { "get": { "tags": [ - "BulkEnvelopes" + "BulkSend" ], - "summary": "Gets status information about bulk recipient batches.", - "description": "Retrieves status information about all bulk recipient batches. A bulk recipient batch is a set of envelopes sent from a single bulk recipient file.\n\nThe response includes information about each bulk recipient batch, including the `batchId` property, which can be used to retrieve a more detailed status of individual bulk recipient batches. The response also includes information about the envelopes sent with bulk recipient batches.", - "operationId": "BulkEnvelopes_GetEnvelopesBulk", + "summary": "Returns a list of bulk send batch summaries. ", + "operationId": "BulkSendV2Batch_GetBulkSendBatches", "consumes": [], "produces": [], "parameters": [ @@ -1477,32 +1566,39 @@ "type": "string" }, { - "name": "count", + "name": "batch_ids", "in": "query", - "description": "The number of results to return. Can be 1 to 20.", "required": false, - "type": "string" + "type": "string", + "description": "A comma-separated list of batch IDs to query." }, { - "name": "include", + "name": "count", "in": "query", "required": false, "type": "string", - "description": "Specifies which entries to include in the response. You can include multiple entries by using commas in the query string. For example: `?include=\"failed,queued\"`.\n\nValid query values:\n* `all` - Returns all entries. This overrides all other query settings, and is the default if no query string is provided.\n* `failed` - Return entries with a failed status.\n* `processing` - Return entries with a processing status.\n* `queued` - Return entries with a queued status.\n* `sent` - Return entries with a sent status." + "description": "The number of results to report. Must be a value from 1 to 1000.\n\nDefault: 100" }, { "name": "start_position", "in": "query", - "description": "Specifies the position of the bulk envelope items from which to start returning results. You can use this parameter for repeated calls, when the number of bulk envelopes returned is too large to be included in a single response. The default value is 0.", "required": false, - "type": "string" + "type": "string", + "description": "The start position for results. Essentially the number of results to skip before collecting them. Must be a value greater than 0." + }, + { + "name": "status", + "in": "query", + "required": false, + "type": "string", + "description": "The kind of results to collect. Must be one of:\n\n- all\n- failed\n- sent\n- queued" } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/BulkEnvelopes" + "$ref": "#/definitions/bulkSendBatchSummaries" } }, "400": { @@ -1513,21 +1609,21 @@ } }, "deprecated": false, - "x-ds-methodname": "list", - "x-ds-method": "list", - "x-ds-service": "BulkEnvelopes", + "x-ds-methodname": "getBulkSendBatches", + "x-ds-method": "getBulkSendBatches", + "x-ds-service": "Uncategorized", + "description": "Returns a summary of bulk send batches.\n\nUse the `batch_ids` query parameter to narrow the list of batches.", "x-ds-in-sdk": true }, "parameters": [] }, - "/v2.1/accounts/{accountId}/bulk_envelopes/{batchId}": { + "/v2.1/accounts/{accountId}/bulk_send_batch/{bulkSendBatchId}": { "get": { "tags": [ - "BulkEnvelopes" + "BulkSend" ], - "summary": "Gets the status of a specified bulk send operation.", - "description": "Retrieves the status information of a specified bulk recipient batch, which is a set of envelopes sent from a single bulk recipient file.", - "operationId": "BulkEnvelopes_GetBulkEnvelopesBatchId", + "summary": "Gets the status of a specific bulk send batch.", + "operationId": "BulkSendV2Batch_GetBulkSendBatchStatus", "consumes": [], "produces": [], "parameters": [ @@ -1539,39 +1635,18 @@ "type": "string" }, { - "name": "batchId", + "name": "bulkSendBatchId", "in": "path", "required": true, "type": "string", - "description": "Identifier used to query the status of an individual bulk recipient batch." - }, - { - "name": "count", - "in": "query", - "description": "The maximum number of results to return.", - "required": false, - "type": "string" - }, - { - "name": "include", - "in": "query", - "description": "Specifies which entries to include in the response. You can include multiple entries by using commas in the query string. For example: `?include=\"failed,queued\"`.\n\nValid query values:\n* `all` - Returns all entries. This overrides all other query settings, and is the default if no query string is provided.\n* `failed` - Return entries with a failed status.\n* `processing` - Return entries with a processing status.\n* `queued` - Return entries with a queued status.\n* `sent` - Return entries with a sent status.", - "required": false, - "type": "string" - }, - { - "name": "start_position", - "in": "query", - "description": "Specifies the position in the list of envelopes from which to start returning bulk recipient batch status information.", - "required": false, - "type": "string" + "description": "The batch ID." } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/bulkEnvelopeStatus" + "$ref": "#/definitions/bulkSendBatchStatus" } }, "400": { @@ -1582,21 +1657,18 @@ } }, "deprecated": false, - "x-ds-methodname": "get", - "x-ds-method": "get", - "x-ds-service": "BulkEnvelopes", + "x-ds-methodname": "getBulkSendBatchStatus", + "x-ds-method": "getBulkSendBatchStatus", + "x-ds-service": "Uncategorized", + "description": "Gets the general status of a specific bulk send batch such as:\n\n- number of successes\n- number pending\n- number of errors\n\nThe `bulkErrors` property of the response object contains more information about the errors.", "x-ds-in-sdk": true }, - "parameters": [] - }, - "/v2.1/accounts/{accountId}/captive_recipients/{recipientPart}": { - "delete": { + "put": { "tags": [ - "Accounts" + "BulkSend" ], - "summary": "Deletes the signature for one or more captive recipient records.", - "description": "Deletes the signature for one or more captive recipient records; it is primarily used for testing. This provides a way to reset the signature associated with a client user ID so that a new signature can be created the next time the client user ID is used.", - "operationId": "CaptiveRecipients_DeleteCaptiveRecipientsPart", + "summary": "Updates a specific bulk send batch status.", + "operationId": "BulkSendV2Batch_PutBulkSendBatchStatus", "consumes": [], "produces": [], "parameters": [ @@ -1608,76 +1680,27 @@ "type": "string" }, { - "name": "recipientPart", + "name": "bulkSendBatchId", "in": "path", "required": true, "type": "string", - "description": "Signature is the only supported value. " - }, - { - "name": "captiveRecipientInformation", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/captiveRecipientInformation" - }, "description": "" - } - ], - "responses": { - "200": { - "description": "Successful response.", - "schema": { - "$ref": "#/definitions/captiveRecipientInformation" - } - }, - "400": { - "description": "Error encountered.", - "schema": { - "$ref": "#/definitions/errorDetails" - } - } - }, - "deprecated": false, - "x-ds-methodname": "deleteCaptiveRecipient", - "x-ds-method": "deleteCaptiveRecipient", - "x-ds-service": "Accounts", - "x-ds-in-sdk": true - }, - "parameters": [] - }, - "/v2.1/accounts/{accountId}/chunked_uploads": { - "post": { - "tags": [ - "ChunkedUploads" - ], - "summary": "Initiate a new chunked upload.", - "operationId": "ChunkedUploads_PostChunkedUploads", - "consumes": [], - "produces": [], - "parameters": [ - { - "name": "accountId", - "in": "path", - "description": "The external account number (int) or account ID GUID.", - "required": true, - "type": "string" }, { - "name": "chunkedUploadRequest", + "name": "bulkSendBatchRequest", "in": "body", "required": false, "schema": { - "$ref": "#/definitions/chunkedUploadRequest" + "$ref": "#/definitions/bulkSendBatchRequest" }, "description": "" } ], "responses": { - "201": { + "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/ChunkedUploads" + "$ref": "#/definitions/bulkSendBatchStatus" } }, "400": { @@ -1688,22 +1711,21 @@ } }, "deprecated": false, - "x-ds-methodname": "createChunkedUpload", - "x-ds-api-status": "beta", - "x-ds-method": "create", - "x-ds-service": "Envelopes", - "description": "This method initiates a new chunked upload with the first part of the content.", + "x-ds-methodname": "updateBulkSendBatchStatus", + "x-ds-method": "updateBulkSendBatchStatus", + "x-ds-service": "Uncategorized", + "description": "", "x-ds-in-sdk": true }, "parameters": [] }, - "/v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}": { + "/v2.1/accounts/{accountId}/bulk_send_lists": { "get": { "tags": [ - "ChunkedUploads" + "BulkSend" ], - "summary": "Retrieves metadata about a chunked upload.", - "operationId": "ChunkedUploads_GetChunkedUpload", + "summary": "Gets bulk send lists", + "operationId": "BulkSendV2CRUD_GetBulkSendLists", "consumes": [], "produces": [], "parameters": [ @@ -1713,27 +1735,13 @@ "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" - }, - { - "name": "chunkedUploadId", - "in": "path", - "required": true, - "type": "string", - "description": "The id of the chunked upload. " - }, - { - "name": "include", - "in": "query", - "required": false, - "type": "string", - "description": "(Optional) This parameter enables you to include additional attribute data in the response. The valid value for this method is `checksum`, which returns an SHA256 checksum of the content of the chunked upload in the response. You can use compare this checksum against your own checksum of the original content to verify that there are no missing parts before you attempt to commit the chunked upload." } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/ChunkedUploads" + "$ref": "#/definitions/bulkSendingListSummaries" } }, "400": { @@ -1744,49 +1752,43 @@ } }, "deprecated": false, - "x-ds-methodname": "getChunkedUpload", - "x-ds-api-status": "beta", - "x-ds-method": "get", - "x-ds-service": "Envelopes", - "description": "Returns the details (but not the content) about a chunked upload.\n\n**Note**: You cannot obtain details about a chunked upload that has expired, been deleted, or consumed by other actions.", + "x-ds-methodname": "getBulkSendLists", + "x-ds-method": "getBulkSendLists", + "x-ds-service": "Uncategorized", + "description": "This method returns a list of bulk send lists belonging to the current user, as well as basic information about each list.", "x-ds-in-sdk": true }, - "put": { + "post": { "tags": [ - "ChunkedUploads" + "BulkSend" ], - "summary": "Commit a chunked upload.", - "operationId": "ChunkedUploads_PutChunkedUploads", + "summary": "Creates a bulk send list", + "operationId": "BulkSendV2CRUD_PostBulkSendList", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", - "description": "(Required) The external account number (int) or account ID GUID.", + "description": "The id of the account.", "required": true, "type": "string" }, { - "name": "chunkedUploadId", - "in": "path", - "required": true, - "type": "string", - "description": "(Required) The id of the chunked upload to commit." - }, - { - "name": "action", - "in": "query", + "name": "bulkSendingList", + "in": "body", "required": false, - "type": "string", - "description": "(Required) You must use this query parameter with the value `commit`, which affirms the request to validate and prepare the chunked upload for use with other API calls." + "schema": { + "$ref": "#/definitions/bulkSendingList" + }, + "description": "" } ], "responses": { - "200": { + "201": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/ChunkedUploads" + "$ref": "#/definitions/bulkSendingList" } }, "400": { @@ -1797,19 +1799,21 @@ } }, "deprecated": false, - "x-ds-methodname": "updateChunkedUpload", - "x-ds-api-status": "beta", - "x-ds-method": "commit", - "x-ds-service": "Envelopes", - "description": "This method checks the integrity of a chunked upload and then commits it. When this request is successful, the chunked upload is then ready to be referenced in other API calls.\n\nIf the request is unsuccessful, ensure that you have uploaded all of the parts by using the Update method.\n\n**Note**: After you commit a chunked upload, it no longer accepts additional parts.", + "x-ds-methodname": "createBulkSendList", + "x-ds-method": "createBulkSendList", + "x-ds-service": "Uncategorized", + "description": "This method creates a bulk send list that you can use to send an envelope to up to 1,000 recipients at once.\n\nIt returns the following errors:\n\n| Error code | Description |\n| :------------------------------------------------------ | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| BULK_SEND_MAX_COPIES_EXCEEDED | A bulk sending list cannot specify more than XXX copies in the mailing list. Call the settings API endpoint to find the maximum number of copies in a batch allowed for your account. In almost all cases, the default limit is 1000. |\n| BULK_SEND_RECIPIENT_IDS_MUST_BE_UNIQUE | No two recipientIds can be same within a bulkCopy. Same restriction as a regular envelope applies. Specify unique recipient IDs for each recipient within a bulkCopy (model for envelope in mailing list). |\n| BULK_SEND_RECIPIENT_ID_REQUIRED | If no RoleName is present, recipientID is required in mailing list's bulkCopy. Add a roleName (that coalesces with template/envelope) or a recipientID. |\n| BULK_SEND_RECIPIENT_NAME_REQUIRED | Recipient {0} has no name. Specify a name for the recipient. |\n| BULK_SEND_EMAIL_ADDRESS_REQUIRED_FOR_EMAIL_RECIPIENT | Recipient {0} is an email recipient with no email address. Specify an email for the email recipient. |\n| BULK_SEND_FAX_NUMBER_REQUIRED_FOR_FAX_RECIPIENT | Recipient {0} is a fax recipient with no fax number. Specify a fax number for the fax recipient. |\n| BULK_SEND_FAX_NUMBER_NOT_VALID | Recipient {0} specifies fax number {1}, which is not valid. Specify a valid fax number for the fax recipient. |\n| BULK_SEND_EMAIL_ADDRESS_NOT_VALID | Recipient {0} specifies email address {1}, which is not a valid email address. Specify a valid email address for the recipient. |\n| BULK_SEND_PHONE_NUMBER_REQURED_FOR_SMS_AUTH | Recipient {0} specifies SMS auth, but no number was provided. Specify a phone number for the SMS auth recipient. |\n| BULK_SEND_PHONE_NUMBER_INVALID_FOR_SMS_AUTH | Recipient {0} specifies phone number {1} for SMS auth, which is not valid. Specify a valid phone number for the SMS auth recipient. |\n| BULK_SEND_ROLE_NAMES_MUST_BE_UNIQUE | Recipient role names cannot be duplicated; role {duplicateRecipientRole} appears multiple times. Use unique roleNames for recipients. |\n| BULK_SEND_CANNOT_USE_BOTH_ROLE_AND_ID_ON_SAME_RECIPIENT | Recipients cannot have both ID and Role; {0} has both. Specify a roleName or recipientId, but not both for the same recipient. |\n| BULK_SEND_CANNOT_USE_BOTH_ROLE_AND_ID_IN_SAME_LIST | Cannot use both recipient role and ID in the same list. Specify a roleName or recipientId, but not both in the same list. |\n| BULK_SEND_INVALID_ID_CHECK_CONFIGURATION | Recipient {0} specified SMS authentication, but no SMS auth settings were provided. Provide an SMS auth setting (proper ID configuration) if SMS auth is specified. |\n| BULK_SEND_INVALID_SBS_INPUT_CONFIGURATION | Recipient {0} has more than one signature provider specified. Or signingProviderName is not specified. Or Signature provider : {0} is either unknown or not an available pen for this account. One or more SBS configuration is missing or invalid. The error details provide specifics. |\n| BULK_SEND_TAB_LABELS_MUST_BE_UNIQUE | Tab label {0} is duplicated. Needs to be unique. Use a unique tab label. |\n| BULK_SEND_TAB_LABEL_REQUIRED | Tab label is required. Specify a tab label. |\n| BULK_SEND_TAB_VALUE_REQUIRED | Tab Label value is required. Specify a value for the tab label. |\n| BULK_SEND_ENVELOPE_CUSTOM_FIELD_NAME_MUST_BE_UNIQUE | Custom fields must have distinct names. The field {0} appears more than once in a copy. Use unique names for custom fields. |\n| BULK_SEND_ENVELOPE_CUSTOM_FIELD_NAME_REQUIRED | All custom fields must have names. Specify a name for the custom field. |\n| BULK_SEND_ENVELOPE_CUSTOM_FIELD_VALUE_REQUIRED | Custom field {0} has no value. A custom field can have an empty value, but it cannot have a null value. Specify a value for the custom field. |", "x-ds-in-sdk": true }, - "delete": { + "parameters": [] + }, + "/v2.1/accounts/{accountId}/bulk_send_lists/{bulkSendListId}": { + "get": { "tags": [ - "ChunkedUploads" + "BulkSend" ], - "summary": "Deletes a chunked upload.", - "operationId": "ChunkedUploads_DeleteChunkedUpload", + "summary": "Gets a specific bulk send list", + "operationId": "BulkSendV2CRUD_GetBulkSendList", "consumes": [], "produces": [], "parameters": [ @@ -1821,18 +1825,18 @@ "type": "string" }, { - "name": "chunkedUploadId", + "name": "bulkSendListId", "in": "path", "required": true, "type": "string", - "description": "The id of the chunked upload. " + "description": "The GUID of the bulk send list. This property is created after you post a new bulk send list." } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/ChunkedUploads" + "$ref": "#/definitions/bulkSendingList" } }, "400": { @@ -1843,22 +1847,18 @@ } }, "deprecated": false, - "x-ds-methodname": "deleteChunkedUpload", - "x-ds-api-status": "beta", - "x-ds-method": "delete", - "x-ds-service": "Envelopes", - "description": "Deletes a chunked upload that has been committed but not yet consumed.\n\nThis method cannot be used to delete the following types of chunked uploads, which the system deletes automatically:\n\n\n- Chunked uploads that have been consumed by use in another API call.\n- Expired chunked uploads.\n\n**Note**: If you are aware of a chunked upload that can be discarded, the best practice is to explicitly delete it. If you wait for the system to automatically delete it after it expires, the chunked upload will continue to count against your quota.", + "x-ds-methodname": "getBulkSendList", + "x-ds-method": "getBulkSendList", + "x-ds-service": "Uncategorized", + "description": "This method returns all of the details associated with a specific bulk send list that belongs to the current user.", "x-ds-in-sdk": true }, - "parameters": [] - }, - "/v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/{chunkedUploadPartSeq}": { "put": { "tags": [ - "ChunkedUploads" + "BulkSend" ], - "summary": "Add a chunk to an existing chunked upload.", - "operationId": "ChunkedUploads_PutChunkedUploadPart", + "summary": "Updates a bulk send list", + "operationId": "BulkSendV2CRUD_PutBulkSendList", "consumes": [], "produces": [], "parameters": [ @@ -1870,25 +1870,18 @@ "type": "string" }, { - "name": "chunkedUploadId", + "name": "bulkSendListId", "in": "path", "required": true, "type": "string", - "description": "The id of the chunked upload. " + "description": "The GUID of the bulk send list. This property is created after you post a new bulk send list." }, { - "name": "chunkedUploadPartSeq", - "in": "path", - "required": true, - "type": "string", - "description": "The sequence or order of the part in the chunked upload. By default, the sequence of the first part that is uploaded as part of the Create request is `0`.\n\n**Note**: You can add parts out of order. However, the chunked upload must consist of a contiguous series of one or more parts before you can successfully commit it." - }, - { - "name": "chunkedUploadRequest", + "name": "bulkSendingList", "in": "body", "required": false, "schema": { - "$ref": "#/definitions/chunkedUploadRequest" + "$ref": "#/definitions/bulkSendingList" }, "description": "" } @@ -1897,7 +1890,7 @@ "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/ChunkedUploads" + "$ref": "#/definitions/bulkSendingList" } }, "400": { @@ -1908,23 +1901,18 @@ } }, "deprecated": false, - "x-ds-methodname": "updateChunkedUploadPart", - "x-ds-api-status": "beta", - "x-ds-method": "update", - "x-ds-service": "Envelopes", - "description": "Adds a chunk or part to an existing chunked upload. After you use the Create method to initiate a new chunked upload and upload the first part, \nuse this method to upload subsequent parts.\n\nFor simplicity, we recommend that you upload the parts in their sequential order ( 1,2, 3, 4, etc.). The Create method adds the first part and assigns it the `sequence` value `0`. As a result, we recommend that you start with a `sequence` value of `1` when you use this method, and continue uploading parts contiguously until you have uploaded the entirety of the original content to DocuSign.\n\nExample:\n\n\n```\nPUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/1\nPUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/2\nPUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/3\n```\n\n**Note**: You cannot replace a part that DocuSign has already received, or add parts to a chunked upload that is already successfully committed.", + "x-ds-methodname": "updateBulkSendList", + "x-ds-method": "updateBulkSendList", + "x-ds-service": "Uncategorized", + "description": "This method replaces the definition of an existing bulk send list.", "x-ds-in-sdk": true }, - "parameters": [] - }, - "/v2.1/accounts/{accountId}/connect": { - "get": { + "delete": { "tags": [ - "ConnectConfigurations" + "BulkSend" ], - "summary": "Get Connect Configuration Information", - "description": "Retrieves all the DocuSign Custom Connect definitions for the specified account.\n\n###### Note: Connect must be enabled for your account to use this function. This does not retrieve information for Connect configurations for Box, eOriginal, or Salesforce.", - "operationId": "Connect_GetConnectConfigs", + "summary": "Deletes a bulk send list", + "operationId": "BulkSendV2CRUD_DeleteBulkSendList", "consumes": [], "produces": [], "parameters": [ @@ -1934,13 +1922,20 @@ "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" + }, + { + "name": "bulkSendListId", + "in": "path", + "required": true, + "type": "string", + "description": "The GUID of the bulk send list. This property is created after you post a new bulk send list." } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/connectConfigResults" + "$ref": "#/definitions/bulkSendingListSummaries" } }, "400": { @@ -1951,18 +1946,21 @@ } }, "deprecated": false, - "x-ds-methodname": "listConfigurations", - "x-ds-method": "list", - "x-ds-service": "Connect", + "x-ds-methodname": "deleteBulkSendList", + "x-ds-method": "deleteBulkSendList", + "x-ds-service": "Uncategorized", + "description": "This method deletes a bulk send list.", "x-ds-in-sdk": true }, - "put": { + "parameters": [] + }, + "/v2.1/accounts/{accountId}/bulk_send_lists/{bulkSendListId}/send": { + "post": { "tags": [ - "ConnectConfigurations" + "BulkSend" ], - "summary": "Updates a specified Connect configuration.", - "description": "Updates the specified DocuSign Connect configuration in your account.\n\n###### Note: Connect must be enabled for your account to use this function. This cannot be used to update Connect configurations for Box, eOriginal, or Salesforce.", - "operationId": "Connect_PutConnectConfiguration", + "summary": "Creates a bulk send request", + "operationId": "BulkSendV2Send_PostBulkSendRequest", "consumes": [], "produces": [], "parameters": [ @@ -1974,20 +1972,27 @@ "type": "string" }, { - "name": "ConnectConfigurations", + "name": "bulkSendListId", + "in": "path", + "required": true, + "type": "string", + "description": "The GUID of the bulk send list. This property is created after you post a new bulk send list." + }, + { + "name": "bulkSendRequest", "in": "body", "required": false, "schema": { - "$ref": "#/definitions/ConnectConfigurations" + "$ref": "#/definitions/bulkSendRequest" }, "description": "" } ], "responses": { - "200": { + "201": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/ConnectConfigurations" + "$ref": "#/definitions/bulkSendResponse" } }, "400": { @@ -1998,18 +2003,21 @@ } }, "deprecated": false, - "x-ds-methodname": "updateConfiguration", - "x-ds-method": "update", - "x-ds-service": "Connect", + "x-ds-methodname": "createBulkSendRequest", + "x-ds-method": "createBulkSendRequest", + "x-ds-service": "Uncategorized", + "description": "This method initiates the bulk send process. It generates a bulk send request based on an [existing bulk send list][create_list] and an envelope or template.\n\nConsider using the [BulkSend::createBulkSendTestRequest][create_test] method to test your bulk send list for compatibility with the envelope or template that you want to send first. To learn about the complete bulk send flow, see the [Bulk Send overview][BulkSendOverview].\n\nIf the envelopes were successfully queued for asynchronous processing, the response contains a `batchId` that you can use to get the status of the batch. If a failure occurs, the API returns an error message.\n\n**Note**: Partial success or failure generally does not occur. Only the entire batch is queued for asynchronous processing.\n\nThis method returns the following errors:\n\n| Error code | Description |\n| :--------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| BULK_SEND_ENVELOPE_NOT_IN_SENDABLE_STATE | Envelope {0} is not in a sendable state. The envelope is not complete. Make sure it has a sendable status, such as `created`. |\n| BULK_SEND_ENVELOPE_LIST_CONTAINS_NO_COPIES | Cannot send an envelope with a bulk sending list which contains no copies. The list you're trying to bulk send is empty. Make sure the bulk sending list you're using contains recipients. |\n| BULK_SEND_ENVELOPE_LIST_CONTAINS_TOO_MANY_COPIES | Bulk sending list contains more than {0} copies. The list you're trying to bulk send will cause your account to exceed the 1,000-copy limit imposed for all accounts. Try sending two or more separate lists. |\n| BULK_SEND_ENVELOPE_CANNOT_BE_NULL | Cannot send a bulk list without an envelope. Specify the envelope ID or template ID for the envelope you want to bulk send. |\n| BULK_SEND_BLOB_STORE_ERROR | Could not save copy of bulk sending list. An error writing to the database occurred. Try again. If the error persists, contact DocuSign Support. |\n| BULK_SEND_ACCOUNT_HAS_TOO_MANY_QUEUED_ENVELOPES | Cannot send this bulk sending list because doing so would exceed the maximum of {maxCopies} in-flight envelopes. This account currently has {unprocessedEnvelopes} envelopes waiting to be processed. Please try again later.\" .Try again later, or contact DocuSign Support to request a higher tier. |\n| BULK_SEND_ENVELOPE_NOT_FOUND | Envelope {envelopeOrTemplateId} does not exist or you do not have permission to access it. The envelopeId or templateId specified could not be found. Specify a valid value. |\n| BULK_SEND_LIST_NOT_FOUND | Bulk Sending list {listId} does not exist or you do not have permission to access it. The mailingListId specified could not be found. Specify a valid value. |\n| BULK_SEND_ENVELOPE_HAS_NO_RECIPIENTS | Bulk sending copy contains recipients, but the specified envelope does not. The recipients on the envelope and the bulk send list do not match. Make sure the envelope and list are compatible for sending. |\n| BULK_SEND_RECIPIENT_ID_DOES_NOT_EXIST_IN_ENVELOPE | Recipient {0} does not exist in the envelope. Add the missing recipient to the envelope. |\n| BULK_SEND_RECIPIENT_ID_DOES_NOT_MATCH | Recipient ID {envelopeMember.ID} does not match. Make sure the recipient information in the list and the envelope match up. |\n| BULK_SEND_ENVELOPE_HAS_BULK_RECIPIENT | Recipient {0} is a bulk recipient. This is not supported. No legacy 'bulk recipient' allowed. In v2.1 of the eSignature API, you must use a bulk send list instead of a bulk recipient. See the API documentation for details. |\n| BULK_SEND_RECIPIENT_ROLE_DOES_NOT_MATCH | Recipient Role {envelopeMember.RoleName} does not match. Make sure the recipient information in the list and the envelope is compatible. |\n| BULK_SEND_DUPLICATE_RECIPIENT_DETECTED | Duplicate recipients ({0}) not allowed, unless recipients have unique routing order specified on envelope. |\n| BULK_SEND_ENVELOPE_HAS_NO_TABS | Bulk sending copy contains tabs, but the specified envelope does not. List and envelope tabs cannot be coalesced. Make sure they are compatible for sending. |\n| BULK_SEND_TAB_LABEL_DOES_NOT_EXIST_IN_ENVELOPE | Tab with label {0} does not exist in envelope. Add the tab label to the envelope, remove the label from the list, or make sure you're specifying the correct list and envelope. |\n| BULK_SEND_TAB_DOES_NOT_MATCH | Tab {0} does not match {0} in envelope. A tab exists on the list that does not match or is missing on the envelope. Make sure the tabs on the list and the envelope match. |\n| BULK_SEND_ENVELOPE_HAS_NO_ENVELOPE_CUSTOM_FIELDS | Bulk sending copy contains custom fields, but the specified envelope does not. There are custom fields on the list that the envelope does not have. Make sure that any custom fields on the list and the envelope match. |\n| BULK_SEND_ENVELOPE_CUSTOM_FIELD_DOES_NOT_EXIST_IN_ENVELOPE | Custom field {0} does not exist in the envelope. Either add the custom field on the list to the envelope, remove the custom field from the list, or make sure you're specifying the correct list and envelope. |\n| BULK_SEND_ENVELOPE_CUSTOM_FIELD_NAME_DOES_NOT_MATCH | Custom field names must match. {0} and {1} do not match. The custom field names on the list and the envelope do not match. Use identical names for both. |\n\n[create_list]: https://developers.docusign.com/docs/esign-rest-api/reference/BulkEnvelopes/BulkSend/createBulkSendList\n[create_test]: https://developers.docusign.com/docs/esign-rest-api/reference/BulkEnvelopes/BulkSend/createBulkSendTestRequest\n[BulkSendOverview]: https://developers.docusign.com/docs/esign-rest-api/reference/BulkEnvelopes/BulkSend\n\n", "x-ds-in-sdk": true }, + "parameters": [] + }, + "/v2.1/accounts/{accountId}/bulk_send_lists/{bulkSendListId}/test": { "post": { "tags": [ - "ConnectConfigurations" + "BulkSend" ], - "summary": "Creates a connect configuration for the specified account.", - "description": "Creates a DocuSign Custom Connect definition for your account. DocuSign Connect enables the sending of real-time data updates to external applications. These updates are generated by user transactions as the envelope progresses through actions to completion. The Connect Service provides updated information about the status of these transactions and returns updates that include the actual content of document form fields. Be aware that, these updates might or might not include the document itself. For more information about Connect, see the [DocuSign Connect](https://developers.docusign.com/esign-rest-api/guides/connect).\n\n###### Note: Connect must be enabled for your account to use this function. This cannot be used to set up Connect configurations for Salesforce or eOriginal.\n", - "operationId": "Connect_PostConnectConfiguration", + "summary": "Creates a bulk send test", + "operationId": "BulkSendV2Test_PostBulkSendTestRequest", "consumes": [], "produces": [], "parameters": [ @@ -2021,11 +2029,18 @@ "type": "string" }, { - "name": "ConnectConfigurations", + "name": "bulkSendListId", + "in": "path", + "required": true, + "type": "string", + "description": "The GUID of the bulk send list. This property is created after you post a new bulk send list." + }, + { + "name": "bulkSendRequest", "in": "body", "required": false, "schema": { - "$ref": "#/definitions/ConnectConfigurations" + "$ref": "#/definitions/bulkSendRequest" }, "description": "" } @@ -2034,7 +2049,471 @@ "201": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/ConnectConfigurations" + "$ref": "#/definitions/bulkSendTestResponse" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "createBulkSendTestRequest", + "x-ds-method": "createBulkSendTestRequest", + "x-ds-service": "Uncategorized", + "description": "This method tests a bulk send list for compatibility with the envelope or template that you want to send. For example, a template that has three roles is not compatible with a bulk send list that has only two recipients. For this reason, you might want to test compatibility first.\n\nA successful test result returns `true` for the `canBeSent` property. An unsuccessful test returns a JSON response that contains information about the errors that occurred.\n\nIf the test is successful, you can then send the envelope or template by using the [BulkSend::createBulkSendRequest][BulkSendRequest] method.\n\n## Envelope Compatibility Checks\n\nThis section describes the envelope compatibility checks that the system performs.\n\n**Top-Level Issues**\n\n- Envelopes must be in a sendable state.\n- The bulk send list must contain at least one copy (instance of an envelope), and no more than the maximum number of copies allowed for the account.\n- The envelope must not be null and must be visible to the current user.\n- The account cannot have more queued envelopes than the maximum number configured for the account.\n- The bulk send list must exist.\n\n**Recipients**\n\n- The envelope must have recipients.\n- If you are using an envelope, all of the recipients defined in the bulk send list must have corresponding recipient IDs in the envelope definition. If you are using a template, you must either match the recipient IDs or role IDs.\n- The envelope cannot contain a bulk recipient (an artifact of the legacy version of DocuSign's bulk send\n functionality).\n\n**Recipient Tabs**\n\n- Every `recipient ID, tab label` pair in the bulk send list must correspond to a tab in the envelope.\n\n**Custom Fields**\n\n- Each envelope-level custom field in the bulk send list must correspond to the name of a `customField` in the\n envelope definition. You do not have to match the recipient-level custom fields.\n\n[BulkSendRequest]: https://developers.docusign.com/docs/esign-rest-api/reference/BulkEnvelopes/BulkSend/createBulkSendRequest\n\n\n", + "x-ds-in-sdk": true + }, + "parameters": [] + }, + "/v2.1/accounts/{accountId}/captive_recipients/{recipientPart}": { + "delete": { + "tags": [ + "Accounts" + ], + "summary": "Deletes the signature for one or more captive recipient records.", + "description": "This method deletes the signature for one or more captive recipient records. It is primarily used for testing. This functionality provides a way to reset the signature associated with a client user ID so that a new signature can be created the next time the client user ID is used.", + "operationId": "CaptiveRecipients_DeleteCaptiveRecipientsPart", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "The external account number (int) or account ID GUID.", + "required": true, + "type": "string" + }, + { + "name": "recipientPart", + "in": "path", + "required": true, + "type": "string", + "description": "Signature is the only supported value. " + }, + { + "name": "captiveRecipientInformation", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/captiveRecipientInformation" + }, + "description": "" + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/captiveRecipientInformation" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "deleteCaptiveRecipient", + "x-ds-method": "deleteCaptiveRecipient", + "x-ds-service": "Accounts", + "x-ds-in-sdk": true + }, + "parameters": [] + }, + "/v2.1/accounts/{accountId}/chunked_uploads": { + "post": { + "tags": [ + "ChunkedUploads" + ], + "summary": "Initiate a new chunked upload.", + "operationId": "ChunkedUploads_PostChunkedUploads", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "The external account number (int) or account ID GUID.", + "required": true, + "type": "string" + }, + { + "name": "chunkedUploadRequest", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/chunkedUploadRequest" + }, + "description": "" + } + ], + "responses": { + "201": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/chunkedUploadResponse" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "createChunkedUpload", + "x-ds-api-status": "beta", + "x-ds-method": "create", + "x-ds-service": "Envelopes", + "description": "This method initiates a new chunked upload with the first part of the content.", + "x-ds-in-sdk": true + }, + "parameters": [] + }, + "/v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}": { + "get": { + "tags": [ + "ChunkedUploads" + ], + "summary": "Retrieves metadata about a chunked upload.", + "operationId": "ChunkedUploads_GetChunkedUpload", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "The external account number (int) or account ID GUID.", + "required": true, + "type": "string" + }, + { + "name": "chunkedUploadId", + "in": "path", + "required": true, + "type": "string", + "description": "The id of the chunked upload. " + }, + { + "name": "include", + "in": "query", + "required": false, + "type": "string", + "description": "(Optional) This parameter enables you to include additional attribute data in the response. The valid value for this method is `checksum`, which returns an SHA256 checksum of the content of the chunked upload in the response. You can use compare this checksum against your own checksum of the original content to verify that there are no missing parts before you attempt to commit the chunked upload." + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/chunkedUploadResponse" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "getChunkedUpload", + "x-ds-api-status": "beta", + "x-ds-method": "get", + "x-ds-service": "Envelopes", + "description": "Returns the details (but not the content) about a chunked upload.\n\n**Note**: You cannot obtain details about a chunked upload that has expired, been deleted, or consumed by other actions.", + "x-ds-in-sdk": true + }, + "put": { + "tags": [ + "ChunkedUploads" + ], + "summary": "Commit a chunked upload.", + "operationId": "ChunkedUploads_PutChunkedUploads", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "(Required) The external account number (int) or account ID GUID.", + "required": true, + "type": "string" + }, + { + "name": "chunkedUploadId", + "in": "path", + "required": true, + "type": "string", + "description": "(Required) The id of the chunked upload to commit." + }, + { + "name": "action", + "in": "query", + "required": false, + "type": "string", + "description": "(Required) You must use this query parameter with the value `commit`, which affirms the request to validate and prepare the chunked upload for use with other API calls." + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/chunkedUploadResponse" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "updateChunkedUpload", + "x-ds-api-status": "beta", + "x-ds-method": "commit", + "x-ds-service": "Envelopes", + "description": "This method checks the integrity of a chunked upload and then commits it. When this request is successful, the chunked upload is then ready to be referenced in other API calls.\n\nIf the request is unsuccessful, ensure that you have uploaded all of the parts by using the Update method.\n\n**Note**: After you commit a chunked upload, it no longer accepts additional parts.", + "x-ds-in-sdk": true + }, + "delete": { + "tags": [ + "ChunkedUploads" + ], + "summary": "Deletes a chunked upload.", + "operationId": "ChunkedUploads_DeleteChunkedUpload", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "The external account number (int) or account ID GUID.", + "required": true, + "type": "string" + }, + { + "name": "chunkedUploadId", + "in": "path", + "required": true, + "type": "string", + "description": "The id of the chunked upload. " + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/chunkedUploadResponse" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "deleteChunkedUpload", + "x-ds-api-status": "beta", + "x-ds-method": "delete", + "x-ds-service": "Envelopes", + "description": "Deletes a chunked upload that has been committed but not yet consumed.\n\nThis method cannot be used to delete the following types of chunked uploads, which the system deletes automatically:\n\n\n- Chunked uploads that have been consumed by use in another API call.\n- Expired chunked uploads.\n\n**Note**: If you are aware of a chunked upload that can be discarded, the best practice is to explicitly delete it. If you wait for the system to automatically delete it after it expires, the chunked upload will continue to count against your quota.", + "x-ds-in-sdk": true + }, + "parameters": [] + }, + "/v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/{chunkedUploadPartSeq}": { + "put": { + "tags": [ + "ChunkedUploads" + ], + "summary": "Add a chunk to an existing chunked upload.", + "operationId": "ChunkedUploads_PutChunkedUploadPart", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "The external account number (int) or account ID GUID.", + "required": true, + "type": "string" + }, + { + "name": "chunkedUploadId", + "in": "path", + "required": true, + "type": "string", + "description": "The id of the chunked upload. " + }, + { + "name": "chunkedUploadPartSeq", + "in": "path", + "required": true, + "type": "string", + "description": "The sequence or order of the part in the chunked upload. By default, the sequence of the first part that is uploaded as part of the Create request is `0`.\n\n**Note**: You can add parts out of order. However, the chunked upload must consist of a contiguous series of one or more parts before you can successfully commit it." + }, + { + "name": "chunkedUploadRequest", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/chunkedUploadRequest" + }, + "description": "" + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/chunkedUploadResponse" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "updateChunkedUploadPart", + "x-ds-api-status": "beta", + "x-ds-method": "update", + "x-ds-service": "Envelopes", + "description": "Adds a chunk or part to an existing chunked upload. After you use the Create method to initiate a new chunked upload and upload the first part, \nuse this method to upload subsequent parts.\n\nFor simplicity, we recommend that you upload the parts in their sequential order ( 1,2, 3, 4, etc.). The Create method adds the first part and assigns it the `sequence` value `0`. As a result, we recommend that you start with a `sequence` value of `1` when you use this method, and continue uploading parts contiguously until you have uploaded the entirety of the original content to DocuSign.\n\nExample:\n\n\n```\nPUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/1\nPUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/2\nPUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/3\n```\n\n**Note**: You cannot replace a part that DocuSign has already received, or add parts to a chunked upload that is already successfully committed.", + "x-ds-in-sdk": true + }, + "parameters": [] + }, + "/v2.1/accounts/{accountId}/connect": { + "get": { + "tags": [ + "ConnectConfigurations" + ], + "summary": "Get Connect Configuration Information", + "description": "Retrieves all the DocuSign Custom Connect definitions for the specified account.\n\n**Note**: Connect must be enabled for your account to use this function. This does not retrieve information for Connect configurations for Box, eOriginal, or Salesforce.", + "operationId": "Connect_GetConnectConfigs", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "The external account number (int) or account ID GUID.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/connectConfigResults" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "listConfigurations", + "x-ds-method": "list", + "x-ds-service": "Connect", + "x-ds-in-sdk": true + }, + "put": { + "tags": [ + "ConnectConfigurations" + ], + "summary": "Updates a specified Connect configuration.", + "description": "Updates the specified DocuSign Connect configuration in your account.\n\n**Note**: Connect must be enabled for your account to use this function. This cannot be used to update Connect configurations for Box, eOriginal, or Salesforce.", + "operationId": "Connect_PutConnectConfiguration", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "The external account number (int) or account ID GUID.", + "required": true, + "type": "string" + }, + { + "name": "connectCustomConfiguration", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/connectCustomConfiguration" + }, + "description": "" + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/connectCustomConfiguration" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "updateConfiguration", + "x-ds-method": "update", + "x-ds-service": "Connect", + "x-ds-in-sdk": true + }, + "post": { + "tags": [ + "ConnectConfigurations" + ], + "summary": "Creates a connect configuration for the specified account.", + "description": "Creates a DocuSign Custom Connect definition for your account. DocuSign Connect enables the sending of real-time data updates to external applications. These updates are generated by user transactions as the envelope progresses through actions to completion. The Connect Service provides updated information about the status of these transactions and returns updates that include the actual content of document form fields. Be aware that, these updates might or might not include the document itself. For more information about Connect, see the [DocuSign Connect](https://developers.docusign.com/esign-rest-api/guides/connect).\n\n**Note**: Connect must be enabled for your account to use this function. This cannot be used to set up Connect configurations for Salesforce or eOriginal.\n", + "operationId": "Connect_PostConnectConfiguration", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "The external account number (int) or account ID GUID.", + "required": true, + "type": "string" + }, + { + "name": "connectCustomConfiguration", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/connectCustomConfiguration" + }, + "description": "" + } + ], + "responses": { + "201": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/connectCustomConfiguration" } }, "400": { @@ -2057,8 +2536,8 @@ "tags": [ "ConnectConfigurations" ], - "summary": "Get information on a Connect Configuration", - "description": "Retrieves the information for the specified DocuSign Connect configuration.\n\n###### Note: Connect must be enabled for your account to use this function.\n", + "summary": "Gets the details about a Connect configuration.", + "description": "Retrieves the information for the specified DocuSign Connect configuration.\n\n**Note**: Connect must be enabled for your account to use this function.\n", "operationId": "Connect_GetConnectConfig", "consumes": [], "produces": [], @@ -2103,7 +2582,7 @@ "ConnectConfigurations" ], "summary": "Deletes the specified connect configuration.", - "description": "Deletes the specified DocuSign Connect configuration.\n\n###### Note: Connect must be enabled for your account to use this function.\n\n \n", + "description": "Deletes the specified DocuSign Connect configuration.\n\n**Note**: Connect must be enabled for your account to use this function.\n\n\n", "operationId": "Connect_DeleteConnectConfig", "consumes": [], "produces": [], @@ -2207,7 +2686,7 @@ "in": "query", "required": false, "type": "string", - "description": "Filters returned user records by full user name or a substring of user name." + "description": "Filters results based on a full or partial user name.\n\n**Note**: When you enter a partial user name, you do not use a wildcard character." } ], "responses": { @@ -2253,7 +2732,7 @@ { "name": "envelopeId", "in": "path", - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" } @@ -2286,7 +2765,7 @@ "ConnectEvents" ], "summary": "Republishes Connect information for multiple envelopes.", - "description": "Republishes Connect information for the specified set of envelopes. The primary use is to republish Connect post failures by including envelope IDs for the envelopes that failed to post in the request. The list of envelope IDs that failed to post correctly can be retrieved by calling to [Connect::listEventLogs](https://developers.docusign.com/esign-rest-api/reference/Connect/ConnectEvents/list) retrieve the failure log.\n", + "description": "Republishes Connect information for the specified set of envelopes. The primary use is to republish Connect post failures by including envelope IDs for the envelopes that failed to post in the request. The list of envelope IDs that failed to post correctly can be retrieved by calling to [Connect::listEventLogs](https://developers.docusign.com/docs/esign-rest-api/reference/Connect/ConnectEvents/list) retrieve the failure log.\n", "operationId": "ConnectPublish_PutConnectRetry", "consumes": [], "produces": [], @@ -2360,14 +2839,14 @@ "in": "query", "required": false, "type": "string", - "description": "End of the search date range. Only returns templates created up to this date/time. If no value is provided, this defaults to the current date." + "description": "The end of a search date range in UTC DateTime format. When you use this parameter, only templates created up to this date and time are returned.\n\n**Note**: If this property is null, the value defaults to the current date." } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/ConnectEvents" + "$ref": "#/definitions/connectLogs" } }, "400": { @@ -2406,7 +2885,7 @@ { "name": "failureId", "in": "path", - "description": "ID of the Connect post failure.", + "description": "The id of the Connect post failure.", "required": true, "type": "string" } @@ -2436,7 +2915,7 @@ "ConnectEvents" ], "summary": "Gets the Connect log.", - "description": "Retrieves a list of connect log entries for your account.\n\n###### Note: The `enableLog` setting in the Connect configuration must be set to true to enable logging. If logging is not enabled, then no log entries are recorded. ", + "description": "Retrieves a list of connect log entries for your account.\n\n**Note**: The `enableLog` setting in the Connect configuration must be set to true to enable logging. If logging is not enabled, then no log entries are recorded.", "operationId": "ConnectLog_GetConnectLogs", "consumes": [], "produces": [], @@ -2460,14 +2939,14 @@ "in": "query", "required": false, "type": "string", - "description": "End of the search date range. Only returns templates created up to this date/time. If no value is provided, this defaults to the current date." + "description": "The end of a search date range in UTC DateTime format. When you use this parameter, only templates created up to this date and time are returned.\n\n**Note**: If this property is null, the value defaults to the current date." } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/ConnectEvents" + "$ref": "#/definitions/connectLogs" } }, "400": { @@ -2487,8 +2966,8 @@ "tags": [ "ConnectEvents" ], - "summary": "Gets a list of Connect log entries.", - "description": "Retrieves a list of connect log entries for your account.\n\n###### Note: The `enableLog` property in the Connect configuration must be set to **true** to enable logging. If logging is not enabled, then no log entries are recorded.", + "summary": "Deletes a list of Connect log entries.", + "description": "Deletes a list of Connect log entries for your account.", "operationId": "ConnectLog_DeleteConnectLogs", "consumes": [], "produces": [], @@ -2525,8 +3004,8 @@ "tags": [ "ConnectEvents" ], - "summary": "Get the specified Connect log entry.", - "description": "Retrieves the specified Connect log entry for your account.\n\n###### Note: The `enableLog` setting in the Connect configuration must be set to true to enable logging. If logging is not enabled, then no log entries are recorded. ", + "summary": "Gets a Connect log entry.", + "description": "Retrieves the specified Connect log entry for your account.\n\n**Note**: The `enableLog` setting in the Connect configuration must be set to true to enable logging. If logging is not enabled, then no log entries are recorded.", "operationId": "ConnectLog_GetConnectLog", "consumes": [], "produces": [], @@ -2541,14 +3020,14 @@ { "name": "logId", "in": "path", - "description": "ID of the Connect log entry.", + "description": "The id of the Connect log entry.", "required": true, "type": "string" }, { "name": "additional_info", "in": "query", - "description": "When true, the connectDebugLog information is included in the response.", + "description": "When set to **true**, the response includes the `connectDebugLog` information.", "required": false, "type": "string" } @@ -2593,7 +3072,7 @@ { "name": "logId", "in": "path", - "description": "ID of the Connect log entry.", + "description": "The id of the Connect log entry.", "required": true, "type": "string" } @@ -2617,13 +3096,58 @@ }, "parameters": [] }, + "/v2.1/accounts/{accountId}/connect/secret/{keyId}": { + "delete": { + "tags": [ + "ConnectSecret" + ], + "summary": "Deletes the connect HMAC Secret for specified account.", + "operationId": "ConnectHMAC_DeleteConnectSecret", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "The external account number (int) or account ID GUID.", + "required": true, + "type": "string" + }, + { + "name": "keyId", + "in": "path", + "required": true, + "type": "string", + "description": "" + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "deleteConnectSecret", + "x-ds-method": "deleteConnectSecret", + "x-ds-service": "Uncategorized", + "description": "", + "x-ds-in-sdk": true + }, + "parameters": [] + }, "/v2.1/accounts/{accountId}/consumer_disclosure": { "get": { "tags": [ "AccountConsumerDisclosures" ], - "summary": "Gets the Electronic Record and Signature Disclosure for the account.", - "description": "Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, associated with the account. You can use an optional query string to set the language for the disclosure.", + "summary": "Gets the default Electronic Record and Signature Disclosure for an account.", + "description": "Retrieves the default, HTML-formatted Electronic Record and Signature Disclosure (ERSD) associated with the account. \n\nThis is the default ERSD disclosure that DocuSign provides for the convenience of U.S.-based customers only. This default disclosure is only valid for transactions between U.S.-based parties.\n\nTo set the language of the disclosure that you want to retrieve, use the optional `langCode` query parameter.", "operationId": "ConsumerDisclosure_GetConsumerDisclosure", "consumes": [], "produces": [], @@ -2638,7 +3162,7 @@ { "name": "langCode", "in": "query", - "description": "Specifies the language used in the response. The supported languages, with the language value shown in parenthesis, are: Arabic (ar), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk), and Vietnamese (vi).\n\nAdditionally, the value can be set to `browser` to automatically detect the browser language being used by the viewer and display the disclosure in that language. \n", + "description": "(Optional) The code for the signer language version of the disclosure that you want to retrieve. The following languages are supported:\n\n- Arabic (`ar`)\n- Bulgarian (`bg`)\n- Czech (`cs`)\n- Chinese Simplified (`zh_CN`)\n- Chinese Traditional (`zh_TW`)\n- Croatian (`hr`)\n- Danish (`da`)\n- Dutch (`nl`)\n- English US (`en`)\n- English UK (`en_GB`)\n- Estonian (`et`)\n- Farsi (`fa`)\n- Finnish (`fi`)\n- French (`fr`)\n- French Canadian (`fr_CA`)\n- German (`de`)\n- Greek (`el`)\n- Hebrew (`he`)\n- Hindi (`hi`)\n- Hungarian (`hu`)\n- Bahasa Indonesian (`id`)\n- Italian (`it`)\n- Japanese (`ja`)\n- Korean (`ko`)\n- Latvian (`lv`)\n- Lithuanian (`lt`)\n- Bahasa Melayu (`ms`)\n- Norwegian (`no`)\n- Polish (`pl`)\n- Portuguese (`pt`)\n- Portuguese Brazil (`pt_BR`)\n- Romanian (`ro`)\n- Russian (`ru`)\n- Serbian (`sr`)\n- Slovak (`sk`)\n- Slovenian (`sl`)\n- Spanish (`es`)\n- Spanish Latin America (`es_MX`)\n- Swedish (`sv`)\n- Thai (`th`)\n- Turkish (`tr`)\n- Ukrainian (`uk`) \n- Vietnamese (`vi`)\n\nAdditionally, you can automatically detect the browser language being used by the viewer and display the disclosure in that language by setting the value to `browser`.", "required": false, "type": "string" } @@ -2670,8 +3194,8 @@ "tags": [ "AccountConsumerDisclosures" ], - "summary": "Gets the Electronic Record and Signature Disclosure.", - "description": "Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, for the requested envelope recipient. This might be different than the current account disclosure depending on account settings, such as branding, and when the account disclosure was last updated. An optional query string can be included to return the language for the disclosure. ", + "summary": "Gets the Electronic Record and Signature Disclosure for an account.", + "description": "Retrieves the HTML-formatted Electronic Record and Signature Disclosure (ERSD) associated with the account. \n\nTo set the language of the disclosure that you want to retrieve, use the optional `langCode` query parameter.\n\n**Note**: The text of the default disclosure is always in English, but if you are using a custom disclosure and have created versions of it in different signer languages, you can use the `langCode` parameter to specify the signer language version that you want to retrieve. ", "operationId": "ConsumerDisclosure_GetConsumerDisclosureLangCode", "consumes": [], "produces": [], @@ -2686,7 +3210,7 @@ { "name": "langCode", "in": "path", - "description": "The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to \"browser\" to automatically detect the browser language being used by the viewer and display the disclosure in that language.", + "description": "(Optional) The code for the signer language version of the disclosure that you want to retrieve. The following languages are supported:\n\n- Arabic (`ar`)\n- Bulgarian (`bg`)\n- Czech (`cs`)\n- Chinese Simplified (`zh_CN`)\n- Chinese Traditional (`zh_TW`)\n- Croatian (`hr`)\n- Danish (`da`)\n- Dutch (`nl`)\n- English US (`en`)\n- English UK (`en_GB`)\n- Estonian (`et`)\n- Farsi (`fa`)\n- Finnish (`fi`)\n- French (`fr`)\n- French Canadian (`fr_CA`)\n- German (`de`)\n- Greek (`el`)\n- Hebrew (`he`)\n- Hindi (`hi`)\n- Hungarian (`hu`)\n- Bahasa Indonesian (`id`)\n- Italian (`it`)\n- Japanese (`ja`)\n- Korean (`ko`)\n- Latvian (`lv`)\n- Lithuanian (`lt`)\n- Bahasa Melayu (`ms`)\n- Norwegian (`no`)\n- Polish (`pl`)\n- Portuguese (`pt`)\n- Portuguese Brazil (`pt_BR`)\n- Romanian (`ro`)\n- Russian (`ru`)\n- Serbian (`sr`)\n- Slovak (`sk`)\n- Slovenian (`sl`)\n- Spanish (`es`)\n- Spanish Latin America (`es_MX`)\n- Swedish (`sv`)\n- Thai (`th`)\n- Turkish (`tr`)\n- Ukrainian (`uk`) \n- Vietnamese (`vi`)\n\nAdditionally, you can automatically detect the browser language being used by the viewer and display the disclosure in that language by setting the value to `browser`.", "required": true, "type": "string" } @@ -2715,7 +3239,7 @@ "tags": [ "AccountConsumerDisclosures" ], - "summary": "Update Consumer Disclosure.", + "summary": "Updates the Electronic Record and Signature Disclosure for an account.", "operationId": "ConsumerDisclosure_PutConsumerDisclosure", "consumes": [], "produces": [], @@ -2730,7 +3254,7 @@ { "name": "langCode", "in": "path", - "description": "The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to \"browser\" to automatically detect the browser language being used by the viewer and display the disclosure in that language.", + "description": "(Optional) The code for the signer language version of the disclosure that you want to update. The following languages are supported:\n\n- Arabic (`ar`)\n- Bulgarian (`bg`)\n- Czech (`cs`)\n- Chinese Simplified (`zh_CN`)\n- Chinese Traditional (`zh_TW`)\n- Croatian (`hr`)\n- Danish (`da`)\n- Dutch (`nl`)\n- English US (`en`)\n- English UK (`en_GB`)\n- Estonian (`et`)\n- Farsi (`fa`)\n- Finnish (`fi`)\n- French (`fr`)\n- French Canadian (`fr_CA`)\n- German (`de`)\n- Greek (`el`)\n- Hebrew (`he`)\n- Hindi (`hi`)\n- Hungarian (`hu`)\n- Bahasa Indonesian (`id`)\n- Italian (`it`)\n- Japanese (`ja`)\n- Korean (`ko`)\n- Latvian (`lv`)\n- Lithuanian (`lt`)\n- Bahasa Melayu (`ms`)\n- Norwegian (`no`)\n- Polish (`pl`)\n- Portuguese (`pt`)\n- Portuguese Brazil (`pt_BR`)\n- Romanian (`ro`)\n- Russian (`ru`)\n- Serbian (`sr`)\n- Slovak (`sk`)\n- Slovenian (`sl`)\n- Spanish (`es`)\n- Spanish Latin America (`es_MX`)\n- Swedish (`sv`)\n- Thai (`th`)\n- Turkish (`tr`)\n- Ukrainian (`uk`) \n- Vietnamese (`vi`)\n\nAdditionally, you can automatically detect the browser language being used by the viewer and display the disclosure in that language by setting the value to `browser`.", "required": true, "type": "string" }, @@ -2739,14 +3263,14 @@ "in": "query", "required": false, "type": "string", - "description": "When set to **true**, the response includes metadata indicating which properties are editable." + "description": "(Optional) When set to true, the response includes metadata indicating which properties are editable." }, { - "name": "EnvelopeConsumerDisclosures", + "name": "consumerDisclosure", "in": "body", "required": false, "schema": { - "$ref": "#/definitions/EnvelopeConsumerDisclosures" + "$ref": "#/definitions/consumerDisclosure" }, "description": "" } @@ -2755,7 +3279,7 @@ "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/EnvelopeConsumerDisclosures" + "$ref": "#/definitions/consumerDisclosure" } }, "400": { @@ -2769,7 +3293,7 @@ "x-ds-methodname": "updateConsumerDisclosure", "x-ds-method": "update", "x-ds-service": "Accounts", - "description": "", + "description": "Account administrators can use this method to perform the following tasks:\n\n- Customize values in the default disclosure.\n- Switch to a custom disclosure that uses your own text and HTML formatting.\n- Change values in your existing consumer disclosure. \n\nTo specify the signer language version of the disclosure that you are updating, use the optional `langCode` query parameter.\n\n**Note**: Only account administrators can use this method. Each time you change the disclosure content, all unsigned recipients of outstanding documents will be required to accept a new version. \n\n## Updating the default disclosure\n\nWhen you update the default disclosure, you can edit all properties except for the following ones:\n\n- `accountEsignId`: This property is read only.\n- `custom`: The default value is **false**. Editing this property causes the default disclosure to switch to a custom disclosure.\n- `esignAgreement`: This property is read only.\n- `esignText`: You cannot edit this property when `custom` is set to **false**. The API returns a 200 OK HTTP response, but does not update the `esignText`.\n- Metadata properties: These properties are read only.\n\n**Note**: The text of the default disclosure is always in English.\n\n## Switching to a custom disclosure\n\nTo switch to a custom disclosure, set the `custom` property to **true** and customize the value for the `eSignText` property. \n\nYou can also edit all of the other properties except for the following ones:\n\n- `accountEsignId`: This property is read only.\n- `esignAgreement`: This property is read only.\n- Metadata properties: These properties are read only.\n\n**Note**: When you use a custom disclosure, you can create versions of it in different signer languages and se the `langCode` parameter to specify the signer language version that you are updating.\n\n**Important**: When you switch from a default to a custom disclosure, note the following information:\n\n- You will not be able to return to using the default disclosure.\n- Only the disclosure for the currently selected signer language is saved. DocuSign will not automatically translate your custom disclosure. You must create a disclosure for each language that your signers use.\n\n## Updating a custom disclosure\n\nWhen you update a custom disclosure, you can update all of the properties except for the following ones:\n\n- `accountEsignId`: This property is read only. \n- `esignAgreement`: This property is read only.\n- Metadata properties: These properties are read only.\n\n**Important**: Only the disclosure for the currently selected signer language is saved. DocuSign will not automatically translate your custom disclosure. You must create a disclosure for each language that your signers use.\n\n", "x-ds-in-sdk": true }, "parameters": [] @@ -2779,7 +3303,7 @@ "tags": [ "Contacts" ], - "summary": "Replaces contacts associated with an account for the DocuSign service.", + "summary": "Updates one or more contacts.", "operationId": "Contacts_PutContacts", "consumes": [], "produces": [], @@ -2819,14 +3343,14 @@ "x-ds-methodname": "putContacts", "x-ds-method": "update", "x-ds-service": "Users", - "description": "", + "description": "This method updates one or more contacts associated with an account.", "x-ds-in-sdk": true }, "post": { "tags": [ "Contacts" ], - "summary": "Imports multiple new contacts into the contacts collection from CSV, JSON, or XML (based on content type).", + "summary": "Imports new contacts into a contacts list.", "operationId": "Contacts_PostContacts", "consumes": [], "produces": [], @@ -2866,14 +3390,14 @@ "x-ds-methodname": "postContacts", "x-ds-method": "create", "x-ds-service": "Users", - "description": "", + "description": "This method imports multiple new contacts into a contact list from a CSV, JSON, or XML file.\n\nTo use this method, you must provide a request body in one of the supported formats and include a `content-type` header with the appropriate value.", "x-ds-in-sdk": true }, "delete": { "tags": [ "Contacts" ], - "summary": "Delete contacts associated with an account for the DocuSign service.", + "summary": "Deletes multiple contacts from an account.", "operationId": "Contacts_DeleteContacts", "consumes": [], "produces": [], @@ -2913,7 +3437,7 @@ "x-ds-methodname": "deleteContacts", "x-ds-method": "deleteList", "x-ds-service": "Users", - "description": "", + "description": "This method deletes multiple contacts associated with an account.", "x-ds-in-sdk": true }, "parameters": [] @@ -2923,7 +3447,7 @@ "tags": [ "Contacts" ], - "summary": "Gets a particular contact associated with the user's account.", + "summary": "Gets one or more contacts.", "operationId": "Contacts_GetContactById", "consumes": [], "produces": [], @@ -2938,7 +3462,7 @@ { "name": "contactId", "in": "path", - "description": "The unique identifier of a person in the contacts address book.", + "description": "The id of a contact person in the account's address book.", "required": true, "type": "string" }, @@ -2947,7 +3471,7 @@ "in": "query", "required": false, "type": "string", - "description": "" + "description": "(Optional) The cloud provider from which to retrieve the contacts. Valid values are:\n\n- `rooms`\n- `docusignCore` (default)" } ], "responses": { @@ -2968,14 +3492,14 @@ "x-ds-methodname": "getContactById", "x-ds-method": "get", "x-ds-service": "Users", - "description": "", + "description": "This method returns one or more contacts\nassociated with a DocuSign account. You can also\nretrieve contacts from connected [cloud storage][CloudStorage] providers by using the\n`cloud_provider` query parameter. By default,\ncontacts are retrieved from the DocuSign account's\ndefault address book.\n\nTo return a specific contact, use the `contactId`\nquery parameter. To return all contacts associated\nwith an account, omit this parameter.\n\n[CloudStorage]: https://developers.docusign.com/docs/esign-rest-api/reference/CloudStorage", "x-ds-in-sdk": true }, "delete": { "tags": [ "Contacts" ], - "summary": "Replaces a particular contact associated with an account for the DocuSign service.", + "summary": "Deletes a contact.", "operationId": "Contacts_DeleteContactWithId", "consumes": [], "produces": [], @@ -2990,7 +3514,7 @@ { "name": "contactId", "in": "path", - "description": "The unique identifier of a person in the contacts address book.", + "description": "The id of a contact person in the account's address book.", "required": true, "type": "string" } @@ -3013,7 +3537,7 @@ "x-ds-methodname": "deleteContactWithId", "x-ds-method": "delete", "x-ds-service": "Users", - "description": "", + "description": "This method deletes a contact associated with an account.", "x-ds-in-sdk": true }, "parameters": [] @@ -3023,8 +3547,8 @@ "tags": [ "AccountCustomFields" ], - "summary": "Gets a list of custom fields associated with the account.", - "description": "Retrieves a list of envelope custom fields associated with the account. You can use these fields in the envelopes for your account to record information about the envelope, help search for envelopes and track information. The envelope custom fields are shown in the Envelope Settings section when a user is creating an envelope in the DocuSign member console. The envelope custom fields are not seen by the envelope recipients.\n\nThere are two types of envelope custom fields, text, and list. A text custom field lets the sender enter the value for the field. The list custom field lets the sender select the value of the field from a list you provide.", + "summary": "Gets a list of custom fields.", + "description": "This method returns a list of the envelope and document custom fields associated with an account.", "operationId": "AccountCustomFields_GetAccountCustomFields", "consumes": [], "produces": [], @@ -3061,7 +3585,7 @@ "tags": [ "AccountCustomFields" ], - "summary": "Creates an acount custom field.", + "summary": "Creates an account custom field.", "operationId": "AccountCustomFields_PostAccountCustomFields", "consumes": [], "produces": [], @@ -3078,7 +3602,7 @@ "in": "query", "required": false, "type": "string", - "description": "" + "description": "(Optional) When set to **true**, the new custom field is applied to all of the templates on the account." }, { "name": "customField", @@ -3108,7 +3632,7 @@ "x-ds-methodname": "createCustomField", "x-ds-method": "create", "x-ds-service": "Accounts", - "description": "", + "description": "This method creates a custom field and makes it available for all new envelopes associated with an account.", "x-ds-in-sdk": true }, "parameters": [] @@ -3118,7 +3642,7 @@ "tags": [ "AccountCustomFields" ], - "summary": "Updates an existing account custom field.", + "summary": "Updates an account custom field.", "operationId": "AccountCustomFields_PutAccountCustomFields", "consumes": [], "produces": [], @@ -3135,7 +3659,7 @@ "in": "path", "required": true, "type": "string", - "description": "" + "description": "The id of the custom field." }, { "name": "apply_to_templates", @@ -3172,14 +3696,14 @@ "x-ds-methodname": "updateCustomField", "x-ds-method": "update", "x-ds-service": "Accounts", - "description": "", + "description": "This method updates an existing account custom field.", "x-ds-in-sdk": true }, "delete": { "tags": [ "AccountCustomFields" ], - "summary": "Delete an existing account custom field.", + "summary": "Deletes an account custom field.", "operationId": "AccountCustomFields_DeleteAccountCustomFields", "consumes": [], "produces": [], @@ -3196,7 +3720,7 @@ "in": "path", "required": true, "type": "string", - "description": "" + "description": "The id of the custom field." }, { "name": "apply_to_templates", @@ -3221,6 +3745,88 @@ "x-ds-methodname": "deleteCustomField", "x-ds-method": "delete", "x-ds-service": "Accounts", + "description": "This method deletes an existing account custom field.", + "x-ds-in-sdk": true + }, + "parameters": [] + }, + "/v2.1/accounts/{accountId}/display_appliance_info/dynamicsystemsettings": { + "get": { + "tags": [ + "ApplianceInfo" + ], + "summary": "Returns document pages for Display Appliance.", + "operationId": "EnvelopeApplianceInfo_GetDynamicSystemSettings", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "The external account number (int) or account ID GUID.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/displayApplianceInfo" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "getDynamicSystemSettings", + "x-ds-method": "getDynamicSystemSettings", + "x-ds-service": "Uncategorized", + "description": "", + "x-ds-in-sdk": true + }, + "parameters": [] + }, + "/v2.1/accounts/{accountId}/display_appliance_info/templateInfo": { + "post": { + "tags": [ + "ApplianceInfo" + ], + "summary": "Returns whether a template was encrypted by Display Appliance.", + "operationId": "EnvelopeApplianceInfo_GetTemplateInfo", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "The external account number (int) or account ID GUID.", + "required": true, + "type": "string" + } + ], + "responses": { + "201": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/displayApplianceInfo" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "getTemplateInfo", + "x-ds-method": "getTemplateInfo", + "x-ds-service": "Uncategorized", "description": "", "x-ds-in-sdk": true }, @@ -3247,7 +3853,7 @@ { "name": "ac_status", "in": "query", - "description": "Specifies the Authoritative Copy Status for the envelopes. The possible values are: \n\n- `Unknown`\n- `Original`\n- `Transferred`\n- `AuthoritativeCopy`\n- `AuthoritativeCopyExportPending`\n- `AuthoritativeCopyExported`\n- `DepositPending`\n- `Deposited`\n- `DepositedEO`\n- `DepositFailed`", + "description": "Specifies the Authoritative Copy Status for the envelopes. The possible values are: Unknown, Original, Transferred, AuthoritativeCopy, AuthoritativeCopyExportPending, AuthoritativeCopyExported, DepositPending, Deposited, DepositedEO, or DepositFailed.", "required": false, "type": "string" }, @@ -3331,7 +3937,7 @@ { "name": "from_to_status", "in": "query", - "description": "The envelope status that you are checking for. Possible values are:\n\n\n- `Changed` (default)\n- `Completed`\n- `Created`\n- `Declined`\n- `Deleted`\n- `Delivered`\n- `Processing`\n- `Sent`\n- `Signed`\n- `TimedOut`\n- `Voided`\n\nFor example, if you specify `Changed`, this method\nreturns a list of envelopes that changed status\nduring the `from_date` to `to_date` time period. \n", + "description": "This is the status type checked for in the `from_date`/`to_date` period. If `changed` is specified, then envelopes that changed status during the period are found. If for example, `created` is specified, then envelopes created during the period are found. Default is `changed`. \n\nPossible values are: Voided, Changed, Created, Deleted, Sent, Delivered, Signed, Completed, Declined, TimedOut and Processing.", "required": false, "type": "string" }, @@ -3340,14 +3946,14 @@ "in": "query", "required": false, "type": "string", - "description": "Specifies additional information to return about the envelopes. Enter a comma-separated list, such as `tabs,recipients`. Valid values are:\n\n- `custom_fields`: The custom fields associated with the envelope.\n- `documents`: The documents associated with the envelope.\n- `attachments`: The attachments associated with the envelope.\n- `extensions`: Information about the email settings associated with the envelope.\n- `folders`: The folders where the envelope exists.\n- `recipients`: The recipients associated with the envelope.\n- `powerform`: The PowerForms associated with the envelope.\n- `tabs`: The tabs associated with the envelope.\n- `payment_tabs`: The payment tabs associated with the envelope.\n" + "description": "Specifies additional information to return about the envelopes. Enter a comma-separated list, such as `tabs,recipients`. Valid values are:\n\n- `custom_fields`: The custom fields associated with the envelope.\n- `documents`: The documents associated with the envelope.\n- `attachments`: The attachments associated with the envelope.\n- `extensions`: Information about the email settings associated with the envelope.\n- `folders`: The folders where the envelope exists.\n- `recipients`: The recipients associated with the envelope.\n- `powerform`: The PowerForms associated with the envelope.\n- `payment_tabs`: The payment tabs associated with the envelope.\n" }, { "name": "include_purge_information", "in": "query", "required": false, "type": "string", - "description": "When **true**, information about envelopes that the sender has deleted are included in the response." + "description": "When set to **true**, information about envelopes that have been deleted is included in the response." }, { "name": "intersecting_folder_ids", @@ -3391,6 +3997,13 @@ "type": "string", "description": "The time in seconds that the query should run before returning data." }, + { + "name": "requester_date_format", + "in": "query", + "required": false, + "type": "string", + "description": "" + }, { "name": "search_text", "in": "query", @@ -3422,7 +4035,7 @@ { "name": "transaction_ids", "in": "query", - "description": "A comma-separated list of envelope transaction IDs.\nTransaction IDs are only valid for seven days.\n", + "description": "If included in the query string, this is a comma separated list of envelope `transactionId`s. \n\nIf included in the `request_body`, this is a list of envelope `transactionId`s. \n\n###### Note: `transactionId`s are only valid in the DocuSign system for seven days.\n", "required": false, "type": "string" }, @@ -3469,37 +4082,37 @@ "x-ds-in-sdk": true, "x-ds-examples": [ { - "description": "This example shows a how to get information about\nenvelopes created since January 1, 2016.\n\nThe request for this endpoint has no payload.\n\n### Request\n```\nGET /restapi/v2.1/accounts/1703061/envelopes?from_date=2016-01-01\n```\n", + "description": "This example shows a how to get information about\nenvelopes created since January 1, 2016 and before October 6, 2016.\nYou can leave off the `to_date` parameter to get envelopes created from the `from_date` to today.\n\nThe request for this endpoint has no payload.\n\n### Request\n```\nGET /restapi/v2.1/accounts/1703061/envelopes?from_date=2016-01-01&to_date=2016-10-06\n```\n", "direction": "response", "format": "json", "response": { "endPosition": "1", "envelopes": [ { - "certificateUri": "/envelopes/379497bb-cc85-4654-bab9-a8e397f538d0/documents/certificate", - "customFieldsUri": "/envelopes/379497bb-cc85-4654-bab9-a8e397f538d0/custom_fields", - "documentsCombinedUri": "/envelopes/379497bb-cc85-4654-bab9-a8e397f538d0/documents/combined", - "documentsUri": "/envelopes/379497bb-cc85-4654-bab9-a8e397f538d0/documents", - "envelopeId": "379497bb-cc85-4654-bab9-a8e397f538d0", - "envelopeUri": "/envelopes/379497bb-cc85-4654-bab9-a8e397f538d0", - "notificationUri": "/envelopes/379497bb-cc85-4654-bab9-a8e397f538d0/notification", - "recipientsUri": "/envelopes/379497bb-cc85-4654-bab9-a8e397f538d0/recipients", + "certificateUri": "/envelopes/379497bb-xxxx-xxxx-xxxx-a8e397f538d0/documents/certificate", + "customFieldsUri": "/envelopes/379497bb-xxxx-xxxx-xxxx-a8e397f538d0/custom_fields", + "documentsCombinedUri": "/envelopes/379497bb-xxxx-xxxx-xxxx-a8e397f538d0/documents/combined", + "documentsUri": "/envelopes/379497bb-xxxx-xxxx-xxxx-a8e397f538d0/documents", + "envelopeId": "379497bb-xxxx-xxxx-xxxx-a8e397f538d0", + "envelopeUri": "/envelopes/379497bb-xxxx-xxxx-xxxx-a8e397f538d0", + "notificationUri": "/envelopes/379497bb-xxxx-xxxx-xxxx-a8e397f538d0/notification", + "recipientsUri": "/envelopes/379497bb-xxxx-xxxx-xxxx-a8e397f538d0/recipients", "status": "completed", "statusChangedDateTime": "2016-10-04T15:26:28.2830000Z", - "templatesUri": "/envelopes/379497bb-cc85-4654-bab9-a8e397f538d0/templates" + "templatesUri": "/envelopes/379497bb-xxxx-xxxx-xxxx-a8e397f538d0/templates" }, { - "certificateUri": "/envelopes/4b728be4-4417-45c6-b7e8-d63e23f822b6/documents/certificate", - "customFieldsUri": "/envelopes/4b728be4-4417-45c6-b7e8-d63e23f822b6/custom_fields", - "documentsCombinedUri": "/envelopes/4b728be4-4417-45c6-b7e8-d63e23f822b6/documents/combined", - "documentsUri": "/envelopes/4b728be4-4417-45c6-b7e8-d63e23f822b6/documents", - "envelopeId": "4b728be4-4417-45c6-b7e8-d63e23f822b6", - "envelopeUri": "/envelopes/4b728be4-4417-45c6-b7e8-d63e23f822b6", - "notificationUri": "/envelopes/4b728be4-4417-45c6-b7e8-d63e23f822b6/notification", - "recipientsUri": "/envelopes/4b728be4-4417-45c6-b7e8-d63e23f822b6/recipients", + "certificateUri": "/envelopes/4b728be4-xxxx-xxxx-xxxx-d63e23f822b6/documents/certificate", + "customFieldsUri": "/envelopes/4b728be4-xxxx-xxxx-xxxx-d63e23f822b6/custom_fields", + "documentsCombinedUri": "/envelopes/4b728be4-xxxx-xxxx-xxxx-d63e23f822b6/documents/combined", + "documentsUri": "/envelopes/4b728be4-xxxx-xxxx-xxxx-d63e23f822b6/documents", + "envelopeId": "4b728be4-xxxx-xxxx-xxxx-d63e23f822b6", + "envelopeUri": "/envelopes/4b728be4-xxxx-xxxx-xxxx-d63e23f822b6", + "notificationUri": "/envelopes/4b728be4-xxxx-xxxx-xxxx-d63e23f822b6/notification", + "recipientsUri": "/envelopes/4b728be4-xxxx-xxxx-xxxx-d63e23f822b6/recipients", "status": "sent", "statusChangedDateTime": "2016-10-05T01:04:58.7770000Z", - "templatesUri": "/envelopes/4b728be4-4417-45c6-b7e8-d63e23f822b6/templates" + "templatesUri": "/envelopes/4b728be4-xxxx-xxxx-xxxx-d63e23f822b6/templates" } ], "nextUri": "", @@ -3519,7 +4132,7 @@ "Envelopes" ], "summary": "Creates an envelope.", - "description": "Creates and sends an envelope or creates a draft envelope.\nEnvelopes are fundamental resources in the DocuSign platform.\n\nWith this method you can:\n\n* Create and send an envelope\n with [documents][], [recipients][], and [tabs][].\n* Create and send an envelope from a template.\n* Create and send an envelope from\n a combination of documents and templates.\n* Create a draft envelope.\n\n\nWhen you use this method\nto create and send an envelope\nin a single request,\nthe following parameters in the request body (an [`envelopeDefinition`][envelopeDefinition]) are required:\n\n| Parameter | Description |\n| :-------- | :---------- |\n| `status` | Set to `sent` to send the envelope to recipients.
Set to `created` (or don't set at all) to save the envelope as a draft. |\n| `emailSubject` | The subject of the email used to send the envelope. |\n| `documents` | The [documents][] to be signed. |\n| `recipients` | The email addresses of the envelope [recipients][]. |\n\n\nThere are many ways to use envelopes.\nYou can create and send an envelope\nwith a single API request,\nor you can use several API requests\nto create, populate, and send envelopes.\n\n\n| See… | To learn about… |\n| :----------------------- | :--------------------------------------------------------------------------------------------------------------------------------- |\n| [Envelopes][envelopes] | Envelopes, [adding documents][addingdocs], [tracking][], [locking][], [deleting][], [templates][] |\n| [Documents][documents] | Documents, [attachments][], [supplemental documents][supdocs], [authoritative copies][authcopies], [purging][] |\n| [Recipients][recipients] | Recipients, [recipient types][reciptypes], [recipient status][recipstatus] |\n| [Tabs][tabs] | Tabs, [tab types][tabtypes], [anchoring tabs][tabanchor], [auto-populating tabs][tabauto], [custom tabs][tabcustom], [payments][] |\n\n\n[addingdocs]: https://developers.docusign.com/esign-rest-api/guides/concepts/envelopes#adding-documents-to-an-envelope\n[attachments]: https://developers.docusign.com/esign-rest-api/guides/concepts/documents#attachments\n[authcopies]: https://developers.docusign.com/esign-rest-api/guides/concepts/documents#authoritative-copies\n[conoverview]: https://developers.docusign.com/esign-rest-api/guides/concepts/overview\n[deleting]: https://developers.docusign.com/esign-rest-api/guides/concepts/envelopes#deleting-envelopes\n[documents]: https://developers.docusign.com/esign-rest-api/guides/concepts/documents\n[envelopeDefinition]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/create#envelopeDefinition\n[envelopes]: https://developers.docusign.com/esign-rest-api/guides/concepts/envelopes\n[locking]: https://developers.docusign.com/esign-rest-api/guides/concepts/envelopes#locking-envelopes\n[payments]: https://developers.docusign.com/esign-rest-api/guides/concepts/tabs#requesting-payments\n[purging]: https://developers.docusign.com/esign-rest-api/guides/concepts/documents#purging-documents\n[recipients]: https://developers.docusign.com/esign-rest-api/guides/concepts/recipients\n[recipstatus]: https://developers.docusign.com/esign-rest-api/guides/concepts/recipients#recipient-status\n[reciptypes]: https://developers.docusign.com/esign-rest-api/guides/concepts/recipients#recipient-types\n[supdocs]: https://developers.docusign.com/esign-rest-api/guides/concepts/documents#supplemental-documents\n[tabanchor]: https://developers.docusign.com/esign-rest-api/guides/concepts/tabs#anchoring-tabs\n[tabauto]: https://developers.docusign.com/esign-rest-api/guides/concepts/tabs#automatically-populating-tabs\n[tabcustom]: https://developers.docusign.com/esign-rest-api/guides/concepts/tabs#using-custom-tabs-in-envelopes-and-templates\n[tabs]: https://developers.docusign.com/esign-rest-api/guides/concepts/tabs\n[tabtypes]: https://developers.docusign.com/esign-rest-api/guides/concepts/tabs#tab-types\n[templates]: https://developers.docusign.com/esign-rest-api/guides/concepts/envelopes#working-with-templates\n[tracking]: https://developers.docusign.com/esign-rest-api/guides/concepts/envelopes#tracking-envelope-status\n", + "description": "Creates and sends an envelope or creates a draft envelope.\nEnvelopes are fundamental resources in the DocuSign platform.\n\nWith this method you can:\n\n* Create and send an envelope\n with [documents][], [recipients][], and [tabs][].\n* [Create and send an envelope from a template](https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/templates/).\n* [Create and send an envelope from\n a combination of documents and templates](https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/templates/composite/).\n* Create a draft envelope.\n\n\nWhen you use this method\nto create and send an envelope\nin a single request,\nthe following parameters in the request body (an [`envelopeDefinition`][envelopeDefinition]) are required:\n\n| Parameter | Description |\n| :-------- | :---------- |\n| `status` | Set to `sent` to send the envelope to recipients.
Set to `created` (or don't set at all) to save the envelope as a draft. |\n| `emailSubject` | The subject of the email used to send the envelope. |\n| `documents` | The [documents][] to be signed. |\n| `recipients` | The email addresses of the envelope [recipients][]. |\n\n\n**Note**: If the envelope has a workflow definition\nand the `workflowStatus` is `paused`,\nthe envelope will not be sent immediately,\neven if the envelope's `status` is `sent`.\n\nThere are many ways to use envelopes.\nYou can create and send an envelope\nwith a single API request,\nor you can use several API requests\nto create, populate, and send envelopes.\n\n\n| See: | To learn about: |\n| :----------------------- | :--------------------------------------------------------------------------------------------------------------------------------- |\n| [Envelopes][envelopes] | Envelopes, [adding documents][addingdocs], [tracking][], [locking][], [deleting][], [templates][] |\n| [Documents][documents] | Documents, [attachments][], [supplemental documents][supdocs], [authoritative copies][authcopies], [purging][] |\n| [Recipients][recipients] | Recipients, [recipient types][reciptypes], [recipient status][recipstatus] |\n| [Tabs][tabs] | Tabs, [anchoring tabs][tabanchor], [custom tabs][tabcustom], [payments][] |\n\n\n[addingdocs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/envelopes/\n[attachments]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/documents/\n[authcopies]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/documents/\n[conoverview]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/overview\n[deleting]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/envelopes/\n[documents]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/documents\n[envelopeDefinition]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/Envelopes/create/\n[envelopes]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/envelopes\n[locking]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/envelopes/\n[payments]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/payment/\n[purging]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/documents/\n[recipients]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/recipients\n[recipstatus]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/recipients/\n[reciptypes]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/recipients/\n[supdocs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/documents/\n[tabanchor]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place/\n[tabcustom]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/custom-tabs/\n[tabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs\n[tabtypes]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/\n[templates]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/envelopes/\n[tracking]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/envelopes/\n\n**Note**: When you create an envelope by using a [composite template](https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/templates/composite/), you should specify the envelope custom fields in the inline template. Any custom fields that you specify at the root level are ignored.\n", "operationId": "Envelopes_PostEnvelopes", "consumes": [], "produces": [], @@ -3555,7 +4168,7 @@ { "name": "merge_roles_on_draft", "in": "query", - "description": "When set to **true**, template roles will be merged, and empty recipients will be removed. This parameter applies when you create a draft envelope with multiple templates. (To create a draft envelope, the `status` field is set to `created`.)\n\n###### Note: DocuSign recommends that this parameter should be set to **true** whenever you create a draft envelope with multiple templates.", + "description": "When set to **true**, template roles will be merged, and empty recipients will be removed. This parameter applies when you create a draft envelope with multiple templates. (To create a draft envelope, the `status` field is set to `created`.)\n\n**Note**: DocuSign recommends that this parameter should be set to **true** whenever you create a draft envelope with multiple templates.", "required": false, "type": "string" }, @@ -3590,14 +4203,14 @@ "x-ds-in-sdk": true, "x-ds-examples": [ { - "description": "This example shows a request/response that includes:\n\n* A single PDF document to be signed\n* One tab positioned using anchor text\n* One recipient\n\nSee [Requesting a Signature via Email](/esign/guide/usage/request_a_signature.html)\nfor a full walkthrough of this example.\n", + "description": "This example shows a request/response that includes:\n\n* A single PDF document to be signed\n* One tab positioned using anchor text\n* One recipient\n\nSee [Requesting a Signature via Email](/esign-rest-api/code-examples/request-a-signature-via-email)\nfor a full walkthrough of this example.\n", "direction": "both", "format": "json", "response": { - "envelopeId": "63e05468-6432-41d2-b01c-8b48f7dbeb80", + "envelopeId": "63e05468-xxxx-xxxx-xxxx-8b48f7dbeb80", "status": "sent", "statusDateTime": "2016-05-29T17:11:56.1800000Z", - "uri": "/envelopes/63e05468-6432-41d2-b01c-8b48f7dbeb80" + "uri": "/envelopes/63e05468-xxxx-xxxx-xxxx-8b48f7dbeb80" }, "request": { "documents": [ @@ -3664,10 +4277,10 @@ "direction": "both", "format": "json", "response": { - "envelopeId": "63e05468-6432-41d2-b01c-8b48f7dbeb80", + "envelopeId": "63e05468-xxxx-xxxx-xxxx-8b48f7dbeb80", "status": "sent", "statusDateTime": "2016-05-29T17:11:56.1800000Z", - "uri": "/envelopes/63e05468-6432-41d2-b01c-8b48f7dbeb80" + "uri": "/envelopes/63e05468-xxxx-xxxx-xxxx-8b48f7dbeb80" }, "request": { "documents": [ @@ -3817,8 +4430,8 @@ "direction": "both", "format": "json", "response": { - "envelopeId": "aaaaaaaa-41c4-4d21-b6e4-52a86fb94be8", - "uri": "/envelopes/aaaaaaaa-41c4-4d21-b6e4-52a86fb94be8", + "envelopeId": "aaaaaaaa-xxxx-xxxx-xxxx-52a86fb94be8", + "uri": "/envelopes/aaaaaaaa-xxxx-xxxx-xxxx-52a86fb94be8", "statusDateTime": "2017-06-15T11:02:39.3996430Z", "status": "sent" }, @@ -3888,12 +4501,12 @@ "title": "Create a Notarized Signing Recipient" }, { - "description": "DocuSign enables document signers use\n[electronic](https://www.docusign.com/products/electronic-signature) or\n[digital](https://www.docusign.com/how-it-works/electronic-signature/digital-signature) signatures.\n\nDocuSign has tightly integrated standard digital signatures into the DocuSign Signature platform. This enables a single envelope to include:\n\n* electronic signatures,\n* AES digital signatures using certificates from DocuSign or from your organization,\n* QES digital signatures from government certified Trust Service Providers (TSPs).\n\nThis example enables the signer to create an eIDAS compliant AES signature with embedded signing. InPerson signers can also use SBS digital signatures.\n\n[More information on creating SBS digital signature requests.](../../../../guide/appendix/standards_based_signatures.html)\n\nThe `clientId` in the example tells DocuSign that the Signing Ceremony will be embedded.\nThe example also includes an `eventNotification` object for receiving envelope status updates from DocuSign.\n\n## Embedding the signing ceremony\n1. Send the `Envelopes: create` call as shown below in the Request/Response section.\n2. The response will include the `envelopeId`\n3. Use the [EnvelopeViews: createRecipient](../../EnvelopeViews/createRecipient) request to obtain the redirectURL as follows:\n\n`POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/recipient`\n\n````\n{\n \"clientUserId\": \"1000\",\n \"email\": \"Sam@spade.com\",\n \"userName\": \"Sam Spade\",\n \"returnUrl\": \"https://your_app.example.com\",\n \"AuthenticationMethod\": \"Password\"\n}\n````\nThe response will include the `url`. Redirect the user's browser to the url to start the signing ceremony.\n\n###### Note: You must **immediately** redirect the user to the url you receive from DocuSign. The url is only valid for 5 minutes. Don't request a recipient view url until you are ready to redirect the user's browser.\n", + "description": "DocuSign enables document signers use\n[electronic](https://www.docusign.com/products/electronic-signature) or\n[digital](https://www.docusign.com/how-it-works/electronic-signature/digital-signature) signatures.\n\nDocuSign has tightly integrated standard digital signatures into the DocuSign Signature platform. This enables a single envelope to include:\n\n* electronic signatures,\n* AES digital signatures using certificates from DocuSign or from your organization,\n* QES digital signatures from government certified Trust Service Providers (TSPs).\n\nThis example enables the signer to create an eIDAS compliant AES signature with embedded signing. InPerson signers can also use SBS digital signatures.\n\n[More information on creating SBS digital signature requests.](/esign-rest-api/guides/standards-based-signatures)\n\nThe `clientId` in the example tells DocuSign that the Signing Ceremony will be embedded.\nThe example also includes an `eventNotification` object for receiving envelope status updates from DocuSign.\n\n## Embedding the signing ceremony\n1. Send the `Envelopes: create` call as shown below in the Request/Response section.\n2. The response will include the `envelopeId`\n3. Use the [EnvelopeViews: createRecipient](../../EnvelopeViews/createRecipient) request to obtain the redirectURL as follows:\n\n`POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/recipient`\n\n````\n{\n \"clientUserId\": \"1000\",\n \"email\": \"Sam@spade.com\",\n \"userName\": \"Sam Spade\",\n \"returnUrl\": \"https://your_app.example.com\",\n \"AuthenticationMethod\": \"Password\"\n}\n````\nThe response will include the `url`. Redirect the user's browser to the url to start the signing ceremony.\n\n**Note**: You must **immediately** redirect the user to the url you receive from DocuSign. The url is only valid for 5 minutes. Don't request a recipient view url until you are ready to redirect the user's browser.\n", "direction": "both", "format": "json", "response": { - "envelopeId": "caaaaaaa-144e-45ce-8e8e-c171528e99c8", - "uri": "/envelopes/caaaaaaa-144e-45ce-8e8e-c171528e99c8", + "envelopeId": "caaaaaaa-xxxx-xxxx-xxxx-c171528e99c8", + "uri": "/envelopes/caaaaaaa-xxxx-xxxx-xxxx-c171528e99c8", "statusDateTime": "2017-06-22T06:44:49.1642220Z", "status": "sent" }, @@ -3973,7 +4586,7 @@ "Envelopes" ], "summary": "Gets the status of a single envelope.", - "description": "Retrieves the overall status for the specified envelope. To get the status of a list of envelopes, use [Envelope: listStatusChanges ](https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/listStatusChanges/).", + "description": "Retrieves the overall status for the specified envelope.\nTo get the status of a list of envelopes, use\n[Envelope: listStatusChanges ](https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/Envelopes/listStatusChanges/).", "operationId": "Envelopes_GetEnvelope", "consumes": [], "produces": [], @@ -3988,7 +4601,7 @@ { "name": "envelopeId", "in": "path", - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, @@ -4011,7 +4624,7 @@ "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/Envelopes" + "$ref": "#/definitions/envelope" } }, "400": { @@ -4028,71 +4641,71 @@ "x-ds-in-sdk": true, "x-ds-examples": [ { - "description": "This example shows a how to get information about\nan envelope with a given envelope id.\n\nThe request for this endpoint has no payload.\n\n### Request\n```\nGET /restapi/v2.1/accounts/1703061/envelopes/4b728be4-4417-45c6-b7e8-d63e23f822b6\n```\n", + "description": "This example shows a how to get information about\nan envelope with a given envelope id.\n\nThe request for this endpoint has no payload.\n\n### Request\n```\nGET /restapi/v2.1/accounts/1703061/envelopes/4b728be4-xxxx-xxxx-xxxx-d63e23f822b6\n```\n", "direction": "response", "format": "json", "response": { "allowMarkup": "false", "autoNavigation": "true", - "brandId": "56502fe1-3245-4cf5-8d74-97cb5c43176a", - "certificateUri": "/envelopes/4b728be4-4417-45c6-b7e8-d63e23f822b6/documents/certificate", + "brandId": "56502fe1-xxxx-xxxx-xxxx-97cb5c43176a", + "certificateUri": "/envelopes/4b728be4-xxxx-xxxx-xxxx-d63e23f822b6/documents/certificate", "createdDateTime": "2016-10-05T01:04:58.1830000Z", - "customFieldsUri": "/envelopes/4b728be4-4417-45c6-b7e8-d63e23f822b6/custom_fields", - "documentsCombinedUri": "/envelopes/4b728be4-4417-45c6-b7e8-d63e23f822b6/documents/combined", - "documentsUri": "/envelopes/4b728be4-4417-45c6-b7e8-d63e23f822b6/documents", + "customFieldsUri": "/envelopes/4b728be4-xxxx-xxxx-xxxx-d63e23f822b6/custom_fields", + "documentsCombinedUri": "/envelopes/4b728be4-xxxx-xxxx-xxxx-d63e23f822b6/documents/combined", + "documentsUri": "/envelopes/4b728be4-xxxx-xxxx-xxxx-d63e23f822b6/documents", "emailSubject": "Please sign the NDA", "enableWetSign": "true", - "envelopeId": "4b728be4-4417-45c6-b7e8-d63e23f822b6", + "envelopeId": "4b728be4-xxxx-xxxx-xxxx-d63e23f822b6", "envelopeIdStamping": "true", - "envelopeUri": "/envelopes/4b728be4-4417-45c6-b7e8-d63e23f822b6", + "envelopeUri": "/envelopes/4b728be4-xxxx-xxxx-xxxx-d63e23f822b6", "initialSentDateTime": "2016-10-05T01:04:58.7770000Z", "is21CFRPart11": "false", "isSignatureProviderEnvelope": "false", "lastModifiedDateTime": "2016-10-05T01:04:58.1830000Z", - "notificationUri": "/envelopes/4b728be4-4417-45c6-b7e8-d63e23f822b6/notification", + "notificationUri": "/envelopes/4b728be4-xxxx-xxxx-xxxx-d63e23f822b6/notification", "purgeState": "unpurged", - "recipientsUri": "/envelopes/4b728be4-4417-45c6-b7e8-d63e23f822b6/recipients", + "recipientsUri": "/envelopes/4b728be4-xxxx-xxxx-xxxx-d63e23f822b6/recipients", "sentDateTime": "2016-10-05T01:04:58.7770000Z", "status": "sent", "statusChangedDateTime": "2016-10-05T01:04:58.7770000Z", - "templatesUri": "/envelopes/4b728be4-4417-45c6-b7e8-d63e23f822b6/templates" + "templatesUri": "/envelopes/4b728be4-xxxx-xxxx-xxxx-d63e23f822b6/templates" }, "request": null, "style": "custom", "title": "Get Status About a Specific Envelope" }, { - "description": "This example shows a how to get information about\nenvelopes created since January 1, 2016.\n\nThe request for this endpoint has no payload.\n\n### Request\n```\nGET /restapi/v2.1/accounts/1703061/envelopes?from_date=2016-01-01\n```\n", + "description": "This example shows a how to get information about\nenvelopes created since January 1, 2016 and before October 6, 2016.\nYou can leave off the `to_date` parameter to get envelopes created from the `from_date` to today.\n\nThe request for this endpoint has no payload.\n\n### Request\n```\nGET /restapi/v2.1/accounts/1703061/envelopes?from_date=2016-01-01&to_date=2016-10-06\n```\n", "direction": "response", "format": "json", "response": { "endPosition": "1", "envelopes": [ { - "certificateUri": "/envelopes/379497bb-cc85-4654-bab9-a8e397f538d0/documents/certificate", - "customFieldsUri": "/envelopes/379497bb-cc85-4654-bab9-a8e397f538d0/custom_fields", - "documentsCombinedUri": "/envelopes/379497bb-cc85-4654-bab9-a8e397f538d0/documents/combined", - "documentsUri": "/envelopes/379497bb-cc85-4654-bab9-a8e397f538d0/documents", - "envelopeId": "379497bb-cc85-4654-bab9-a8e397f538d0", - "envelopeUri": "/envelopes/379497bb-cc85-4654-bab9-a8e397f538d0", - "notificationUri": "/envelopes/379497bb-cc85-4654-bab9-a8e397f538d0/notification", - "recipientsUri": "/envelopes/379497bb-cc85-4654-bab9-a8e397f538d0/recipients", + "certificateUri": "/envelopes/379497bb-xxxx-xxxx-xxxx-a8e397f538d0/documents/certificate", + "customFieldsUri": "/envelopes/379497bb-xxxx-xxxx-xxxx-a8e397f538d0/custom_fields", + "documentsCombinedUri": "/envelopes/379497bb-xxxx-xxxx-xxxx-a8e397f538d0/documents/combined", + "documentsUri": "/envelopes/379497bb-xxxx-xxxx-xxxx-a8e397f538d0/documents", + "envelopeId": "379497bb-xxxx-xxxx-xxxx-a8e397f538d0", + "envelopeUri": "/envelopes/379497bb-xxxx-xxxx-xxxx-a8e397f538d0", + "notificationUri": "/envelopes/379497bb-xxxx-xxxx-xxxx-a8e397f538d0/notification", + "recipientsUri": "/envelopes/379497bb-xxxx-xxxx-xxxx-a8e397f538d0/recipients", "status": "completed", "statusChangedDateTime": "2016-10-04T15:26:28.2830000Z", - "templatesUri": "/envelopes/379497bb-cc85-4654-bab9-a8e397f538d0/templates" + "templatesUri": "/envelopes/379497bb-xxxx-xxxx-xxxx-a8e397f538d0/templates" }, { - "certificateUri": "/envelopes/4b728be4-4417-45c6-b7e8-d63e23f822b6/documents/certificate", - "customFieldsUri": "/envelopes/4b728be4-4417-45c6-b7e8-d63e23f822b6/custom_fields", - "documentsCombinedUri": "/envelopes/4b728be4-4417-45c6-b7e8-d63e23f822b6/documents/combined", - "documentsUri": "/envelopes/4b728be4-4417-45c6-b7e8-d63e23f822b6/documents", - "envelopeId": "4b728be4-4417-45c6-b7e8-d63e23f822b6", - "envelopeUri": "/envelopes/4b728be4-4417-45c6-b7e8-d63e23f822b6", - "notificationUri": "/envelopes/4b728be4-4417-45c6-b7e8-d63e23f822b6/notification", - "recipientsUri": "/envelopes/4b728be4-4417-45c6-b7e8-d63e23f822b6/recipients", + "certificateUri": "/envelopes/4b728be4-xxxx-xxxx-xxxx-d63e23f822b6/documents/certificate", + "customFieldsUri": "/envelopes/4b728be4-xxxx-xxxx-xxxx-d63e23f822b6/custom_fields", + "documentsCombinedUri": "/envelopes/4b728be4-xxxx-xxxx-xxxx-d63e23f822b6/documents/combined", + "documentsUri": "/envelopes/4b728be4-xxxx-xxxx-xxxx-d63e23f822b6/documents", + "envelopeId": "4b728be4-xxxx-xxxx-xxxx-d63e23f822b6", + "envelopeUri": "/envelopes/4b728be4-xxxx-xxxx-xxxx-d63e23f822b6", + "notificationUri": "/envelopes/4b728be4-xxxx-xxxx-xxxx-d63e23f822b6/notification", + "recipientsUri": "/envelopes/4b728be4-xxxx-xxxx-xxxx-d63e23f822b6/recipients", "status": "sent", "statusChangedDateTime": "2016-10-05T01:04:58.7770000Z", - "templatesUri": "/envelopes/4b728be4-4417-45c6-b7e8-d63e23f822b6/templates" + "templatesUri": "/envelopes/4b728be4-xxxx-xxxx-xxxx-d63e23f822b6/templates" } ], "nextUri": "", @@ -4112,7 +4725,7 @@ "Envelopes" ], "summary": "Send, void, or modify a draft envelope. Purge documents from a completed envelope.", - "description": "This method enables you to make changes to an envelope.\nYou can use it to:\n\n* Send a draft envelope\n* Void an in-process envelope\n* Modify a draft envelope\n* Purge documents and envelope metadata from the DocuSign platform\n\n\n
\n

\n\nAlthough the request body for this method\nis a complete envelope definition,\nyou only need to provide\nthe properties that\nyou're updating. \n\n

\n
\n\n\n## Sending a Draft Envelope\n\nTo send a draft envelope, include the following code in the request body:\n\n```json\n{\n \"status\": \"sent\"\n}\n```\n\n\n## Voiding an In-Process Envelope\n\nTo void an in-process envelope, include the following code in the request body:\n\n```json\n{\n \"status\": \"voided\",\n \"voidedReason\": \"The reason for voiding the envelope\"\n}\n```\n\n## Modifying Envelope Email Information\n\nTo change the email subject and message of a draft envelope,\ninclude the following code in the request body:\n\n```json\n{\n \"emailSubject\": \"new email subject\",\n \"emailBlurb\": \"new email message\"\n}\n```\n\n## Purging Documents from DocuSign\n\n\nTo place only the documents\nin the purge queue,\nleaving any\ncorresponding attachments \nand tabs in the DocuSign platform,\nset the `purgeState` property\nto `documents_queued`.\n\n\n```json\n{\n \"purgeState\": \"documents_queued\"\n}\n```\n\nTo place documents,\nattachments,\nand tabs\nin the purge queue,\nset the `purgeState` property\nto `documents_and_metadata_queued`.\n\n```json\n{\n \"purgeState\": \"documents_and_metadata_queued\"\n}\n```\n\n\nYou can purge documents\nonly from completed envelopes\nthat are not marked as the authoritative copy.\nThe user requesting the purge\nmust have permission to purge documents\nand\nmust be the sender or be acting on behalf of the sender.\n\n\n\nWhen the purge request is initiated\nthe items to be purged\nare placed in the purge queue\nfor deletion in 14 days.\nThe sender\nand\nall recipients with DocuSign accounts\nassociated with the envelope\nget an email notification\nthe the documents will be deleted in 14 days.\nThe notification contains a link\nto the documents.\nA second email notification\nis sent 7 days later.\nAt the end of the 14-day period\nthe documents are deleted from the system.\nRecipients without DocuSign accounts\ndo not receive email notifications.\n\n\nIf your account has a Document Retention policy,\nenvelope documents\nare automatically placed\nin the purge queue,\nand notification emails are sent\nat the end of the retention period.\nSetting a Document Retention policy is the same as setting a\nschedule for purging documents.\n\n## Removing Documents from the Purge Queue\n\nTo remove documents from the purge queue, include the following code in the request body:\n\n```\n{\n \"purgeState\": \"documents_dequeued\"\n}\n```", + "description": "This method enables you to make changes to an envelope.\nYou can use it to:\n\n* Send a draft envelope\n* Void an in-process envelope\n* Modify a draft envelope\n* Purge documents and envelope metadata from the DocuSign platform\n\n\n
\n

\n\nAlthough the request body for this method\nis a complete envelope definition,\nyou only need to provide\nthe properties that\nyou're updating.\n\n

\n
\n\n\n## Sending a Draft Envelope\n\nTo send a draft envelope, include the following code in the request body:\n\n```json\n{\n \"status\": \"sent\"\n}\n```\n\nYou can attach a workflow before sending the envelope:\n\n```json\n{\n \"status\": \"sent\",\n \"workflow\": {\n \"workflowSteps\": [\n {\n \"action\": \"pause_before\",\n \"description\": \"pause_before routing order 2\",\n \"itemId\": 2,\n \"triggerOnItem\": \"routing_order\"\n }\n ]\n }\n}\n```\n\n## Working with Workflows\n\nTo unpause a workflow, the request body should include this:\n\n```json\n{\n \"workflow\": {\n \"workflowStatus\": \"in_progress\"\n }\n}\n```\n\n## Voiding an In-Process Envelope\n\nTo void an in-process envelope, include the following code in the request body:\n\n```json\n{\n \"status\": \"voided\",\n \"voidedReason\": \"The reason for voiding the envelope\"\n}\n```\n\n## Modifying Envelope Email Information\n\nTo change the email subject and message of a draft envelope,\ninclude the following code in the request body:\n\n```json\n{\n \"emailSubject\": \"new email subject\",\n \"emailBlurb\": \"new email message\"\n}\n```\n\n## Purging Documents from DocuSign\n\n\nTo place only the documents\nin the purge queue,\nleaving any\ncorresponding attachments\nand tabs in the DocuSign platform,\nset the `purgeState` property\nto `documents_queued`.\n\n\n```json\n{\n \"purgeState\": \"documents_queued\"\n}\n```\n\nTo place documents,\nattachments,\nand tabs\nin the purge queue,\nset the `purgeState` property\nto `documents_and_metadata_queued`.\n\n```json\n{\n \"purgeState\": \"documents_and_metadata_queued\"\n}\n```\n\n\nYou can purge documents\nonly from completed envelopes\nthat are not marked as the authoritative copy.\nThe user requesting the purge\nmust have permission to purge documents\nand\nmust be the sender or be acting on behalf of the sender.\n\n\n\nWhen the purge request is initiated\nthe items to be purged\nare placed in the purge queue\nfor deletion in 14 days.\nThe sender\nand\nall recipients with DocuSign accounts\nassociated with the envelope\nget an email notification\nthe the documents will be deleted in 14 days.\nThe notification contains a link\nto the documents.\nA second email notification\nis sent 7 days later.\nAt the end of the 14-day period\nthe documents are deleted from the system.\nRecipients without DocuSign accounts\ndo not receive email notifications.\n\n\nIf your account has a Document Retention policy,\nenvelope documents\nare automatically placed\nin the purge queue,\nand notification emails are sent\nat the end of the retention period.\nSetting a Document Retention policy is the same as setting a\nschedule for purging documents.\n\n## Removing Documents from the Purge Queue\n\nTo remove documents from the purge queue, include the following code in the request body:\n\n```\n{\n \"purgeState\": \"documents_dequeued\"\n}\n```", "operationId": "Envelopes_PutEnvelope", "consumes": [], "produces": [], @@ -4127,7 +4740,7 @@ { "name": "envelopeId", "in": "path", - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, @@ -4146,13 +4759,13 @@ "type": "string" }, { - "name": "Envelopes", + "name": "envelope", "in": "body", "required": false, "schema": { - "$ref": "#/definitions/Envelopes" + "$ref": "#/definitions/envelope" }, - "description": "" + "description": "A container used to send documents to recipients. The envelope carries information about the sender and timestamps to indicate the progress of the delivery procedure. It can contain collections of Documents, Tabs and Recipients." } ], "responses": { @@ -4197,7 +4810,7 @@ { "name": "envelopeId", "in": "path", - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" } @@ -4243,7 +4856,7 @@ { "name": "envelopeId", "in": "path", - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, @@ -4298,7 +4911,7 @@ { "name": "envelopeId", "in": "path", - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, @@ -4363,7 +4976,7 @@ { "name": "envelopeId", "in": "path", - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" } @@ -4413,7 +5026,7 @@ { "name": "envelopeId", "in": "path", - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, @@ -4472,7 +5085,7 @@ { "name": "envelopeId", "in": "path", - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" } @@ -4499,13 +5112,71 @@ }, "parameters": [] }, - "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/comments": { - "post": { + "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/comments/transcript": { + "get": { "tags": [ "Comments" ], - "summary": "", - "operationId": "Comments_PostEnvelopeComments", + "summary": "Gets a PDF transcript of all of the comments in an envelope.", + "operationId": "Comments_GetCommentsTranscript", + "consumes": [], + "produces": [ + "application/pdf" + ], + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "The external account number (int) or account ID GUID.", + "required": true, + "type": "string" + }, + { + "name": "envelopeId", + "in": "path", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", + "required": true, + "type": "string" + }, + { + "name": "encoding", + "in": "query", + "required": false, + "type": "string", + "description": "(Optional) The encoding to use for the file." + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "type": "file" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "getCommentsTranscript", + "x-ds-method": "get", + "x-ds-service": "Uncategorized", + "description": "Retrieves a PDF file containing all of the comments that senders and recipients have added to the documents in an envelope.\n\n**Note**: Comments are disabled by default. To use the comments feature, an account administrator must enable comments on the account (in the `accountSettingsInformation` object, set the `enableSigningExtensionComments` property to **true**). ", + "x-ds-in-sdk": true + }, + "parameters": [] + }, + "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/custom_fields": { + "get": { + "tags": [ + "EnvelopeCustomFields" + ], + "summary": "Gets the custom field information for the specified envelope.", + "description": "Retrieves the custom field information for the specified envelope. You can use these fields in the envelopes for your account to record information about the envelope, help search for envelopes, and track information. The envelope custom fields are shown in the Envelope Settings section when a user is creating an envelope in the DocuSign member console. The envelope custom fields are not seen by the envelope recipients.\n\nThere are two types of envelope custom fields, text, and list. A text custom field lets the sender enter the value for the field. With a list custom field, the sender selects the value of the field from a pre-made list.", + "operationId": "CustomFields_GetCustomFields", "consumes": [], "produces": [], "parameters": [ @@ -4519,25 +5190,70 @@ { "name": "envelopeId", "in": "path", - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/customFieldsEnvelope" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "listCustomFields", + "x-ds-method": "list", + "x-ds-service": "Envelopes", + "x-ds-in-sdk": true + }, + "put": { + "tags": [ + "EnvelopeCustomFields" + ], + "summary": "Updates envelope custom fields in an envelope.", + "description": "Updates the envelope custom fields in draft and in-process envelopes.\n\nEach custom field used in an envelope must have a unique name.\n", + "operationId": "CustomFields_PutCustomFields", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { - "name": "commentsPublish", + "name": "envelopeId", + "in": "path", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", + "required": true, + "type": "string" + }, + { + "name": "EnvelopeCustomFields", "in": "body", "required": false, "schema": { - "$ref": "#/definitions/commentsPublish" + "$ref": "#/definitions/EnvelopeCustomFields" }, "description": "" } ], "responses": { - "201": { + "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/commentHistoryResult" + "$ref": "#/definitions/EnvelopeCustomFields" } }, "400": { @@ -4548,25 +5264,74 @@ } }, "deprecated": false, - "x-ds-methodname": "createEnvelopeComments", - "x-ds-method": "createEnvelopeComments", - "x-ds-service": "Uncategorized", - "description": "", + "x-ds-methodname": "updateCustomFields", + "x-ds-method": "update", + "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, - "parameters": [] - }, - "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/comments/transcript": { - "get": { + "post": { "tags": [ - "Comments" + "EnvelopeCustomFields" ], - "summary": "", - "operationId": "Comments_GetCommentsTranscript", + "summary": "Creates envelope custom fields for an envelope.", + "description": "Updates the envelope custom fields for draft and in-process envelopes.\n\nYou may assign up to three envelope custom fields to an envelope. This limit does not include account (document) custom fields. Each custom field used in an envelope must have a unique name.\n", + "operationId": "CustomFields_PostCustomFields", "consumes": [], - "produces": [ - "application/pdf" + "produces": [], + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "The external account number (int) or account ID GUID.", + "required": true, + "type": "string" + }, + { + "name": "envelopeId", + "in": "path", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", + "required": true, + "type": "string" + }, + { + "name": "EnvelopeCustomFields", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/EnvelopeCustomFields" + }, + "description": "" + } ], + "responses": { + "201": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/EnvelopeCustomFields" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "createCustomFields", + "x-ds-method": "create", + "x-ds-service": "Envelopes", + "x-ds-in-sdk": true + }, + "delete": { + "tags": [ + "EnvelopeCustomFields" + ], + "summary": "Deletes envelope custom fields for draft and in-process envelopes.", + "description": "Deletes envelope custom fields for draft and in-process envelopes.", + "operationId": "CustomFields_DeleteCustomFields", + "consumes": [], + "produces": [], "parameters": [ { "name": "accountId", @@ -4578,15 +5343,17 @@ { "name": "envelopeId", "in": "path", - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { - "name": "encoding", - "in": "query", + "name": "EnvelopeCustomFields", + "in": "body", "required": false, - "type": "string", + "schema": { + "$ref": "#/definitions/EnvelopeCustomFields" + }, "description": "" } ], @@ -4594,7 +5361,7 @@ "200": { "description": "Successful response.", "schema": { - "type": "file" + "$ref": "#/definitions/EnvelopeCustomFields" } }, "400": { @@ -4605,23 +5372,20 @@ } }, "deprecated": false, - "x-ds-methodname": "getCommentsTranscript", - "x-ds-api-status": "beta", - "x-ds-method": "get", - "x-ds-service": "Uncategorized", - "description": "", + "x-ds-methodname": "deleteCustomFields", + "x-ds-method": "delete", + "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, "parameters": [] }, - "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/custom_fields": { + "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info": { "get": { "tags": [ - "EnvelopeCustomFields" + "ApplianceInfo" ], - "summary": "Gets the custom field information for the specified envelope.", - "description": "Retrieves the custom field information for the specified envelope. You can use these fields in the envelopes for your account to record information about the envelope, help search for envelopes, and track information. The envelope custom fields are shown in the Envelope Settings section when a user is creating an envelope in the DocuSign member console. The envelope custom fields are not seen by the envelope recipients.\n\nThere are two types of envelope custom fields, text, and list. A text custom field lets the sender enter the value for the field. With a list custom field, the sender selects the value of the field from a pre-made list.", - "operationId": "CustomFields_GetCustomFields", + "summary": "Returns envelope and recipient information for Display Appliance.", + "operationId": "EnvelopeApplianceInfo_GetApplianceInfo", "consumes": [], "produces": [], "parameters": [ @@ -4635,7 +5399,7 @@ { "name": "envelopeId", "in": "path", - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" } @@ -4644,7 +5408,7 @@ "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/customFieldsEnvelope" + "$ref": "#/definitions/displayApplianceInfo" } }, "400": { @@ -4655,18 +5419,21 @@ } }, "deprecated": false, - "x-ds-methodname": "listCustomFields", - "x-ds-method": "list", - "x-ds-service": "Envelopes", + "x-ds-methodname": "getApplianceInfo", + "x-ds-method": "getApplianceInfo", + "x-ds-service": "Uncategorized", + "description": "", "x-ds-in-sdk": true }, - "put": { + "parameters": [] + }, + "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/account_info": { + "get": { "tags": [ - "EnvelopeCustomFields" + "ApplianceInfo" ], - "summary": "Updates envelope custom fields in an envelope.", - "description": "Updates the envelope custom fields in draft and in-process envelopes.\n\nEach custom field used in an envelope must have a unique name.\n", - "operationId": "CustomFields_PutCustomFields", + "summary": "Returns envelope account information for Display Appliance.", + "operationId": "EnvelopeApplianceInfo_GetAccount", "consumes": [], "produces": [], "parameters": [ @@ -4680,25 +5447,16 @@ { "name": "envelopeId", "in": "path", - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" - }, - { - "name": "EnvelopeCustomFields", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/EnvelopeCustomFields" - }, - "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/EnvelopeCustomFields" + "$ref": "#/definitions/displayApplianceAccount" } }, "400": { @@ -4709,18 +5467,21 @@ } }, "deprecated": false, - "x-ds-methodname": "updateCustomFields", - "x-ds-method": "update", - "x-ds-service": "Envelopes", + "x-ds-methodname": "getAccount", + "x-ds-method": "getAccount", + "x-ds-service": "Uncategorized", + "description": "", "x-ds-in-sdk": true }, - "post": { + "parameters": [] + }, + "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/custom_fields": { + "get": { "tags": [ - "EnvelopeCustomFields" + "ApplianceInfo" ], - "summary": "Updates envelope custom fields for an envelope.", - "description": "Updates the envelope custom fields for draft and in-process envelopes.\n\nEach custom field used in an envelope must have a unique name.", - "operationId": "CustomFields_PostCustomFields", + "summary": "Return custom fields information for Display Appliance.", + "operationId": "EnvelopeApplianceInfo_GetCustomFields", "consumes": [], "produces": [], "parameters": [ @@ -4734,25 +5495,16 @@ { "name": "envelopeId", "in": "path", - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" - }, - { - "name": "EnvelopeCustomFields", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/EnvelopeCustomFields" - }, - "description": "" } ], "responses": { - "201": { + "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/EnvelopeCustomFields" + "$ref": "#/definitions/displayApplianceInfo" } }, "400": { @@ -4763,18 +5515,21 @@ } }, "deprecated": false, - "x-ds-methodname": "createCustomFields", - "x-ds-method": "create", - "x-ds-service": "Envelopes", + "x-ds-methodname": "getCustomFields", + "x-ds-method": "getCustomFields", + "x-ds-service": "Uncategorized", + "description": "", "x-ds-in-sdk": true }, - "delete": { + "parameters": [] + }, + "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/custom_fields/delete": { + "post": { "tags": [ - "EnvelopeCustomFields" + "ApplianceInfo" ], - "summary": "Deletes envelope custom fields for draft and in-process envelopes.", - "description": "Deletes envelope custom fields for draft and in-process envelopes.", - "operationId": "CustomFields_DeleteCustomFields", + "summary": "Deletes custom fields information for Display Appliance.", + "operationId": "EnvelopeApplianceInfo_DeleteCustomFields", "consumes": [], "produces": [], "parameters": [ @@ -4788,26 +5543,14 @@ { "name": "envelopeId", "in": "path", - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" - }, - { - "name": "EnvelopeCustomFields", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/EnvelopeCustomFields" - }, - "description": "" } ], "responses": { - "200": { - "description": "Successful response.", - "schema": { - "$ref": "#/definitions/EnvelopeCustomFields" - } + "201": { + "description": "Successful response." }, "400": { "description": "Error encountered.", @@ -4818,20 +5561,20 @@ }, "deprecated": false, "x-ds-methodname": "deleteCustomFields", - "x-ds-method": "delete", - "x-ds-service": "Envelopes", + "x-ds-method": "deleteCustomFields", + "x-ds-service": "Uncategorized", + "description": "", "x-ds-in-sdk": true }, "parameters": [] }, - "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents": { + "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/date_signed": { "get": { "tags": [ - "EnvelopeDocuments" + "ApplianceInfo" ], - "summary": "Gets a list of envelope documents.", - "description": "Retrieves a list of documents associated with the specified envelope.", - "operationId": "Documents_GetDocuments", + "summary": "Gets date signed information for Display Appliance.", + "operationId": "EnvelopeApplianceInfo_GetDateSigned", "consumes": [], "produces": [], "parameters": [ @@ -4845,51 +5588,16 @@ { "name": "envelopeId", "in": "path", - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" - }, - { - "name": "documents_by_userid", - "in": "query", - "required": false, - "type": "string", - "description": "When set to **true**, allows recipients to get documents by their user id. For example, if a user is included in two different routing orders with different visibilities, using this parameter returns all of the documents from both routing orders." - }, - { - "name": "include_metadata", - "in": "query", - "required": false, - "type": "string", - "description": "When set to **true**, the response includes metadata that indicates which properties the sender can edit." - }, - { - "name": "include_tabs", - "in": "query", - "required": false, - "type": "string", - "description": "When set to **true**, information about the tabs associated with the documents are included in the response." - }, - { - "name": "recipient_id", - "in": "query", - "required": false, - "type": "string", - "description": "Allows the sender to retrieve the documents as one of the recipients that they control. The `documents_by_userid` parameter must be set to **false** for this to work." - }, - { - "name": "shared_user_id", - "in": "query", - "required": false, - "type": "string", - "description": "The ID of a shared user that you want to impersonate in order to retrieve their view of the list of documents. This parameter is used in the context of a shared inbox (i.e., when you share envelopes from one user to another through the RADmin console)." } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/EnvelopeDocuments" + "$ref": "#/definitions/displayApplianceInfo" } }, "400": { @@ -4900,101 +5608,21 @@ } }, "deprecated": false, - "x-ds-methodname": "listDocuments", - "x-ds-method": "list", - "x-ds-service": "Envelopes", - "x-ds-in-sdk": true, - "x-ds-examples": [ - { - "description": "This example shows how\nto get a list\nof all the documents in an envelope.\n\nThe request for this endpoint has no payload.\n\n### Request\n\n```\nGET /restapi/v2.1/accounts/1703061/envelopes/44efc9e6-915e-4b1d-9b54-801410d6922d/documents\n```\n", - "direction": "response", - "format": "json", - "response": { - "envelopeDocuments": [ - { - "availableDocumentTypes": [ - { - "isDefault": "true", - "type": "electronic" - } - ], - "display": "inline", - "documentId": "1", - "includeInDownload": "true", - "name": "NDA.pdf", - "order": "1", - "pages": "3", - "signerMustAcknowledge": "no_interaction", - "type": "content", - "uri": "/envelopes/44efc9e6-915e-4b1d-9b54-801410d6922d/documents/1" - }, - { - "availableDocumentTypes": [ - { - "isDefault": "true", - "type": "electronic" - } - ], - "display": "inline", - "documentId": "2", - "includeInDownload": "true", - "name": "House.pdf", - "order": "2", - "pages": "1", - "signerMustAcknowledge": "no_interaction", - "type": "content", - "uri": "/envelopes/44efc9e6-915e-4b1d-9b54-801410d6922d/documents/2" - }, - { - "availableDocumentTypes": [ - { - "isDefault": "true", - "type": "electronic" - } - ], - "display": "inline", - "documentId": "3", - "includeInDownload": "true", - "name": "contractor_agreement.docx", - "order": "3", - "pages": "2", - "signerMustAcknowledge": "no_interaction", - "type": "content", - "uri": "/envelopes/44efc9e6-915e-4b1d-9b54-801410d6922d/documents/3" - }, - { - "availableDocumentTypes": [ - { - "isDefault": "true", - "type": "electronic" - } - ], - "display": "inline", - "documentId": "certificate", - "includeInDownload": "true", - "name": "Summary", - "order": "999", - "pages": "4", - "signerMustAcknowledge": "no_interaction", - "type": "summary", - "uri": "/envelopes/44efc9e6-915e-4b1d-9b54-801410d6922d/documents/certificate" - } - ], - "envelopeId": "44efc9e6-915e-4b1d-9b54-801410d6922d" - }, - "request": null, - "style": "custom", - "title": "List All Documents in an Envelope" - } - ] + "x-ds-methodname": "getDateSigned", + "x-ds-method": "getDateSigned", + "x-ds-service": "Uncategorized", + "description": "", + "x-ds-in-sdk": true }, + "parameters": [] + }, + "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/document/{documentId}": { "put": { "tags": [ - "EnvelopeDocuments" + "ApplianceInfo" ], - "summary": "Adds one or more documents to an existing envelope document.", - "description": "Adds one or more documents to an existing envelope document.\n

**Note**: When adding or modifying documents for an in-process envelope, DocuSign recommends locking the envelope prior to making any changes.\n\nIf the file name of a document contains unicode characters, you need to include a `Content-Disposition` header. Example:\n\n\n**Header**: `Content-Disposition`\n\n\n**Value**: `file; filename=\\\"name\\\";fileExtension=ext;documentId=1`", - "operationId": "Documents_PutDocuments", + "summary": "Updates document information for Display Applianc.", + "operationId": "EnvelopeApplianceInfo_PutDocument", "consumes": [], "produces": [], "parameters": [ @@ -5006,28 +5634,23 @@ "type": "string" }, { - "name": "envelopeId", + "name": "documentId", "in": "path", - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", + "description": "The `documentId` is set by the API client. It is an integer that falls between `1` and 2,147,483,647. The value is encoded as a string without commas. The values `1`, `2`, `3`, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a `documentId` property that specifies the document on which to place the tab.", "required": true, "type": "string" }, { - "name": "envelopeDefinition", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/envelopeDefinition" - }, - "description": "" + "name": "envelopeId", + "in": "path", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "Successful response.", - "schema": { - "$ref": "#/definitions/EnvelopeDocuments" - } + "description": "Successful response." }, "400": { "description": "Error encountered.", @@ -5037,18 +5660,18 @@ } }, "deprecated": false, - "x-ds-methodname": "updateDocuments", - "x-ds-method": "updateList", - "x-ds-service": "Envelopes", + "x-ds-methodname": "updateDocument", + "x-ds-method": "updateDocument", + "x-ds-service": "Uncategorized", + "description": "", "x-ds-in-sdk": true }, "delete": { "tags": [ - "EnvelopeDocuments" + "ApplianceInfo" ], - "summary": "Deletes documents from a draft envelope.", - "description": "Deletes one or more documents from an existing envelope that has not yet been completed.\n\nTo delete a document, use only the relevant parts of the [`envelopeDefinition`](#envelopeDefinition).\nFor example, this request body specifies that you want to delete the document whose `documentId` is \"1\".\n\n\n```text\n{\n \"documents\": [\n {\n \"documentId\": \"1\"\n }\n ]\n}\n```\n\nThe envelope status must be one of:\n\n- `created`\n- `sent`\n- `delivered`\n\n\n", - "operationId": "Documents_DeleteDocuments", + "summary": "Deletes document information for Display Appliance.", + "operationId": "EnvelopeApplianceInfo_DeleteDocument", "consumes": [], "produces": [], "parameters": [ @@ -5060,28 +5683,23 @@ "type": "string" }, { - "name": "envelopeId", + "name": "documentId", "in": "path", - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", + "description": "The `documentId` is set by the API client. It is an integer that falls between `1` and 2,147,483,647. The value is encoded as a string without commas. The values `1`, `2`, `3`, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a `documentId` property that specifies the document on which to place the tab.", "required": true, "type": "string" }, { - "name": "envelopeDefinition", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/envelopeDefinition" - }, - "description": "" + "name": "envelopeId", + "in": "path", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "Successful response.", - "schema": { - "$ref": "#/definitions/EnvelopeDocuments" - } + "description": "Successful response." }, "400": { "description": "Error encountered.", @@ -5091,25 +5709,23 @@ } }, "deprecated": false, - "x-ds-methodname": "deleteDocuments", - "x-ds-method": "delete", - "x-ds-service": "Envelopes", + "x-ds-methodname": "deleteDocument", + "x-ds-method": "deleteDocument", + "x-ds-service": "Uncategorized", + "description": "", "x-ds-in-sdk": true }, "parameters": [] }, - "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}": { + "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/document_page_list": { "get": { "tags": [ - "EnvelopeDocuments" + "ApplianceInfo" ], - "summary": "Gets a document from an envelope.", - "description": "Retrieves the specified document from the envelope. If the account has the Highlight Data Changes feature enabled, there is an option to request that any changes in the envelope be highlighted.\n\nThe `{documentID}` parameter takes two special values:\n\n| Value | Description |\n| :--- | :--- |\n| `combined` | Retrieve a PDF that contains the combined content of all documents and the certificate. |\n| `archive` | Retrieve a ZIP archive that contains all of the PDF documents, the certificate, and any .WAV files used for voice authentication. |\n", - "operationId": "Documents_GetDocument", + "summary": "Return document pages for Display Appliance.", + "operationId": "EnvelopeApplianceInfo_GetDocumentPages", "consumes": [], - "produces": [ - "application/pdf" - ], + "produces": [], "parameters": [ { "name": "accountId", @@ -5118,89 +5734,19 @@ "required": true, "type": "string" }, - { - "name": "documentId", - "in": "path", - "description": "Integer that identifies the document in the envelope.", - "required": true, - "type": "string" - }, { "name": "envelopeId", "in": "path", - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" - }, - { - "name": "certificate", - "in": "query", - "description": "When set to **false**, the envelope signing certificate is removed from the download.", - "required": false, - "type": "string" - }, - { - "name": "documents_by_userid", - "in": "query", - "required": false, - "type": "string", - "description": "When set to **true**, allows recipients to get documents by their user id. For example, if a user is included in two different routing orders with different visibilities, using this parameter returns all of the documents from both routing orders." - }, - { - "name": "encoding", - "in": "query", - "required": false, - "type": "string", - "description": "" - }, - { - "name": "encrypt", - "in": "query", - "description": "When set to **true**, the PDF bytes returned in the response are encrypted for all the key managers configured on your DocuSign account. The documents can be decrypted with the KeyManager Decrypt Document API.", - "required": false, - "type": "string" - }, - { - "name": "language", - "in": "query", - "description": "Specifies the language for the Certificate of Completion in the response. The supported languages are: Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Dutch (nl), English US (en), French (fr), German (de), Italian (it), Japanese (ja), Korean (ko), Portuguese (pt), Portuguese (Brazil) (pt_BR), Russian (ru), Spanish (es). ", - "required": false, - "type": "string" - }, - { - "name": "recipient_id", - "in": "query", - "required": false, - "type": "string", - "description": "Allows the sender to retrieve the documents as one of the recipients that they control. The `documents_by_userid` parameter must be set to **false** for this functionality to work." - }, - { - "name": "shared_user_id", - "in": "query", - "required": false, - "type": "string", - "description": "The ID of a shared user that you want to impersonate in order to retrieve their view of the list of documents. This parameter is used in the context of a shared inbox (i.e., when you share envelopes from one user to another through the RADmin console)." - }, - { - "name": "show_changes", - "in": "query", - "description": "When set to **true**, any changed fields for the returned PDF are highlighted in yellow and optional signatures or initials outlined in red. ", - "required": false, - "type": "string" - }, - { - "name": "watermark", - "in": "query", - "description": "When set to **true**, the account has the watermark feature enabled, and the envelope is not complete, the watermark for the account is added to the PDF documents. This option can remove the watermark. ", - "required": false, - "type": "string" } ], "responses": { "200": { "description": "Successful response.", "schema": { - "type": "file" + "$ref": "#/definitions/displayApplianceInfo" } }, "400": { @@ -5211,119 +5757,21 @@ } }, "deprecated": false, - "x-ds-methodname": "getDocument", - "x-ds-method": "get", - "x-ds-service": "Envelopes", - "x-ds-in-sdk": true, - "x-ds-examples": [ - { - "description": "This example shows how to retrieve\na single document from an envelope\nas a PDF file.\n\n\nThe request for this endpoint has no payload.\n\n### Request\n\n```\nGET /restapi/v2.1/accounts/1703061/envelopes/44efc9e6-915e-4b1d-9b54-801410d6922d/documents/3\n```\n\n", - "direction": "response", - "format": "json", - "response": "PDF File", - "request": null, - "style": "custom", - "title": "Get a Single Document as a PDF File" - }, - { - "description": "If you use `combined` instead of a document id\nthe response is a PDF file that contains\nall of the documents in the specified envelope.\n\nThe request for this endpoint has no payload.\n\n### Request\n\n```\nGET /restapi/v2.1/accounts/1703061/envelopes/44efc9e6-915e-4b1d-9b54-801410d6922d/documents/combined\n```\n\n", - "direction": "response", - "format": "json", - "response": "PDF File", - "request": null, - "style": "custom", - "title": "Get All Documents as a Single PDF File" - }, - { - "description": "This example shows how\nto get a list\nof all the documents in an envelope.\n\nThe request for this endpoint has no payload.\n\n### Request\n\n```\nGET /restapi/v2.1/accounts/1703061/envelopes/44efc9e6-915e-4b1d-9b54-801410d6922d/documents\n```\n", - "direction": "response", - "format": "json", - "response": { - "envelopeDocuments": [ - { - "availableDocumentTypes": [ - { - "isDefault": "true", - "type": "electronic" - } - ], - "display": "inline", - "documentId": "1", - "includeInDownload": "true", - "name": "NDA.pdf", - "order": "1", - "pages": "3", - "signerMustAcknowledge": "no_interaction", - "type": "content", - "uri": "/envelopes/44efc9e6-915e-4b1d-9b54-801410d6922d/documents/1" - }, - { - "availableDocumentTypes": [ - { - "isDefault": "true", - "type": "electronic" - } - ], - "display": "inline", - "documentId": "2", - "includeInDownload": "true", - "name": "House.pdf", - "order": "2", - "pages": "1", - "signerMustAcknowledge": "no_interaction", - "type": "content", - "uri": "/envelopes/44efc9e6-915e-4b1d-9b54-801410d6922d/documents/2" - }, - { - "availableDocumentTypes": [ - { - "isDefault": "true", - "type": "electronic" - } - ], - "display": "inline", - "documentId": "3", - "includeInDownload": "true", - "name": "contractor_agreement.docx", - "order": "3", - "pages": "2", - "signerMustAcknowledge": "no_interaction", - "type": "content", - "uri": "/envelopes/44efc9e6-915e-4b1d-9b54-801410d6922d/documents/3" - }, - { - "availableDocumentTypes": [ - { - "isDefault": "true", - "type": "electronic" - } - ], - "display": "inline", - "documentId": "certificate", - "includeInDownload": "true", - "name": "Summary", - "order": "999", - "pages": "4", - "signerMustAcknowledge": "no_interaction", - "type": "summary", - "uri": "/envelopes/44efc9e6-915e-4b1d-9b54-801410d6922d/documents/certificate" - } - ], - "envelopeId": "44efc9e6-915e-4b1d-9b54-801410d6922d" - }, - "request": null, - "style": "custom", - "title": "List All Documents in an Envelope" - } - ] + "x-ds-methodname": "getDocumentPages", + "x-ds-method": "getDocumentPages", + "x-ds-service": "Uncategorized", + "description": "", + "x-ds-in-sdk": true }, - "put": { + "parameters": [] + }, + "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/image": { + "post": { "tags": [ - "EnvelopeDocuments" + "ApplianceInfo" ], - "summary": "Adds a document to an existing draft envelope.", - "description": "Adds a document to an existing draft envelope. The bytes of the document make up the body of the request. \n\n\n\n**Note**: When adding or modifying documents for an in-process envelope, DocuSign recommends locking the envelope prior to making any changes.\n\n\n\n\nIf the file name of the document contains unicode characters, you need to include a `Content-Disposition` header. Example:\n\n\n**Header**: `Content-Disposition`\n\n\n**Value**: `file; filename=\\\"name\\\";fileExtension=ext;documentId=1`\n", - "operationId": "Documents_PutDocument", + "summary": "Returns images for Display Appliance.", + "operationId": "EnvelopeApplianceInfo_GetImage", "consumes": [], "produces": [], "parameters": [ @@ -5334,26 +5782,19 @@ "required": true, "type": "string" }, - { - "name": "documentId", - "in": "path", - "description": "Integer that identifies the document in the envelope.", - "required": true, - "type": "string" - }, { "name": "envelopeId", "in": "path", - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" } ], "responses": { - "200": { + "201": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/envelopeDocument" + "$ref": "#/definitions/displayApplianceInfo" } }, "400": { @@ -5364,21 +5805,21 @@ } }, "deprecated": false, - "x-ds-methodname": "updateDocument", - "x-ds-method": "update", - "x-ds-service": "Envelopes", + "x-ds-methodname": "getImage", + "x-ds-method": "getImage", + "x-ds-service": "Uncategorized", + "description": "", "x-ds-in-sdk": true }, "parameters": [] }, - "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields": { - "get": { + "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/localepolicy/{userId}": { + "post": { "tags": [ - "EnvelopeDocumentFields" + "ApplianceInfo" ], - "summary": "Gets the custom document fields from an existing envelope document.", - "description": "Retrieves the custom document field information from an existing envelope document.", - "operationId": "DocumentFields_GetDocumentFields", + "summary": "Returns locale policy information for Display Appliance.", + "operationId": "EnvelopeApplianceInfo_GetLocalePolicy", "consumes": [], "produces": [], "parameters": [ @@ -5390,25 +5831,25 @@ "type": "string" }, { - "name": "documentId", + "name": "envelopeId", "in": "path", - "description": "Integer that identifies the document in the envelope.", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { - "name": "envelopeId", + "name": "userId", "in": "path", - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", + "description": "The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.\n", "required": true, "type": "string" } ], "responses": { - "200": { + "201": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/EnvelopeDocumentFields" + "$ref": "#/definitions/displayApplianceInfo" } }, "400": { @@ -5419,18 +5860,21 @@ } }, "deprecated": false, - "x-ds-methodname": "listDocumentFields", - "x-ds-method": "list", - "x-ds-service": "Envelopes", + "x-ds-methodname": "getLocalePolicy", + "x-ds-method": "getLocalePolicy", + "x-ds-service": "Uncategorized", + "description": "", "x-ds-in-sdk": true }, + "parameters": [] + }, + "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/page_info": { "put": { "tags": [ - "EnvelopeDocumentFields" + "ApplianceInfo" ], - "summary": "Updates existing custom document fields in an existing envelope document.", - "description": "Updates existing custom document fields in an existing envelope document.", - "operationId": "DocumentFields_PutDocumentFields", + "summary": "Updates page information for Display Appliance.", + "operationId": "EnvelopeApplianceInfo_PutPageInfo", "consumes": [], "produces": [], "parameters": [ @@ -5441,36 +5885,17 @@ "required": true, "type": "string" }, - { - "name": "documentId", - "in": "path", - "description": "Integer that identifies the document in the envelope.", - "required": true, - "type": "string" - }, { "name": "envelopeId", "in": "path", - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" - }, - { - "name": "EnvelopeDocumentFields", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/EnvelopeDocumentFields" - }, - "description": "" } ], "responses": { "200": { - "description": "Successful response.", - "schema": { - "$ref": "#/definitions/EnvelopeDocumentFields" - } + "description": "Successful response." }, "400": { "description": "Error encountered.", @@ -5480,18 +5905,18 @@ } }, "deprecated": false, - "x-ds-methodname": "updateDocumentFields", - "x-ds-method": "update", - "x-ds-service": "Envelopes", + "x-ds-methodname": "updatePageInfo", + "x-ds-method": "updatePageInfo", + "x-ds-service": "Uncategorized", + "description": "", "x-ds-in-sdk": true }, "post": { "tags": [ - "EnvelopeDocumentFields" + "ApplianceInfo" ], - "summary": "Creates custom document fields in an existing envelope document.", - "description": "Creates custom document fields in an existing envelope document.", - "operationId": "DocumentFields_PostDocumentFields", + "summary": "Creates page information for Display Appliance.", + "operationId": "EnvelopeApplianceInfo_PostPageInfo", "consumes": [], "produces": [], "parameters": [ @@ -5502,36 +5927,17 @@ "required": true, "type": "string" }, - { - "name": "documentId", - "in": "path", - "description": "Integer that identifies the document in the envelope.", - "required": true, - "type": "string" - }, { "name": "envelopeId", "in": "path", - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" - }, - { - "name": "EnvelopeDocumentFields", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/EnvelopeDocumentFields" - }, - "description": "" } ], "responses": { "201": { - "description": "Successful response.", - "schema": { - "$ref": "#/definitions/EnvelopeDocumentFields" - } + "description": "Successful response." }, "400": { "description": "Error encountered.", @@ -5541,18 +5947,21 @@ } }, "deprecated": false, - "x-ds-methodname": "createDocumentFields", - "x-ds-method": "create", - "x-ds-service": "Envelopes", + "x-ds-methodname": "createPageInfo", + "x-ds-method": "createPageInfo", + "x-ds-service": "Uncategorized", + "description": "", "x-ds-in-sdk": true }, - "delete": { + "parameters": [] + }, + "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/page_info/delete": { + "post": { "tags": [ - "EnvelopeDocumentFields" + "ApplianceInfo" ], - "summary": "Deletes custom document fields from an existing envelope document.", - "description": "Deletes custom document fields from an existing envelope document.", - "operationId": "DocumentFields_DeleteDocumentFields", + "summary": "Deletes page information for Display Appliance.", + "operationId": "EnvelopeApplianceInfo_DeletePageInfo", "consumes": [], "produces": [], "parameters": [ @@ -5563,36 +5972,17 @@ "required": true, "type": "string" }, - { - "name": "documentId", - "in": "path", - "description": "Integer that identifies the document in the envelope.", - "required": true, - "type": "string" - }, { "name": "envelopeId", "in": "path", - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" - }, - { - "name": "EnvelopeDocumentFields", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/EnvelopeDocumentFields" - }, - "description": "" } ], "responses": { - "200": { - "description": "Successful response.", - "schema": { - "$ref": "#/definitions/EnvelopeDocumentFields" - } + "201": { + "description": "Successful response." }, "400": { "description": "Error encountered.", @@ -5602,20 +5992,21 @@ } }, "deprecated": false, - "x-ds-methodname": "deleteDocumentFields", - "x-ds-method": "delete", - "x-ds-service": "Envelopes", + "x-ds-methodname": "deletePageInfo", + "x-ds-method": "deletePageInfo", + "x-ds-service": "Uncategorized", + "description": "", "x-ds-in-sdk": true }, "parameters": [] }, - "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/html_definitions": { - "get": { + "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/pdf": { + "put": { "tags": [ - "EnvelopeDocumentHtmlDefinitions" + "ApplianceInfo" ], - "summary": "", - "operationId": "ResponsiveHtml_GetEnvelopeDocumentHtmlDefinitions", + "summary": "Sets latest PDF for Display Appliance.", + "operationId": "EnvelopeApplianceInfo_PutPdf", "consumes": [], "produces": [], "parameters": [ @@ -5626,17 +6017,10 @@ "required": true, "type": "string" }, - { - "name": "documentId", - "in": "path", - "description": "Integer that identifies the document in the envelope.", - "required": true, - "type": "string" - }, { "name": "envelopeId", "in": "path", - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" } @@ -5645,7 +6029,7 @@ "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/EnvelopeDocumentHtmlDefinitions" + "$ref": "#/definitions/displayAppliancePdf" } }, "400": { @@ -5656,21 +6040,21 @@ } }, "deprecated": false, - "x-ds-methodname": "getEnvelopeDocumentHtmlDefinitions", - "x-ds-method": "get", + "x-ds-methodname": "updatePdf", + "x-ds-method": "updatePdf", "x-ds-service": "Uncategorized", "description": "", "x-ds-in-sdk": true }, "parameters": [] }, - "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages": { + "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/pdf/{pdfId}": { "get": { "tags": [ - "Envelopes" + "ApplianceInfo" ], - "summary": "Returns document page image(s) based on input.", - "operationId": "Pages_GetPageImages", + "summary": "Return PDF for Display Appliance.", + "operationId": "EnvelopeApplianceInfo_GetPdf", "consumes": [], "produces": [], "parameters": [ @@ -5682,135 +6066,26 @@ "type": "string" }, { - "name": "documentId", + "name": "envelopeId", "in": "path", - "description": "Integer that identifies the document in the envelope.", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { - "name": "envelopeId", + "name": "pdfId", "in": "path", - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", "required": true, - "type": "string" - }, - { - "name": "count", - "in": "query", - "required": false, - "type": "string", - "description": "The maximum number of results to return." - }, - { - "name": "dpi", - "in": "query", - "required": false, - "type": "string", - "description": "The number of dots per inch (DPI) for the resulting images. Valid values are 1-310 DPI. The default value is 94." - }, - { - "name": "max_height", - "in": "query", - "required": false, - "type": "string", - "description": "Sets the maximum height of the returned images in pixels." - }, - { - "name": "max_width", - "in": "query", - "required": false, - "type": "string", - "description": "Sets the maximum width of the returned images in pixels." - }, - { - "name": "nocache", - "in": "query", - "required": false, - "type": "string", - "description": "If **true**, using cache is disabled and image information is retrieved from a database. **True** is the default value. " - }, - { - "name": "show_changes", - "in": "query", - "required": false, - "type": "string", - "description": "If **true**, changes display in the user interface." - }, - { - "name": "start_position", - "in": "query", - "required": false, "type": "string", - "description": "The position within the total result set from which to start returning values. The value **thumbnail** may be used to return the page image." + "description": "**Deprecated**. \n\nThe `pdfId` property in the consumer_disclosure PUT request is deprecated. For security reasons going forward, any value provided in the request packet must be ignored. " } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/pageImages" - } - }, - "400": { - "description": "Error encountered.", - "schema": { - "$ref": "#/definitions/errorDetails" + "$ref": "#/definitions/displayAppliancePdf" } - } - }, - "deprecated": false, - "x-ds-methodname": "getDocumentPageImages", - "x-ds-method": "getPageImages", - "x-ds-service": "Envelopes", - "description": "Returns images of the pages in a document for display based on the parameters that you specify.", - "x-ds-in-sdk": true - }, - "parameters": [] - }, - "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}": { - "delete": { - "tags": [ - "Envelopes" - ], - "summary": "Deletes a page from a document in an envelope.", - "description": "Deletes a page from a document in an envelope based on the page number.", - "operationId": "Pages_DeletePage", - "consumes": [], - "produces": [], - "parameters": [ - { - "name": "accountId", - "in": "path", - "description": "The external account number (int) or account ID GUID.", - "required": true, - "type": "string" - }, - { - "name": "documentId", - "in": "path", - "description": "Integer that identifies the document in the envelope.", - "required": true, - "type": "string" - }, - { - "name": "envelopeId", - "in": "path", - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", - "required": true, - "type": "string" - }, - { - "name": "pageNumber", - "in": "path", - "description": "The page number being accessed.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Successful response." }, "400": { "description": "Error encountered.", @@ -5820,25 +6095,23 @@ } }, "deprecated": false, - "x-ds-methodname": "deleteDocumentPage", - "x-ds-method": "deleteDocumentPage", - "x-ds-service": "Envelopes", + "x-ds-methodname": "getPdf", + "x-ds-method": "getPdf", + "x-ds-service": "Uncategorized", + "description": "", "x-ds-in-sdk": true }, "parameters": [] }, - "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}/page_image": { + "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/pdf_blobs": { "get": { "tags": [ - "Envelopes" + "ApplianceInfo" ], - "summary": "Gets a page image from an envelope for display.", - "description": "Returns an image of a page in a document for display.", - "operationId": "Pages_GetPageImage", + "summary": "Returns PDF blobs for Display Appliance.", + "operationId": "EnvelopeApplianceInfo_GetPdfBlob", "consumes": [], - "produces": [ - "image/png" - ], + "produces": [], "parameters": [ { "name": "accountId", @@ -5847,61 +6120,19 @@ "required": true, "type": "string" }, - { - "name": "documentId", - "in": "path", - "description": "Integer that identifies the document in the envelope.", - "required": true, - "type": "string" - }, { "name": "envelopeId", "in": "path", - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", - "required": true, - "type": "string" - }, - { - "name": "pageNumber", - "in": "path", - "description": "The page number being accessed.", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" - }, - { - "name": "dpi", - "in": "query", - "description": "Sets the dots per inch (DPI) for the returned image.", - "required": false, - "type": "string" - }, - { - "name": "max_height", - "in": "query", - "description": "Sets the maximum height for the page image in pixels. The DPI is recalculated based on this setting.", - "required": false, - "type": "string" - }, - { - "name": "max_width", - "in": "query", - "description": "Sets the maximum width for the page image in pixels. The DPI is recalculated based on this setting.", - "required": false, - "type": "string" - }, - { - "name": "show_changes", - "in": "query", - "required": false, - "type": "string", - "description": "When **true**, changes display in the user interface." } ], "responses": { "200": { "description": "Successful response.", "schema": { - "type": "file" + "$ref": "#/definitions/displayAppliancePdf" } }, "400": { @@ -5912,18 +6143,18 @@ } }, "deprecated": false, - "x-ds-methodname": "getDocumentPageImage", - "x-ds-method": "getPageImage", - "x-ds-service": "Envelopes", + "x-ds-methodname": "getPdfBlob", + "x-ds-method": "getPdfBlob", + "x-ds-service": "Uncategorized", + "description": "", "x-ds-in-sdk": true }, "put": { "tags": [ - "Envelopes" + "ApplianceInfo" ], - "summary": "Rotates page image from an envelope for display.", - "description": "Rotates page image from an envelope for display. The page image can be rotated to the left or right.", - "operationId": "Pages_PutPageImage", + "summary": "Updates PDF blobs for Display Appliance.", + "operationId": "EnvelopeApplianceInfo_PutPdfBlob", "consumes": [], "produces": [], "parameters": [ @@ -5934,35 +6165,12 @@ "required": true, "type": "string" }, - { - "name": "documentId", - "in": "path", - "description": "Integer that identifies the document in the envelope.", - "required": true, - "type": "string" - }, { "name": "envelopeId", "in": "path", - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", - "required": true, - "type": "string" - }, - { - "name": "pageNumber", - "in": "path", - "description": "The page number being accessed.", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" - }, - { - "name": "pageRequest", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/pageRequest" - }, - "description": "" } ], "responses": { @@ -5977,20 +6185,18 @@ } }, "deprecated": false, - "x-ds-methodname": "rotateDocumentPage", - "x-ds-method": "rotateDocumentPage", - "x-ds-service": "Envelopes", + "x-ds-methodname": "updatePdfBlob", + "x-ds-method": "updatePdfBlob", + "x-ds-service": "Uncategorized", + "description": "", "x-ds-in-sdk": true }, - "parameters": [] - }, - "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}/tabs": { - "get": { + "post": { "tags": [ - "EnvelopeDocumentTabs" + "ApplianceInfo" ], - "summary": "Returns tabs on the specified page.", - "operationId": "Tabs_GetPageTabs", + "summary": "Adds PDF blobs for Display Appliance.", + "operationId": "EnvelopeApplianceInfo_PostPdfBlob", "consumes": [], "produces": [], "parameters": [ @@ -6001,33 +6207,19 @@ "required": true, "type": "string" }, - { - "name": "documentId", - "in": "path", - "description": "Integer that identifies the document in the envelope.", - "required": true, - "type": "string" - }, { "name": "envelopeId", "in": "path", - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", - "required": true, - "type": "string" - }, - { - "name": "pageNumber", - "in": "path", - "description": "The page number being accessed.", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" } ], "responses": { - "200": { + "201": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/EnvelopeDocumentTabs" + "$ref": "#/definitions/displayAppliancePdf" } }, "400": { @@ -6038,21 +6230,21 @@ } }, "deprecated": false, - "x-ds-methodname": "getPageTabs", - "x-ds-method": "getByPage", - "x-ds-service": "Envelopes", + "x-ds-methodname": "createPdfBlob", + "x-ds-method": "createPdfBlob", + "x-ds-service": "Uncategorized", "description": "", "x-ds-in-sdk": true }, "parameters": [] }, - "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/responsive_html_preview": { - "post": { + "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/recipient_denied_copy": { + "put": { "tags": [ - "DocumentResponsiveHtmlPreview" + "ApplianceInfo" ], - "summary": "", - "operationId": "ResponsiveHtml_PostDocumentResponsiveHtmlPreview", + "summary": "Updates RecipientDeniedDocumentCopy for Display Appliance.", + "operationId": "EnvelopeApplianceInfo_PutRecipientDeniedDocumentCopy", "consumes": [], "produces": [], "parameters": [ @@ -6063,36 +6255,17 @@ "required": true, "type": "string" }, - { - "name": "documentId", - "in": "path", - "description": "Integer that identifies the document in the envelope.", - "required": true, - "type": "string" - }, { "name": "envelopeId", "in": "path", - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" - }, - { - "name": "documentHtmlDefinition", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/documentHtmlDefinition" - }, - "description": "" } ], "responses": { - "201": { - "description": "Successful response.", - "schema": { - "$ref": "#/definitions/DocumentResponsiveHtmlPreview" - } + "200": { + "description": "Successful response." }, "400": { "description": "Error encountered.", @@ -6102,21 +6275,18 @@ } }, "deprecated": false, - "x-ds-methodname": "createDocumentResponsiveHtmlPreview", - "x-ds-method": "create", + "x-ds-methodname": "updateRecipientDeniedDocumentCopy", + "x-ds-method": "updateRecipientDeniedDocumentCopy", "x-ds-service": "Uncategorized", "description": "", "x-ds-in-sdk": true }, - "parameters": [] - }, - "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/tabs": { - "get": { + "delete": { "tags": [ - "EnvelopeDocumentTabs" + "ApplianceInfo" ], - "summary": "Returns the tabs on a document.", - "operationId": "Tabs_GetDocumentTabs", + "summary": "Deletes RecipientDeniedDocumentCopy for Display Appliance.", + "operationId": "EnvelopeApplianceInfo_DeleteRecipientDeniedDocumentCopy", "consumes": [], "produces": [], "parameters": [ @@ -6127,34 +6297,17 @@ "required": true, "type": "string" }, - { - "name": "documentId", - "in": "path", - "description": "Integer that identifies the document in the envelope.", - "required": true, - "type": "string" - }, { "name": "envelopeId", "in": "path", - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" - }, - { - "name": "page_numbers", - "in": "query", - "required": false, - "type": "string", - "description": "Filters for tabs that occur on the pages that you specify. Enter as a comma-separated list of page GUIDs.\n\nExample: `page_numbers=2,6`\n\nNote: You can only enter individual page numbers, and not a page range." } ], "responses": { "200": { - "description": "Successful response.", - "schema": { - "$ref": "#/definitions/EnvelopeDocumentTabs" - } + "description": "Successful response." }, "400": { "description": "Error encountered.", @@ -6164,18 +6317,21 @@ } }, "deprecated": false, - "x-ds-methodname": "getDocumentTabs", - "x-ds-method": "get", - "x-ds-service": "Envelopes", - "description": "This method returns the tabs associated with a document.", + "x-ds-methodname": "deleteRecipientDeniedDocumentCopy", + "x-ds-method": "deleteRecipientDeniedDocumentCopy", + "x-ds-service": "Uncategorized", + "description": "", "x-ds-in-sdk": true }, - "put": { + "parameters": [] + }, + "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/signer_attachment_info": { + "get": { "tags": [ - "EnvelopeDocumentTabs" + "ApplianceInfo" ], - "summary": "", - "operationId": "Tabs_PutDocumentTabs", + "summary": "Returns signer attachment information for Display Appliance.", + "operationId": "EnvelopeApplianceInfo_GetSignerAttachment", "consumes": [], "produces": [], "parameters": [ @@ -6186,35 +6342,19 @@ "required": true, "type": "string" }, - { - "name": "documentId", - "in": "path", - "description": "Integer that identifies the document in the envelope.", - "required": true, - "type": "string" - }, { "name": "envelopeId", "in": "path", - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" - }, - { - "name": "TemplateRecipientTabs", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/TemplateRecipientTabs" - }, - "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/TemplateRecipientTabs" + "$ref": "#/definitions/displayApplianceSignerAttachment" } }, "400": { @@ -6225,18 +6365,18 @@ } }, "deprecated": false, - "x-ds-methodname": "updateDocumentTabs", - "x-ds-method": "updateDocumentTabs", + "x-ds-methodname": "getSignerAttachment", + "x-ds-method": "getSignerAttachment", "x-ds-service": "Uncategorized", "description": "", "x-ds-in-sdk": true }, - "post": { + "delete": { "tags": [ - "EnvelopeDocumentTabs" + "ApplianceInfo" ], - "summary": "", - "operationId": "Tabs_PostDocumentTabs", + "summary": "Deletes signer attachment information for Display Appliance.", + "operationId": "EnvelopeApplianceInfo_DeleteSignerAttachment", "consumes": [], "produces": [], "parameters": [ @@ -6247,36 +6387,17 @@ "required": true, "type": "string" }, - { - "name": "documentId", - "in": "path", - "description": "Integer that identifies the document in the envelope.", - "required": true, - "type": "string" - }, { "name": "envelopeId", "in": "path", - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" - }, - { - "name": "TemplateRecipientTabs", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/TemplateRecipientTabs" - }, - "description": "" } ], "responses": { - "201": { - "description": "Successful response.", - "schema": { - "$ref": "#/definitions/TemplateRecipientTabs" - } + "200": { + "description": "Successful response." }, "400": { "description": "Error encountered.", @@ -6286,18 +6407,22 @@ } }, "deprecated": false, - "x-ds-methodname": "createDocumentTabs", - "x-ds-method": "createDocumentTabs", + "x-ds-methodname": "deleteSignerAttachment", + "x-ds-method": "deleteSignerAttachment", "x-ds-service": "Uncategorized", "description": "", "x-ds-in-sdk": true }, - "delete": { + "parameters": [] + }, + "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents": { + "get": { "tags": [ - "EnvelopeDocumentTabs" + "EnvelopeDocuments" ], - "summary": "", - "operationId": "Tabs_DeleteDocumentTabs", + "summary": "Gets a list of envelope documents.", + "description": "Retrieves a list of documents associated with the specified envelope.", + "operationId": "Documents_GetDocuments", "consumes": [], "produces": [], "parameters": [ @@ -6309,97 +6434,60 @@ "type": "string" }, { - "name": "documentId", + "name": "envelopeId", "in": "path", - "description": "Integer that identifies the document in the envelope.", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { - "name": "envelopeId", - "in": "path", - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", - "required": true, - "type": "string" + "name": "documents_by_userid", + "in": "query", + "required": false, + "type": "string", + "description": "When set to **true**, allows recipients to get documents by their user id. For example, if a user is included in two different routing orders with different visibilities, using this parameter returns all of the documents from both routing orders." }, { - "name": "TemplateRecipientTabs", - "in": "body", + "name": "include_document_size", + "in": "query", "required": false, - "schema": { - "$ref": "#/definitions/TemplateRecipientTabs" - }, + "type": "string", "description": "" - } - ], - "responses": { - "200": { - "description": "Successful response.", - "schema": { - "$ref": "#/definitions/TemplateRecipientTabs" - } }, - "400": { - "description": "Error encountered.", - "schema": { - "$ref": "#/definitions/errorDetails" - } - } - }, - "deprecated": false, - "x-ds-methodname": "deleteDocumentTabs", - "x-ds-method": "deleteDocumentTabs", - "x-ds-service": "Uncategorized", - "description": "", - "x-ds-in-sdk": true - }, - "parameters": [] - }, - "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/templates": { - "get": { - "tags": [ - "EnvelopeTemplates" - ], - "summary": "Gets the templates associated with a document in an existing envelope.", - "description": "Retrieves the templates associated with a document in the specified envelope.", - "operationId": "Templates_GetDocumentTemplates", - "consumes": [], - "produces": [], - "parameters": [ { - "name": "accountId", - "in": "path", - "description": "The external account number (int) or account ID GUID.", - "required": true, - "type": "string" + "name": "include_metadata", + "in": "query", + "required": false, + "type": "string", + "description": "When set to **true**, the response includes metadata that indicates which properties the sender can edit." }, { - "name": "documentId", - "in": "path", - "description": "Integer that identifies the document in the envelope.", - "required": true, - "type": "string" + "name": "include_tabs", + "in": "query", + "required": false, + "type": "string", + "description": "When set to **true**, information about the tabs associated with the documents are included in the response." }, { - "name": "envelopeId", - "in": "path", - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", - "required": true, - "type": "string" + "name": "recipient_id", + "in": "query", + "required": false, + "type": "string", + "description": "Allows the sender to retrieve the documents as one of the recipients that they control. The `documents_by_userid` parameter must be set to **false** for this to work." }, { - "name": "include", + "name": "shared_user_id", "in": "query", "required": false, "type": "string", - "description": "A comma-separated list that limits the results.\nValid values are:\n\n* `applied`\n* `matched`\n" + "description": "The ID of a shared user that you want to impersonate in order to retrieve their view of the list of documents. This parameter is used in the context of a shared inbox (i.e., when you share envelopes from one user to another through the RADmin console)." } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/EnvelopeTemplates" + "$ref": "#/definitions/envelopeDocumentsResult" } }, "400": { @@ -6410,18 +6498,101 @@ } }, "deprecated": false, - "x-ds-methodname": "listTemplatesForDocument", - "x-ds-method": "listByDocument", + "x-ds-methodname": "listDocuments", + "x-ds-method": "list", "x-ds-service": "Envelopes", - "x-ds-in-sdk": true - }, - "post": { + "x-ds-in-sdk": true, + "x-ds-examples": [ + { + "description": "This example shows how\nto get a list\nof all the documents in an envelope.\n\nThe request for this endpoint has no payload.\n\n### Request\n\n```\nGET /restapi/v2.1/accounts/1703061/envelopes/44efc9e6-xxxx-xxxx-xxxx-801410d6922d/documents\n```\n", + "direction": "response", + "format": "json", + "response": { + "envelopeDocuments": [ + { + "availableDocumentTypes": [ + { + "isDefault": "true", + "type": "electronic" + } + ], + "display": "inline", + "documentId": "1", + "includeInDownload": "true", + "name": "NDA.pdf", + "order": "1", + "pages": "3", + "signerMustAcknowledge": "no_interaction", + "type": "content", + "uri": "/envelopes/44efc9e6-xxxx-xxxx-xxxx-801410d6922d/documents/1" + }, + { + "availableDocumentTypes": [ + { + "isDefault": "true", + "type": "electronic" + } + ], + "display": "inline", + "documentId": "2", + "includeInDownload": "true", + "name": "House.pdf", + "order": "2", + "pages": "1", + "signerMustAcknowledge": "no_interaction", + "type": "content", + "uri": "/envelopes/44efc9e6-xxxx-xxxx-xxxx-801410d6922d/documents/2" + }, + { + "availableDocumentTypes": [ + { + "isDefault": "true", + "type": "electronic" + } + ], + "display": "inline", + "documentId": "3", + "includeInDownload": "true", + "name": "contractor_agreement.docx", + "order": "3", + "pages": "2", + "signerMustAcknowledge": "no_interaction", + "type": "content", + "uri": "/envelopes/44efc9e6-xxxx-xxxx-xxxx-801410d6922d/documents/3" + }, + { + "availableDocumentTypes": [ + { + "isDefault": "true", + "type": "electronic" + } + ], + "display": "inline", + "documentId": "certificate", + "includeInDownload": "true", + "name": "Summary", + "order": "999", + "pages": "4", + "signerMustAcknowledge": "no_interaction", + "type": "summary", + "uri": "/envelopes/44efc9e6-xxxx-xxxx-xxxx-801410d6922d/documents/certificate" + } + ], + "envelopeId": "44efc9e6-xxxx-xxxx-xxxx-801410d6922d" + }, + "request": null, + "style": "custom", + "title": "List All Documents in an Envelope" + } + ] + }, + "put": { "tags": [ - "EnvelopeTemplates" + "EnvelopeDocuments" ], - "summary": "Adds templates to a document in an envelope.", - "description": "Adds templates to a document in the specified envelope.", - "operationId": "Templates_PostDocumentTemplates", + "summary": "Adds one or more documents to an existing envelope document.", + "description": "Adds one or more documents to an existing envelope document.\n

**Note**: When adding or modifying documents for an in-process envelope, DocuSign recommends locking the envelope prior to making any changes.\n\nIf the file name of a document contains unicode characters, you need to include a `Content-Disposition` header. Example:\n\n\n**Header**: `Content-Disposition`\n\n\n**Value**: `file; filename=\\\"name\\\";fileExtension=ext;documentId=1`", + "operationId": "Documents_PutDocuments", "consumes": [], "produces": [], "parameters": [ @@ -6432,35 +6603,28 @@ "required": true, "type": "string" }, - { - "name": "documentId", - "in": "path", - "description": "Integer that identifies the document in the envelope.", - "required": true, - "type": "string" - }, { "name": "envelopeId", "in": "path", - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { - "name": "documentTemplateList", + "name": "envelopeDefinition", "in": "body", "required": false, "schema": { - "$ref": "#/definitions/documentTemplateList" + "$ref": "#/definitions/envelopeDefinition" }, "description": "" } ], "responses": { - "201": { + "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/documentTemplateList" + "$ref": "#/definitions/envelopeDocumentsResult" } }, "400": { @@ -6471,21 +6635,18 @@ } }, "deprecated": false, - "x-ds-methodname": "applyTemplateToDocument", - "x-ds-method": "applyToDocument", + "x-ds-methodname": "updateDocuments", + "x-ds-method": "updateList", "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, - "parameters": [] - }, - "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/templates/{templateId}": { "delete": { "tags": [ - "EnvelopeTemplates" + "EnvelopeDocuments" ], - "summary": "Deletes a template from a document in an existing envelope.", - "description": "Deletes the specified template from a document in an existing envelope.", - "operationId": "Templates_DeleteDocumentTemplates", + "summary": "Deletes documents from a draft envelope.", + "description": "Deletes one or more documents from an existing envelope that has not yet been completed.\n\nTo delete a document, use only the relevant parts of the [`envelopeDefinition`](#envelopeDefinition).\nFor example, this request body specifies that you want to delete the document whose `documentId` is \"1\".\n\n\n```text\n{\n \"documents\": [\n {\n \"documentId\": \"1\"\n }\n ]\n}\n```\n\nThe envelope status must be one of:\n\n- `created`\n- `sent`\n- `delivered`\n\n\n", + "operationId": "Documents_DeleteDocuments", "consumes": [], "produces": [], "parameters": [ @@ -6496,31 +6657,29 @@ "required": true, "type": "string" }, - { - "name": "documentId", - "in": "path", - "description": "Integer that identifies the document in the envelope.", - "required": true, - "type": "string" - }, { "name": "envelopeId", "in": "path", - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { - "name": "templateId", - "in": "path", - "description": "The ID of the template.", - "required": true, - "type": "string" + "name": "envelopeDefinition", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/envelopeDefinition" + }, + "description": "" } ], "responses": { "200": { - "description": "Successful response." + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/envelopeDocumentsResult" + } }, "400": { "description": "Error encountered.", @@ -6530,23 +6689,25 @@ } }, "deprecated": false, - "x-ds-methodname": "deleteTemplatesFromDocument", + "x-ds-methodname": "deleteDocuments", "x-ds-method": "delete", "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, "parameters": [] }, - "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/email_settings": { + "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}": { "get": { "tags": [ - "EnvelopeEmailSettings" + "EnvelopeDocuments" ], - "summary": "Gets the email setting overrides for an envelope.", - "description": "Retrieves the email override settings for the specified envelope.", - "operationId": "EmailSettings_GetEmailSettings", + "summary": "Gets a document from an envelope.", + "description": "Retrieves the specified document from the envelope. If the account has the Highlight Data Changes feature enabled, there is an option to request that any changes in the envelope be highlighted.", + "operationId": "Documents_GetDocument", "consumes": [], - "produces": [], + "produces": [ + "application/pdf" + ], "parameters": [ { "name": "accountId", @@ -6555,19 +6716,89 @@ "required": true, "type": "string" }, + { + "name": "documentId", + "in": "path", + "description": "This parameter takes the following special keywords:\n\n- `combined`: Retrieves a PDF file that contains the combined content of all of the documents. If the account option **Attach certification of completion to envelope** is on, then the Certificate of Completion is also included in the PDF file. You set this account option in the Admin tool on the **Signing Settings** screen, or by setting the `attachCompletedEnvelope` property in the `accountSettings` object to **true**.\n- `archive`: Retrieves a ZIP archive that contains all of the PDF documents and the Certificate of Completion.\n", + "required": true, + "type": "string" + }, { "name": "envelopeId", "in": "path", - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" + }, + { + "name": "certificate", + "in": "query", + "description": "When set to **false**, the envelope signing certificate is removed from the download.", + "required": false, + "type": "string" + }, + { + "name": "documents_by_userid", + "in": "query", + "required": false, + "type": "string", + "description": "When set to **true**, allows recipients to get documents by their user id. For example, if a user is included in two different routing orders with different visibilities, using this parameter returns all of the documents from both routing orders." + }, + { + "name": "encoding", + "in": "query", + "required": false, + "type": "string", + "description": "Reserved for DocuSign." + }, + { + "name": "encrypt", + "in": "query", + "description": "When set to **true**, the PDF bytes returned in the response are encrypted for all the key managers configured on your DocuSign account. You can decrypt the documents by using the Key Manager DecryptDocument API method. For more information about Key Manager, see the DocuSign Security Appliance Installation Guide that your organization received from DocuSign.", + "required": false, + "type": "string" + }, + { + "name": "language", + "in": "query", + "description": "Specifies the language for the Certificate of Completion in the response. The supported languages are: Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Dutch (nl), English US (en), French (fr), German (de), Italian (it), Japanese (ja), Korean (ko), Portuguese (pt), Portuguese (Brazil) (pt_BR), Russian (ru), Spanish (es). ", + "required": false, + "type": "string" + }, + { + "name": "recipient_id", + "in": "query", + "required": false, + "type": "string", + "description": "Allows the sender to retrieve the documents as one of the recipients that they control. The `documents_by_userid` parameter must be set to **false** for this functionality to work." + }, + { + "name": "shared_user_id", + "in": "query", + "required": false, + "type": "string", + "description": "The ID of a shared user that you want to impersonate in order to retrieve their view of the list of documents. This parameter is used in the context of a shared inbox (i.e., when you share envelopes from one user to another through the RADmin console)." + }, + { + "name": "show_changes", + "in": "query", + "description": "When set to **true**, any changed fields for the returned PDF are highlighted in yellow and optional signatures or initials outlined in red. ", + "required": false, + "type": "string" + }, + { + "name": "watermark", + "in": "query", + "description": "When set to **true**, the account has the watermark feature enabled, and the envelope is not complete, then the watermark for the account is added to the PDF documents. This option can remove the watermark. ", + "required": false, + "type": "string" } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/EnvelopeEmailSettings" + "type": "file" } }, "400": { @@ -6578,18 +6809,119 @@ } }, "deprecated": false, - "x-ds-methodname": "getEmailSettings", + "x-ds-methodname": "getDocument", "x-ds-method": "get", "x-ds-service": "Envelopes", - "x-ds-in-sdk": true + "x-ds-in-sdk": true, + "x-ds-examples": [ + { + "description": "This example shows how to retrieve\na single document from an envelope\nas a PDF file.\n\n\nThe request for this endpoint has no payload.\n\n### Request\n\n```\nGET /restapi/v2.1/accounts/1703061/envelopes/44efc9e6-xxxx-xxxx-xxxx-801410d6922d/documents/3\n```\n\n", + "direction": "response", + "format": "json", + "response": "PDF File", + "request": null, + "style": "custom", + "title": "Get a Single Document as a PDF File" + }, + { + "description": "If you use `combined` instead of a document id\nthe response is a PDF file that contains\nall of the documents in the specified envelope.\n\nThe request for this endpoint has no payload.\n\n### Request\n\n```\nGET /restapi/v2.1/accounts/1703061/envelopes/44efc9e6-xxxx-xxxx-xxxx-801410d6922d/documents/combined\n```\n\n", + "direction": "response", + "format": "json", + "response": "PDF File", + "request": null, + "style": "custom", + "title": "Get All Documents as a Single PDF File" + }, + { + "description": "This example shows how\nto get a list\nof all the documents in an envelope.\n\nThe request for this endpoint has no payload.\n\n### Request\n\n```\nGET /restapi/v2.1/accounts/1703061/envelopes/44efc9e6-xxxx-xxxx-xxxx-801410d6922d/documents\n```\n", + "direction": "response", + "format": "json", + "response": { + "envelopeDocuments": [ + { + "availableDocumentTypes": [ + { + "isDefault": "true", + "type": "electronic" + } + ], + "display": "inline", + "documentId": "1", + "includeInDownload": "true", + "name": "NDA.pdf", + "order": "1", + "pages": "3", + "signerMustAcknowledge": "no_interaction", + "type": "content", + "uri": "/envelopes/44efc9e6-xxxx-xxxx-xxxx-801410d6922d/documents/1" + }, + { + "availableDocumentTypes": [ + { + "isDefault": "true", + "type": "electronic" + } + ], + "display": "inline", + "documentId": "2", + "includeInDownload": "true", + "name": "House.pdf", + "order": "2", + "pages": "1", + "signerMustAcknowledge": "no_interaction", + "type": "content", + "uri": "/envelopes/44efc9e6-xxxx-xxxx-xxxx-801410d6922d/documents/2" + }, + { + "availableDocumentTypes": [ + { + "isDefault": "true", + "type": "electronic" + } + ], + "display": "inline", + "documentId": "3", + "includeInDownload": "true", + "name": "contractor_agreement.docx", + "order": "3", + "pages": "2", + "signerMustAcknowledge": "no_interaction", + "type": "content", + "uri": "/envelopes/44efc9e6-xxxx-xxxx-xxxx-801410d6922d/documents/3" + }, + { + "availableDocumentTypes": [ + { + "isDefault": "true", + "type": "electronic" + } + ], + "display": "inline", + "documentId": "certificate", + "includeInDownload": "true", + "name": "Summary", + "order": "999", + "pages": "4", + "signerMustAcknowledge": "no_interaction", + "type": "summary", + "uri": "/envelopes/44efc9e6-xxxx-xxxx-xxxx-801410d6922d/documents/certificate" + } + ], + "envelopeId": "44efc9e6-xxxx-xxxx-xxxx-801410d6922d" + }, + "request": null, + "style": "custom", + "title": "List All Documents in an Envelope" + } + ] }, "put": { "tags": [ - "EnvelopeEmailSettings" + "EnvelopeDocuments" ], - "summary": "Updates the email setting overrides for an envelope.", - "description": "Updates the existing email override settings for the specified envelope. Note that modifying email settings will only affect email communications that occur after the modification was made.\n\nThis can also be used to delete an individual email override setting by using an empty string for the value to be deleted.", - "operationId": "EmailSettings_PutEmailSettings", + "summary": "Adds a document to an existing draft envelope.", + "description": "Adds a document to an existing draft envelope. The bytes of the document make up the body of the request. \n\n\n\n**Note**: When adding or modifying documents for an in-process envelope, DocuSign recommends locking the envelope prior to making any changes.\n\n\n\n\nIf the file name of the document contains unicode characters, you need to include a `Content-Disposition` header. Example:\n\n\n**Header**: `Content-Disposition`\n\n\n**Value**: `file; filename=\\\"name\\\";fileExtension=ext;documentId=1`\n", + "operationId": "Documents_PutDocument", "consumes": [], "produces": [], "parameters": [ @@ -6601,27 +6933,25 @@ "type": "string" }, { - "name": "envelopeId", + "name": "documentId", "in": "path", - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", + "description": "The `documentId` is set by the API client. It is an integer that falls between `1` and 2,147,483,647. The value is encoded as a string without commas. The values `1`, `2`, `3`, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a `documentId` property that specifies the document on which to place the tab.", "required": true, "type": "string" }, { - "name": "EnvelopeEmailSettings", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/EnvelopeEmailSettings" - }, - "description": "" + "name": "envelopeId", + "in": "path", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", + "required": true, + "type": "string" } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/EnvelopeEmailSettings" + "$ref": "#/definitions/envelopeDocument" } }, "400": { @@ -6632,18 +6962,21 @@ } }, "deprecated": false, - "x-ds-methodname": "updateEmailSettings", + "x-ds-methodname": "updateDocument", "x-ds-method": "update", "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, - "post": { + "parameters": [] + }, + "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields": { + "get": { "tags": [ - "EnvelopeEmailSettings" + "EnvelopeDocumentFields" ], - "summary": "Adds email setting overrides to an envelope.", - "description": "Adds email override settings, changing the email address to reply to an email address, name, or the BCC for email archive information, for the envelope. Note that adding email settings will only affect email communications that occur after the addition was made.\n\n### Important: The BCC Email address feature is designed to provide a copy of all email communications for external archiving purposes. DocuSign recommends that envelopes sent using the BCC for Email Archive feature, including the BCC Email Override option, include additional signer authentication options. To send a copy of the envelope to a recipient who does not need to sign, use a Carbon Copies or Certified Deliveries Recipient Type.", - "operationId": "EmailSettings_PostEmailSettings", + "summary": "Gets the custom document fields from an existing envelope document.", + "description": "Retrieves the custom document field information from an existing envelope document.", + "operationId": "DocumentFields_GetDocumentFields", "consumes": [], "produces": [], "parameters": [ @@ -6655,27 +6988,25 @@ "type": "string" }, { - "name": "envelopeId", + "name": "documentId", "in": "path", - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", + "description": "The `documentId` is set by the API client. It is an integer that falls between `1` and 2,147,483,647. The value is encoded as a string without commas. The values `1`, `2`, `3`, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a `documentId` property that specifies the document on which to place the tab.", "required": true, "type": "string" }, { - "name": "EnvelopeEmailSettings", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/EnvelopeEmailSettings" - }, - "description": "" + "name": "envelopeId", + "in": "path", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", + "required": true, + "type": "string" } ], "responses": { - "201": { + "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/EnvelopeEmailSettings" + "$ref": "#/definitions/EnvelopeDocumentFields" } }, "400": { @@ -6686,18 +7017,18 @@ } }, "deprecated": false, - "x-ds-methodname": "createEmailSettings", - "x-ds-method": "create", + "x-ds-methodname": "listDocumentFields", + "x-ds-method": "list", "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, - "delete": { + "put": { "tags": [ - "EnvelopeEmailSettings" + "EnvelopeDocumentFields" ], - "summary": "Deletes the email setting overrides for an envelope.", - "description": "Deletes all existing email override settings for the envelope. If you want to delete an individual email override setting, use the PUT and set the value to an empty string. Note that deleting email settings will only affect email communications that occur after the deletion and the normal account email settings are used for future email communications.", - "operationId": "EmailSettings_DeleteEmailSettings", + "summary": "Updates existing custom document fields in an existing envelope document.", + "description": "Updates existing custom document fields in an existing envelope document.", + "operationId": "DocumentFields_PutDocumentFields", "consumes": [], "produces": [], "parameters": [ @@ -6708,19 +7039,35 @@ "required": true, "type": "string" }, + { + "name": "documentId", + "in": "path", + "description": "The `documentId` is set by the API client. It is an integer that falls between `1` and 2,147,483,647. The value is encoded as a string without commas. The values `1`, `2`, `3`, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a `documentId` property that specifies the document on which to place the tab.", + "required": true, + "type": "string" + }, { "name": "envelopeId", "in": "path", - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" + }, + { + "name": "EnvelopeDocumentFields", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/EnvelopeDocumentFields" + }, + "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/EnvelopeEmailSettings" + "$ref": "#/definitions/EnvelopeDocumentFields" } }, "400": { @@ -6731,20 +7078,18 @@ } }, "deprecated": false, - "x-ds-methodname": "deleteEmailSettings", - "x-ds-method": "delete", + "x-ds-methodname": "updateDocumentFields", + "x-ds-method": "update", "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, - "parameters": [] - }, - "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/form_data": { - "get": { + "post": { "tags": [ - "EnvelopeFormData" + "EnvelopeDocumentFields" ], - "summary": "Returns envelope form data for an existing envelope.", - "operationId": "FormData_GetFormData", + "summary": "Creates custom document fields in an existing envelope document.", + "description": "Creates custom document fields in an existing envelope document.", + "operationId": "DocumentFields_PostDocumentFields", "consumes": [], "produces": [], "parameters": [ @@ -6755,19 +7100,35 @@ "required": true, "type": "string" }, + { + "name": "documentId", + "in": "path", + "description": "The `documentId` is set by the API client. It is an integer that falls between `1` and 2,147,483,647. The value is encoded as a string without commas. The values `1`, `2`, `3`, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a `documentId` property that specifies the document on which to place the tab.", + "required": true, + "type": "string" + }, { "name": "envelopeId", "in": "path", - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" + }, + { + "name": "EnvelopeDocumentFields", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/EnvelopeDocumentFields" + }, + "description": "" } ], "responses": { - "200": { + "201": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/EnvelopeFormData" + "$ref": "#/definitions/EnvelopeDocumentFields" } }, "400": { @@ -6778,21 +7139,18 @@ } }, "deprecated": false, - "x-ds-methodname": "getFormData", - "x-ds-method": "get", + "x-ds-methodname": "createDocumentFields", + "x-ds-method": "create", "x-ds-service": "Envelopes", - "description": "This method downloads the envelope and field data from any in-process, completed, or canceled envelope that you sent or that is shared with you. Recipients who are also full administrators on an account can view form data for any envelopes that another user on the account has sent to them.\n\n**Note**: To use this feature, the Sending Setting \"Allow sender to download form data\" must be enabled for the account.", "x-ds-in-sdk": true }, - "parameters": [] - }, - "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/html_definitions": { - "get": { + "delete": { "tags": [ - "EnvelopeHtmlDefinitions" + "EnvelopeDocumentFields" ], - "summary": "", - "operationId": "ResponsiveHtml_GetEnvelopeHtmlDefinitions", + "summary": "Deletes custom document fields from an existing envelope document.", + "description": "Deletes custom document fields from an existing envelope document.", + "operationId": "DocumentFields_DeleteDocumentFields", "consumes": [], "produces": [], "parameters": [ @@ -6803,19 +7161,35 @@ "required": true, "type": "string" }, + { + "name": "documentId", + "in": "path", + "description": "The `documentId` is set by the API client. It is an integer that falls between `1` and 2,147,483,647. The value is encoded as a string without commas. The values `1`, `2`, `3`, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a `documentId` property that specifies the document on which to place the tab.", + "required": true, + "type": "string" + }, { "name": "envelopeId", "in": "path", - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" + }, + { + "name": "EnvelopeDocumentFields", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/EnvelopeDocumentFields" + }, + "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/EnvelopeDocumentHtmlDefinitions" + "$ref": "#/definitions/EnvelopeDocumentFields" } }, "400": { @@ -6826,22 +7200,20 @@ } }, "deprecated": false, - "x-ds-methodname": "getEnvelopeHtmlDefinitions", - "x-ds-method": "list", - "x-ds-service": "Uncategorized", - "description": "", + "x-ds-methodname": "deleteDocumentFields", + "x-ds-method": "delete", + "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, "parameters": [] }, - "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/lock": { + "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/html_definitions": { "get": { "tags": [ - "EnvelopeLocks" + "EnvelopeDocumentHtmlDefinitions" ], - "summary": "Gets envelope lock information.", - "description": "Retrieves general information about an envelope lock.\n\nIf the call is made by the locked by user and the request has the same integrator key as original, then the `X-DocuSign-Edit` header and additional lock information is included in the response. This information enables users to recover a lost editing session token and the `X-DocuSign-Edit` header.", - "operationId": "Lock_GetEnvelopeLock", + "summary": "Gets the Original HTML Definition used to\ngenerate the Responsive HTML for a given document.", + "operationId": "ResponsiveHtml_GetEnvelopeDocumentHtmlDefinitions", "consumes": [], "produces": [], "parameters": [ @@ -6852,10 +7224,17 @@ "required": true, "type": "string" }, + { + "name": "documentId", + "in": "path", + "description": "The `documentId` is set by the API client. It is an integer that falls between `1` and 2,147,483,647. The value is encoded as a string without commas. The values `1`, `2`, `3`, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a `documentId` property that specifies the document on which to place the tab.", + "required": true, + "type": "string" + }, { "name": "envelopeId", "in": "path", - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" } @@ -6864,7 +7243,7 @@ "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/EnvelopeLocks" + "$ref": "#/definitions/documentHtmlDefinitionOriginals" } }, "400": { @@ -6875,18 +7254,21 @@ } }, "deprecated": false, - "x-ds-methodname": "getLock", + "x-ds-methodname": "getEnvelopeDocumentHtmlDefinitions", "x-ds-method": "get", - "x-ds-service": "Envelopes", + "x-ds-service": "Uncategorized", + "description": "", "x-ds-in-sdk": true }, - "put": { + "parameters": [] + }, + "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages": { + "get": { "tags": [ - "EnvelopeLocks" + "Envelopes" ], - "summary": "Updates an envelope lock.", - "description": "Updates the lock duration or the `lockedByApp` property for the specified envelope. The user must match the user specified by the `lockByUser` property, and the integrator key that you pass in must match the integrator key information. You must also include the `X-DocuSign-Edit` header, which contains a `lockToken` that proves ownership of the lock and the `lockDurationInSeconds`. The token that you need for this header is returned in the response to the POST and GET methods.\n\nExample:\n\n`X-DocuSign-Edit:{{lockToken}}`", - "operationId": "Lock_PutEnvelopeLock", + "summary": "Returns document page image(s) based on input.", + "operationId": "Pages_GetPageImages", "consumes": [], "produces": [], "parameters": [ @@ -6897,28 +7279,75 @@ "required": true, "type": "string" }, + { + "name": "documentId", + "in": "path", + "description": "The `documentId` is set by the API client. It is an integer that falls between `1` and 2,147,483,647. The value is encoded as a string without commas. The values `1`, `2`, `3`, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a `documentId` property that specifies the document on which to place the tab.", + "required": true, + "type": "string" + }, { "name": "envelopeId", "in": "path", - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { - "name": "lockRequest", - "in": "body", + "name": "count", + "in": "query", "required": false, - "schema": { - "$ref": "#/definitions/lockRequest" - }, - "description": "" + "type": "string", + "description": "The maximum number of results to return." + }, + { + "name": "dpi", + "in": "query", + "required": false, + "type": "string", + "description": "The number of dots per inch (DPI) for the resulting images. Valid values are 1-310 DPI. The default value is 94." + }, + { + "name": "max_height", + "in": "query", + "required": false, + "type": "string", + "description": "Sets the maximum height of the returned images in pixels." + }, + { + "name": "max_width", + "in": "query", + "required": false, + "type": "string", + "description": "Sets the maximum width of the returned images in pixels." + }, + { + "name": "nocache", + "in": "query", + "required": false, + "type": "string", + "description": "If **true**, using cache is disabled and image information is retrieved from a database. **True** is the default value. " + }, + { + "name": "show_changes", + "in": "query", + "required": false, + "type": "string", + "description": "If **true**, changes display in the user interface." + }, + { + "name": "start_position", + "in": "query", + "required": false, + "type": "string", + "description": "The position within the total result set from which to start returning values. The value **thumbnail** may be used to return the page image." } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/EnvelopeLocks" + "$ref": "#/definitions/pageImages" } }, "400": { @@ -6929,18 +7358,22 @@ } }, "deprecated": false, - "x-ds-methodname": "updateLock", - "x-ds-method": "update", + "x-ds-methodname": "getDocumentPageImages", + "x-ds-method": "getPageImages", "x-ds-service": "Envelopes", + "description": "Returns images of the pages in a document for display based on the parameters that you specify.", "x-ds-in-sdk": true }, - "post": { + "parameters": [] + }, + "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}": { + "delete": { "tags": [ - "EnvelopeLocks" + "Envelopes" ], - "summary": "Lock an envelope.", - "description": "Locks the specified envelope, and sets the time until the lock expires, to prevent other users or recipients from accessing and changing the envelope.\n\n**Note**: Users must have envelope locking capability enabled to use this function (userSetting `canLockEnvelopes` must be set to true for the user).\n\nThe response to this request returns a `lockToken` parameter. You must use the `lockToken` to update or delete an existing lock.", - "operationId": "Lock_PostEnvelopeLock", + "summary": "Deletes a page from a document in an envelope.", + "description": "Deletes a page from a document in an envelope based on the page number.", + "operationId": "Pages_DeletePage", "consumes": [], "produces": [], "parameters": [ @@ -6951,29 +7384,31 @@ "required": true, "type": "string" }, + { + "name": "documentId", + "in": "path", + "description": "The `documentId` is set by the API client. It is an integer that falls between `1` and 2,147,483,647. The value is encoded as a string without commas. The values `1`, `2`, `3`, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a `documentId` property that specifies the document on which to place the tab.", + "required": true, + "type": "string" + }, { "name": "envelopeId", "in": "path", - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { - "name": "lockRequest", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/lockRequest" - }, - "description": "" + "name": "pageNumber", + "in": "path", + "description": "The page number being accessed.", + "required": true, + "type": "string" } ], "responses": { - "201": { - "description": "Successful response.", - "schema": { - "$ref": "#/definitions/EnvelopeLocks" - } + "200": { + "description": "Successful response." }, "400": { "description": "Error encountered.", @@ -6983,20 +7418,25 @@ } }, "deprecated": false, - "x-ds-methodname": "createLock", - "x-ds-method": "create", + "x-ds-methodname": "deleteDocumentPage", + "x-ds-method": "deleteDocumentPage", "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, - "delete": { + "parameters": [] + }, + "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}/page_image": { + "get": { "tags": [ - "EnvelopeLocks" + "Envelopes" ], - "summary": "Deletes an envelope lock.", - "description": "Deletes the lock from the specified envelope. The user must match the user specified by the `lockByUser` property, and the integrator key that you pass in must match the integrator key information. You must also include the `X-DocuSign-Edit` header, which contains a `lockToken` that proves ownership of the lock and the `lockDurationInSeconds`. The token that you need for this header is returned in the response to the POST and GET methods.\n\nExample:\n\n`X-DocuSign-Edit:{{lockToken}}`", - "operationId": "Lock_DeleteEnvelopeLock", + "summary": "Gets a page image from an envelope for display.", + "description": "Returns an image of a page in a document for display.", + "operationId": "Pages_GetPageImage", "consumes": [], - "produces": [], + "produces": [ + "image/png" + ], "parameters": [ { "name": "accountId", @@ -7005,19 +7445,61 @@ "required": true, "type": "string" }, + { + "name": "documentId", + "in": "path", + "description": "The `documentId` is set by the API client. It is an integer that falls between `1` and 2,147,483,647. The value is encoded as a string without commas. The values `1`, `2`, `3`, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a `documentId` property that specifies the document on which to place the tab.", + "required": true, + "type": "string" + }, { "name": "envelopeId", "in": "path", - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", + "required": true, + "type": "string" + }, + { + "name": "pageNumber", + "in": "path", + "description": "The page number being accessed.", "required": true, "type": "string" + }, + { + "name": "dpi", + "in": "query", + "description": "Sets the dots per inch (DPI) for the returned image.", + "required": false, + "type": "string" + }, + { + "name": "max_height", + "in": "query", + "description": "Sets the maximum height for the page image in pixels. The DPI is recalculated based on this setting.", + "required": false, + "type": "string" + }, + { + "name": "max_width", + "in": "query", + "description": "Sets the maximum width for the page image in pixels. The DPI is recalculated based on this setting.", + "required": false, + "type": "string" + }, + { + "name": "show_changes", + "in": "query", + "required": false, + "type": "string", + "description": "When **true**, changes display in the user interface." } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/EnvelopeLocks" + "type": "file" } }, "400": { @@ -7028,21 +7510,18 @@ } }, "deprecated": false, - "x-ds-methodname": "deleteLock", - "x-ds-method": "delete", + "x-ds-methodname": "getDocumentPageImage", + "x-ds-method": "getPageImage", "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, - "parameters": [] - }, - "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/notification": { - "get": { + "put": { "tags": [ "Envelopes" ], - "summary": "Gets envelope notification information.", - "description": "Retrieves the envelope notification, reminders and expirations, information for an existing envelope.", - "operationId": "Notification_GetEnvelopesEnvelopeIdNotification", + "summary": "Rotates page image from an envelope for display.", + "description": "Rotates page image from an envelope for display. The page image can be rotated to the left or right.", + "operationId": "Pages_PutPageImage", "consumes": [], "produces": [], "parameters": [ @@ -7053,20 +7532,40 @@ "required": true, "type": "string" }, + { + "name": "documentId", + "in": "path", + "description": "The `documentId` is set by the API client. It is an integer that falls between `1` and 2,147,483,647. The value is encoded as a string without commas. The values `1`, `2`, `3`, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a `documentId` property that specifies the document on which to place the tab.", + "required": true, + "type": "string" + }, { "name": "envelopeId", "in": "path", - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", + "required": true, + "type": "string" + }, + { + "name": "pageNumber", + "in": "path", + "description": "The page number being accessed.", "required": true, "type": "string" + }, + { + "name": "pageRequest", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/pageRequest" + }, + "description": "" } ], "responses": { "200": { - "description": "Successful response.", - "schema": { - "$ref": "#/definitions/notification" - } + "description": "Successful response." }, "400": { "description": "Error encountered.", @@ -7076,17 +7575,20 @@ } }, "deprecated": false, - "x-ds-methodname": "getNotificationSettings", - "x-ds-method": "getNotificationSettings", + "x-ds-methodname": "rotateDocumentPage", + "x-ds-method": "rotateDocumentPage", "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, - "put": { + "parameters": [] + }, + "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}/tabs": { + "get": { "tags": [ - "Envelopes" + "EnvelopeDocumentTabs" ], - "summary": "Sets envelope notifications for an existing envelope.", - "operationId": "Notification_PutEnvelopesEnvelopeIdNotification", + "summary": "Returns tabs on the specified page.", + "operationId": "Tabs_GetPageTabs", "consumes": [], "produces": [], "parameters": [ @@ -7097,28 +7599,33 @@ "required": true, "type": "string" }, + { + "name": "documentId", + "in": "path", + "description": "The `documentId` is set by the API client. It is an integer that falls between `1` and 2,147,483,647. The value is encoded as a string without commas. The values `1`, `2`, `3`, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a `documentId` property that specifies the document on which to place the tab.", + "required": true, + "type": "string" + }, { "name": "envelopeId", "in": "path", - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { - "name": "envelopeNotificationRequest", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/envelopeNotificationRequest" - }, - "description": "" + "name": "pageNumber", + "in": "path", + "description": "The page number being accessed.", + "required": true, + "type": "string" } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/notification" + "$ref": "#/definitions/EnvelopeDocumentTabs" } }, "400": { @@ -7129,22 +7636,21 @@ } }, "deprecated": false, - "x-ds-methodname": "updateNotificationSettings", - "x-ds-method": "updateNotificationSettings", + "x-ds-methodname": "getPageTabs", + "x-ds-method": "getByPage", "x-ds-service": "Envelopes", - "description": "This method sets the notifications (reminders and expirations) for an existing envelope. The request body sends a structure containing reminders and expirations settings. It also specifies whether to use the settings specified in the request, or the account default notification settings for the envelope.\n\nNote that this request only specifies when notifications are sent; it does not initiate sending of email messages.", + "description": "", "x-ds-in-sdk": true }, "parameters": [] }, - "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients": { - "get": { + "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/responsive_html_preview": { + "post": { "tags": [ - "EnvelopeRecipients" + "DocumentResponsiveHtmlPreview" ], - "summary": "Gets the status of recipients for an envelope.", - "description": "Retrieves the status of all recipients in a single envelope and identifies the current recipient in the routing list. This method can also be used to retrieve the tab values.\n\nThe `currentRoutingOrder` property of the response contains the `routingOrder` value of the current recipient indicating that the envelope has been sent to the recipient, but the recipient has not completed their actions.", - "operationId": "Recipients_GetRecipients", + "summary": "Creates a preview of the responsive version of a document.", + "operationId": "ResponsiveHtml_PostDocumentResponsiveHtmlPreview", "consumes": [], "produces": [], "parameters": [ @@ -7156,46 +7662,34 @@ "type": "string" }, { - "name": "envelopeId", + "name": "documentId", "in": "path", - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", + "description": "The `documentId` is set by the API client. It is an integer that falls between `1` and 2,147,483,647. The value is encoded as a string without commas. The values `1`, `2`, `3`, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a `documentId` property that specifies the document on which to place the tab.", "required": true, "type": "string" }, { - "name": "include_anchor_tab_locations", - "in": "query", - "description": " When set to **true** and `include_tabs` value is set to **true**, all tabs with anchor tab properties are included in the response. ", - "required": false, - "type": "string" - }, - { - "name": "include_extended", - "in": "query", - "description": " When set to **true**, the extended properties are included in the response. ", - "required": false, + "name": "envelopeId", + "in": "path", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", + "required": true, "type": "string" }, { - "name": "include_metadata", - "in": "query", - "required": false, - "type": "string", - "description": "Boolean value that specifies whether to include metadata associated with the recipients (for envelopes only, not templates)." - }, - { - "name": "include_tabs", - "in": "query", - "description": "When set to **true**, the tab information associated with the recipient is included in the response. If you do not specify this parameter, the effect is the default behavior (**false**).", + "name": "documentHtmlDefinition", + "in": "body", "required": false, - "type": "string" + "schema": { + "$ref": "#/definitions/documentHtmlDefinition" + }, + "description": "" } ], "responses": { - "200": { + "201": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/EnvelopeRecipients" + "$ref": "#/definitions/documentHtmlDefinitions" } }, "400": { @@ -7206,110 +7700,21 @@ } }, "deprecated": false, - "x-ds-methodname": "listRecipients", - "x-ds-method": "list", - "x-ds-service": "Envelopes", - "x-ds-in-sdk": true, - "x-ds-examples": [ - { - "description": "This example shows the result of an envelope\nwith one signer and a CC'ed recipient.\n\n\n### Request\nThe request for this endpoint has no payload.\n\n```\nGET /restapi/v2.1/accounts/1703061/envelopes/44efc9e6-915e-4b1d-9b54-801410d6922d/recipients\n```\n\n\n", - "direction": "response", - "format": "json", - "response": { - "agents": [], - "carbonCopies": [ - { - "email": "aoneil@example.com", - "name": "Ariana O'Neill", - "recipientId": "2", - "recipientIdGuid": "72edf9b6-4a4e-4c24-b982-86bc5d598bb8", - "requireIdLookup": "false", - "routingOrder": "2", - "status": "completed", - "userId": "b72bd827-096b-4c40-b33d-64ab32f0a0eb" - } - ], - "certifiedDeliveries": [], - "currentRoutingOrder": "1", - "editors": [], - "inPersonSigners": [], - "intermediaries": [], - "recipientCount": "2", - "signers": [ - { - "deliveredDateTime": "2016-10-05T21:18:12.3330000Z", - "email": "jallard@example.com", - "isBulkRecipient": "false", - "name": "Jennie Allard", - "recipientId": "1", - "recipientIdGuid": "4575d5e9-7654-467b-b2f5-6c59ca7c43f8", - "requireIdLookup": "false", - "routingOrder": "1", - "signedDateTime": "2016-10-05T21:18:41.6930000Z", - "status": "completed", - "userId": "ca45284a-a94e-4ee2-90af-76035bd795b2" - } - ] - }, - "request": null, - "style": "custom", - "title": "List Recipients and CC-ed Recipients" - }, - { - "description": "This example shows the method's response after the envelope was signed.\n\nThe signer recipient successfully authenticated using:\n* An access code (a pre-shared secret between the sender and the signer)\n* Authentication via Facebook. The Facebook email address is recorded in the Certificate of Completion\n", - "direction": "response", - "format": "json", - "response": { - "agents": [], - "carbonCopies": [], - "certifiedDeliveries": [], - "currentRoutingOrder": "1", - "editors": [], - "inPersonSigners": [], - "intermediaries": [], - "recipientCount": "1", - "signers": [ - { - "accessCode": "1234", - "deliveredDateTime": "2016-07-11T06:19:36.4200000Z", - "email": "larry@example.com", - "idCheckConfigurationName": "Facebook", - "isBulkRecipient": "false", - "name": "Larry Smithers", - "recipientAuthenticationStatus": { - "accessCodeResult": { - "eventTimestamp": "2016-07-11T06:18:55.7170000Z", - "status": "Passed" - }, - "facebookResult": { - "eventTimestamp": "2016-07-11T06:19:28.3170000Z", - "status": "Passed" - } - }, - "recipientId": "1", - "recipientIdGuid": "9670e679-adbd-4d1b-913d-02b43027cb0a", - "requireIdLookup": "true", - "routingOrder": "1", - "signInEachLocation": "false", - "signedDateTime": "2016-07-11T06:19:44.7470000Z", - "status": "completed", - "userId": "57a7b68f-0113-4870-9385-381042d14ca5" - } - ] - }, - "request": null, - "style": "custom", - "title": "List Recipients Who Used Facebook and Access Code Authentication" - } - ] + "x-ds-methodname": "createDocumentResponsiveHtmlPreview", + "x-ds-method": "create", + "x-ds-service": "Uncategorized", + "description": "Creates a preview of the\n[responsive](https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/responsive/)\nHTML version of a specific document.\nThis method enables you to preview a PDF document\nconversion to responsive HTML across device types prior to sending.\n\nThe request body is a `documentHtmlDefinition` object, which holds the responsive signing parameters that define how to generate the HTML version of the signing document.", + "x-ds-in-sdk": true }, - "put": { + "parameters": [] + }, + "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/tabs": { + "get": { "tags": [ - "EnvelopeRecipients" + "EnvelopeDocumentTabs" ], - "summary": "Updates recipients in a draft envelope or corrects recipient information for an in process envelope.", - "description": "Updates recipients in a draft envelope or corrects recipient information for an in process envelope. \n\nFor draft envelopes, you can edit the following properties: `email`, `userName`, `routingOrder`, `faxNumber`, `deliveryMethod`, `accessCode`, and `requireIdLookup`.\n\nOnce an envelope has been sent, you can only edit: `email`, `userName`, `signerName`, `signingGroupId`, `routingOrder`, `faxNumber`, and `deliveryMethod`. You can also select to resend an envelope by using the `resend_envelope` option.\n\nIf you send information for a recipient that does not already exist in a draft envelope, the recipient is added to the envelope (similar to the POST).", - "operationId": "Recipients_PutRecipients", + "summary": "Returns the tabs on a document.", + "operationId": "Tabs_GetDocumentTabs", "consumes": [], "produces": [], "parameters": [ @@ -7321,48 +7726,39 @@ "type": "string" }, { - "name": "envelopeId", + "name": "documentId", "in": "path", - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", + "description": "The `documentId` is set by the API client. It is an integer that falls between `1` and 2,147,483,647. The value is encoded as a string without commas. The values `1`, `2`, `3`, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a `documentId` property that specifies the document on which to place the tab.", "required": true, "type": "string" }, { - "name": "combine_same_order_recipients", - "in": "query", - "required": false, - "type": "string", - "description": "When **true**, recipients are combined or merged with matching recipients. Recipient matching occurs as part of [template matching](https://docs.docusign.com/DocuSignHelp/Content/automatic-template-matching.htm), and is based on Recipient Role and Routing Order." + "name": "envelopeId", + "in": "path", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", + "required": true, + "type": "string" }, { - "name": "offline_signing", + "name": "include_metadata", "in": "query", "required": false, "type": "string", - "description": "Indicates if offline signing is enabled for the recipient when a network connection is unavailable. " + "description": "When set to **true**, the response includes metadata indicating which properties are editable." }, { - "name": "resend_envelope", + "name": "page_numbers", "in": "query", - "description": "When set to **true**, resends the envelope if the new recipient's routing order is before or the same as the envelope's next recipient.", - "required": false, - "type": "string" - }, - { - "name": "EnvelopeRecipients", - "in": "body", "required": false, - "schema": { - "$ref": "#/definitions/EnvelopeRecipients" - }, - "description": "" + "type": "string", + "description": "Filters for tabs that occur on the pages that you specify. Enter as a comma-separated list of page GUIDs.\n\nExample: `page_numbers=2,6`\n\nNote: You can only enter individual page numbers, and not a page range." } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/recipientsUpdateSummary" + "$ref": "#/definitions/EnvelopeDocumentTabs" } }, "400": { @@ -7373,18 +7769,18 @@ } }, "deprecated": false, - "x-ds-methodname": "updateRecipients", - "x-ds-method": "update", + "x-ds-methodname": "getDocumentTabs", + "x-ds-method": "get", "x-ds-service": "Envelopes", + "description": "This method returns the tabs associated with a document.", "x-ds-in-sdk": true }, - "post": { + "put": { "tags": [ - "EnvelopeRecipients" + "EnvelopeDocumentTabs" ], - "summary": "Adds one or more recipients to an envelope.", - "description": "Adds one or more recipients to an envelope.\n\nFor an in process envelope, one that has been sent and has not been completed or voided, an email is sent to a new recipient when they are reached in the routing order. If the new recipient's routing order is before or the same as the envelope's next recipient, an email is only sent if the optional `resend_envelope` query string is set to **true**.", - "operationId": "Recipients_PostRecipients", + "summary": "Updates the tabs for an envelope document.", + "operationId": "Tabs_PutDocumentTabs", "consumes": [], "produces": [], "parameters": [ @@ -7396,34 +7792,34 @@ "type": "string" }, { - "name": "envelopeId", + "name": "documentId", "in": "path", - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", + "description": "The `documentId` is set by the API client. It is an integer that falls between `1` and 2,147,483,647. The value is encoded as a string without commas. The values `1`, `2`, `3`, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a `documentId` property that specifies the document on which to place the tab.", "required": true, "type": "string" }, { - "name": "resend_envelope", - "in": "query", - "description": "When set to **true**, resends the envelope if the new recipient's routing order is before or the same as the envelope's next recipient.", - "required": false, + "name": "envelopeId", + "in": "path", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", + "required": true, "type": "string" }, { - "name": "EnvelopeRecipients", + "name": "tabs", "in": "body", "required": false, "schema": { - "$ref": "#/definitions/EnvelopeRecipients" + "$ref": "#/definitions/tabs" }, - "description": "" + "description": "A list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients." } ], "responses": { - "201": { + "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/EnvelopeRecipients" + "$ref": "#/definitions/tabs" } }, "400": { @@ -7434,18 +7830,18 @@ } }, "deprecated": false, - "x-ds-methodname": "createRecipient", - "x-ds-method": "create", - "x-ds-service": "Envelopes", + "x-ds-methodname": "updateDocumentTabs", + "x-ds-method": "update", + "x-ds-service": "Uncategorized", + "description": "", "x-ds-in-sdk": true }, - "delete": { + "post": { "tags": [ - "EnvelopeRecipients" + "EnvelopeDocumentTabs" ], - "summary": "Deletes recipients from an envelope.", - "description": "Deletes one or more recipients from a draft or sent envelope. List the recipients that you want to delete in the body of the request. This method uses the `recipientId` as the key for deleting recipients.\n\nIf the envelope is `In Process`, meaning that it has been sent and has not been completed or voided, recipients that have completed their actions cannot be deleted.", - "operationId": "Recipients_DeleteRecipients", + "summary": "Adds the tabs to an envelope document.", + "operationId": "Tabs_PostDocumentTabs", "consumes": [], "produces": [], "parameters": [ @@ -7456,28 +7852,35 @@ "required": true, "type": "string" }, + { + "name": "documentId", + "in": "path", + "description": "The `documentId` is set by the API client. It is an integer that falls between `1` and 2,147,483,647. The value is encoded as a string without commas. The values `1`, `2`, `3`, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a `documentId` property that specifies the document on which to place the tab.", + "required": true, + "type": "string" + }, { "name": "envelopeId", "in": "path", - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { - "name": "EnvelopeRecipients", + "name": "tabs", "in": "body", "required": false, "schema": { - "$ref": "#/definitions/EnvelopeRecipients" + "$ref": "#/definitions/tabs" }, - "description": "" + "description": "A list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients." } ], "responses": { - "200": { + "201": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/EnvelopeRecipients" + "$ref": "#/definitions/tabs" } }, "400": { @@ -7488,21 +7891,18 @@ } }, "deprecated": false, - "x-ds-methodname": "deleteRecipients", - "x-ds-method": "deleteList", - "x-ds-service": "Envelopes", + "x-ds-methodname": "createDocumentTabs", + "x-ds-method": "create", + "x-ds-service": "Uncategorized", + "description": "", "x-ds-in-sdk": true }, - "parameters": [] - }, - "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}": { "delete": { "tags": [ - "EnvelopeRecipients" + "EnvelopeDocumentTabs" ], - "summary": "Deletes a recipient from an envelope.", - "description": "Deletes a recipient from a `draft` or `sent` envelope.\n\nIf the envelope is \"In Process\" (has been sent and is not completed or voided), recipients that have completed their actions cannot be deleted.", - "operationId": "Recipients_DeleteRecipient", + "summary": "Deletes tabs from an envelope document.", + "operationId": "Tabs_DeleteDocumentTabs", "consumes": [], "produces": [], "parameters": [ @@ -7514,25 +7914,34 @@ "type": "string" }, { - "name": "envelopeId", + "name": "documentId", "in": "path", - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", + "description": "The `documentId` is set by the API client. It is an integer that falls between `1` and 2,147,483,647. The value is encoded as a string without commas. The values `1`, `2`, `3`, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a `documentId` property that specifies the document on which to place the tab.", "required": true, "type": "string" }, { - "name": "recipientId", + "name": "envelopeId", "in": "path", - "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" + }, + { + "name": "tabs", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/tabs" + }, + "description": "A list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients." } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/EnvelopeRecipients" + "$ref": "#/definitions/tabs" } }, "400": { @@ -7543,21 +7952,22 @@ } }, "deprecated": false, - "x-ds-methodname": "deleteRecipient", + "x-ds-methodname": "deleteDocumentTabs", "x-ds-method": "delete", - "x-ds-service": "Envelopes", + "x-ds-service": "Uncategorized", + "description": "", "x-ds-in-sdk": true }, "parameters": [] }, - "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/bulk_recipients": { + "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/templates": { "get": { "tags": [ - "EnvelopeBulkRecipients" + "EnvelopeTemplates" ], - "summary": "Gets the bulk recipient file from an envelope.", - "description": "Retrieves the bulk recipient file information from an envelope that has a bulk recipient.", - "operationId": "Recipients_GetBulkRecipients", + "summary": "Gets the templates associated with a document in an existing envelope.", + "description": "Retrieves the templates associated with a document in the specified envelope.", + "operationId": "Templates_GetDocumentTemplates", "consumes": [], "produces": [], "parameters": [ @@ -7569,39 +7979,32 @@ "type": "string" }, { - "name": "envelopeId", + "name": "documentId", "in": "path", - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", + "description": "The `documentId` is set by the API client. It is an integer that falls between `1` and 2,147,483,647. The value is encoded as a string without commas. The values `1`, `2`, `3`, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a `documentId` property that specifies the document on which to place the tab.", "required": true, "type": "string" }, { - "name": "recipientId", + "name": "envelopeId", "in": "path", - "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { - "name": "include_tabs", + "name": "include", "in": "query", "required": false, "type": "string", - "description": "When set to **true**, the response includes the tabs associated with the recipients.\n" - }, - { - "name": "start_position", - "in": "query", - "required": false, - "type": "string", - "description": "The starting position in the results set." + "description": "A comma-separated list that limits the results.\nValid values are:\n\n* `applied`\n* `matched`\n" } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/EnvelopeBulkRecipients" + "$ref": "#/definitions/templateInformation" } }, "400": { @@ -7612,21 +8015,19 @@ } }, "deprecated": false, - "x-ds-methodname": "getRecipients", - "x-ds-method": "list", - "x-ds-service": "BulkEnvelopes", + "x-ds-methodname": "listTemplatesForDocument", + "x-ds-method": "listByDocument", + "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, - "put": { + "post": { "tags": [ - "EnvelopeBulkRecipients" - ], - "summary": "Adds or replaces envelope bulk recipients.", - "description": "Updates the bulk recipients in a draft envelope using a file upload. The Content-Type supported for uploading a bulk recipient file is CSV (text/csv).\n\nThe REST API does not support modifying individual rows or values in the bulk recipients file. It only allows the entire file to be added or replaced with a new file.", - "operationId": "Recipients_PutBulkRecipients", - "consumes": [ - "text/csv" + "EnvelopeTemplates" ], + "summary": "Adds templates to a document in an envelope.", + "description": "Adds templates to a document in the specified envelope.", + "operationId": "Templates_PostDocumentTemplates", + "consumes": [], "produces": [], "parameters": [ { @@ -7637,34 +8038,41 @@ "type": "string" }, { - "name": "envelopeId", + "name": "documentId", "in": "path", - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", + "description": "The `documentId` is set by the API client. It is an integer that falls between `1` and 2,147,483,647. The value is encoded as a string without commas. The values `1`, `2`, `3`, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a `documentId` property that specifies the document on which to place the tab.", "required": true, "type": "string" }, { - "name": "recipientId", + "name": "envelopeId", "in": "path", - "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { - "name": "bulkRecipientsRequest", + "name": "preserve_template_recipient", + "in": "query", + "required": false, + "type": "string", + "description": "" + }, + { + "name": "documentTemplateList", "in": "body", "required": false, "schema": { - "$ref": "#/definitions/bulkRecipientsRequest" + "$ref": "#/definitions/documentTemplateList" }, "description": "" } ], "responses": { - "200": { + "201": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/bulkRecipientsSummaryResponse" + "$ref": "#/definitions/documentTemplateList" } }, "400": { @@ -7675,18 +8083,21 @@ } }, "deprecated": false, - "x-ds-methodname": "updateRecipients", - "x-ds-method": "update", - "x-ds-service": "BulkEnvelopes", + "x-ds-methodname": "applyTemplateToDocument", + "x-ds-method": "applyToDocument", + "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, + "parameters": [] + }, + "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/templates/{templateId}": { "delete": { "tags": [ - "EnvelopeBulkRecipients" + "EnvelopeTemplates" ], - "summary": "Deletes the bulk recipient file from an envelope.", - "description": "Deletes the bulk recipient file from an envelope. This cannot be used if the envelope has been sent.\n\nAfter using this, the `bulkRecipientsUri` property is not returned in subsequent GET calls for the envelope, but the recipient will remain as a bulk recipient.", - "operationId": "Recipients_DeleteBulkRecipientsFile", + "summary": "Deletes a template from a document in an existing envelope.", + "description": "Deletes the specified template from a document in an existing envelope.", + "operationId": "Templates_DeleteDocumentTemplates", "consumes": [], "produces": [], "parameters": [ @@ -7697,27 +8108,31 @@ "required": true, "type": "string" }, + { + "name": "documentId", + "in": "path", + "description": "The `documentId` is set by the API client. It is an integer that falls between `1` and 2,147,483,647. The value is encoded as a string without commas. The values `1`, `2`, `3`, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a `documentId` property that specifies the document on which to place the tab.", + "required": true, + "type": "string" + }, { "name": "envelopeId", "in": "path", - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { - "name": "recipientId", + "name": "templateId", "in": "path", - "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", + "description": "The id of the template.", "required": true, "type": "string" } ], "responses": { "200": { - "description": "Successful response.", - "schema": { - "$ref": "#/definitions/bulkRecipientsUpdateResponse" - } + "description": "Successful response." }, "400": { "description": "Error encountered.", @@ -7727,21 +8142,21 @@ } }, "deprecated": false, - "x-ds-methodname": "deleteRecipients", + "x-ds-methodname": "deleteTemplatesFromDocument", "x-ds-method": "delete", - "x-ds-service": "BulkEnvelopes", + "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, "parameters": [] }, - "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/consumer_disclosure": { + "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/email_settings": { "get": { "tags": [ - "EnvelopeConsumerDisclosures" + "EnvelopeEmailSettings" ], - "summary": "Gets the Electronic Record and Signature Disclosure associated with the account.", - "description": "Retrieves the Electronic Record and Signature Disclosure, with html formatting, associated with the account. You can use an optional query string to set the language for the disclosure.", - "operationId": "ConsumerDisclosure_GetConsumerDisclosureEnvelopeIdRecipientId", + "summary": "Gets the email setting overrides for an envelope.", + "description": "Retrieves the email override settings for the specified envelope.", + "operationId": "EmailSettings_GetEmailSettings", "consumes": [], "produces": [], "parameters": [ @@ -7755,30 +8170,16 @@ { "name": "envelopeId", "in": "path", - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", - "required": true, - "type": "string" - }, - { - "name": "recipientId", - "in": "path", - "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" - }, - { - "name": "langCode", - "in": "query", - "required": false, - "type": "string", - "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/EnvelopeConsumerDisclosures" + "$ref": "#/definitions/emailSettings" } }, "400": { @@ -7789,21 +8190,18 @@ } }, "deprecated": false, - "x-ds-methodname": "getConsumerDisclosureDefault", - "x-ds-method": "getDefault", + "x-ds-methodname": "getEmailSettings", + "x-ds-method": "get", "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, - "parameters": [] - }, - "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/consumer_disclosure/{langCode}": { - "get": { + "put": { "tags": [ - "EnvelopeConsumerDisclosures" + "EnvelopeEmailSettings" ], - "summary": "Reserved: Gets the Electronic Record and Signature Disclosure associated with the account.", - "description": "Reserved: Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, associated with the account.", - "operationId": "ConsumerDisclosure_GetConsumerDisclosureEnvelopeIdRecipientIdLangCode", + "summary": "Updates the email setting overrides for an envelope.", + "description": "Updates the existing email override settings for the specified envelope. Note that modifying email settings will only affect email communications that occur after the modification was made.\n\nThis can also be used to delete an individual email override setting by using an empty string for the value to be deleted.", + "operationId": "EmailSettings_PutEmailSettings", "consumes": [], "produces": [], "parameters": [ @@ -7817,37 +8215,25 @@ { "name": "envelopeId", "in": "path", - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", - "required": true, - "type": "string" - }, - { - "name": "langCode", - "in": "path", - "description": "The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to \"browser\" to automatically detect the browser language being used by the viewer and display the disclosure in that language.", - "required": true, - "type": "string" - }, - { - "name": "recipientId", - "in": "path", - "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { - "name": "langCode", - "in": "query", + "name": "emailSettings", + "in": "body", "required": false, - "type": "string", - "description": "" + "schema": { + "$ref": "#/definitions/emailSettings" + }, + "description": "A complex type that contains email settings." } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/EnvelopeConsumerDisclosures" + "$ref": "#/definitions/emailSettings" } }, "400": { @@ -7858,20 +8244,18 @@ } }, "deprecated": false, - "x-ds-methodname": "getConsumerDisclosure", - "x-ds-method": "get", + "x-ds-methodname": "updateEmailSettings", + "x-ds-method": "update", "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, - "parameters": [] - }, - "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/document_visibility": { - "get": { + "post": { "tags": [ - "EnvelopeDocumentVisibility" + "EnvelopeEmailSettings" ], - "summary": "Returns document visibility for a recipient", - "operationId": "Recipients_GetRecipientDocumentVisibility", + "summary": "Adds email setting overrides to an envelope.", + "description": "Adds email override settings, changing the email address to reply to an email address, name, or the BCC for email archive information, for the envelope. Note that adding email settings will only affect email communications that occur after the addition was made.\n\n### Important: The BCC Email address feature is designed to provide a copy of all email communications for external archiving purposes. DocuSign recommends that envelopes sent using the BCC for Email Archive feature, including the BCC Email Override option, include additional signer authentication options. To send a copy of the envelope to a recipient who does not need to sign, use a Carbon Copy or Certified Delivery recipient type.", + "operationId": "EmailSettings_PostEmailSettings", "consumes": [], "produces": [], "parameters": [ @@ -7885,23 +8269,25 @@ { "name": "envelopeId", "in": "path", - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { - "name": "recipientId", - "in": "path", - "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", - "required": true, - "type": "string" + "name": "emailSettings", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/emailSettings" + }, + "description": "A complex type that contains email settings." } ], "responses": { - "200": { + "201": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/EnvelopeDocumentVisibility" + "$ref": "#/definitions/emailSettings" } }, "400": { @@ -7912,18 +8298,18 @@ } }, "deprecated": false, - "x-ds-methodname": "getRecipientDocumentVisibility", - "x-ds-method": "get", + "x-ds-methodname": "createEmailSettings", + "x-ds-method": "create", "x-ds-service": "Envelopes", - "description": "This method returns information about document visibility for a recipient.", "x-ds-in-sdk": true }, - "put": { + "delete": { "tags": [ - "EnvelopeDocumentVisibility" + "EnvelopeEmailSettings" ], - "summary": "Updates document visibility for a recipient", - "operationId": "Recipients_PutRecipientDocumentVisibility", + "summary": "Deletes the email setting overrides for an envelope.", + "description": "Deletes all existing email override settings for the envelope. If you want to delete an individual email override setting, use the PUT and set the value to an empty string. Note that deleting email settings will only affect email communications that occur after the deletion and the normal account email settings are used for future email communications.", + "operationId": "EmailSettings_DeleteEmailSettings", "consumes": [], "produces": [], "parameters": [ @@ -7937,32 +8323,16 @@ { "name": "envelopeId", "in": "path", - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", - "required": true, - "type": "string" - }, - { - "name": "recipientId", - "in": "path", - "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" - }, - { - "name": "EnvelopeDocumentVisibility", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/EnvelopeDocumentVisibility" - }, - "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/EnvelopeDocumentVisibility" + "$ref": "#/definitions/emailSettings" } }, "400": { @@ -7973,26 +8343,22 @@ } }, "deprecated": false, - "x-ds-methodname": "updateRecipientDocumentVisibility", - "x-ds-method": "update", + "x-ds-methodname": "deleteEmailSettings", + "x-ds-method": "delete", "x-ds-service": "Envelopes", - "description": "This method updates document visibility for a recipient.\n\n**Note**: A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents.", "x-ds-in-sdk": true }, "parameters": [] }, - "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/initials_image": { + "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/form_data": { "get": { "tags": [ - "Envelopes" + "EnvelopeFormData" ], - "summary": "Gets the initials image for a user.", - "description": "Retrieves the initials image for the specified user. The image is returned in the same format as it was uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image.\n\nThe userId specified in the endpoint must match the authenticated user's user id and the user must be a member of the account.\n\nThe `signatureIdOrName` paramter accepts signature ID or signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly URL encode. If you use the user name, it is likely that the name includes spaces and you might need to URL encode the name before using it in the endpoint. \n\nFor example: \"Bob Smith\" to \"Bob%20Smith\"\n\nOlder envelopes might only contain chromed images. If getting the non-chromed image fails, try getting the chromed image.", - "operationId": "Recipients_GetRecipientInitialsImage", + "summary": "Returns envelope form data for an existing envelope.", + "operationId": "FormData_GetFormData", "consumes": [], - "produces": [ - "image/gif" - ], + "produces": [], "parameters": [ { "name": "accountId", @@ -8004,30 +8370,16 @@ { "name": "envelopeId", "in": "path", - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", - "required": true, - "type": "string" - }, - { - "name": "recipientId", - "in": "path", - "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" - }, - { - "name": "include_chrome", - "in": "query", - "description": "The added line and identifier around the initial image. Note: Older envelopes might only have chromed images. If getting the non-chromed image fails, try getting the chromed image.", - "required": false, - "type": "string" } ], "responses": { "200": { "description": "Successful response.", "schema": { - "type": "file" + "$ref": "#/definitions/envelopeFormData" } }, "400": { @@ -8038,21 +8390,22 @@ } }, "deprecated": false, - "x-ds-methodname": "getRecipientInitialsImage", - "x-ds-method": "getRecipientInitialsImage", + "x-ds-methodname": "getFormData", + "x-ds-method": "get", "x-ds-service": "Envelopes", + "description": "This method downloads the envelope and field data from any in-process, completed, or canceled envelope that you sent or that is shared with you. Recipients who are also full administrators on an account can view form data for any envelopes that another user on the account has sent to them.\n\n**Note**: To use this feature, the Sending Setting \"Allow sender to download form data\" must be enabled for the account.", "x-ds-in-sdk": true }, - "put": { + "parameters": [] + }, + "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/html_definitions": { + "get": { "tags": [ - "Envelopes" - ], - "summary": "Sets the initials image for an accountless signer.", - "description": "Updates the initials image for a signer that does not have a DocuSign account. The supported image formats for this file are: gif, png, jpeg, and bmp. The file size must be less than 200K.\n\nFor the Authentication/Authorization for this call, the credentials must match the sender of the envelope, the recipient must be an accountless signer or in person signer. The account must have the `CanSendEnvelope` property set to **true** and the `ExpressSendOnly` property in `SendingUser` structure must be set to **false**.", - "operationId": "Recipients_PutRecipientInitialsImage", - "consumes": [ - "image/gif" + "EnvelopeHtmlDefinitions" ], + "summary": "Gets the Original HTML Definition used to generate the Responsive HTML for the envelope.", + "operationId": "ResponsiveHtml_GetEnvelopeHtmlDefinitions", + "consumes": [], "produces": [], "parameters": [ { @@ -8065,21 +8418,17 @@ { "name": "envelopeId", "in": "path", - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", - "required": true, - "type": "string" - }, - { - "name": "recipientId", - "in": "path", - "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" } ], "responses": { "200": { - "description": "Successful response." + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/documentHtmlDefinitionOriginals" + } }, "400": { "description": "Error encountered.", @@ -8089,21 +8438,22 @@ } }, "deprecated": false, - "x-ds-methodname": "updateRecipientInitialsImage", - "x-ds-method": "updateRecipientInitialsImage", - "x-ds-service": "Envelopes", + "x-ds-methodname": "getEnvelopeHtmlDefinitions", + "x-ds-method": "list", + "x-ds-service": "Uncategorized", + "description": "", "x-ds-in-sdk": true }, "parameters": [] }, - "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/signature": { + "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/lock": { "get": { "tags": [ - "Envelopes" + "EnvelopeLocks" ], - "summary": "Gets signature information for a signer or sign-in-person recipient.", - "description": "Retrieves signature information for a signer or sign-in-person recipient.", - "operationId": "Recipients_GetRecipientSignature", + "summary": "Gets envelope lock information.", + "description": "Retrieves general information about an envelope lock.\n\nThe user requesting the information must be the same user\nwho locked the envelope.\n\nYou can use this method to recover the lock information,\nincluding the `lockToken`,\nfor a locked envelope.\nThe `X-DocuSign-Edit` header is included in the response.\n\nSee [EnvelopeLocks: create](https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopelocks/create/)\nfor a description of the `X-DocuSign-Edit` header.\n", + "operationId": "Lock_GetEnvelopeLock", "consumes": [], "produces": [], "parameters": [ @@ -8117,14 +8467,7 @@ { "name": "envelopeId", "in": "path", - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", - "required": true, - "type": "string" - }, - { - "name": "recipientId", - "in": "path", - "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" } @@ -8133,7 +8476,7 @@ "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/UserSignatures" + "$ref": "#/definitions/EnvelopeLocks" } }, "400": { @@ -8144,25 +8487,20 @@ } }, "deprecated": false, - "x-ds-methodname": "getRecipientSignature", - "x-ds-method": "getRecipientSignature", + "x-ds-methodname": "getLock", + "x-ds-method": "get", "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, - "parameters": [] - }, - "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/signature_image": { - "get": { + "put": { "tags": [ - "Envelopes" + "EnvelopeLocks" ], - "summary": "Retrieve signature image information for a signer/sign-in-person recipient.", - "description": "Retrieves the specified user signature image. The image is returned in the same format as uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image.\n\nThe userId specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account.\n\nThe `signatureIdOrName` parameter accepts signature ID or signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that don't properly URL encode. If you use the user name, it is likely that the name includes spaces and you might need to URL encode the name before using it in the endpoint. \n\nFor example: \"Bob Smith\" to \"Bob%20Smith\"\n\nOlder envelopes might only have chromed images. If getting the non-chromed image fails, try getting the chromed image.", - "operationId": "Recipients_GetRecipientSignatureImage", + "summary": "Updates an envelope lock.", + "description": "Updates the lock information for a locked envelope.\n\nYou must include the `X-DocuSign-Edit` header\nas described in\n[EnvelopeLocks: create](https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopelocks/create/).\n\n\nUse this method to change the duration\nof the lock (`lockDurationInSeconds`)\nor the `lockedByApp` string.\n\nThe request body is a full `lockRequest` object,\nbut you only need to specify the\nproperties that you are updating. For example:\n\n```\n{\n \"lockDurationInSeconds\": \"3600\",\n \"lockedByApp\": \"My Application\"\n}\n```\n\n", + "operationId": "Lock_PutEnvelopeLock", "consumes": [], - "produces": [ - "image/gif" - ], + "produces": [], "parameters": [ { "name": "accountId", @@ -8174,30 +8512,25 @@ { "name": "envelopeId", "in": "path", - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", - "required": true, - "type": "string" - }, - { - "name": "recipientId", - "in": "path", - "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { - "name": "include_chrome", - "in": "query", - "description": "When set to **true**, the response includes the chromed version of the signature image.", + "name": "lockRequest", + "in": "body", "required": false, - "type": "string" + "schema": { + "$ref": "#/definitions/lockRequest" + }, + "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { - "type": "file" + "$ref": "#/definitions/EnvelopeLocks" } }, "400": { @@ -8208,21 +8541,19 @@ } }, "deprecated": false, - "x-ds-methodname": "getRecipientSignatureImage", - "x-ds-method": "getRecipientSignatureImage", + "x-ds-methodname": "updateLock", + "x-ds-method": "update", "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, - "put": { + "post": { "tags": [ - "Envelopes" - ], - "summary": "Sets the signature image for an accountless signer.", - "description": "Updates the signature image for an accountless signer. The supported image formats for this file are: gif, png, jpeg, and bmp. The file size must be less than 200K.\n\nFor the Authentication/Authorization for this call, the credentials must match the sender of the envelope, the recipient must be an accountless signer or in person signer. The account must have the `CanSendEnvelope` property set to **true** and the `ExpressSendOnly` property in `SendingUser` structure must be set to **false**.", - "operationId": "Recipients_PutRecipientSignatureImage", - "consumes": [ - "image/gif" + "EnvelopeLocks" ], + "summary": "Locks an envelope.", + "description": "This method locks the specified envelope and sets the time until\nthe lock expires to prevent other users or recipients from\nchanging the envelope.\n\n**Note**: To use this method, the envelope locking\ncapability must be enabled for the user; that is, the user setting\n`canLockEnvelopes` must be set to **true**.\n\nThe response to this request includes a `lockToken` parameter\nthat you must use in the `X-DocuSign-Edit` header for\nevery PUT method (typically a method that updates an envelope)\nwhile the envelope is locked.\n\n\nIf you do not provide the `lockToken` when accessing\na locked envelope, you will get the following\nerror:\n\n```\n{\n \"errorCode\": \"EDIT_LOCK_NOT_LOCK_OWNER\",\n \"message\": \"The user is not the owner of the lock. The template is locked by another user or in another application\"\n}\n```\n\n\n### The X-DocuSign-Edit header\n\nThe `X-DocuSign-Edit` header looks like this\nand can be specified in either JSON or XML.\n\n**JSON**\n```\n{\n \"LockToken\": \"token-from-response\",\n \"LockDurationInSeconds\": \"600\"\n}\n```\n\n**XML**\n```\n\n token-from-response\n 600\n\n```\n\nIn the actual HTTP header, you would remove the linebreaks:\n\n```\nX-DocuSign-Edit: {\"LockToken\": \"token-from-response\", \"LockDurationInSeconds\": \"600\" }\n or\nX-DocuSign-Edit:token-from-response600\n```\n\n\n", + "operationId": "Lock_PostEnvelopeLock", + "consumes": [], "produces": [], "parameters": [ { @@ -8235,21 +8566,26 @@ { "name": "envelopeId", "in": "path", - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { - "name": "recipientId", - "in": "path", - "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", - "required": true, - "type": "string" + "name": "lockRequest", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/lockRequest" + }, + "description": "" } ], "responses": { - "200": { - "description": "Successful response." + "201": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/EnvelopeLocks" + } }, "400": { "description": "Error encountered.", @@ -8259,21 +8595,18 @@ } }, "deprecated": false, - "x-ds-methodname": "updateRecipientSignatureImage", - "x-ds-method": "updateRecipientSignatureImage", + "x-ds-methodname": "createLock", + "x-ds-method": "create", "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, - "parameters": [] - }, - "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs": { - "get": { + "delete": { "tags": [ - "EnvelopeRecipientTabs" + "EnvelopeLocks" ], - "summary": "Gets the tabs information for a signer or sign-in-person recipient in an envelope.", - "description": "Retrieves information about the tabs associated with a recipient. You can make a single API call to get all the tab values and information from a given, completed envelope in addition to draft ones. Tab values can be retrieved by using the [EnvelopeRecipients:list method](https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipients/list/) with query parameter include_tabs set to \"true\".", - "operationId": "Recipients_GetRecipientTabs", + "summary": "Deletes an envelope lock.", + "description": "Deletes the lock from the specified envelope.\nThe user deleting the lock must be the same user\nwho locked the envelope.\n\nYou must include the `X-DocuSign-Edit` header\nas described in\n[EnvelopeLocks: create](https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopelocks/create/).\n\nThis method takes an optional query paramter\nthat lets you specify whether\nchanges made while the envelope was locked\nare kept or discarded.\n\n\n| Query Parameter | Description |\n| :-------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `save_changes` | (Optional) When set to **true** (the default), any changes made while the lock was active are saved. When set to **false**, any changes made while the envelope was locked are discarded. |", + "operationId": "Lock_DeleteEnvelopeLock", "consumes": [], "produces": [], "parameters": [ @@ -8287,37 +8620,16 @@ { "name": "envelopeId", "in": "path", - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", - "required": true, - "type": "string" - }, - { - "name": "recipientId", - "in": "path", - "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" - }, - { - "name": "include_anchor_tab_locations", - "in": "query", - "description": "When set to **true**, all tabs with anchor tab properties are included in the response. If you do not specify this parameter, the effect is the default behavior (**false**).", - "required": false, - "type": "string" - }, - { - "name": "include_metadata", - "in": "query", - "required": false, - "type": "string", - "description": "When set to **true**, the response includes metadata indicating which properties are editable." } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/EnvelopeRecipientTabs" + "$ref": "#/definitions/EnvelopeLocks" } }, "400": { @@ -8328,18 +8640,21 @@ } }, "deprecated": false, - "x-ds-methodname": "listTabs", - "x-ds-method": "list", + "x-ds-methodname": "deleteLock", + "x-ds-method": "delete", "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, - "put": { + "parameters": [] + }, + "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/notification": { + "get": { "tags": [ - "EnvelopeRecipientTabs" + "Envelopes" ], - "summary": "Updates the tabs for a recipient.\n\n", - "description": "Updates one or more tabs for a recipient in a draft envelope. \n**Note**: The Update method can be used if the envelope is not yet complete. To update an existing tab, the request body must include the `tabId`.", - "operationId": "Recipients_PutRecipientTabs", + "summary": "Gets envelope notification information.", + "description": "Retrieves the envelope notification, reminders and expirations, information for an existing envelope.", + "operationId": "Notification_GetEnvelopesEnvelopeIdNotification", "consumes": [], "produces": [], "parameters": [ @@ -8353,32 +8668,16 @@ { "name": "envelopeId", "in": "path", - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", - "required": true, - "type": "string" - }, - { - "name": "recipientId", - "in": "path", - "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" - }, - { - "name": "EnvelopeRecipientTabs", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/EnvelopeRecipientTabs" - }, - "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/EnvelopeRecipientTabs" + "$ref": "#/definitions/notification" } }, "400": { @@ -8389,18 +8688,17 @@ } }, "deprecated": false, - "x-ds-methodname": "updateTabs", - "x-ds-method": "update", + "x-ds-methodname": "getNotificationSettings", + "x-ds-method": "getNotificationSettings", "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, - "post": { + "put": { "tags": [ - "EnvelopeRecipientTabs" + "Envelopes" ], - "summary": "Adds tabs for a recipient.", - "description": "Adds one or more tabs for a recipient.", - "operationId": "Recipients_PostRecipientTabs", + "summary": "Sets envelope notifications for an existing envelope.", + "operationId": "Notification_PutEnvelopesEnvelopeIdNotification", "consumes": [], "produces": [], "parameters": [ @@ -8414,32 +8712,25 @@ { "name": "envelopeId", "in": "path", - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", - "required": true, - "type": "string" - }, - { - "name": "recipientId", - "in": "path", - "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { - "name": "EnvelopeRecipientTabs", + "name": "envelopeNotificationRequest", "in": "body", "required": false, "schema": { - "$ref": "#/definitions/EnvelopeRecipientTabs" + "$ref": "#/definitions/envelopeNotificationRequest" }, "description": "" } ], "responses": { - "201": { + "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/EnvelopeRecipientTabs" + "$ref": "#/definitions/notification" } }, "400": { @@ -8450,18 +8741,22 @@ } }, "deprecated": false, - "x-ds-methodname": "createTabs", - "x-ds-method": "create", + "x-ds-methodname": "updateNotificationSettings", + "x-ds-method": "updateNotificationSettings", "x-ds-service": "Envelopes", + "description": "This method sets the notifications (reminders and expirations) for an existing envelope. The request body sends a structure containing reminders and expirations settings. It also specifies whether to use the settings specified in the request, or the account default notification settings for the envelope.\n\nNote that this request only specifies when notifications are sent; it does not initiate sending of email messages.", "x-ds-in-sdk": true }, - "delete": { + "parameters": [] + }, + "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients": { + "get": { "tags": [ - "EnvelopeRecipientTabs" + "EnvelopeRecipients" ], - "summary": "Deletes the tabs associated with a recipient.", - "description": "Deletes one or more tabs associated with a recipient in a draft envelope.", - "operationId": "Recipients_DeleteRecipientTabs", + "summary": "Gets the status of recipients for an envelope.", + "description": "Retrieves the status of all recipients in a single envelope and identifies the current recipient in the routing list. This method can also be used to retrieve the tab values.\n\nThe `currentRoutingOrder` property of the response contains the `routingOrder` value of the current recipient indicating that the envelope has been sent to the recipient, but the recipient has not completed their actions.", + "operationId": "Recipients_GetRecipients", "consumes": [], "produces": [], "parameters": [ @@ -8475,32 +8770,44 @@ { "name": "envelopeId", "in": "path", - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { - "name": "recipientId", - "in": "path", - "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", - "required": true, + "name": "include_anchor_tab_locations", + "in": "query", + "description": " When set to **true** and `include_tabs` value is set to **true**, all tabs with anchor tab properties are included in the response. ", + "required": false, "type": "string" }, { - "name": "EnvelopeRecipientTabs", - "in": "body", + "name": "include_extended", + "in": "query", + "description": " When set to **true**, the extended properties are included in the response. ", "required": false, - "schema": { - "$ref": "#/definitions/EnvelopeRecipientTabs" - }, - "description": "" + "type": "string" + }, + { + "name": "include_metadata", + "in": "query", + "required": false, + "type": "string", + "description": "Boolean value that specifies whether to include metadata associated with the recipients (for envelopes only, not templates)." + }, + { + "name": "include_tabs", + "in": "query", + "description": "When set to **true**, the tab information associated with the recipient is included in the response.", + "required": false, + "type": "string" } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/EnvelopeRecipientTabs" + "$ref": "#/definitions/EnvelopeRecipients" } }, "400": { @@ -8511,23 +8818,113 @@ } }, "deprecated": false, - "x-ds-methodname": "deleteTabs", - "x-ds-method": "delete", + "x-ds-methodname": "listRecipients", + "x-ds-method": "list", "x-ds-service": "Envelopes", - "x-ds-in-sdk": true - }, - "parameters": [] - }, - "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/document_visibility": { - "put": { - "tags": [ - "EnvelopeDocumentVisibility" - ], - "summary": "Updates document visibility for recipients", - "operationId": "Recipients_PutRecipientsDocumentVisibility", - "consumes": [], - "produces": [], - "parameters": [ + "x-ds-in-sdk": true, + "x-ds-examples": [ + { + "description": "This example shows the result of an envelope\nwith one signer and a CC'ed recipient.\n\n\n### Request\nThe request for this endpoint has no payload.\n\n```\nGET /restapi/v2.1/accounts/1703061/envelopes/44efc9e6-xxxx-xxxx-xxxx-801410d6922d/recipients\n```\n\n\n", + "direction": "response", + "format": "json", + "response": { + "agents": [], + "carbonCopies": [ + { + "email": "aoneil@example.com", + "name": "Ariana O'Neill", + "recipientId": "2", + "recipientIdGuid": "72edf9b6-xxxx-xxxx-xxxx-86bc5d598bb8", + "requireIdLookup": "false", + "routingOrder": "2", + "status": "completed", + "userId": "b72bd827-xxxx-xxxx-xxxx-64ab32f0a0eb" + } + ], + "certifiedDeliveries": [], + "currentRoutingOrder": "1", + "editors": [], + "inPersonSigners": [], + "intermediaries": [], + "recipientCount": "2", + "signers": [ + { + "deliveredDateTime": "2016-10-05T21:18:12.3330000Z", + "email": "jallard@example.com", + "isBulkRecipient": "false", + "name": "Jennie Allard", + "recipientId": "1", + "recipientIdGuid": "4575d5e9-xxxx-xxxx-xxxx-6c59ca7c43f8", + "requireIdLookup": "false", + "routingOrder": "1", + "signedDateTime": "2016-10-05T21:18:41.6930000Z", + "status": "completed", + "userId": "ca45284a-xxxx-xxxx-xxxx-76035bd795b2" + } + ] + }, + "request": null, + "style": "custom", + "title": "List Recipients and CC-ed Recipients" + }, + { + "description": "This example shows the method's response after the envelope was signed.\n\nThe signer recipient successfully authenticated using:\n* An access code (a pre-shared secret between the sender and the signer)\n* Authentication via Facebook. The Facebook email address is recorded in the Certificate of Completion\n", + "direction": "response", + "format": "json", + "response": { + "agents": [], + "carbonCopies": [], + "certifiedDeliveries": [], + "currentRoutingOrder": "1", + "editors": [], + "inPersonSigners": [], + "intermediaries": [], + "recipientCount": "1", + "signers": [ + { + "accessCode": "1234", + "deliveredDateTime": "2016-07-11T06:19:36.4200000Z", + "email": "larry@example.com", + "idCheckConfigurationName": "Facebook", + "isBulkRecipient": "false", + "name": "Larry Smithers", + "recipientAuthenticationStatus": { + "accessCodeResult": { + "eventTimestamp": "2016-07-11T06:18:55.7170000Z", + "status": "Passed" + }, + "facebookResult": { + "eventTimestamp": "2016-07-11T06:19:28.3170000Z", + "status": "Passed" + } + }, + "recipientId": "1", + "recipientIdGuid": "9670e679-xxxx-xxxx-xxxx-02b43027cb0a", + "requireIdLookup": "true", + "routingOrder": "1", + "signInEachLocation": "false", + "signedDateTime": "2016-07-11T06:19:44.7470000Z", + "status": "completed", + "userId": "57a7b68f-xxxx-xxxx-xxxx-381042d14ca5" + } + ] + }, + "request": null, + "style": "custom", + "title": "List Recipients Who Used Facebook and Access Code Authentication" + } + ] + }, + "put": { + "tags": [ + "EnvelopeRecipients" + ], + "summary": "Updates recipients in a draft envelope or corrects recipient information for an in-process envelope.", + "description": "Updates the recipients of a draft envelope or corrects recipient information for an in-process envelope. \n\nIf you send information for a recipient that does not already exist in a draft envelope, the recipient is added to the envelope (similar to the EnvelopeRecipients::Create method).\n\nYou can also use this method to resend an envelope to a recipient by using the `resend_envelope` option.\n\n**Updating Sent Envelopes**\n\nAfter an envelope has been sent, you can edit only the following properties: \n\n- `accessCode`\n- `agentCanEditName`\n- `agentCanEditEmail`\n- `customFields`\n- `deliveryMethod`\n- `documentVisibility`\n- `email`\n- `emailNotification`\n- `idCheckConfigurationName`\n- `name`\n- `note`\n- `phoneAuthentication`\n- `recipientType` (For this to work, you must also change the recipient object to match the recipient type.)\n- `requireIdLookup`\n- `routingOrder`\n- `routingOrder`\n- `signingGroupId` (You can change this id to switch to a different signing group and its corresponding set of recipients.)\n- `smsAuthentication`\n- `suppressEmails`\n- `userName`", + "operationId": "Recipients_PutRecipients", + "consumes": [], + "produces": [], + "parameters": [ { "name": "accountId", "in": "path", @@ -8538,16 +8935,37 @@ { "name": "envelopeId", "in": "path", - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { - "name": "EnvelopeDocumentVisibility", + "name": "combine_same_order_recipients", + "in": "query", + "required": false, + "type": "string", + "description": "When set to **true**, recipients are combined or merged with matching recipients. Recipient matching occurs as part of [template matching](https://docs.docusign.com/DocuSignHelp/Content/automatic-template-matching.htm), and is based on Recipient Role and Routing Order." + }, + { + "name": "offline_signing", + "in": "query", + "required": false, + "type": "string", + "description": "Indicates if offline signing is enabled for the recipient when a network connection is unavailable. " + }, + { + "name": "resend_envelope", + "in": "query", + "description": "When set to **true**, resends the envelope if the new recipient's routing order is before or the same as the envelope's next recipient.", + "required": false, + "type": "string" + }, + { + "name": "EnvelopeRecipients", "in": "body", "required": false, "schema": { - "$ref": "#/definitions/EnvelopeDocumentVisibility" + "$ref": "#/definitions/EnvelopeRecipients" }, "description": "" } @@ -8556,7 +8974,7 @@ "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/EnvelopeDocumentVisibility" + "$ref": "#/definitions/recipientsUpdateSummary" } }, "400": { @@ -8567,21 +8985,18 @@ } }, "deprecated": false, - "x-ds-methodname": "updateRecipientsDocumentVisibility", - "x-ds-method": "updateList", + "x-ds-methodname": "updateRecipients", + "x-ds-method": "update", "x-ds-service": "Envelopes", - "description": "This method updates document visibility for one or more recipients based on the `recipientId` and `visible` values that you include in the request body.\n\n**Note**: A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents.", "x-ds-in-sdk": true }, - "parameters": [] - }, - "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/responsive_html_preview": { "post": { "tags": [ - "ResponsiveHtmlPreview" + "EnvelopeRecipients" ], - "summary": "", - "operationId": "ResponsiveHtml_PostResponsiveHtmlPreview", + "summary": "Adds one or more recipients to an envelope.", + "description": "Adds one or more recipients to an envelope.\n\nFor an in process envelope, one that has been sent and has not been completed or voided, an email is sent to a new recipient when they are reached in the routing order. If the new recipient's routing order is before or the same as the envelope's next recipient, an email is only sent if the optional `resend_envelope` query string is set to **true**.", + "operationId": "Recipients_PostRecipients", "consumes": [], "produces": [], "parameters": [ @@ -8595,16 +9010,23 @@ { "name": "envelopeId", "in": "path", - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { - "name": "documentHtmlDefinition", + "name": "resend_envelope", + "in": "query", + "description": "When set to **true**, resends the envelope if the new recipient's routing order is before or the same as the envelope's next recipient.", + "required": false, + "type": "string" + }, + { + "name": "EnvelopeRecipients", "in": "body", "required": false, "schema": { - "$ref": "#/definitions/documentHtmlDefinition" + "$ref": "#/definitions/EnvelopeRecipients" }, "description": "" } @@ -8613,7 +9035,7 @@ "201": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/DocumentResponsiveHtmlPreview" + "$ref": "#/definitions/EnvelopeRecipients" } }, "400": { @@ -8624,22 +9046,18 @@ } }, "deprecated": false, - "x-ds-methodname": "createResponsiveHtmlPreview", + "x-ds-methodname": "createRecipient", "x-ds-method": "create", - "x-ds-service": "Uncategorized", - "description": "", + "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, - "parameters": [] - }, - "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/templates": { - "get": { + "delete": { "tags": [ - "EnvelopeTemplates" + "EnvelopeRecipients" ], - "summary": "Get List of Templates used in an Envelope", - "description": "This returns a list of the server-side templates, their name and ID, used in an envelope.\n", - "operationId": "Templates_GetEnvelopeTemplates", + "summary": "Deletes recipients from an envelope.", + "description": "Deletes one or more recipients from a draft or sent envelope. List the recipients that you want to delete in the body of the request. This method uses the `recipientId` as the key for deleting recipients.\n\nIf the envelope is `In Process`, meaning that it has been sent and has not been completed or voided, recipients that have completed their actions cannot be deleted.", + "operationId": "Recipients_DeleteRecipients", "consumes": [], "produces": [], "parameters": [ @@ -8653,23 +9071,25 @@ { "name": "envelopeId", "in": "path", - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { - "name": "include", - "in": "query", - "description": "The possible value is `matching_applied`, which returns template matching information for the template.", + "name": "EnvelopeRecipients", + "in": "body", "required": false, - "type": "string" + "schema": { + "$ref": "#/definitions/EnvelopeRecipients" + }, + "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/EnvelopeTemplates" + "$ref": "#/definitions/EnvelopeRecipients" } }, "400": { @@ -8680,18 +9100,21 @@ } }, "deprecated": false, - "x-ds-methodname": "listTemplates", - "x-ds-method": "list", + "x-ds-methodname": "deleteRecipients", + "x-ds-method": "deleteList", "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, - "post": { + "parameters": [] + }, + "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}": { + "delete": { "tags": [ - "EnvelopeTemplates" + "EnvelopeRecipients" ], - "summary": "Adds templates to an envelope.", - "description": "Adds templates to the specified envelope.", - "operationId": "Templates_PostEnvelopeTemplates", + "summary": "Deletes a recipient from an envelope.", + "description": "Deletes a recipient from a `draft` or `sent` envelope.\n\nIf the envelope is \"In Process\" (has been sent and is not completed or voided), recipients that have completed their actions cannot be deleted.", + "operationId": "Recipients_DeleteRecipient", "consumes": [], "produces": [], "parameters": [ @@ -8705,25 +9128,23 @@ { "name": "envelopeId", "in": "path", - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { - "name": "documentTemplateList", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/documentTemplateList" - }, - "description": "" + "name": "recipientId", + "in": "path", + "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", + "required": true, + "type": "string" } ], "responses": { - "201": { + "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/documentTemplateList" + "$ref": "#/definitions/EnvelopeRecipients" } }, "400": { @@ -8734,21 +9155,21 @@ } }, "deprecated": false, - "x-ds-methodname": "applyTemplate", - "x-ds-method": "apply", + "x-ds-methodname": "deleteRecipient", + "x-ds-method": "delete", "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, "parameters": [] }, - "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/correct": { - "post": { + "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/consumer_disclosure": { + "get": { "tags": [ - "EnvelopeViews" + "EnvelopeConsumerDisclosures" ], - "summary": "Returns a URL to the envelope correction UI.", - "description": "Returns a URL that allows you to embed the envelope correction view of the DocuSign UI in your applications.\n\nImportant: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView. ", - "operationId": "Views_PostEnvelopeCorrectView", + "summary": "Gets the default Electronic Record and Signature Disclosure for an envelope.", + "description": "Retrieves the default, HTML-formatted Electronic Record and Signature Disclosure (ERSD) for the envelope that you specify. \n\nThis is the default ERSD disclosure that DocuSign provides for the convenience of U.S.-based customers only. This default disclosure is only valid for transactions between U.S.-based parties.\n\nTo set the language of the disclosure that you want to retrieve, use the optional `langCode` query parameter.", + "operationId": "ConsumerDisclosure_GetConsumerDisclosureEnvelopeIdRecipientId", "consumes": [], "produces": [], "parameters": [ @@ -8762,25 +9183,30 @@ { "name": "envelopeId", "in": "path", - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { - "name": "correctViewRequest", - "in": "body", + "name": "recipientId", + "in": "path", + "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", + "required": true, + "type": "string" + }, + { + "name": "langCode", + "in": "query", "required": false, - "schema": { - "$ref": "#/definitions/correctViewRequest" - }, - "description": "" + "type": "string", + "description": "(Optional) The code for the signer language version of the disclosure that you want to retrieve. The following languages are supported:\n\n- Arabic (`ar`)\n- Bulgarian (`bg`)\n- Czech (`cs`)\n- Chinese Simplified (`zh_CN`)\n- Chinese Traditional (`zh_TW`)\n- Croatian (`hr`)\n- Danish (`da`)\n- Dutch (`nl`)\n- English US (`en`)\n- English UK (`en_GB`)\n- Estonian (`et`)\n- Farsi (`fa`)\n- Finnish (`fi`)\n- French (`fr`)\n- French Canadian (`fr_CA`)\n- German (`de`)\n- Greek (`el`)\n- Hebrew (`he`)\n- Hindi (`hi`)\n- Hungarian (`hu`)\n- Bahasa Indonesian (`id`)\n- Italian (`it`)\n- Japanese (`ja`)\n- Korean (`ko`)\n- Latvian (`lv`)\n- Lithuanian (`lt`)\n- Bahasa Melayu (`ms`)\n- Norwegian (`no`)\n- Polish (`pl`)\n- Portuguese (`pt`)\n- Portuguese Brazil (`pt_BR`)\n- Romanian (`ro`)\n- Russian (`ru`)\n- Serbian (`sr`)\n- Slovak (`sk`)\n- Slovenian (`sl`)\n- Spanish (`es`)\n- Spanish Latin America (`es_MX`)\n- Swedish (`sv`)\n- Thai (`th`)\n- Turkish (`tr`)\n- Ukrainian (`uk`) \n- Vietnamese (`vi`)\n\nAdditionally, you can automatically detect the browser language being used by the viewer and display the disclosure in that language by setting the value to `browser`." } ], "responses": { - "201": { + "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/EnvelopeViews" + "$ref": "#/definitions/consumerDisclosure" } }, "400": { @@ -8791,21 +9217,21 @@ } }, "deprecated": false, - "x-ds-methodname": "createCorrectView", - "x-ds-method": "createCorrect", + "x-ds-methodname": "getConsumerDisclosureDefault", + "x-ds-method": "getDefault", "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, "parameters": [] }, - "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/edit": { - "post": { + "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/consumer_disclosure/{langCode}": { + "get": { "tags": [ - "EnvelopeViews" + "EnvelopeConsumerDisclosures" ], - "summary": "Returns a URL to the edit view UI.", - "description": "Returns a URL that allows you to embed the edit view of the DocuSign UI in your applications. This is a one-time use login token that allows the user to be placed into the DocuSign editing view. \n\nUpon sending completion, the user is returned to the return URL provided by the API application.\n\nImportant: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView. ", - "operationId": "Views_PostEnvelopeEditView", + "summary": "Gets the Electronic Record and Signature Disclosure for a specific envelope recipient.", + "description": "Retrieves the HTML-formatted Electronic Record and Signature Disclosure (ERSD) for the envelope recipient that you specify. This disclosure might differ from the account-level disclosure, based on the signing brand applied to the envelope and the recipient's language settings.\n\nTo set the language of the disclosure that you want to retrieve, specify the `langCode` as either a path or query parameter.", + "operationId": "ConsumerDisclosure_GetConsumerDisclosureEnvelopeIdRecipientIdLangCode", "consumes": [], "produces": [], "parameters": [ @@ -8819,25 +9245,37 @@ { "name": "envelopeId", "in": "path", - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { - "name": "returnUrlRequest", - "in": "body", + "name": "langCode", + "in": "path", + "description": "(Optional) The code for the signer language version of the disclosure that you want to retrieve, as a path parameter. The following languages are supported:\n\n- Arabic (`ar`)\n- Bulgarian (`bg`)\n- Czech (`cs`)\n- Chinese Simplified (`zh_CN`)\n- Chinese Traditional (`zh_TW`)\n- Croatian (`hr`)\n- Danish (`da`)\n- Dutch (`nl`)\n- English US (`en`)\n- English UK (`en_GB`)\n- Estonian (`et`)\n- Farsi (`fa`)\n- Finnish (`fi`)\n- French (`fr`)\n- French Canadian (`fr_CA`)\n- German (`de`)\n- Greek (`el`)\n- Hebrew (`he`)\n- Hindi (`hi`)\n- Hungarian (`hu`)\n- Bahasa Indonesian (`id`)\n- Italian (`it`)\n- Japanese (`ja`)\n- Korean (`ko`)\n- Latvian (`lv`)\n- Lithuanian (`lt`)\n- Bahasa Melayu (`ms`)\n- Norwegian (`no`)\n- Polish (`pl`)\n- Portuguese (`pt`)\n- Portuguese Brazil (`pt_BR`)\n- Romanian (`ro`)\n- Russian (`ru`)\n- Serbian (`sr`)\n- Slovak (`sk`)\n- Slovenian (`sl`)\n- Spanish (`es`)\n- Spanish Latin America (`es_MX`)\n- Swedish (`sv`)\n- Thai (`th`)\n- Turkish (`tr`)\n- Ukrainian (`uk`) \n- Vietnamese (`vi`)\n\nAdditionally, you can automatically detect the browser language being used by the viewer and display the disclosure in that language by setting the value to `browser`.", + "required": true, + "type": "string" + }, + { + "name": "recipientId", + "in": "path", + "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", + "required": true, + "type": "string" + }, + { + "name": "langCode", + "in": "query", "required": false, - "schema": { - "$ref": "#/definitions/returnUrlRequest" - }, - "description": "" + "type": "string", + "description": "(Optional) The code for the signer language version of the disclosure that you want to retrieve, as a query parameter. The following languages are supported:\n\n- Arabic (`ar`)\n- Bulgarian (`bg`)\n- Czech (`cs`)\n- Chinese Simplified (`zh_CN`)\n- Chinese Traditional (`zh_TW`)\n- Croatian (`hr`)\n- Danish (`da`)\n- Dutch (`nl`)\n- English US (`en`)\n- English UK (`en_GB`)\n- Estonian (`et`)\n- Farsi (`fa`)\n- Finnish (`fi`)\n- French (`fr`)\n- French Canadian (`fr_CA`)\n- German (`de`)\n- Greek (`el`)\n- Hebrew (`he`)\n- Hindi (`hi`)\n- Hungarian (`hu`)\n- Bahasa Indonesian (`id`)\n- Italian (`it`)\n- Japanese (`ja`)\n- Korean (`ko`)\n- Latvian (`lv`)\n- Lithuanian (`lt`)\n- Bahasa Melayu (`ms`)\n- Norwegian (`no`)\n- Polish (`pl`)\n- Portuguese (`pt`)\n- Portuguese Brazil (`pt_BR`)\n- Romanian (`ro`)\n- Russian (`ru`)\n- Serbian (`sr`)\n- Slovak (`sk`)\n- Slovenian (`sl`)\n- Spanish (`es`)\n- Spanish Latin America (`es_MX`)\n- Swedish (`sv`)\n- Thai (`th`)\n- Turkish (`tr`)\n- Ukrainian (`uk`) \n- Vietnamese (`vi`)\n\nAdditionally, you can automatically detect the browser language being used by the viewer and display the disclosure in that language by setting the value to `browser`." } ], "responses": { - "201": { + "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/EnvelopeViews" + "$ref": "#/definitions/consumerDisclosure" } }, "400": { @@ -8848,36 +9286,20 @@ } }, "deprecated": false, - "x-ds-methodname": "createEditView", - "x-ds-method": "createEdit", + "x-ds-methodname": "getConsumerDisclosure", + "x-ds-method": "get", "x-ds-service": "Envelopes", - "x-ds-in-sdk": true, - "x-ds-examples": [ - { - "description": "The response contains the URL\nof the embeddable edit view\nfor a specified envelope.\n\nThe request body contains\na `returnUrl`.\nThis is the URL\nthat the DocuSign platform\nwill redirect the user to\nwhen the view is closed.\n\n", - "direction": "both", - "format": "json", - "response": { - "url": "https://demo.docusign.net/Member/StartInSession.aspx?StartConsole=1&t=c8dc7c1e-77fb-4ec8-a336-405ba1f7d38b&DocuEnvelope=4b728be4-4417-45c6-b7e8-d63e23f822b6&send=1" - }, - "request": { - "returnUrl": "https://dsapp.example.com/return/from/edit/view" - }, - "style": "custom", - "title": "Getting an Edit View URL and Setting a Return URL" - } - ] + "x-ds-in-sdk": true }, "parameters": [] }, - "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/recipient": { - "post": { + "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/document_visibility": { + "get": { "tags": [ - "EnvelopeViews" + "EnvelopeDocumentVisibility" ], - "summary": "Returns a URL to the recipient view UI.", - "description": "Returns a URL that enables you to embed the recipient view of the DocuSign UI in your applications. If the recipient is a signer, then the view will provide the signing ceremony.\n\n###### Note: Please redirect the client to the URL. iFrames should not be used, especially if the recipient is using a mobile or tablet. \n\nThis method is only used with envelopes in the `sent` status.\n\nYour application is responsible for authenticating the identity of the recipient or signer when you use this method. Use the parameters `assertionId`, `authenticationInstant`, `authenticationMethod`, `clientUserId`, and `securityDomain` to record information on how the recipient was authenticated. At a minimum, `authenticationMethod` and `clientUserId` are required. The information that you provide is included in the envelope's certificate of completion.\n\n## The event status parameter\nAfter the signer completes or ends the signing ceremony, DocuSign will redirect the user's browser back to your app via the `returnUrl` that you supply. DocuSIgn appends an `event` query parameter to the URL with the outcome of the signing ceremony. Your app should use the event parameter to determine the next step for the envelope. Don't fetch the envelope's status via Envelopes: get or a similar method; that could break the DocuSign rule against polling.\n\n## The URL is time-limited\nThe URL returned by this method is valid for one use. It must be used/displayed within a couple of minutes after being generated. Once the recipient is redirected to the recipient view, they must interact with the DocuSign system periodically or their session will time out.\n\nBecause the URL is time-limited, it should not be stored or sent via email. Immediately redirect the user's browser to the URL after you receive it.\n\nIf you want to invite someone to an embedded signing session via email, the email invitation's URL must be to your application. When invoked, your app should request a recipientView URL from DocuSign and then redirect the signer to that URL.\n\n## Maintaining State\nAfter the recipient completes the recipient view (or signing ceremony), they are redirected to your application. Your application can recover state information about the transaction by storing information in a cookie, or by including query parameters in the `returnUrl` field. Eg, `https://myapp.eg.com/docusign_return?myState=12345` When the user is redirected to your app, the `event` query parameter will be appended. In this example, prevent spoofing by not using a guessable value as the state value.", - "operationId": "Views_PostEnvelopeRecipientView", + "summary": "Returns document visibility for a recipient", + "operationId": "Recipients_GetRecipientDocumentVisibility", "consumes": [], "produces": [], "parameters": [ @@ -8891,25 +9313,23 @@ { "name": "envelopeId", "in": "path", - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { - "name": "recipientViewRequest", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/recipientViewRequest" - }, - "description": "" + "name": "recipientId", + "in": "path", + "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", + "required": true, + "type": "string" } ], "responses": { - "201": { + "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/EnvelopeViews" + "$ref": "#/definitions/documentVisibilityList" } }, "400": { @@ -8920,20 +9340,18 @@ } }, "deprecated": false, - "x-ds-methodname": "createRecipientView", - "x-ds-method": "createRecipient", + "x-ds-methodname": "getRecipientDocumentVisibility", + "x-ds-method": "get", "x-ds-service": "Envelopes", + "description": "This method returns information about document visibility for a recipient.", "x-ds-in-sdk": true }, - "parameters": [] - }, - "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/recipient_preview": { - "post": { + "put": { "tags": [ - "EnvelopeViews" + "EnvelopeDocumentVisibility" ], - "summary": "", - "operationId": "Views_PostEnvelopeRecipientPreview", + "summary": "Updates document visibility for a recipient", + "operationId": "Recipients_PutRecipientDocumentVisibility", "consumes": [], "produces": [], "parameters": [ @@ -8947,25 +9365,32 @@ { "name": "envelopeId", "in": "path", - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { - "name": "recipientPreviewRequest", + "name": "recipientId", + "in": "path", + "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", + "required": true, + "type": "string" + }, + { + "name": "documentVisibilityList", "in": "body", "required": false, "schema": { - "$ref": "#/definitions/recipientPreviewRequest" + "$ref": "#/definitions/documentVisibilityList" }, "description": "" } ], "responses": { - "201": { + "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/TemplateViews" + "$ref": "#/definitions/documentVisibilityList" } }, "400": { @@ -8976,54 +9401,51 @@ } }, "deprecated": false, - "x-ds-methodname": "createEnvelopeRecipientPreview", - "x-ds-method": "createEnvelopeRecipientPreview", - "x-ds-service": "Uncategorized", - "description": "", + "x-ds-methodname": "updateRecipientDocumentVisibility", + "x-ds-method": "update", + "x-ds-service": "Envelopes", + "description": "This method updates document visibility for a recipient.\n\n**Note**: A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents.", "x-ds-in-sdk": true }, "parameters": [] }, - "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/sender": { + "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/identity_proof_token": { "post": { "tags": [ - "EnvelopeViews" + "EnvelopeRecipients" ], - "summary": "Returns a URL to the sender view UI.", - "description": "Returns a URL that enables you to embed the sender view of the DocuSign UI in your applications.\n\nThe returned URL can only be redirected to immediately after it is generated. It can only be used once.\nTherefore, request the URL immediately before you redirect your user to it.\n\nFor the best user experience, don't use an iFrame. For iOS devices DocuSign recommends using a WebView.\n\nMultiple solutions are available for maintaining your\nclient state. See the **Maintaining State** section of the [Embedded Signing introduction.](https://developers.docusign.com/esign-rest-api/guides/embedded-signing)\n\nAfter the user has completed the sending view, the browser is redirected to the `returnUrl` supplied.\n\nBy default, if the envelope already contains one or more documents, DocuSign will initially show the document tagging view when you redirect to the URL. \n\nTo start with the envelope's recipients and documents view instead, examine the URL in the method's response. \nThen change the query parameter from `send=1` to `send=0` to start with the recipients/documents view.\n\n

\n

Information Security notice: This method provides full access to the sender's user account.\nWhen you use this view, the sender has full access to the user account. If the sender user account has administrative privileges, then this method also provides administrator access.

\n\n

If your use case needs to enable a sender to update a draft envelope before it is sent, then either:

\n\n\n
\n", - "operationId": "Views_PostEnvelopeSenderView", + "summary": "Creates a resource token for a sender to request ID Evidence data. ", + "operationId": "Recipients_PostRecipientProofFileResourceToken", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", - "description": "The external account number (int) or account ID GUID.", + "description": "The account ID.", "required": true, "type": "string" }, { "name": "envelopeId", "in": "path", - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { - "name": "returnUrlRequest", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/returnUrlRequest" - }, - "description": "" + "name": "recipientId", + "in": "path", + "description": "The `recipientIdGuid`.", + "required": true, + "type": "string" } ], "responses": { "201": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/EnvelopeViews" + "$ref": "#/definitions/proofServiceResourceToken" } }, "400": { @@ -9034,22 +9456,27 @@ } }, "deprecated": false, - "x-ds-methodname": "createSenderView", - "x-ds-method": "createSender", - "x-ds-service": "Envelopes", + "x-ds-methodname": "createRecipientProofFileResourceToken", + "x-ds-api-status": "beta", + "x-ds-method": "createRecipientProofFileResourceToken", + "x-ds-service": "Uncategorized", + "description": "Creates a resource token for a sender. This token allows a sender to return identification data for a recipient using the [ID Evidence API](https://developers.docusign.com/docs/idevidence-api/).", "x-ds-in-sdk": true }, "parameters": [] }, - "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/shared": { - "post": { + "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/initials_image": { + "get": { "tags": [ - "EnvelopeViews" + "Envelopes" ], - "summary": "", - "operationId": "Views_PostEnvelopeRecipientSharedView", + "summary": "Gets the initials image for a user.", + "description": "Retrieves the initials image for the specified user. The image is returned in the same format as it was uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image.\n\nThe userId specified in the endpoint must match the authenticated user's user id and the user must be a member of the account.\n\nThe `signatureIdOrName` paramter accepts signature ID or signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly URL encode. If you use the user name, it is likely that the name includes spaces and you might need to URL encode the name before using it in the endpoint. \n\nFor example: \"Bob Smith\" to \"Bob%20Smith\"\n\nOlder envelopes might only contain chromed images. If getting the non-chromed image fails, try getting the chromed image.", + "operationId": "Recipients_GetRecipientInitialsImage", "consumes": [], - "produces": [], + "produces": [ + "image/gif" + ], "parameters": [ { "name": "accountId", @@ -9061,25 +9488,30 @@ { "name": "envelopeId", "in": "path", - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { - "name": "recipientViewRequest", - "in": "body", + "name": "recipientId", + "in": "path", + "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", + "required": true, + "type": "string" + }, + { + "name": "include_chrome", + "in": "query", + "description": "The added line and identifier around the initial image. Note: Older envelopes might only have chromed images. If getting the non-chromed image fails, try getting the chromed image.", "required": false, - "schema": { - "$ref": "#/definitions/recipientViewRequest" - }, - "description": "" + "type": "string" } ], "responses": { - "201": { + "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/TemplateViews" + "type": "file" } }, "400": { @@ -9090,23 +9522,21 @@ } }, "deprecated": false, - "x-ds-methodname": "createEnvelopeRecipientSharedView", - "x-ds-method": "createSharedRecipient", - "x-ds-service": "Uncategorized", - "description": "", + "x-ds-methodname": "getRecipientInitialsImage", + "x-ds-method": "getRecipientInitialsImage", + "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, - "parameters": [] - }, - "/v2.1/accounts/{accountId}/envelopes/status": { "put": { "tags": [ "Envelopes" ], - "summary": "Gets the envelope status for the specified envelopes.", - "description": "Retrieves the envelope status for the specified envelopes.\n\nYou can specify the list of envelopes in the `envelope_ids` query parameter or in the request body as part of a `envelopeIdsRequest` object.", - "operationId": "Envelopes_PutStatus", - "consumes": [], + "summary": "Sets the initials image for an accountless signer.", + "description": "Updates the initials image for a signer that does not have a DocuSign account. The supported image formats for this file are: gif, png, jpeg, and bmp. The file size must be less than 200K.\n\nFor the Authentication/Authorization for this call, the credentials must match the sender of the envelope, the recipient must be an accountless signer or in person signer. The account must have the `CanSendEnvelope` property set to **true** and the `ExpressSendOnly` property in `SendingUser` structure must be set to **false**.", + "operationId": "Recipients_PutRecipientInitialsImage", + "consumes": [ + "image/gif" + ], "produces": [], "parameters": [ { @@ -9117,105 +9547,78 @@ "type": "string" }, { - "name": "ac_status", - "in": "query", - "required": false, - "type": "string", - "description": "Specifies the Authoritative Copy Status for the envelopes. The possible values are: \n\n- `Unknown`\n- `Original`\n- `Transferred`\n- `AuthoritativeCopy`\n- `AuthoritativeCopyExportPending`\n- `AuthoritativeCopyExported`\n- `DepositPending`\n- `Deposited`\n- `DepositedEO`\n- `DepositFailed`" + "name": "envelopeId", + "in": "path", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", + "required": true, + "type": "string" }, { - "name": "block", - "in": "query", - "required": false, - "type": "string", - "description": "If **true** removes any results that match one of the provided `transaction_ids`." + "name": "recipientId", + "in": "path", + "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Successful response." }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "updateRecipientInitialsImage", + "x-ds-method": "updateRecipientInitialsImage", + "x-ds-service": "Envelopes", + "x-ds-in-sdk": true + }, + "parameters": [] + }, + "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/signature": { + "get": { + "tags": [ + "Envelopes" + ], + "summary": "Gets signature information for a signer or sign-in-person recipient.", + "description": "Retrieves signature information for a signer or sign-in-person recipient.", + "operationId": "Recipients_GetRecipientSignature", + "consumes": [], + "produces": [], + "parameters": [ { - "name": "count", - "in": "query", - "required": false, - "type": "string", - "description": "The maximum number of results to return." + "name": "accountId", + "in": "path", + "description": "The external account number (int) or account ID GUID.", + "required": true, + "type": "string" }, { - "name": "email", - "in": "query", - "required": false, - "type": "string", - "description": "Email address of the sender." + "name": "envelopeId", + "in": "path", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", + "required": true, + "type": "string" }, { - "name": "envelope_ids", - "in": "query", - "required": false, - "type": "string", - "description": "The envelope IDs to include in the results.\n\nThe value of this property can be:\n- A comma-separated list of envelope IDs\n- The special value `request_body`. In this case, this method uses the envelope IDs in the request body." - }, - { - "name": "from_date", - "in": "query", - "required": false, - "type": "string", - "description": "The date/time setting that specifies when the request begins checking for status changes for envelopes in the account. This is required unless parameters `envelope_ids` and/or `transaction_Ids` are provided. \n\n****Note****: This parameter must be set to a valid `DateTime`, or `envelope_ids` and/or `transaction_ids` must be specified." - }, - { - "name": "from_to_status", - "in": "query", - "required": false, - "type": "string", - "description": "The envelope status that you are checking for. Possible values are:\n\n\n- `Changed` (default)\n- `Completed`\n- `Created`\n- `Declined`\n- `Deleted`\n- `Delivered`\n- `Processing`\n- `Sent`\n- `Signed`\n- `TimedOut`\n- `Voided`\n\nFor example, if you specify `Changed`, this method\nreturns a list of envelopes that changed status\nduring the `from_date` to `to_date` time period. \n" - }, - { - "name": "start_position", - "in": "query", - "required": false, - "type": "string", - "description": "Starting position for search." - }, - { - "name": "status", - "in": "query", - "required": false, - "type": "string", - "description": "A comma-separated list of envelope status to search for. Possible values are:\n\n- `completed`\n- `created`\n- `declined`\n- `deleted`\n- `delivered`\n- `processing`\n- `sent`\n- `signed`\n- `template`\n- `voided`\n" - }, - { - "name": "to_date", - "in": "query", - "required": false, - "type": "string", - "description": "Optional date/time setting\nthat specifies the last date/time \nor envelope status changes in the result set. \n\nDefault: \"now\", the time that you call the method. \n" - }, - { - "name": "transaction_ids", - "in": "query", - "required": false, - "type": "string", - "description": "The transaction IDs to include in the results. Note that transaction IDs are valid for seven days.\n\nThe value of this property can be:\n- A list of comma-separated transaction IDs\n- The special value `request_body`. In this case, this method uses the transaction IDs in the request body." - }, - { - "name": "user_name", - "in": "query", - "required": false, - "type": "string", - "description": "Limit results to envelopes\nsent by the account user\nwith this user name.\n\n`email` must be given as well,\nand both `email` and `user_name`\nmust refer to an existing account user.\n" - }, - { - "name": "envelopeIdsRequest", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/envelopeIdsRequest" - }, - "description": "" - } - ], - "responses": { - "200": { - "description": "Successful response.", - "schema": { - "$ref": "#/definitions/envelopesInformation" - } + "name": "recipientId", + "in": "path", + "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/userSignature" + } }, "400": { "description": "Error encountered.", @@ -9225,22 +9628,25 @@ } }, "deprecated": false, - "x-ds-methodname": "listStatus", - "x-ds-method": "listStatus", + "x-ds-methodname": "getRecipientSignature", + "x-ds-method": "getRecipientSignature", "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, "parameters": [] }, - "/v2.1/accounts/{accountId}/envelopes/transfer_rules": { + "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/signature_image": { "get": { "tags": [ - "EnvelopeTransferRules" + "Envelopes" ], - "summary": "", - "operationId": "EnvelopeTransferRules_GetEnvelopeTransferRules", + "summary": "Retrieve signature image information for a signer/sign-in-person recipient.", + "description": "Retrieves the specified user signature image. The image is returned in the same format as uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image.\n\nThe userId specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account.\n\nThe `signatureIdOrName` parameter accepts signature ID or signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that don't properly URL encode. If you use the user name, it is likely that the name includes spaces and you might need to URL encode the name before using it in the endpoint. \n\nFor example: \"Bob Smith\" to \"Bob%20Smith\"\n\nOlder envelopes might only have chromed images. If getting the non-chromed image fails, try getting the chromed image.", + "operationId": "Recipients_GetRecipientSignatureImage", "consumes": [], - "produces": [], + "produces": [ + "image/gif" + ], "parameters": [ { "name": "accountId", @@ -9250,25 +9656,32 @@ "type": "string" }, { - "name": "count", - "in": "query", - "required": false, - "type": "string", - "description": "The maximum number of results to return." + "name": "envelopeId", + "in": "path", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", + "required": true, + "type": "string" }, { - "name": "start_position", + "name": "recipientId", + "in": "path", + "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", + "required": true, + "type": "string" + }, + { + "name": "include_chrome", "in": "query", + "description": "When set to **true**, the response includes the chromed version of the signature image.", "required": false, - "type": "string", - "description": "The position within the total result set from which to start returning values. The value **thumbnail** may be used to return the page image." + "type": "string" } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/EnvelopeTransferRules" + "type": "file" } }, "400": { @@ -9279,19 +9692,21 @@ } }, "deprecated": false, - "x-ds-methodname": "getEnvelopeTransferRules", - "x-ds-method": "getEnvelopeTransferRules", - "x-ds-service": "Uncategorized", - "description": "", + "x-ds-methodname": "getRecipientSignatureImage", + "x-ds-method": "getRecipientSignatureImage", + "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, "put": { "tags": [ - "EnvelopeTransferRules" + "Envelopes" + ], + "summary": "Sets the signature image for an accountless signer.", + "description": "Updates the signature image for an accountless signer. The supported image formats for this file are: gif, png, jpeg, and bmp. The file size must be less than 200K.\n\nFor the Authentication/Authorization for this call, the credentials must match the sender of the envelope, the recipient must be an accountless signer or in person signer. The account must have the `CanSendEnvelope` property set to **true** and the `ExpressSendOnly` property in `SendingUser` structure must be set to **false**.", + "operationId": "Recipients_PutRecipientSignatureImage", + "consumes": [ + "image/gif" ], - "summary": "", - "operationId": "EnvelopeTransferRules_PutEnvelopeTransferRules", - "consumes": [], "produces": [], "parameters": [ { @@ -9302,21 +9717,23 @@ "type": "string" }, { - "name": "EnvelopeTransferRules", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/EnvelopeTransferRules" - }, - "description": "" + "name": "envelopeId", + "in": "path", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", + "required": true, + "type": "string" + }, + { + "name": "recipientId", + "in": "path", + "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "Successful response.", - "schema": { - "$ref": "#/definitions/EnvelopeTransferRules" - } + "description": "Successful response." }, "400": { "description": "Error encountered.", @@ -9326,18 +9743,21 @@ } }, "deprecated": false, - "x-ds-methodname": "updateEnvelopeTransferRules", - "x-ds-method": "updateEnvelopeTransferRules", - "x-ds-service": "Uncategorized", - "description": "", + "x-ds-methodname": "updateRecipientSignatureImage", + "x-ds-method": "updateRecipientSignatureImage", + "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, - "post": { + "parameters": [] + }, + "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs": { + "get": { "tags": [ - "EnvelopeTransferRules" + "EnvelopeRecipientTabs" ], - "summary": "", - "operationId": "EnvelopeTransferRules_PostEnvelopeTransferRules", + "summary": "Gets the tabs information for a signer or sign-in-person recipient in an envelope.", + "description": "Retrieves information about the tabs associated\nwith a recipient. You can make a single API call\nto get all the tab values and information from a\ngiven, completed envelope in addition to draft\nones. Tab values can be retrieved by using the\n[EnvelopeRecipients:list method](https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipients/list/)\nwith query parameter `include_tabs` set to **true**.", + "operationId": "Recipients_GetRecipientTabs", "consumes": [], "produces": [], "parameters": [ @@ -9349,20 +9769,39 @@ "type": "string" }, { - "name": "envelopeTransferRuleRequest", - "in": "body", + "name": "envelopeId", + "in": "path", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", + "required": true, + "type": "string" + }, + { + "name": "recipientId", + "in": "path", + "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", + "required": true, + "type": "string" + }, + { + "name": "include_anchor_tab_locations", + "in": "query", + "description": "When set to **true**, all tabs with anchor tab properties are included in the response. The default value is **false**.", "required": false, - "schema": { - "$ref": "#/definitions/envelopeTransferRuleRequest" - }, - "description": "" + "type": "string" + }, + { + "name": "include_metadata", + "in": "query", + "required": false, + "type": "string", + "description": "When set to **true**, the response includes metadata indicating which properties are editable." } ], "responses": { - "201": { + "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/EnvelopeTransferRules" + "$ref": "#/definitions/EnvelopeRecipientTabs" } }, "400": { @@ -9373,21 +9812,18 @@ } }, "deprecated": false, - "x-ds-methodname": "createEnvelopeTransferRules", - "x-ds-method": "createEnvelopeTransferRules", - "x-ds-service": "Uncategorized", - "description": "", + "x-ds-methodname": "listTabs", + "x-ds-method": "list", + "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, - "parameters": [] - }, - "/v2.1/accounts/{accountId}/envelopes/transfer_rules/{envelopeTransferRuleId}": { "put": { "tags": [ - "EnvelopeTransferRules" + "EnvelopeRecipientTabs" ], - "summary": "", - "operationId": "EnvelopeTransferRules_PutEnvelopeTransferRule", + "summary": "Updates the tabs for a recipient.\n\n", + "description": "Updates one or more tabs for a recipient in a draft envelope. \n**Note**: The Update method can be used if the envelope is not yet complete. To update an existing tab, the request body must include the `tabId`.", + "operationId": "Recipients_PutRecipientTabs", "consumes": [], "produces": [], "parameters": [ @@ -9399,18 +9835,25 @@ "type": "string" }, { - "name": "envelopeTransferRuleId", + "name": "envelopeId", "in": "path", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, - "type": "string", - "description": "" + "type": "string" }, { - "name": "envelopeTransferRule", + "name": "recipientId", + "in": "path", + "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", + "required": true, + "type": "string" + }, + { + "name": "EnvelopeRecipientTabs", "in": "body", "required": false, "schema": { - "$ref": "#/definitions/envelopeTransferRule" + "$ref": "#/definitions/EnvelopeRecipientTabs" }, "description": "" } @@ -9419,7 +9862,7 @@ "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/envelopeTransferRule" + "$ref": "#/definitions/EnvelopeRecipientTabs" } }, "400": { @@ -9430,18 +9873,18 @@ } }, "deprecated": false, - "x-ds-methodname": "updateEnvelopeTransferRule", - "x-ds-method": "updateEnvelopeTransferRule", - "x-ds-service": "Uncategorized", - "description": "", + "x-ds-methodname": "updateTabs", + "x-ds-method": "update", + "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, - "delete": { + "post": { "tags": [ - "EnvelopeTransferRules" + "EnvelopeRecipientTabs" ], - "summary": "", - "operationId": "EnvelopeTransferRules_DeleteEnvelopeTransferRules", + "summary": "Adds tabs for a recipient.", + "description": "Adds one or more tabs for a recipient.", + "operationId": "Recipients_PostRecipientTabs", "consumes": [], "produces": [], "parameters": [ @@ -9453,16 +9896,35 @@ "type": "string" }, { - "name": "envelopeTransferRuleId", + "name": "envelopeId", "in": "path", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, - "type": "string", + "type": "string" + }, + { + "name": "recipientId", + "in": "path", + "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", + "required": true, + "type": "string" + }, + { + "name": "EnvelopeRecipientTabs", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/EnvelopeRecipientTabs" + }, "description": "" } ], "responses": { - "200": { - "description": "Successful response." + "201": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/EnvelopeRecipientTabs" + } }, "400": { "description": "Error encountered.", @@ -9472,22 +9934,18 @@ } }, "deprecated": false, - "x-ds-methodname": "deleteEnvelopeTransferRules", - "x-ds-method": "deleteEnvelopeTransferRules", - "x-ds-service": "Uncategorized", - "description": "", + "x-ds-methodname": "createTabs", + "x-ds-method": "create", + "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, - "parameters": [] - }, - "/v2.1/accounts/{accountId}/folders": { - "get": { + "delete": { "tags": [ - "Folders" + "EnvelopeRecipientTabs" ], - "summary": "Gets a list of the folders for the account.", - "description": "Retrieves a list of the folders for the account, including the folder hierarchy. You can specify whether to return just the template folder or template folder and normal folders by setting the `template` query string parameter.", - "operationId": "Folders_GetFolders", + "summary": "Deletes the tabs associated with a recipient.", + "description": "Deletes one or more tabs associated with a recipient in a draft envelope.", + "operationId": "Recipients_DeleteRecipientTabs", "consumes": [], "produces": [], "parameters": [ @@ -9499,46 +9957,34 @@ "type": "string" }, { - "name": "include", - "in": "query", - "required": false, - "type": "string", - "description": "A comma-separated list of folder types to include in the response.\nValid values are:\n\n- `envelope_folders`: Returns a list of envelope folders. (Default)\n- `template_folders`: Returns a list of template folders. \n- `shared_template_folders`: Returns a list of shared template folders.\n" - }, - { - "name": "include_items", - "in": "query", - "required": false, - "type": "string", - "description": "Indicates whether folder items are included in the response. If this parameter is omitted, the default is false." - }, - { - "name": "start_position", - "in": "query", - "required": false, - "type": "string", - "description": "The position within the total result set from which to start returning values." + "name": "envelopeId", + "in": "path", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", + "required": true, + "type": "string" }, { - "name": "template", - "in": "query", - "description": "This parameter is deprecated as of version 2.1. Use `include` instead.", - "required": false, + "name": "recipientId", + "in": "path", + "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", + "required": true, "type": "string" }, { - "name": "user_filter", - "in": "query", + "name": "EnvelopeRecipientTabs", + "in": "body", "required": false, - "type": "string", - "description": "Narrows down the resulting folder list by the following values:\n\n- `all`: Returns all templates owned or shared with the user. (default)\n- `owned_by_me`: Returns only templates the user owns.\n- `shared_with_me`: Returns only templates that are shared with the user.\n" + "schema": { + "$ref": "#/definitions/EnvelopeRecipientTabs" + }, + "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/Folders" + "$ref": "#/definitions/EnvelopeRecipientTabs" } }, "400": { @@ -9549,100 +9995,50 @@ } }, "deprecated": false, - "x-ds-methodname": "list", - "x-ds-method": "list", - "x-ds-service": "Folders", + "x-ds-methodname": "deleteTabs", + "x-ds-method": "delete", + "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, "parameters": [] }, - "/v2.1/accounts/{accountId}/folders/{folderId}": { - "get": { + "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/views/identity_manual_review": { + "post": { "tags": [ - "Folders" + "EnvelopeRecipients" ], - "summary": "Gets a list of the envelopes in the specified folder.", - "description": "Retrieves a list of the envelopes in the specified folder. You can narrow the query by specifying search criteria in the query string parameters.", - "operationId": "Folders_GetFolderItems", + "summary": "Create the link to the page for manually reviewing IDs.", + "operationId": "Views_PostRecipientManualReviewView", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", - "description": "The external account number (int) or account ID GUID.", + "description": "A value that identifies your account. This value is automatically generated by DocuSign for any account you create. Copy the value from the API Account ID field in the [AppsI and Keys](https://support.docusign.com/en/guides/ndse-admin-guide-api-and-keys) page.", "required": true, "type": "string" }, { - "name": "folderId", + "name": "envelopeId", "in": "path", - "description": "Unique identifier for the folder.", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { - "name": "from_date", - "in": "query", - "description": "Reserved for DocuSign.", - "required": false, - "type": "string" - }, - { - "name": "include_items", - "in": "query", - "required": false, - "type": "string", - "description": "Indicates whether folder items are included in the response. If this parameter is omitted, the default is false." - }, - { - "name": "owner_email", - "in": "query", - "description": "Reserved for DocuSign.", - "required": false, - "type": "string" - }, - { - "name": "owner_name", - "in": "query", - "description": "Reserved for DocuSign.", - "required": false, - "type": "string" - }, - { - "name": "search_text", - "in": "query", - "description": "Reserved for DocuSign.", - "required": false, - "type": "string" - }, - { - "name": "start_position", - "in": "query", - "description": "Reserved for DocuSign.", - "required": false, - "type": "string" - }, - { - "name": "status", - "in": "query", - "description": "Reserved for DocuSign.", - "required": false, - "type": "string" - }, - { - "name": "to_date", - "in": "query", - "description": "Reserved for DocuSign.", - "required": false, + "name": "recipientId", + "in": "path", + "description": "A GUID value that DocuSign assigns to identify each recipient in an envelope. This value is globally unique for all recipients, not just those in your account.\n\nThe specified recipient must belong to a workflow that allows the [manual review](https://support.docusign.com/en/guides/Identity-Verification-DocuSign-eSignature-Admin-Guide) of IDs. In addition, the status of the automatic verification for this recipient must return `Failed` and the value of the `vendorFailureStatusCode` field must be `MANUAL_REVIEW_STARTED` as shown in the following extract of a response to the [GET ENVELOPE](https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/get/) method:\n

\n\n```\n\"recipientAuthenticationStatus\": {\n \"identityVerificationResult\": { \n \"status\": \"Failed\",\n \"eventTimestamp\": \"2020-09-04T16:59:42.8045667Z\",\n \"vendorFailureStatusCode\": \"MANUAL_REVIEW_STARTED\"\n }\n }\n```", + "required": true, "type": "string" } ], "responses": { - "200": { + "201": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/folderItemsResponse" + "$ref": "#/definitions/viewUrl" } }, "400": { @@ -9653,18 +10049,21 @@ } }, "deprecated": false, - "x-ds-methodname": "listItems", - "x-ds-method": "listItems", - "x-ds-service": "Folders", + "x-ds-methodname": "createRecipientManualReviewView", + "x-ds-method": "createRecipientManualReviewView", + "x-ds-service": "Uncategorized", + "description": "This method returns the URL of the page that allows a sender to [manually review](https://support.docusign.com/en/guides/ndse-user-guide-send-documents-with-id-verification) the ID of a recipient. ", "x-ds-in-sdk": true }, + "parameters": [] + }, + "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/document_visibility": { "put": { "tags": [ - "Folders" + "EnvelopeRecipients" ], - "summary": "Moves an envelope from its current folder to the specified folder.", - "description": "Moves an envelope from its current folder to the specified folder.\n\nYou can use this method to delete envelopes by specifying `recyclebin` in the `folderId` parameter.\nPlacing an in-process envelope (envelope status of `sent` or `delivered`) in the recycle bin voids the envelope.\n\nYou can also use this method to delete templates by specifying a template ID instead of an envelope ID in the 'envelopeIds' property and specifying `recyclebin` in the `folderId` parameter. ", - "operationId": "Folders_PutFolderById", + "summary": "Updates document visibility for recipients", + "operationId": "Recipients_PutRecipientsDocumentVisibility", "consumes": [], "produces": [], "parameters": [ @@ -9676,18 +10075,18 @@ "type": "string" }, { - "name": "folderId", + "name": "envelopeId", "in": "path", - "description": "Unique identifier for the folder.", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { - "name": "foldersRequest", + "name": "documentVisibilityList", "in": "body", "required": false, "schema": { - "$ref": "#/definitions/foldersRequest" + "$ref": "#/definitions/documentVisibilityList" }, "description": "" } @@ -9696,7 +10095,7 @@ "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/Folders" + "$ref": "#/definitions/documentVisibilityList" } }, "400": { @@ -9707,21 +10106,21 @@ } }, "deprecated": false, - "x-ds-methodname": "moveEnvelopes", - "x-ds-method": "moveEnvelopes", - "x-ds-service": "Folders", + "x-ds-methodname": "updateRecipientsDocumentVisibility", + "x-ds-method": "updateRecipientsDocumentVisibility", + "x-ds-service": "EnvelopeDocumentVisibility", + "description": "This method updates document visibility for one or more recipients based on the `recipientId` and `visible` values that you include in the request body.\n\n**Note**: A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents.", "x-ds-in-sdk": true }, "parameters": [] }, - "/v2.1/accounts/{accountId}/groups": { - "get": { + "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/responsive_html_preview": { + "post": { "tags": [ - "Groups" + "ResponsiveHtmlPreview" ], - "summary": "Gets information about groups associated with the account.", - "description": "Retrieves information about groups associated with the account.", - "operationId": "Groups_GetGroups", + "summary": "Creates a preview of the responsive versions of all of the documents in an envelope.", + "operationId": "ResponsiveHtml_PostResponsiveHtmlPreview", "consumes": [], "produces": [], "parameters": [ @@ -9733,46 +10132,27 @@ "type": "string" }, { - "name": "count", - "in": "query", - "description": "Number of records to return. The number must be greater than 1 and less than or equal to 100.", - "required": false, + "name": "envelopeId", + "in": "path", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", + "required": true, "type": "string" }, { - "name": "group_type", - "in": "query", + "name": "documentHtmlDefinition", + "in": "body", "required": false, - "type": "string", + "schema": { + "$ref": "#/definitions/documentHtmlDefinition" + }, "description": "" - }, - { - "name": "include_usercount", - "in": "query", - "required": false, - "type": "string", - "description": "When set to **true**, every group returned in the response includes a `userCount` property that contains the total number of users in the group. The default is **true**." - }, - { - "name": "search_text", - "in": "query", - "required": false, - "type": "string", - "description": "Filters the results of a GET request based on the text that you specify." - }, - { - "name": "start_position", - "in": "query", - "description": "The starting value for the list.", - "required": false, - "type": "string" } ], "responses": { - "200": { + "201": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/Groups" + "$ref": "#/definitions/documentHtmlDefinitions" } }, "400": { @@ -9783,18 +10163,21 @@ } }, "deprecated": false, - "x-ds-methodname": "listGroups", - "x-ds-method": "list", - "x-ds-service": "Groups", + "x-ds-methodname": "createResponsiveHtmlPreview", + "x-ds-method": "create", + "x-ds-service": "Uncategorized", + "description": "Creates a preview of the\n[responsive](https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/responsive/),\nHTML versions of all of the documents in an\nenvelope. This method enables you to preview the\nPDF document conversions to responsive HTML across\ndevice types prior to sending.\n\nThe request body is a `documentHtmlDefinition`\nobject, which holds the responsive signing\nparameters that define how to generate the HTML\nversion of the documents.\n", "x-ds-in-sdk": true }, - "put": { + "parameters": [] + }, + "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/tabs_blob": { + "get": { "tags": [ - "Groups" + "TabsBlob" ], - "summary": "Updates the group information for a group.", - "description": "Updates the group name and modifies, or sets, the permission profile for the group.", - "operationId": "Groups_PutGroups", + "summary": "Gets encrypted tabs for envelope.", + "operationId": "TabsBlob_GetTabsBlob", "consumes": [], "produces": [], "parameters": [ @@ -9806,21 +10189,16 @@ "type": "string" }, { - "name": "Groups", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/Groups" - }, - "description": "" + "name": "envelopeId", + "in": "path", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "Successful response.", - "schema": { - "$ref": "#/definitions/Groups" - } + "description": "Successful response." }, "400": { "description": "Error encountered.", @@ -9830,18 +10208,18 @@ } }, "deprecated": false, - "x-ds-methodname": "updateGroups", - "x-ds-method": "update", - "x-ds-service": "Groups", + "x-ds-methodname": "getTabsBlob", + "x-ds-method": "getTabsBlob", + "x-ds-service": "Uncategorized", + "description": "", "x-ds-in-sdk": true }, - "post": { + "put": { "tags": [ - "Groups" + "TabsBlob" ], - "summary": "Creates one or more groups for the account.", - "description": "Creates one or more groups for the account.\n\nGroups can be used to help manage users by associating users with a group. You can associate a group with a Permission Profile, which sets the user permissions for users in that group without having to set the `userSettings` property for each user. You are not required to set Permission Profiles for a group, but it makes it easier to manage user permissions for a large number of users. You can also use groups with template sharing to limit user access to templates.", - "operationId": "Groups_PostGroups", + "summary": "Updates encrypted tabs for envelope.", + "operationId": "TabsBlob_PutTabsBlob", "consumes": [], "produces": [], "parameters": [ @@ -9853,21 +10231,16 @@ "type": "string" }, { - "name": "Groups", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/Groups" - }, - "description": "" + "name": "envelopeId", + "in": "path", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", + "required": true, + "type": "string" } ], "responses": { - "201": { - "description": "Successful response.", - "schema": { - "$ref": "#/definitions/Groups" - } + "200": { + "description": "Successful response." }, "400": { "description": "Error encountered.", @@ -9877,18 +10250,22 @@ } }, "deprecated": false, - "x-ds-methodname": "createGroups", - "x-ds-method": "create", - "x-ds-service": "Groups", + "x-ds-methodname": "putTabsBlob", + "x-ds-method": "putTabsBlob", + "x-ds-service": "Uncategorized", + "description": "", "x-ds-in-sdk": true }, - "delete": { + "parameters": [] + }, + "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/templates": { + "get": { "tags": [ - "Groups" + "EnvelopeTemplates" ], - "summary": "Deletes an existing user group.", - "description": "Deletes an existing user group.", - "operationId": "Groups_DeleteGroups", + "summary": "Get List of Templates used in an Envelope", + "description": "This returns a list of the server-side templates, their name and ID, used in an envelope.\n", + "operationId": "Templates_GetEnvelopeTemplates", "consumes": [], "produces": [], "parameters": [ @@ -9900,20 +10277,25 @@ "type": "string" }, { - "name": "Groups", - "in": "body", + "name": "envelopeId", + "in": "path", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", + "required": true, + "type": "string" + }, + { + "name": "include", + "in": "query", + "description": "The possible value is `matching_applied`, which returns template matching information for the template.", "required": false, - "schema": { - "$ref": "#/definitions/Groups" - }, - "description": "" + "type": "string" } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/Groups" + "$ref": "#/definitions/templateInformation" } }, "400": { @@ -9924,21 +10306,18 @@ } }, "deprecated": false, - "x-ds-methodname": "deleteGroups", - "x-ds-method": "delete", - "x-ds-service": "Groups", + "x-ds-methodname": "listTemplates", + "x-ds-method": "list", + "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, - "parameters": [] - }, - "/v2.1/accounts/{accountId}/groups/{groupId}/brands": { - "get": { + "post": { "tags": [ - "GroupBrands" + "EnvelopeTemplates" ], - "summary": "Gets group brand ID Information.\n", - "description": "Retrieves information about the brands associated with the requested group.", - "operationId": "Brands_GetGroupBrands", + "summary": "Adds templates to an envelope.", + "description": "Adds templates to the specified envelope.", + "operationId": "Templates_PostEnvelopeTemplates", "consumes": [], "produces": [], "parameters": [ @@ -9950,18 +10329,34 @@ "type": "string" }, { - "name": "groupId", + "name": "envelopeId", "in": "path", - "description": "The ID of the group being accessed.", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" + }, + { + "name": "preserve_template_recipient", + "in": "query", + "required": false, + "type": "string", + "description": "" + }, + { + "name": "documentTemplateList", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/documentTemplateList" + }, + "description": "" } ], "responses": { - "200": { + "201": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/GroupBrands" + "$ref": "#/definitions/documentTemplateList" } }, "400": { @@ -9972,18 +10367,21 @@ } }, "deprecated": false, - "x-ds-methodname": "getBrands", - "x-ds-method": "get", - "x-ds-service": "Groups", + "x-ds-methodname": "applyTemplate", + "x-ds-method": "apply", + "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, - "put": { + "parameters": [] + }, + "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/correct": { + "post": { "tags": [ - "GroupBrands" + "EnvelopeViews" ], - "summary": "Adds group brand ID information to a group.", - "description": "Adds group brand ID information to a group.", - "operationId": "Brands_PutGroupBrands", + "summary": "Returns a URL to the envelope correction UI.", + "description": "Returns a URL that allows you to embed the envelope correction view of the DocuSign UI in your applications.\n\n**Important**: Due to screen space issues, iFrames should not be used for embedded operations on mobile devices. For iOS devices, DocuSign recommends using a WebView. \n\n**Note**: You can revoke this URL by making the DELETE call to the same URL with no request body. \n\n

\n

Information Security notice: This method provides full access to the sending account. When you use this view, the current user has full access to the account. If the account has administrative privileges, then this method also provides administrator access.

\n\n

If your use case needs to enable a sender to update a draft envelope before it is sent or make other changes, take one of the following steps:

\n\n\n
", + "operationId": "Views_PostEnvelopeCorrectView", "consumes": [], "produces": [], "parameters": [ @@ -9995,27 +10393,27 @@ "type": "string" }, { - "name": "groupId", + "name": "envelopeId", "in": "path", - "description": "The ID of the group being accessed.", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { - "name": "brandsRequest", + "name": "correctViewRequest", "in": "body", "required": false, "schema": { - "$ref": "#/definitions/brandsRequest" + "$ref": "#/definitions/correctViewRequest" }, "description": "" } ], "responses": { - "200": { + "201": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/GroupBrands" + "$ref": "#/definitions/EnvelopeViews" } }, "400": { @@ -10026,18 +10424,17 @@ } }, "deprecated": false, - "x-ds-methodname": "updateBrands", - "x-ds-method": "update", - "x-ds-service": "Groups", + "x-ds-methodname": "createCorrectView", + "x-ds-method": "createCorrect", + "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, "delete": { "tags": [ - "GroupBrands" + "EnvelopeViews" ], - "summary": "Deletes brand information from the requested group.", - "description": "Deletes brand information from the requested group.", - "operationId": "Brands_DeleteGroupBrands", + "summary": "Revokes the correction view URL to the Envelope UI.", + "operationId": "Views_DeleteEnvelopeCorrectView", "consumes": [], "produces": [], "parameters": [ @@ -10049,28 +10446,25 @@ "type": "string" }, { - "name": "groupId", + "name": "envelopeId", "in": "path", - "description": "The ID of the group being accessed.", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { - "name": "brandsRequest", + "name": "correctViewRequest", "in": "body", "required": false, "schema": { - "$ref": "#/definitions/brandsRequest" + "$ref": "#/definitions/correctViewRequest" }, "description": "" } ], "responses": { "200": { - "description": "Successful response.", - "schema": { - "$ref": "#/definitions/GroupBrands" - } + "description": "Successful response." }, "400": { "description": "Error encountered.", @@ -10080,21 +10474,22 @@ } }, "deprecated": false, - "x-ds-methodname": "deleteBrands", - "x-ds-method": "delete", - "x-ds-service": "Groups", + "x-ds-methodname": "deleteEnvelopeCorrectView", + "x-ds-method": "deleteEnvelopeCorrectView", + "x-ds-service": "Uncategorized", + "description": "", "x-ds-in-sdk": true }, "parameters": [] }, - "/v2.1/accounts/{accountId}/groups/{groupId}/users": { - "get": { + "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/edit": { + "post": { "tags": [ - "GroupUsers" + "EnvelopeViews" ], - "summary": "Gets a list of users in a group.", - "description": "Retrieves a list of users in a group.", - "operationId": "Groups_GetGroupUsers", + "summary": "Returns a URL to the edit view UI.", + "description": "Returns a URL that enables you to embed the edit view of the DocuSign UI in your applications. This is a one-time use login token that allows the user to be placed into the DocuSign editing view. \n\nUpon sending completion, the user is returned to the return URL provided by the API application.\n\n**Important**: Due to screen space issues, iFrames should not be used for embedded operations on mobile devices. For iOS devices, DocuSign recommends using a WebView. \n\n**Note**: You can revoke this URL by making the DELETE call to the same URL with no request body. \n\n
\n

Information Security notice: This method provides full access to the sending account. When you use this view, the current user has full access to the account. If the account has administrative privileges, then this method also provides administrator access.

\n\n

If your use case needs to enable a sender to update a draft envelope before it is sent or make other changes, take one of the following steps:

\n\n\n
", + "operationId": "Views_PostEnvelopeEditView", "consumes": [], "produces": [], "parameters": [ @@ -10106,32 +10501,27 @@ "type": "string" }, { - "name": "groupId", + "name": "envelopeId", "in": "path", - "description": "The ID of the group being accessed.", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { - "name": "count", - "in": "query", - "description": "Number of records to return. The number must be greater than 1 and less than or equal to 100. ", - "required": false, - "type": "string" - }, - { - "name": "start_position", - "in": "query", - "description": "Starting value for the list.", + "name": "returnUrlRequest", + "in": "body", "required": false, - "type": "string" + "schema": { + "$ref": "#/definitions/returnUrlRequest" + }, + "description": "" } ], "responses": { - "200": { + "201": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/GroupUsers" + "$ref": "#/definitions/EnvelopeViews" } }, "400": { @@ -10142,18 +10532,36 @@ } }, "deprecated": false, - "x-ds-methodname": "listGroupUsers", - "x-ds-method": "list", - "x-ds-service": "Groups", - "x-ds-in-sdk": true + "x-ds-methodname": "createEditView", + "x-ds-method": "createEdit", + "x-ds-service": "Envelopes", + "x-ds-in-sdk": true, + "x-ds-examples": [ + { + "description": "The response contains the URL\nof the embeddable edit view\nfor a specified envelope.\n\nThe request body contains\na `returnUrl`.\nThis is the URL\nthat the DocuSign platform\nwill redirect the user to\nwhen the view is closed.\n\n", + "direction": "both", + "format": "json", + "response": { + "url": "https://demo.docusign.net/Member/StartInSession.aspx?StartConsole=1&t=c8dc7c1e-xxxx-xxxx-xxxx-405ba1f7d38b&DocuEnvelope=4b728be4-xxxx-xxxx-xxxx-d63e23f822b6&send=1" + }, + "request": { + "returnUrl": "https://dsapp.example.com/return/from/edit/view" + }, + "style": "custom", + "title": "Getting an Edit View URL and Setting a Return URL" + } + ] }, - "put": { + "parameters": [] + }, + "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/recipient": { + "post": { "tags": [ - "GroupUsers" + "EnvelopeViews" ], - "summary": "Adds one or more users to an existing group.", - "description": "Adds one or more existing DocuSign users to an existing group.", - "operationId": "Groups_PutGroupUsers", + "summary": "Returns a URL to the recipient view UI.", + "description": "Returns a URL that enables you to embed the recipient view of the DocuSign UI in your applications. If the recipient is a signer, then the view will provide the signing ceremony.\n\n**Note**: Please redirect the client to the URL. iFrames should not be used, especially if the recipient is using a mobile or tablet. \n\nThis method is only used with envelopes in the `sent` status.\n\nYour application is responsible for authenticating the identity of the recipient or signer when you use this method. Use the parameters `assertionId`, `authenticationInstant`, `authenticationMethod`, `clientUserId`, and `securityDomain` to record information on how the recipient was authenticated. At a minimum, `authenticationMethod` and `clientUserId` are required. The information that you provide is included in the envelope's certificate of completion.\n\n## Redirects\nAfter the signer completes or ends the signing ceremony, DocuSign will redirect the user's browser back to your app via the `returnUrl` that you supply. (The user is redirected through a different subdomain, depending on the region of the account sending the envelope. Please [verify your domain whitelist](https://www.docusign.com/trust/security/whitelists).) \n\n### The event status parameter\nDocuSign appends an `event` query parameter to the URL with the outcome of the signing ceremony. Your app can use this event parameter to determine the next step for the envelope. Do not fetch the envelope status by using Envelopes::get or a similar method because doing so could break the DocuSign rule against polling.\n\n**Note**: Because a user can cancel redirection, close their browser after signing, or spoof the landing URL. Hitting the `ReturnUrl` should not be the single source of truth for envelope status for your integration.\n\n## The URL is time-limited\nThe URL returned by this method is valid for one use, and you must use or display it within a couple of minutes after it is generated. AFter the recipient is redirected to the recipient view, they must interact with the DocuSign system periodically or their session will time out.\n\nBecause the URL is time-limited, it should not be stored or sent through email. After you receive it, immediately redirect the user's browser to the URL.\n\nIf you want to invite someone to an embedded signing session via email, the email invitation's URL must be to your application. When invoked, your app should request a recipientView URL from DocuSign and then redirect the signer to that URL.\n\n## Maintaining State\nAfter the recipient completes the recipient view (or signing ceremony), they are redirected to your application. Your application can recover state information about the transaction by storing information in a cookie, or by including query parameters in the `returnUrl` field. Eg, `https://myapp.eg.com/docusign_return?myState=12345` When the user is redirected to your app, the `event` query parameter will be appended. In this example, prevent spoofing by not using a guessable value as the state value.\n\n**Note**: You can revoke the URL by making the DELETE call to the same URL with no request body. ", + "operationId": "Views_PostEnvelopeRecipientView", "consumes": [], "produces": [], "parameters": [ @@ -10165,27 +10573,27 @@ "type": "string" }, { - "name": "groupId", + "name": "envelopeId", "in": "path", - "description": "The ID of the group being accessed.", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { - "name": "userInfoList", + "name": "recipientViewRequest", "in": "body", "required": false, "schema": { - "$ref": "#/definitions/userInfoList" + "$ref": "#/definitions/recipientViewRequest" }, "description": "" } ], "responses": { - "200": { + "201": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/GroupUsers" + "$ref": "#/definitions/EnvelopeViews" } }, "400": { @@ -10196,18 +10604,20 @@ } }, "deprecated": false, - "x-ds-methodname": "updateGroupUsers", - "x-ds-method": "update", - "x-ds-service": "Groups", + "x-ds-methodname": "createRecipientView", + "x-ds-method": "createRecipient", + "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, - "delete": { + "parameters": [] + }, + "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/recipient_preview": { + "post": { "tags": [ - "GroupUsers" + "EnvelopeRecipients" ], - "summary": "Deletes one or more users from a group", - "description": "Deletes one or more users from a group. This request takes a `userInfoList` that contains the users that you want to delete.\n", - "operationId": "Groups_DeleteGroupUsers", + "summary": "Creates an envelope recipient preview.", + "operationId": "Views_PostEnvelopeRecipientPreview", "consumes": [], "produces": [], "parameters": [ @@ -10219,27 +10629,27 @@ "type": "string" }, { - "name": "groupId", + "name": "envelopeId", "in": "path", - "description": "The ID of the group being accessed.", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { - "name": "userInfoList", + "name": "recipientPreviewRequest", "in": "body", "required": false, "schema": { - "$ref": "#/definitions/userInfoList" + "$ref": "#/definitions/recipientPreviewRequest" }, "description": "" } ], "responses": { - "200": { + "201": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/GroupUsers" + "$ref": "#/definitions/viewUrl" } }, "400": { @@ -10250,20 +10660,22 @@ } }, "deprecated": false, - "x-ds-methodname": "deleteGroupUsers", - "x-ds-method": "delete", - "x-ds-service": "Groups", + "x-ds-methodname": "createEnvelopeRecipientPreview", + "x-ds-method": "createEnvelopeRecipientPreview", + "x-ds-service": "Uncategorized", + "description": "This method returns a URL for an envelope recipient preview in the DocuSign UI that you can embed in your application. You use this method to enable the sender to preview the recipients' experience.\n\nFor more information, see [Preview and Send](https://support.docusign.com/en/guides/ndse-user-guide-send-your-documents).", "x-ds-in-sdk": true }, "parameters": [] }, - "/v2.1/accounts/{accountId}/identity_verification": { - "get": { + "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/sender": { + "post": { "tags": [ - "IdentityVerifications" + "EnvelopeViews" ], - "summary": "Retrieves the list of identity verification workflows available to an account", - "operationId": "AccountIdentityVerification_GetAccountIdentityVerification", + "summary": "Returns a URL to the sender view UI.", + "description": "Returns a URL that enables you to embed the sender view of the DocuSign UI in your applications.\n\nThe returned URL can only be redirected to immediately after it is generated. It can only be used once.\nTherefore, request the URL immediately before you redirect your user to it.\n\nFor the best user experience, don't use an iFrame. For iOS devices DocuSign recommends using a WebView.\n\nMultiple solutions are available for maintaining your\nclient state. See the **Maintaining State** section of the [Embedded Signing introduction.](https://developers.docusign.com/esign-rest-api/guides/embedded-signing)\n\nAfter the user has completed the sending view, the browser is redirected to the `returnUrl` supplied.\n\nBy default, if the envelope already contains one or more documents, DocuSign will initially show the document tagging view when you redirect to the URL. \n\nTo start with the envelope's recipients and documents view instead, examine the URL in the method's response. \nThen change the query parameter from `send=1` to `send=0` to start with the recipients/documents view.\n\n**Note**: You can revoke the URL by making the DELETE call to the same URL with no request body. \n\n
\n

Information Security notice: This method provides full access to the sending account. When you use this view, the current user has full access to the account. If the account has administrative privileges, then this method also provides administrator access.

\n\n

If your use case needs to enable a sender to update a draft envelope before it is sent or make other changes, take one of the following steps:

\n\n\n
", + "operationId": "Views_PostEnvelopeSenderView", "consumes": [], "produces": [], "parameters": [ @@ -10273,13 +10685,29 @@ "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" + }, + { + "name": "envelopeId", + "in": "path", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", + "required": true, + "type": "string" + }, + { + "name": "returnUrlRequest", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/returnUrlRequest" + }, + "description": "" } ], "responses": { - "200": { + "201": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/IdentityVerifications" + "$ref": "#/definitions/EnvelopeViews" } }, "400": { @@ -10290,21 +10718,20 @@ } }, "deprecated": false, - "x-ds-methodname": "getAccountIdentityVerification", - "x-ds-method": "list", - "x-ds-service": "Uncategorized", - "description": "Retrieves the list of identity verification workflows available to an account", + "x-ds-methodname": "createSenderView", + "x-ds-method": "createSender", + "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, "parameters": [] }, - "/v2.1/accounts/{accountId}/payment_gateway_accounts": { - "get": { + "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/shared": { + "post": { "tags": [ - "PaymentGatewayAccounts" + "EnvelopeViews" ], - "summary": "List payment gateway account information", - "operationId": "PaymentGatewayAccounts_GetAllPaymentGatewayAccounts", + "summary": "Returns a URL to the shared recipient view UI for an envelope.", + "operationId": "Views_PostEnvelopeRecipientSharedView", "consumes": [], "produces": [], "parameters": [ @@ -10314,13 +10741,29 @@ "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" + }, + { + "name": "envelopeId", + "in": "path", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", + "required": true, + "type": "string" + }, + { + "name": "recipientViewRequest", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/recipientViewRequest" + }, + "description": "" } ], "responses": { - "200": { + "201": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/paymentGatewayAccountsInfo" + "$ref": "#/definitions/viewUrl" } }, "400": { @@ -10331,23 +10774,21 @@ } }, "deprecated": false, - "x-ds-methodname": "getAllPaymentGatewayAccounts", - "x-ds-api-status": "beta", - "x-ds-method": "list", - "x-ds-service": "Accounts", - "description": "List payment gateway account information", + "x-ds-methodname": "createEnvelopeRecipientSharedView", + "x-ds-method": "createSharedRecipient", + "x-ds-service": "Uncategorized", + "description": "Returns a URL that enables you to embed the DocuSign UI recipient view of a [shared envelope](https://support.docusign.com/en/guides/ndse-admin-guide-share-envelopes) in your applications. This is the view that a user sees of an envelope that a recipient on the same account has shared with them.\n\n**Important**: Due to screen space issues, iFrames should not be used for embedded operations on mobile devices. For iOS devices, DocuSign recommends using a WebView.\n\n**Note**: You can revoke this URL by making the DELETE call to the same URL with no request body. \n", "x-ds-in-sdk": true }, "parameters": [] }, - "/v2.1/accounts/{accountId}/permission_profiles": { + "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow": { "get": { "tags": [ - "AccountPermissionProfiles" + "EnvelopeWorkflowDefinition" ], - "summary": "Gets a list of permission profiles.", - "description": "This method returns a list of permission profiles that are associated with an account.", - "operationId": "PermissionProfiles_GetPermissionProfiles", + "summary": "Gets an envelope's workflow definition.", + "operationId": "EnvelopeWorkflowDefinition_GetEnvelopeWorkflowDefinition", "consumes": [], "produces": [], "parameters": [ @@ -10359,18 +10800,18 @@ "type": "string" }, { - "name": "include", - "in": "query", - "required": false, - "type": "string", - "description": "A comma-separated list of additional properties to return in the response. Valid values are:\n\n- `user_count`: The total number of users associated with the permission profile.\n- `closed_users`: Includes closed users in the `user_count`.\n- `account_management`: The account management settings.\n- `metadata`: Metadata indicating whether the properties associated with the account permission profile are editable.\n\nExample: `user_count,closed_users`\n" + "name": "envelopeId", + "in": "path", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", + "required": true, + "type": "string" } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/permissionProfileInformation" + "$ref": "#/definitions/workflow" } }, "400": { @@ -10381,17 +10822,18 @@ } }, "deprecated": false, - "x-ds-methodname": "listPermissions", - "x-ds-method": "list", - "x-ds-service": "Accounts", + "x-ds-methodname": "getEnvelopeWorkflowDefinition", + "x-ds-method": "getEnvelopeWorkflowDefinition", + "x-ds-service": "Uncategorized", + "description": "Returns an envelope's workflow definition if the envelope specified by `envelopeId` has one.", "x-ds-in-sdk": true }, - "post": { + "put": { "tags": [ - "AccountPermissionProfiles" + "EnvelopeWorkflowDefinition" ], - "summary": "Creates a new permission profile for an account.", - "operationId": "PermissionProfiles_PostPermissionProfiles", + "summary": "Updates an envelope's workflow definition.", + "operationId": "EnvelopeWorkflowDefinition_PutEnvelopeWorkflowDefinition", "consumes": [], "produces": [], "parameters": [ @@ -10403,27 +10845,27 @@ "type": "string" }, { - "name": "include", - "in": "query", - "required": false, - "type": "string", - "description": "A comma-separated list of additional properties to return in the response. The only valid value for this request is `metadata`, which returns metadata indicating whether the properties associated with the account permission profile are editable." + "name": "envelopeId", + "in": "path", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", + "required": true, + "type": "string" }, { - "name": "AccountPermissionProfiles", + "name": "workflow", "in": "body", "required": false, "schema": { - "$ref": "#/definitions/AccountPermissionProfiles" + "$ref": "#/definitions/workflow" }, - "description": "Information about the permission profiles associated with an account." + "description": "" } ], "responses": { - "201": { + "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/AccountPermissionProfiles" + "$ref": "#/definitions/workflow" } }, "400": { @@ -10434,21 +10876,18 @@ } }, "deprecated": false, - "x-ds-methodname": "createPermissionProfile", - "x-ds-method": "create", - "x-ds-service": "Accounts", - "description": "This method creates a new permission profile for an account.", + "x-ds-methodname": "updateEnvelopeWorkflowDefinition", + "x-ds-method": "updateEnvelopeWorkflowDefinition", + "x-ds-service": "Uncategorized", + "description": "Updates the specified envelope's workflow definition if it has one.", "x-ds-in-sdk": true }, - "parameters": [] - }, - "/v2.1/accounts/{accountId}/permission_profiles/{permissionProfileId}": { - "get": { + "delete": { "tags": [ - "AccountPermissionProfiles" + "EnvelopeWorkflowDefinition" ], - "summary": "Returns a permission profile for an account.", - "operationId": "PermissionProfiles_GetPermissionProfile", + "summary": "Deletes an envelope's workflow definition.", + "operationId": "EnvelopeWorkflowDefinition_DeleteEnvelopeWorkflowDefinition", "consumes": [], "produces": [], "parameters": [ @@ -10460,26 +10899,16 @@ "type": "string" }, { - "name": "permissionProfileId", + "name": "envelopeId", "in": "path", + "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, - "type": "string", - "description": "The ID of the permission profile. Possible values include:\n\n- `2301416` (for the `DocuSign Viewer` profile)\n- `2301415` (for the `DocuSign Sender` profile)\n- `2301414` (for the `Account Administrator` profile)\n\nIn addition, any custom permission profiles associated with your account will have an automatically generated `permissionProfileId`." - }, - { - "name": "include", - "in": "query", - "required": false, - "type": "string", - "description": "A comma-separated list of additional properties to return in the response. The only valid value for this request is `metadata`, which returns metadata indicating whether the properties associated with the account permission profile are editable." + "type": "string" } ], "responses": { "200": { - "description": "Successful response.", - "schema": { - "$ref": "#/definitions/AccountPermissionProfiles" - } + "description": "Successful response." }, "400": { "description": "Error encountered.", @@ -10489,18 +10918,22 @@ } }, "deprecated": false, - "x-ds-methodname": "getPermissionProfile", - "x-ds-method": "get", - "x-ds-service": "Accounts", - "description": "This method returns information about a specific permission profile that is associated with an account.", + "x-ds-methodname": "deleteEnvelopeWorkflowDefinition", + "x-ds-method": "deleteEnvelopeWorkflowDefinition", + "x-ds-service": "Uncategorized", + "description": "Deletes the specified envelope's workflow definition if it has one.\n", "x-ds-in-sdk": true }, + "parameters": [] + }, + "/v2.1/accounts/{accountId}/envelopes/status": { "put": { "tags": [ - "AccountPermissionProfiles" + "Envelopes" ], - "summary": "Updates a permission profile.", - "operationId": "PermissionProfiles_PutPermissionProfiles", + "summary": "Gets envelope statuses for a set of envelopes.", + "description": "Retrieves envelope statuses for a set of envelopes.\n\nYou must specify _one_ of the following query parameters:\n\n| Parameter | Description |\n| :---------------- | :------------------------------------------------------------------------------- |\n| `from_date` | a valid UTC DateTime: `2016-01-01` |\n| `envelope_ids` | A comma-separated list of envelope IDs
or the special value `request_body` |\n| `transaction_ids` | A comma-separated list of transaction IDs
or the special value `request_body` |\n\nWhen you use the special value `request_body`, the request body looks like this:\n\n```\n{\n \"envelopeIds\": [\n \"44c5ad6c-xxxx-xxxx-xxxx-ebda5e2dfe15\",\n \"8e26040d-xxxx-xxxx-xxxx-1e29b924d237\",\n \"c8b40a2d-xxxx-xxxx-xxxx-4fe56fe10f95\"\n ]\n}\n```\n\n**Note**: It is an error omit the request body altogether.\nThe request body must be at least `{}`.\n\n### You can find an example of using this API endpoint in the following how-to:\n\n* [How to list envelope status changes](https://developers.docusign.com/docs/esign-rest-api/how-to/list-envelope-status-changes/)", + "operationId": "Envelopes_PutStatus", "consumes": [], "produces": [], "parameters": [ @@ -10512,34 +10945,104 @@ "type": "string" }, { - "name": "permissionProfileId", - "in": "path", - "required": true, + "name": "ac_status", + "in": "query", + "required": false, "type": "string", - "description": "The ID of the permission profile. Possible values include:\n\n- `2301416` (for the `DocuSign Viewer` profile)\n- `2301415` (for the `DocuSign Sender` profile)\n- `2301414` (for the `Account Administrator` profile)\n\nIn addition, any custom permission profiles associated with your account will have an automatically generated `permissionProfileId`." + "description": "Specifies the Authoritative Copy Status for the envelopes. The possible values are: \n\n- `Unknown`\n- `Original`\n- `Transferred`\n- `AuthoritativeCopy`\n- `AuthoritativeCopyExportPending`\n- `AuthoritativeCopyExported`\n- `DepositPending`\n- `Deposited`\n- `DepositedEO`\n- `DepositFailed`" }, { - "name": "include", + "name": "block", "in": "query", "required": false, "type": "string", - "description": "A comma-separated list of additional properties to return in the response. The only valid value for this request is `metadata`, which returns metadata indicating whether the properties associated with the account permission profile are editable." + "description": "If set to **true**, removes any results that match one of the provided `transaction_ids`." + }, + { + "name": "count", + "in": "query", + "required": false, + "type": "string", + "description": "The maximum number of results to return." + }, + { + "name": "email", + "in": "query", + "required": false, + "type": "string", + "description": "The email address of the sender." + }, + { + "name": "envelope_ids", + "in": "query", + "required": false, + "type": "string", + "description": "The envelope IDs to include in the results.\n\nThe value of this property can be:\n- A comma-separated list of envelope IDs\n- The special value `request_body`. In this case, the method uses the envelope IDs in the request body." + }, + { + "name": "from_date", + "in": "query", + "required": false, + "type": "string", + "description": "The date/time setting that specifies when the request begins checking for status changes for envelopes in the account. This is required unless parameters `envelope_ids` and/or `transaction_Ids` are provided. \n\n****Note****: This parameter must be set to a valid `DateTime`, or `envelope_ids` and/or `transaction_ids` must be specified." + }, + { + "name": "from_to_status", + "in": "query", + "required": false, + "type": "string", + "description": "The envelope status that you are checking for. Possible values are:\n\n\n- `Changed` (default)\n- `Completed`\n- `Created`\n- `Declined`\n- `Deleted`\n- `Delivered`\n- `Processing`\n- `Sent`\n- `Signed`\n- `TimedOut`\n- `Voided`\n\nFor example, if you specify `Changed`, this method\nreturns a list of envelopes that changed status\nduring the `from_date` to `to_date` time period. \n" + }, + { + "name": "start_position", + "in": "query", + "required": false, + "type": "string", + "description": "The starting index position for search." + }, + { + "name": "status", + "in": "query", + "required": false, + "type": "string", + "description": "A comma-separated list of envelope status to search for. Possible values are:\n\n- `completed`\n- `created`\n- `declined`\n- `deleted`\n- `delivered`\n- `processing`\n- `sent`\n- `signed`\n- `template`\n- `voided`\n" + }, + { + "name": "to_date", + "in": "query", + "required": false, + "type": "string", + "description": "Optional date/time setting\nthat specifies the last date/time \nor envelope status changes in the result set. \n\nThe default value is the time that you call the method. \n" + }, + { + "name": "transaction_ids", + "in": "query", + "required": false, + "type": "string", + "description": "The transaction IDs to include in the results. Note that transaction IDs are valid for seven days.\n\nThe value of this property can be:\n- A list of comma-separated transaction IDs\n- The special value `request_body`. In this case, this method uses the transaction IDs in the request body." + }, + { + "name": "user_name", + "in": "query", + "required": false, + "type": "string", + "description": "Limits results to envelopes\nsent by the account user\nwith this user name.\n\n`email` must be given as well,\nand both `email` and `user_name`\nmust refer to an existing account user.\n" }, { - "name": "AccountPermissionProfiles", + "name": "envelopeIdsRequest", "in": "body", "required": false, "schema": { - "$ref": "#/definitions/AccountPermissionProfiles" + "$ref": "#/definitions/envelopeIdsRequest" }, - "description": "Information about the permission profiles associated with an account." + "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/AccountPermissionProfiles" + "$ref": "#/definitions/envelopesInformation" } }, "400": { @@ -10550,18 +11053,20 @@ } }, "deprecated": false, - "x-ds-methodname": "updatePermissionProfile", - "x-ds-method": "update", - "x-ds-service": "Accounts", - "description": "This method updates an account permission profile.", + "x-ds-methodname": "listStatus", + "x-ds-method": "listStatus", + "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, - "delete": { + "parameters": [] + }, + "/v2.1/accounts/{accountId}/envelopes/transfer_rules": { + "get": { "tags": [ - "AccountPermissionProfiles" + "EnvelopeTransferRules" ], - "summary": "Deletes a permission profile from an account.", - "operationId": "PermissionProfiles_DeletePermissionProfiles", + "summary": "Gets envelope transfer rules.", + "operationId": "EnvelopeTransferRules_GetEnvelopeTransferRules", "consumes": [], "produces": [], "parameters": [ @@ -10573,16 +11078,26 @@ "type": "string" }, { - "name": "permissionProfileId", - "in": "path", - "required": true, + "name": "count", + "in": "query", + "required": false, "type": "string", - "description": "The ID of the permission profile. Possible values include:\n\n- `2301416` (for the `DocuSign Viewer` profile)\n- `2301415` (for the `DocuSign Sender` profile)\n- `2301414` (for the `Account Administrator` profile)\n\nIn addition, any custom permission profiles associated with your account will have an automatically generated `permissionProfileId`." + "description": "(Optional) The maximum number of results to return." + }, + { + "name": "start_position", + "in": "query", + "required": false, + "type": "string", + "description": "(Optional) The position within the total result set from which to start returning values. The value **thumbnail** may be used to return the page image." } ], "responses": { "200": { - "description": "Successful response." + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/envelopeTransferRuleInformation" + } }, "400": { "description": "Error encountered.", @@ -10592,21 +11107,18 @@ } }, "deprecated": false, - "x-ds-methodname": "deletePermissionProfile", - "x-ds-method": "delete", - "x-ds-service": "Accounts", - "description": "This method deletes a permission profile from an account.", + "x-ds-methodname": "get", + "x-ds-method": "get", + "x-ds-service": "Uncategorized", + "description": "This method retrieves a list of envelope transfer rules associated with an account.\n\n**Note**: Only Administrators can create and use envelope transfer rules. In addition, to use envelope transfer rules, the **Transfer Custody** feature must be enabled for your account.", "x-ds-in-sdk": true }, - "parameters": [] - }, - "/v2.1/accounts/{accountId}/powerforms": { - "get": { + "put": { "tags": [ - "PowerForms" + "EnvelopeTransferRules" ], - "summary": "Returns a list of PowerForms.", - "operationId": "PowerForms_GetPowerFormsList", + "summary": "Changes the status of multiple envelope transfer rules.", + "operationId": "EnvelopeTransferRules_PutEnvelopeTransferRules", "consumes": [], "produces": [], "parameters": [ @@ -10618,39 +11130,20 @@ "type": "string" }, { - "name": "from_date", - "in": "query", - "required": false, - "type": "string", - "description": "(Optional) The start date for a date range.\n\n**Note**: If no value is provided, no date filtering is applied." - }, - { - "name": "order", - "in": "query", - "required": false, - "type": "string", - "description": "(Optional) The order in which to sort the results.\n\nValid values are: \n\n\n* `asc`: Ascending order.\n* `desc`: Descending order. " - }, - { - "name": "order_by", - "in": "query", - "required": false, - "type": "string", - "description": "(Optional) The file attribute to use to sort the results.\n\nValid values are: \n\n* `modified`\n* `name`" - }, - { - "name": "to_date", - "in": "query", + "name": "envelopeTransferRuleInformation", + "in": "body", "required": false, - "type": "string", - "description": "(Optional) The end date for a date range.\n\n**Note**: If no value is provided, this property defaults to the current date." + "schema": { + "$ref": "#/definitions/envelopeTransferRuleInformation" + }, + "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/powerFormsResponse" + "$ref": "#/definitions/envelopeTransferRuleInformation" } }, "400": { @@ -10661,18 +11154,18 @@ } }, "deprecated": false, - "x-ds-methodname": "listPowerForms", - "x-ds-method": "list", - "x-ds-service": "PowerForms", - "description": "This method returns a list of PowerForms that are available to the user.", + "x-ds-methodname": "update", + "x-ds-method": "update", + "x-ds-service": "Uncategorized", + "description": "This method changes the status for one or more envelope transfer rules based on the `envelopeTransferRuleId`s in the request body. You use this method to change whether or not the rules are enabled.\n\n**Note**: You cannot change any other information about the envelope transfer rule. Only Administrators can update envelope transfer rules. In addition, to use envelope transfer rules, the **Transfer Custody** feature must be enabled for your account.", "x-ds-in-sdk": true }, "post": { "tags": [ - "PowerForms" + "EnvelopeTransferRules" ], - "summary": "Creates a new PowerForm.", - "operationId": "PowerForms_PostPowerForm", + "summary": "Creates an envelope transfer rule.", + "operationId": "EnvelopeTransferRules_PostEnvelopeTransferRules", "consumes": [], "produces": [], "parameters": [ @@ -10684,11 +11177,11 @@ "type": "string" }, { - "name": "PowerForms", + "name": "envelopeTransferRuleRequest", "in": "body", "required": false, "schema": { - "$ref": "#/definitions/PowerForms" + "$ref": "#/definitions/envelopeTransferRuleRequest" }, "description": "" } @@ -10697,7 +11190,7 @@ "201": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/PowerForms" + "$ref": "#/definitions/envelopeTransferRuleInformation" } }, "400": { @@ -10708,18 +11201,21 @@ } }, "deprecated": false, - "x-ds-methodname": "createPowerForm", + "x-ds-methodname": "create", "x-ds-method": "create", - "x-ds-service": "PowerForms", - "description": "This method creates a new PowerForm. \n\nYou create a PowerForm from an existing DocuSign [template](https://developers.docusign.com/esign-rest-api/reference/Templates/Templates/create), based on the `templateId` in the request body.\n\n PowerForms that you create from a template are referred to as web PowerForms. \n\n**Note**: The RADmin console also supports creating a PowerForm by uploading a PDF file that has active form fields (referred to as a PDF PowerForm). However, PDF PowerForms are deprecated and are not supported in the API.\n\n**Note**: A PowerForm can have only one sender. If you need to associate multiple senders with a PowerForm, create multiple copies of the PowerForm by using the same template (one copy for each sender). By default, the sender is the PowerForm Administrator who creates the PowerForm.\n\n\n\n### Signing Modes\n\nYou can use one of the following signing modes for a PowerForm:\n \n**`email`**\n\nThis mode verifies the recipient's identity by using email authentication before the recipient can sign a document. The recipient enters their email address on the landing page and then clicks **Begin Signing** to begin the signing process. The system then sends an email message with a validation code for the PowerForm to the recipient. If the recipient does not provide a valid email address, they do not receive the email message containing the access code and are not able to open and sign the document.\n\nAlternatively, you can make the process easier for signers by using email authentication only and omitting the access code. To do this, you append the `activateonly` flag to the PowerForm URL and set it to true by passing in the value `1`. When the flag is active, the first recipient receives an email with a link that initiates the signing session without having to enter access code.\n\nExample: `activateonly=1`\n\n**`direct`**\n\nThis mode does not require any verification. After a recipient enters their email address on the landing page and clicks **Begin Signing**, a new browser tab opens and the recipient can immediately begin the signing process.\n\nBecause the `direct` signing mode does not verify the recipient's identity by using email authentication, we strongly recommend that you use this mode only when the PowerForm is accessible behind a secure portal where the recipient's identity is already authenticated, or where another form of authentication is specified for the recipient in the DocuSign template (for example, an access code, phone authentication, or ID check). \n\n**Note**: In the account settings, `enablePowerFormDirect` must be **true** to use `direct` as the `signingMode`.", + "x-ds-service": "Uncategorized", + "description": "This method creates an envelope transfer rule.\n\nWhen you create an envelope transfer rule, you specify the following properties: \n\n- `eventType`\n- `fromGroups`\n- `toUser`\n- `toFolder`\n- `carbonCopyOriginalOwner`\n- `enabled`\n\n**Note**: Only Administrators can create envelope transfer rules. In addition, to use envelope transfer rules, the **Transfer Custody** feature must be enabled for your account.", "x-ds-in-sdk": true }, - "delete": { + "parameters": [] + }, + "/v2.1/accounts/{accountId}/envelopes/transfer_rules/{envelopeTransferRuleId}": { + "put": { "tags": [ - "PowerForms" + "EnvelopeTransferRules" ], - "summary": "Deletes one or more PowerForms.", - "operationId": "PowerForms_DeletePowerFormsList", + "summary": "Changes the status of an envelope transfer rule.", + "operationId": "EnvelopeTransferRules_PutEnvelopeTransferRule", "consumes": [], "produces": [], "parameters": [ @@ -10731,11 +11227,18 @@ "type": "string" }, { - "name": "powerFormsRequest", + "name": "envelopeTransferRuleId", + "in": "path", + "required": true, + "type": "string", + "description": "The id of the envelope transfer rule. The system generates this id when the rule is first created." + }, + { + "name": "envelopeTransferRule", "in": "body", "required": false, "schema": { - "$ref": "#/definitions/powerFormsRequest" + "$ref": "#/definitions/envelopeTransferRule" }, "description": "" } @@ -10744,7 +11247,7 @@ "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/powerFormsResponse" + "$ref": "#/definitions/envelopeTransferRule" } }, "400": { @@ -10755,21 +11258,18 @@ } }, "deprecated": false, - "x-ds-methodname": "deletePowerForms", - "x-ds-method": "deleteList", - "x-ds-service": "PowerForms", - "description": "This method deletes one or more PowerForms. The request body takes an array of PowerForm objects that are deleted based on the `powerFormId`.", + "x-ds-methodname": "updateEnvelopeTransferRule", + "x-ds-method": "updateEnvelopeTransferRule", + "x-ds-service": "Uncategorized", + "description": "This method changes the status of an envelope transfer rule. You use this method to change whether or not the rule is enabled.\n\nYou must include the `envelopeTransferRuleId` both as a query parameter, and in the request body.\n\n**Note**: You cannot change any other information about the envelope transfer rule. Only Administrators can update an envelope transfer rule. In addition, to use envelope transfer rules, the **Transfer Custody** feature must be enabled for your account.", "x-ds-in-sdk": true }, - "parameters": [] - }, - "/v2.1/accounts/{accountId}/powerforms/{powerFormId}": { - "get": { + "delete": { "tags": [ - "PowerForms" + "EnvelopeTransferRules" ], - "summary": "Returns a single PowerForm.", - "operationId": "PowerForms_GetPowerForm", + "summary": "Deletes an envelope transfer rule.", + "operationId": "EnvelopeTransferRules_DeleteEnvelopeTransferRules", "consumes": [], "produces": [], "parameters": [ @@ -10781,19 +11281,16 @@ "type": "string" }, { - "name": "powerFormId", + "name": "envelopeTransferRuleId", "in": "path", "required": true, "type": "string", - "description": "The id of the PowerForm." + "description": "The id of the envelope transfer rule. The system generates this id when the rule is first created." } ], "responses": { "200": { - "description": "Successful response.", - "schema": { - "$ref": "#/definitions/PowerForms" - } + "description": "Successful response." }, "400": { "description": "Error encountered.", @@ -10803,18 +11300,21 @@ } }, "deprecated": false, - "x-ds-methodname": "getPowerForm", - "x-ds-method": "get", - "x-ds-service": "PowerForms", - "description": "This method returns detailed information about a specific PowerForm.", + "x-ds-methodname": "delete", + "x-ds-method": "delete", + "x-ds-service": "Uncategorized", + "description": "This method deletes an envelope transfer rule.\n\n**Note**: Only Administrators can delete envelope transfer rules. In addition, to use envelope transfer rules, the **Transfer Custody** feature must be enabled for your account.", "x-ds-in-sdk": true }, - "put": { + "parameters": [] + }, + "/v2.1/accounts/{accountId}/favorite_templates": { + "get": { "tags": [ - "PowerForms" + "FavoriteTemplates" ], - "summary": "Updates an existing PowerForm.", - "operationId": "PowerForms_PutPowerForm", + "summary": "Retrieves the list of favorited templates for this caller.", + "operationId": "FavoriteTemplates_GetFavoriteTemplates", "consumes": [], "produces": [], "parameters": [ @@ -10824,20 +11324,52 @@ "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/favoriteTemplatesInfo" + } }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "getFavoriteTemplates", + "x-ds-api-status": "beta", + "x-ds-method": "getFavoriteTemplates", + "x-ds-service": "Uncategorized", + "description": "", + "x-ds-in-sdk": true + }, + "put": { + "tags": [ + "FavoriteTemplates" + ], + "summary": "Sets a template as a favorite.\n", + "operationId": "FavoriteTemplates_PutFavoriteTemplate", + "consumes": [], + "produces": [], + "parameters": [ { - "name": "powerFormId", + "name": "accountId", "in": "path", + "description": "The external account number (int) or account ID GUID.", "required": true, - "type": "string", - "description": "The id of the PowerForm." + "type": "string" }, { - "name": "PowerForms", + "name": "favoriteTemplatesInfo", "in": "body", "required": false, "schema": { - "$ref": "#/definitions/PowerForms" + "$ref": "#/definitions/favoriteTemplatesInfo" }, "description": "" } @@ -10846,7 +11378,7 @@ "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/PowerForms" + "$ref": "#/definitions/favoriteTemplatesInfo" } }, "400": { @@ -10857,18 +11389,19 @@ } }, "deprecated": false, - "x-ds-methodname": "updatePowerForm", - "x-ds-method": "update", - "x-ds-service": "PowerForms", - "description": "This method updates an existing PowerForm.", + "x-ds-methodname": "updateFavoriteTemplate", + "x-ds-api-status": "beta", + "x-ds-method": "updateFavoriteTemplate", + "x-ds-service": "Uncategorized", + "description": "", "x-ds-in-sdk": true }, "delete": { "tags": [ - "PowerForms" + "FavoriteTemplates" ], - "summary": "Deletes a PowerForm.", - "operationId": "PowerForms_DeletePowerForm", + "summary": "Unfavorites a template.", + "operationId": "FavoriteTemplates_UnFavoriteTemplate", "consumes": [], "produces": [], "parameters": [ @@ -10880,16 +11413,21 @@ "type": "string" }, { - "name": "powerFormId", - "in": "path", - "required": true, - "type": "string", - "description": "The id of the PowerForm." + "name": "favoriteTemplatesInfo", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/favoriteTemplatesInfo" + }, + "description": "" } ], "responses": { "200": { - "description": "Successful response." + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/favoriteTemplatesInfo" + } }, "400": { "description": "Error encountered.", @@ -10899,21 +11437,23 @@ } }, "deprecated": false, - "x-ds-methodname": "deletePowerForm", - "x-ds-method": "delete", - "x-ds-service": "PowerForms", - "description": "This method deletes a PowerForm.", + "x-ds-methodname": "unFavoriteTemplate", + "x-ds-api-status": "beta", + "x-ds-method": "unFavoriteTemplate", + "x-ds-service": "Uncategorized", + "description": "", "x-ds-in-sdk": true }, "parameters": [] }, - "/v2.1/accounts/{accountId}/powerforms/{powerFormId}/form_data": { + "/v2.1/accounts/{accountId}/folders": { "get": { "tags": [ - "PowerFormData" + "Folders" ], - "summary": "Returns the data that users entered in a PowerForm.", - "operationId": "PowerForms_GetPowerFormFormData", + "summary": "Gets a list of the folders for the account.", + "description": "Retrieves a list of the folders for the account, including the folder hierarchy. You can specify whether to return just the template folder or template folder and normal folders by setting the `template` query string parameter.", + "operationId": "Folders_GetFolders", "consumes": [], "produces": [], "parameters": [ @@ -10925,39 +11465,46 @@ "type": "string" }, { - "name": "powerFormId", - "in": "path", - "required": true, + "name": "include", + "in": "query", + "required": false, "type": "string", - "description": "The id of the PowerForm." + "description": "A comma-separated list of folder types to include in the response.\nValid values are:\n\n- `envelope_folders`: Returns a list of envelope folders. (Default)\n- `template_folders`: Returns a list of template folders. \n- `shared_template_folders`: Returns a list of shared template folders.\n" }, { - "name": "data_layout", + "name": "include_items", "in": "query", "required": false, "type": "string", - "description": "The layout in which to return the PowerForm data. Valid values are:\n\n- `Native`\n- `Csv_Classic`\n- `Csv_One_Envelope_Per_Line`\n- `Xml_Classic`" + "description": "Indicates whether folder items are included in the response. If this parameter is omitted, the default is false." }, { - "name": "from_date", + "name": "start_position", "in": "query", "required": false, "type": "string", - "description": "The start date for a date range in UTC DateTime format.\n\n**Note**: If this property is null, no date filtering is applied." + "description": "The position within the total result set from which to start returning values." }, { - "name": "to_date", + "name": "template", + "in": "query", + "description": "This parameter is deprecated as of version 2.1. Use `include` instead.", + "required": false, + "type": "string" + }, + { + "name": "user_filter", "in": "query", "required": false, "type": "string", - "description": "The end date of a date range in UTC DateTime format. The default value is `UtcNow`." + "description": "Narrows down the resulting folder list by the following values:\n\n- `all`: Returns all templates owned or shared with the user. (default)\n- `owned_by_me`: Returns only templates the user owns.\n- `shared_with_me`: Returns only templates that are shared with the user.\n" } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/powerFormsFormDataResponse" + "$ref": "#/definitions/foldersResponse" } }, "400": { @@ -10968,21 +11515,21 @@ } }, "deprecated": false, - "x-ds-methodname": "getPowerFormData", + "x-ds-methodname": "list", "x-ds-method": "list", - "x-ds-service": "PowerForms", - "description": "This method enables Powerform Administrators or the sender of a PowerForm to download the data that recipients have entered into a PowerForm.\n\nYou specify the format in which you want to retrieve the data in the `Accept` header. This header accepts the following values:\n\n\n- `application/json`: JSON format\n- `application/xml`: XML format\n- `text/csv`: Comma-separated value (CSV) format\n\n**Note**: Only PowerForm Administrators or the PowerForm Sender can download the data associated with a PowerForm.", + "x-ds-service": "Folders", "x-ds-in-sdk": true }, "parameters": [] }, - "/v2.1/accounts/{accountId}/powerforms/senders": { + "/v2.1/accounts/{accountId}/folders/{folderId}": { "get": { "tags": [ - "PowerForms" + "Folders" ], - "summary": "Gets PowerForm senders.", - "operationId": "PowerForms_GetPowerFormsSenders", + "summary": "Gets a list of the envelopes in the specified folder.", + "description": "Retrieves a list of the envelopes in the specified folder. You can narrow the query by specifying search criteria in the query string parameters.", + "operationId": "Folders_GetFolderItems", "consumes": [], "produces": [], "parameters": [ @@ -10994,58 +11541,65 @@ "type": "string" }, { - "name": "start_position", + "name": "folderId", + "in": "path", + "description": "The id of the folder.", + "required": true, + "type": "string" + }, + { + "name": "from_date", + "in": "query", + "description": "Reserved for DocuSign.", + "required": false, + "type": "string" + }, + { + "name": "include_items", "in": "query", "required": false, "type": "string", - "description": "The position within the total result set from which to start returning values. The value **thumbnail** may be used to return the page image." - } - ], - "responses": { - "200": { - "description": "Successful response.", - "schema": { - "$ref": "#/definitions/powerFormSendersResponse" - } + "description": "Indicates whether folder items are included in the response. If this parameter is omitted, the default is false." }, - "400": { - "description": "Error encountered.", - "schema": { - "$ref": "#/definitions/errorDetails" - } - } - }, - "deprecated": false, - "x-ds-methodname": "listPowerFormSenders", - "x-ds-method": "listSenders", - "x-ds-service": "PowerForms", - "description": "This method returns a list of users who have sent PowerForms.", - "x-ds-in-sdk": true - }, - "parameters": [] - }, - "/v2.1/accounts/{accountId}/recipient_names": { - "get": { - "tags": [ - "Accounts" - ], - "summary": "Gets recipient names associated with an email address.", - "description": "Retrieves a list of recipients in the specified account that are associated with a email address supplied in the query string.", - "operationId": "RecipientNames_GetRecipientNames", - "consumes": [], - "produces": [], - "parameters": [ { - "name": "accountId", - "in": "path", - "description": "The external account number (int) or account ID GUID.", - "required": true, + "name": "owner_email", + "in": "query", + "description": "Reserved for DocuSign.", + "required": false, "type": "string" }, { - "name": "email", + "name": "owner_name", + "in": "query", + "description": "Reserved for DocuSign.", + "required": false, + "type": "string" + }, + { + "name": "search_text", + "in": "query", + "description": "Reserved for DocuSign.", + "required": false, + "type": "string" + }, + { + "name": "start_position", + "in": "query", + "description": "Reserved for DocuSign.", + "required": false, + "type": "string" + }, + { + "name": "status", + "in": "query", + "description": "Reserved for DocuSign.", + "required": false, + "type": "string" + }, + { + "name": "to_date", "in": "query", - "description": "The email address for the user", + "description": "Reserved for DocuSign.", "required": false, "type": "string" } @@ -11054,7 +11608,7 @@ "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/recipientNamesResponse" + "$ref": "#/definitions/folderItemsResponse" } }, "400": { @@ -11065,20 +11619,18 @@ } }, "deprecated": false, - "x-ds-methodname": "listRecipientNamesByEmail", - "x-ds-method": "listRecipientNamesByEmail", - "x-ds-service": "Accounts", + "x-ds-methodname": "listItems", + "x-ds-method": "listItems", + "x-ds-service": "Folders", "x-ds-in-sdk": true }, - "parameters": [] - }, - "/v2.1/accounts/{accountId}/seals": { - "get": { + "put": { "tags": [ - "AccountSealProviders" + "Folders" ], - "summary": "", - "operationId": "AccountSignatureProviders_GetSealProviders", + "summary": "Moves an envelope from its current folder to the specified folder.", + "description": "Moves an envelope from its current folder to the specified folder.\n\nYou can use this method to delete envelopes by specifying `recyclebin` in the `folderId` parameter.\nPlacing an in-process envelope (envelope status of `sent` or `delivered`) in the recycle bin voids the envelope.\n\nYou can also use this method to delete templates by specifying a template ID instead of an envelope ID in the `envelopeIds` property and specifying `recyclebin` in the `folderId` parameter. ", + "operationId": "Folders_PutFolderById", "consumes": [], "produces": [], "parameters": [ @@ -11088,13 +11640,29 @@ "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" + }, + { + "name": "folderId", + "in": "path", + "description": "The id of the folder.", + "required": true, + "type": "string" + }, + { + "name": "foldersRequest", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/foldersRequest" + }, + "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/AccountSealProviders" + "$ref": "#/definitions/foldersResponse" } }, "400": { @@ -11105,22 +11673,21 @@ } }, "deprecated": false, - "x-ds-methodname": "getSealProviders", - "x-ds-method": "list", - "x-ds-service": "TrustServiceProviders", - "description": "", + "x-ds-methodname": "moveEnvelopes", + "x-ds-method": "moveEnvelopes", + "x-ds-service": "Folders", "x-ds-in-sdk": true }, "parameters": [] }, - "/v2.1/accounts/{accountId}/search_folders/{searchFolderId}": { + "/v2.1/accounts/{accountId}/groups": { "get": { "tags": [ - "Folders" + "Groups" ], - "summary": "Gets a list of envelopes in folders matching the specified criteria.", - "description": "**This method is deprecated in API v2.1.**\n\nUse [Envelopes::listStatusChanges](https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/listStatusChanges) instead.\n\nRetrieves a list of items that match the criteria specified in the query.\n\nIf the user ID of the user making the call is the same as the user ID for any returned recipient, then the userId property is added to the returned information for those recipients.", - "operationId": "SearchFolders_GetSearchFolderContents", + "summary": "Gets information about groups associated with the account.", + "description": "Retrieves information about groups associated with the account.", + "operationId": "Groups_GetGroups", "consumes": [], "produces": [], "parameters": [ @@ -11131,66 +11698,38 @@ "required": true, "type": "string" }, - { - "name": "searchFolderId", - "in": "path", - "description": "Specifies the envelope group that is searched by the request. These are logical groupings, not actual folder names. Valid values are: drafts, awaiting_my_signature, completed, out_for_signature.", - "required": true, - "type": "string" - }, - { - "name": "all", - "in": "query", - "description": "Specifies that all envelopes that match the criteria are returned.", - "required": false, - "type": "string" - }, { "name": "count", "in": "query", - "description": "Specifies the number of records returned in the cache. The number must be greater than 0 and less than or equal to 100.", - "required": false, - "type": "string" - }, - { - "name": "from_date", - "in": "query", - "description": "Specifies the start of the date range to return. If no value is provided, the default search is the previous 30 days.", + "description": "Number of records to return. The number must be greater than 1 and less than or equal to 100.", "required": false, "type": "string" }, { - "name": "include_recipients", + "name": "group_type", "in": "query", - "description": "When set to **true**, the recipient information is returned in the response.", "required": false, - "type": "string" + "type": "string", + "description": "" }, { - "name": "order", + "name": "include_usercount", "in": "query", - "description": "Specifies the order in which the list is returned. Valid values are: `asc` for ascending order, and `desc` for descending order.", "required": false, - "type": "string" + "type": "string", + "description": "When set to **true**, every group returned in the response includes a `userCount` property that contains the total number of users in the group. The default is **true**." }, { - "name": "order_by", + "name": "search_text", "in": "query", - "description": "Specifies the property used to sort the list. Valid values are: `action_required`, `created`, `completed`, `sent`, `signer_list`, `status`, or `subject`.", "required": false, - "type": "string" + "type": "string", + "description": "Filters the results of a GET request based on the text that you specify." }, { "name": "start_position", "in": "query", - "description": "Specifies the the starting location in the result set of the items that are returned.", - "required": false, - "type": "string" - }, - { - "name": "to_date", - "in": "query", - "description": "Specifies the end of the date range to return.", + "description": "The starting value for the list.", "required": false, "type": "string" } @@ -11199,7 +11738,7 @@ "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/folderItemResponse" + "$ref": "#/definitions/groupInformation" } }, "400": { @@ -11210,21 +11749,18 @@ } }, "deprecated": false, - "x-ds-methodname": "search", - "x-ds-method": "search", - "x-ds-service": "Folders", + "x-ds-methodname": "listGroups", + "x-ds-method": "list", + "x-ds-service": "Groups", "x-ds-in-sdk": true }, - "parameters": [] - }, - "/v2.1/accounts/{accountId}/settings": { - "get": { + "put": { "tags": [ - "Accounts" + "Groups" ], - "summary": "Gets account settings information.", - "description": "Retrieves the account settings information for the specified account.", - "operationId": "Settings_GetSettings", + "summary": "Updates the group information for a group.", + "description": "Updates the group name and modifies, or sets, the permission profile for the group.", + "operationId": "Groups_PutGroups", "consumes": [], "produces": [], "parameters": [ @@ -11234,13 +11770,22 @@ "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" + }, + { + "name": "groupInformation", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/groupInformation" + }, + "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/accountSettingsInformation" + "$ref": "#/definitions/groupInformation" } }, "400": { @@ -11251,18 +11796,18 @@ } }, "deprecated": false, - "x-ds-methodname": "listSettings", - "x-ds-method": "listSettings", - "x-ds-service": "Accounts", + "x-ds-methodname": "updateGroups", + "x-ds-method": "update", + "x-ds-service": "Groups", "x-ds-in-sdk": true }, - "put": { + "post": { "tags": [ - "Accounts" + "Groups" ], - "summary": "Updates the account settings for an account.", - "description": "Updates the account settings for the specified account.", - "operationId": "Settings_PutSettings", + "summary": "Creates one or more groups for the account.", + "description": "Creates one or more groups for the account.\n\nGroups can be used to help manage users by associating users with a group. You can associate a group with a Permission Profile, which sets the user permissions for users in that group without having to set the `userSettings` property for each user. You are not required to set Permission Profiles for a group, but it makes it easier to manage user permissions for a large number of users. You can also use groups with template sharing to limit user access to templates.", + "operationId": "Groups_PostGroups", "consumes": [], "produces": [], "parameters": [ @@ -11274,18 +11819,21 @@ "type": "string" }, { - "name": "accountSettingsInformation", + "name": "groupInformation", "in": "body", "required": false, "schema": { - "$ref": "#/definitions/accountSettingsInformation" + "$ref": "#/definitions/groupInformation" }, "description": "" } ], "responses": { - "200": { - "description": "Successful response." + "201": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/groupInformation" + } }, "400": { "description": "Error encountered.", @@ -11295,20 +11843,18 @@ } }, "deprecated": false, - "x-ds-methodname": "updateSettings", - "x-ds-method": "updateSettings", - "x-ds-service": "Accounts", + "x-ds-methodname": "createGroups", + "x-ds-method": "create", + "x-ds-service": "Groups", "x-ds-in-sdk": true }, - "parameters": [] - }, - "/v2.1/accounts/{accountId}/settings/enote_configuration": { - "get": { + "delete": { "tags": [ - "ENoteConfigurations" + "Groups" ], - "summary": "Returns the configuration information for the eNote eOriginal integration.", - "operationId": "ENoteConfiguration_GetENoteConfiguration", + "summary": "Deletes an existing user group.", + "description": "Deletes an existing user group.\n\nWhen you delete a group, you include only the `groupId` in the request body.\n\nExample:\n\n```\n{\n \"groups\": [\n {\n \"groupId\": \"12345\"\n }\n}\n```\n", + "operationId": "Groups_DeleteGroups", "consumes": [], "produces": [], "parameters": [ @@ -11318,13 +11864,22 @@ "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" + }, + { + "name": "groupInformation", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/groupInformation" + }, + "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/ENoteConfigurations" + "$ref": "#/definitions/groupInformation" } }, "400": { @@ -11335,19 +11890,21 @@ } }, "deprecated": false, - "x-ds-methodname": "getENoteConfiguration", - "x-ds-api-status": "beta", - "x-ds-method": "get", - "x-ds-service": "Accounts", - "description": "", + "x-ds-methodname": "deleteGroups", + "x-ds-method": "delete", + "x-ds-service": "Groups", "x-ds-in-sdk": true }, - "put": { + "parameters": [] + }, + "/v2.1/accounts/{accountId}/groups/{groupId}/brands": { + "get": { "tags": [ - "ENoteConfigurations" + "GroupBrands" ], - "summary": "Updates configuration information for the eNote eOriginal integration.", - "operationId": "ENoteConfiguration_PutENoteConfiguration", + "summary": "Gets the brand information for a group.", + "description": "This method returns information about the brands associated with a group.", + "operationId": "Brands_GetGroupBrands", "consumes": [], "produces": [], "parameters": [ @@ -11359,20 +11916,18 @@ "type": "string" }, { - "name": "ENoteConfigurations", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/ENoteConfigurations" - }, - "description": "" + "name": "groupId", + "in": "path", + "description": "The id of the group.", + "required": true, + "type": "string" } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/ENoteConfigurations" + "$ref": "#/definitions/GroupBrands" } }, "400": { @@ -11383,19 +11938,18 @@ } }, "deprecated": false, - "x-ds-methodname": "updateENoteConfiguration", - "x-ds-api-status": "beta", - "x-ds-method": "update", - "x-ds-service": "Accounts", - "description": "", + "x-ds-methodname": "getBrands", + "x-ds-method": "get", + "x-ds-service": "Groups", "x-ds-in-sdk": true }, - "delete": { + "put": { "tags": [ - "ENoteConfigurations" + "GroupBrands" ], - "summary": "Deletes configuration information for the eNote eOriginal integration.", - "operationId": "ENoteConfiguration_DeleteENoteConfiguration", + "summary": "Adds an existing brand to a group.", + "description": "This method adds one or more existing brands to a group based on the `groupId`.", + "operationId": "Brands_PutGroupBrands", "consumes": [], "produces": [], "parameters": [ @@ -11405,11 +11959,30 @@ "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" + }, + { + "name": "groupId", + "in": "path", + "description": "The ID of the group being accessed.", + "required": true, + "type": "string" + }, + { + "name": "brandsRequest", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/brandsRequest" + }, + "description": "" } ], "responses": { "200": { - "description": "Successful response." + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/GroupBrands" + } }, "400": { "description": "Error encountered.", @@ -11419,22 +11992,18 @@ } }, "deprecated": false, - "x-ds-methodname": "deleteENoteConfiguration", - "x-ds-api-status": "beta", - "x-ds-method": "delete", - "x-ds-service": "Accounts", - "description": "", + "x-ds-methodname": "updateBrands", + "x-ds-method": "update", + "x-ds-service": "Groups", "x-ds-in-sdk": true }, - "parameters": [] - }, - "/v2.1/accounts/{accountId}/settings/envelope_purge_configuration": { - "get": { + "delete": { "tags": [ - "EnvelopePurgeConfiguration" + "GroupBrands" ], - "summary": "", - "operationId": "EnvelopePurgeConfiguration_GetEnvelopePurgeConfiguration", + "summary": "Deletes brand information from a group.", + "description": "This method deletes one or more brands from a group.", + "operationId": "Brands_DeleteGroupBrands", "consumes": [], "produces": [], "parameters": [ @@ -11444,13 +12013,29 @@ "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" + }, + { + "name": "groupId", + "in": "path", + "description": "The id of the group.", + "required": true, + "type": "string" + }, + { + "name": "brandsRequest", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/brandsRequest" + }, + "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/envelopePurgeConfiguration" + "$ref": "#/definitions/GroupBrands" } }, "400": { @@ -11461,19 +12046,21 @@ } }, "deprecated": false, - "x-ds-methodname": "getEnvelopePurgeConfiguration", - "x-ds-api-status": "beta", - "x-ds-method": "getEnvelopePurgeConfiguration", - "x-ds-service": "Uncategorized", - "description": "", + "x-ds-methodname": "deleteBrands", + "x-ds-method": "delete", + "x-ds-service": "Groups", "x-ds-in-sdk": true }, - "put": { + "parameters": [] + }, + "/v2.1/accounts/{accountId}/groups/{groupId}/users": { + "get": { "tags": [ - "EnvelopePurgeConfiguration" + "GroupUsers" ], - "summary": "", - "operationId": "EnvelopePurgeConfiguration_PutEnvelopePurgeConfiguration", + "summary": "Gets a list of users in a group.", + "description": "Retrieves a list of users in a group.", + "operationId": "Groups_GetGroupUsers", "consumes": [], "produces": [], "parameters": [ @@ -11485,20 +12072,32 @@ "type": "string" }, { - "name": "envelopePurgeConfiguration", - "in": "body", + "name": "groupId", + "in": "path", + "description": "The ID of the group being accessed.", + "required": true, + "type": "string" + }, + { + "name": "count", + "in": "query", + "description": "Number of records to return. The number must be greater than 1 and less than or equal to 100. ", "required": false, - "schema": { - "$ref": "#/definitions/envelopePurgeConfiguration" - }, - "description": "" + "type": "string" + }, + { + "name": "start_position", + "in": "query", + "description": "Starting value for the list.", + "required": false, + "type": "string" } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/envelopePurgeConfiguration" + "$ref": "#/definitions/usersResponse" } }, "400": { @@ -11509,22 +12108,18 @@ } }, "deprecated": false, - "x-ds-methodname": "updateEnvelopePurgeConfiguration", - "x-ds-api-status": "beta", - "x-ds-method": "updateEnvelopePurgeConfiguration", - "x-ds-service": "Uncategorized", - "description": "", + "x-ds-methodname": "listGroupUsers", + "x-ds-method": "list", + "x-ds-service": "Groups", "x-ds-in-sdk": true }, - "parameters": [] - }, - "/v2.1/accounts/{accountId}/settings/notification_defaults": { - "get": { + "put": { "tags": [ - "NotificationDefaults" + "GroupUsers" ], - "summary": "", - "operationId": "NotificationDefaults_GetNotificationDefaults", + "summary": "Adds one or more users to an existing group.", + "description": "Adds one or more existing DocuSign users to an existing group.", + "operationId": "Groups_PutGroupUsers", "consumes": [], "produces": [], "parameters": [ @@ -11534,13 +12129,29 @@ "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" + }, + { + "name": "groupId", + "in": "path", + "description": "The ID of the group being accessed.", + "required": true, + "type": "string" + }, + { + "name": "userInfoList", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/userInfoList" + }, + "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/NotificationDefaults" + "$ref": "#/definitions/usersResponse" } }, "400": { @@ -11551,18 +12162,18 @@ } }, "deprecated": false, - "x-ds-methodname": "getNotificationDefaults", - "x-ds-method": "getNotificationDefaults", - "x-ds-service": "Uncategorized", - "description": "", + "x-ds-methodname": "updateGroupUsers", + "x-ds-method": "update", + "x-ds-service": "Groups", "x-ds-in-sdk": true }, - "put": { + "delete": { "tags": [ - "NotificationDefaults" + "GroupUsers" ], - "summary": "", - "operationId": "NotificationDefaults_PutNotificationDefaults", + "summary": "Deletes one or more users from a group", + "description": "Deletes one or more users from a group. This request takes a `userInfoList` that contains the users that you want to delete.\n", + "operationId": "Groups_DeleteGroupUsers", "consumes": [], "produces": [], "parameters": [ @@ -11574,11 +12185,18 @@ "type": "string" }, { - "name": "NotificationDefaults", + "name": "groupId", + "in": "path", + "description": "The ID of the group being accessed.", + "required": true, + "type": "string" + }, + { + "name": "userInfoList", "in": "body", "required": false, "schema": { - "$ref": "#/definitions/NotificationDefaults" + "$ref": "#/definitions/userInfoList" }, "description": "" } @@ -11587,7 +12205,7 @@ "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/NotificationDefaults" + "$ref": "#/definitions/usersResponse" } }, "400": { @@ -11598,21 +12216,20 @@ } }, "deprecated": false, - "x-ds-methodname": "updateNotificationDefaults", - "x-ds-method": "updateNotificationDefaults", - "x-ds-service": "Uncategorized", - "description": "", + "x-ds-methodname": "deleteGroupUsers", + "x-ds-method": "delete", + "x-ds-service": "Groups", "x-ds-in-sdk": true }, "parameters": [] }, - "/v2.1/accounts/{accountId}/settings/password_rules": { + "/v2.1/accounts/{accountId}/identity_verification": { "get": { "tags": [ - "AccountPasswordRules" + "IdentityVerifications" ], - "summary": "Get the password rules", - "operationId": "AccountPasswordRules_GetAccountPasswordRules", + "summary": "Retrieves the Identity Verification workflows available to an account.", + "operationId": "AccountIdentityVerification_GetAccountIdentityVerification", "consumes": [], "produces": [], "parameters": [ @@ -11628,7 +12245,7 @@ "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/AccountPasswordRules" + "$ref": "#/definitions/accountIdentityVerificationResponse" } }, "400": { @@ -11639,18 +12256,21 @@ } }, "deprecated": false, - "x-ds-methodname": "getAccountPasswordRules", - "x-ds-method": "get", - "x-ds-service": "Accounts", - "description": "", + "x-ds-methodname": "getAccountIdentityVerification", + "x-ds-method": "list", + "x-ds-service": "Uncategorized", + "description": "This method returns a list of Identity Verification workflows that are available to an account.\n\n**Note**: To use this method, you must either be an account administrator or a sender.", "x-ds-in-sdk": true }, - "put": { + "parameters": [] + }, + "/v2.1/accounts/{accountId}/payment_gateway_accounts": { + "get": { "tags": [ - "AccountPasswordRules" + "PaymentGatewayAccounts" ], - "summary": "Update the password rules", - "operationId": "AccountPasswordRules_PutAccountPasswordRules", + "summary": "List payment gateway accounts", + "operationId": "PaymentGatewayAccounts_GetAllPaymentGatewayAccounts", "consumes": [], "produces": [], "parameters": [ @@ -11660,22 +12280,13 @@ "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" - }, - { - "name": "AccountPasswordRules", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/AccountPasswordRules" - }, - "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/AccountPasswordRules" + "$ref": "#/definitions/paymentGatewayAccountsInfo" } }, "400": { @@ -11686,21 +12297,23 @@ } }, "deprecated": false, - "x-ds-methodname": "updateAccountPasswordRules", - "x-ds-method": "update", + "x-ds-methodname": "getAllPaymentGatewayAccounts", + "x-ds-api-status": "beta", + "x-ds-method": "list", "x-ds-service": "Accounts", - "description": "", + "description": "This method returns a list of payment gateway accounts and basic information about them.", "x-ds-in-sdk": true }, "parameters": [] }, - "/v2.1/accounts/{accountId}/settings/tabs": { + "/v2.1/accounts/{accountId}/permission_profiles": { "get": { "tags": [ - "AccountTabSettings" + "AccountPermissionProfiles" ], - "summary": "Returns tab settings list for specified account", - "operationId": "TabSettings_GetTabSettings", + "summary": "Gets a list of permission profiles.", + "description": "This method returns a list of permission profiles that are associated with an account.", + "operationId": "PermissionProfiles_GetPermissionProfiles", "consumes": [], "produces": [], "parameters": [ @@ -11710,13 +12323,20 @@ "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" + }, + { + "name": "include", + "in": "query", + "required": false, + "type": "string", + "description": "A comma-separated list of additional properties to return in the response. Valid values are:\n\n- `user_count`: The total number of users associated with the permission profile.\n- `closed_users`: Includes closed users in the `user_count`.\n- `account_management`: The account management settings.\n- `metadata`: Metadata indicating whether the properties associated with the account permission profile are editable.\n\nExample: `user_count,closed_users`\n" } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/AccountTabSettings" + "$ref": "#/definitions/permissionProfileInformation" } }, "400": { @@ -11727,18 +12347,17 @@ } }, "deprecated": false, - "x-ds-methodname": "getAccountTabSettings", - "x-ds-method": "get", + "x-ds-methodname": "listPermissions", + "x-ds-method": "list", "x-ds-service": "Accounts", - "description": "", "x-ds-in-sdk": true }, - "put": { + "post": { "tags": [ - "AccountTabSettings" + "AccountPermissionProfiles" ], - "summary": "Modifies tab settings for specified account", - "operationId": "TabSettings_PutSettings", + "summary": "Creates a new permission profile for an account.", + "operationId": "PermissionProfiles_PostPermissionProfiles", "consumes": [], "produces": [], "parameters": [ @@ -11750,20 +12369,27 @@ "type": "string" }, { - "name": "AccountTabSettings", + "name": "include", + "in": "query", + "required": false, + "type": "string", + "description": "A comma-separated list of additional properties to return in the response. The only valid value for this request is `metadata`, which returns metadata indicating whether the properties associated with the account permission profile are editable." + }, + { + "name": "permissionProfile", "in": "body", "required": false, "schema": { - "$ref": "#/definitions/AccountTabSettings" + "$ref": "#/definitions/permissionProfile" }, "description": "" } ], "responses": { - "200": { + "201": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/AccountTabSettings" + "$ref": "#/definitions/permissionProfile" } }, "400": { @@ -11774,22 +12400,21 @@ } }, "deprecated": false, - "x-ds-methodname": "updateAccountTabSettings", - "x-ds-method": "update", + "x-ds-methodname": "createPermissionProfile", + "x-ds-method": "create", "x-ds-service": "Accounts", - "description": "", + "description": "This method creates a new permission profile for an account.", "x-ds-in-sdk": true }, "parameters": [] }, - "/v2.1/accounts/{accountId}/shared_access": { + "/v2.1/accounts/{accountId}/permission_profiles/{permissionProfileId}": { "get": { "tags": [ - "Accounts" + "AccountPermissionProfiles" ], - "summary": "Reserved: Gets the shared item status for one or more users.", - "description": "Retrieves shared item status for one or more users and types of items.\n\nUsers with account administration privileges can retrieve shared access information for all account users. Users without account administrator privileges can only retrieve shared access information for themselves, and the returned information is limited to retrieving the status of the members of the account that are sharing their folders to the user. This is equivalent to setting the `shared` parameter to `shared_from`.", - "operationId": "SharedAccess_GetSharedAccess", + "summary": "Returns a permission profile for an account.", + "operationId": "PermissionProfiles_GetPermissionProfile", "consumes": [], "produces": [], "parameters": [ @@ -11801,67 +12426,25 @@ "type": "string" }, { - "name": "count", - "in": "query", - "description": "Specifies the maximum number of results included in the response. If no value is specified, this defaults to 1000.", - "required": false, - "type": "string" - }, - { - "name": "envelopes_not_shared_user_status", - "in": "query", - "required": false, + "name": "permissionProfileId", + "in": "path", + "required": true, "type": "string", - "description": "This query parameter works in conjunction with `user_ids`. When you specify one of the following user statuses, the query limits the results to only users that match the specified status:\n- `ActivationRequired`: Membership Activation required\n- `ActivationSent`: Membership activation sent to user\n- `Active`: User Membership is active\n- `Closed`: User Membership is closed\n- `Disabled`: User Membership is disabled" + "description": "The ID of the permission profile. Possible values include:\n\n- `2301416` (for the `DocuSign Viewer` profile)\n- `2301415` (for the `DocuSign Sender` profile)\n- `2301414` (for the `Account Administrator` profile)\n\nIn addition, any custom permission profiles associated with your account will have an automatically generated `permissionProfileId`." }, { - "name": "folder_ids", + "name": "include", "in": "query", "required": false, "type": "string", - "description": "A comma-separated list of folder IDs for which to return shared item information. If `item_type` is set to `folders`, at least one folder ID is required." - }, - { - "name": "item_type", - "in": "query", - "description": "Specifies the type of shared item being requested. The possible values are:\n\n- `envelopes`: Get information about envelope sharing between users.\n- `templates`: Get information about template sharing among users and groups.\n- `folders`: Get information about folder sharing among users and groups.\n", - "required": false, - "type": "string" - }, - { - "name": "search_text", - "in": "query", - "description": "Filter user names based on the specified string. The wild-card '*' (asterisk) can be used in the string.", - "required": false, - "type": "string" - }, - { - "name": "shared", - "in": "query", - "description": "A comma-separated list of sharing filters that specifies which users appear in the response. \n\n- `not_shared`: The response lists users who do not share items of `item_type` with the current user.\n\n- `shared_to`: The response lists users in `user_list` who are sharing items to current user.\n\n- `shared_from`: The response lists users in `user_list` who are sharing items from the current user.\n\n- `shared_to_and_from`: The response lists users in `user_list` who are sharing items to and from the current user.\n\nIf the current user does not have administrative privileges, only the `shared_to` option is valid.", - "required": false, - "type": "string" - }, - { - "name": "start_position", - "in": "query", - "description": "If the number of responses is greater than `count`, this specifies the number of responses to skip. Typically this value is a multiple of `count`. The default is 0.", - "required": false, - "type": "string" - }, - { - "name": "user_ids", - "in": "query", - "description": "A comma-separated list of user IDs for whom the shared item information is being requested.", - "required": false, - "type": "string" + "description": "A comma-separated list of additional properties to return in the response. The only valid value for this request is `metadata`, which returns metadata indicating whether the properties associated with the account permission profile are editable." } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/accountSharedAccess" + "$ref": "#/definitions/permissionProfile" } }, "400": { @@ -11872,18 +12455,18 @@ } }, "deprecated": false, - "x-ds-methodname": "listSharedAccess", - "x-ds-method": "listSharedAccess", + "x-ds-methodname": "getPermissionProfile", + "x-ds-method": "get", "x-ds-service": "Accounts", + "description": "This method returns information about a specific permission profile that is associated with an account.", "x-ds-in-sdk": true }, "put": { "tags": [ - "Accounts" + "AccountPermissionProfiles" ], - "summary": "Reserved: Sets the shared access information for users.", - "description": "This sets the shared access status for one or more users or templates.\n\nWhen setting user shared access, only users with account administration privileges can set shared access status for envelopes.\n\nWhen setting template shared access, only users who own a template and have sharing permission or with account administration privileges can set shared access for templates.\n\nChanges to the shared items status are not additive. The change always replaces the current status.\n\nTo change template shared access, add the query parameter `item_type` = `templates` to the request. When this is set, the user and envelopes properties are not required.\n\n", - "operationId": "SharedAccess_PutSharedAccess", + "summary": "Updates a permission profile.", + "operationId": "PermissionProfiles_PutPermissionProfiles", "consumes": [], "produces": [], "parameters": [ @@ -11895,32 +12478,25 @@ "type": "string" }, { - "name": "item_type", - "in": "query", - "required": false, - "type": "string", - "description": "Specifies the type of shared item being set:\n- `envelopes`: Set envelope sharing between users.\n- `templates`: Set information about template sharing among users and groups.\n- `folders`: Get information about folder sharing among users and groups.\n" - }, - { - "name": "preserve_existing_shared_access", - "in": "query", - "required": false, + "name": "permissionProfileId", + "in": "path", + "required": true, "type": "string", - "description": "When **true**, preserve the existing shared access settings." + "description": "The ID of the permission profile. Possible values include:\n\n- `2301416` (for the `DocuSign Viewer` profile)\n- `2301415` (for the `DocuSign Sender` profile)\n- `2301414` (for the `Account Administrator` profile)\n\nIn addition, any custom permission profiles associated with your account will have an automatically generated `permissionProfileId`." }, { - "name": "user_ids", + "name": "include", "in": "query", "required": false, "type": "string", - "description": "A comma-separated list of IDs for users whose shared item access is being set." + "description": "A comma-separated list of additional properties to return in the response. The only valid value for this request is `metadata`, which returns metadata indicating whether the properties associated with the account permission profile are editable." }, { - "name": "accountSharedAccess", + "name": "permissionProfile", "in": "body", "required": false, "schema": { - "$ref": "#/definitions/accountSharedAccess" + "$ref": "#/definitions/permissionProfile" }, "description": "" } @@ -11929,7 +12505,7 @@ "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/accountSharedAccess" + "$ref": "#/definitions/permissionProfile" } }, "400": { @@ -11940,20 +12516,18 @@ } }, "deprecated": false, - "x-ds-methodname": "updateSharedAccess", - "x-ds-method": "updateSharedAccess", + "x-ds-methodname": "updatePermissionProfile", + "x-ds-method": "update", "x-ds-service": "Accounts", + "description": "This method updates an account permission profile.", "x-ds-in-sdk": true }, - "parameters": [] - }, - "/v2.1/accounts/{accountId}/signatureProviders": { - "get": { + "delete": { "tags": [ - "AccountSignatureProviders" + "AccountPermissionProfiles" ], - "summary": "Returns Account available signature providers for specified account.", - "operationId": "AccountSignatureProviders_GetSignatureProviders", + "summary": "Deletes a permission profile from an account.", + "operationId": "PermissionProfiles_DeletePermissionProfiles", "consumes": [], "produces": [], "parameters": [ @@ -11963,14 +12537,25 @@ "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" + }, + { + "name": "permissionProfileId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the permission profile. Possible values include:\n\n- `2301416` (for the `DocuSign Viewer` profile)\n- `2301415` (for the `DocuSign Sender` profile)\n- `2301414` (for the `Account Administrator` profile)\n\nIn addition, any custom permission profiles associated with your account will have an automatically generated `permissionProfileId`." + }, + { + "name": "move_users_to", + "in": "query", + "required": false, + "type": "string", + "description": "" } ], "responses": { "200": { - "description": "Successful response.", - "schema": { - "$ref": "#/definitions/AccountSignatureProviders" - } + "description": "Successful response." }, "400": { "description": "Error encountered.", @@ -11980,22 +12565,21 @@ } }, "deprecated": false, - "x-ds-methodname": "listSignatureProviders", - "x-ds-method": "list", + "x-ds-methodname": "deletePermissionProfile", + "x-ds-method": "delete", "x-ds-service": "Accounts", - "description": "", + "description": "This method deletes a permission profile from an account.\n\nTo delete a permission profile, it must not have any users associated with it. When you use this method to delete a permission profile, you can reassign the users associated with it to a new permission profile at the same time by using the `move_users_to` query parameter.", "x-ds-in-sdk": true }, "parameters": [] }, - "/v2.1/accounts/{accountId}/signing_groups": { + "/v2.1/accounts/{accountId}/powerforms": { "get": { "tags": [ - "SigningGroups" + "PowerForms" ], - "summary": "Gets a list of the Signing Groups in an account.", - "description": "Retrieves a list of all signing groups in the specified account.", - "operationId": "SigningGroups_GetSigningGroups", + "summary": "Returns a list of PowerForms.", + "operationId": "PowerForms_GetPowerFormsList", "consumes": [], "produces": [], "parameters": [ @@ -12007,25 +12591,39 @@ "type": "string" }, { - "name": "group_type", + "name": "from_date", "in": "query", "required": false, "type": "string", - "description": "" + "description": "(Optional) The start date for a date range.\n\n**Note**: If no value is provided, no date filtering is applied." }, { - "name": "include_users", + "name": "order", "in": "query", - "description": "When set to **true**, the response includes the signing group members. ", "required": false, - "type": "string" + "type": "string", + "description": "(Optional) The order in which to sort the results.\n\nValid values are: \n\n\n* `asc`: Ascending order.\n* `desc`: Descending order. " + }, + { + "name": "order_by", + "in": "query", + "required": false, + "type": "string", + "description": "(Optional) The file attribute to use to sort the results.\n\nValid values are: \n\n* `modified`\n* `name`" + }, + { + "name": "to_date", + "in": "query", + "required": false, + "type": "string", + "description": "(Optional) The end date for a date range.\n\n**Note**: If no value is provided, this property defaults to the current date." } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/signingGroupInformation" + "$ref": "#/definitions/powerFormsResponse" } }, "400": { @@ -12036,18 +12634,18 @@ } }, "deprecated": false, - "x-ds-methodname": "list", + "x-ds-methodname": "listPowerForms", "x-ds-method": "list", - "x-ds-service": "SigningGroups", + "x-ds-service": "PowerForms", + "description": "This method returns a list of PowerForms that are available to the user.", "x-ds-in-sdk": true }, - "put": { + "post": { "tags": [ - "SigningGroups" + "PowerForms" ], - "summary": "Updates signing group names.", - "description": "Updates the name of one or more existing signing groups. ", - "operationId": "SigningGroups_PutSigningGroups", + "summary": "Creates a new PowerForm", + "operationId": "PowerForms_PostPowerForm", "consumes": [], "produces": [], "parameters": [ @@ -12059,20 +12657,20 @@ "type": "string" }, { - "name": "signingGroupInformation", + "name": "powerForm", "in": "body", "required": false, "schema": { - "$ref": "#/definitions/signingGroupInformation" + "$ref": "#/definitions/powerForm" }, - "description": "" + "description": "Information about any PowerForms that are included in the envelope." } ], "responses": { - "200": { + "201": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/signingGroupInformation" + "$ref": "#/definitions/powerForm" } }, "400": { @@ -12083,18 +12681,18 @@ } }, "deprecated": false, - "x-ds-methodname": "updateList", - "x-ds-method": "updateList", - "x-ds-service": "SigningGroups", + "x-ds-methodname": "createPowerForm", + "x-ds-method": "create", + "x-ds-service": "PowerForms", + "description": "This method creates a new PowerForm.\n\nYou create a PowerForm from an existing DocuSign [template](https://developers.docusign.com/docs/esign-rest-api/reference/templates/templates/create/), based on the `templateId` in the request body.\n\n PowerForms that you create from a template are referred to as *web PowerForms*.\n\n**Note**: The RADmin console also supports creating a PowerForm by uploading a PDF file that has active form fields (referred to as a *PDF PowerForm*). However, PDF PowerForms are deprecated and are not supported in the API.\n\n**Note**: A PowerForm can have only one sender. (Because PowerForms are not necessarily sent by email, this user is also referred to as the PowerForm *initiator*.) If you need to associate multiple senders with a PowerForm, create multiple copies of the PowerForm by using the same template (one copy for each sender). By default, the sender is the PowerForm Administrator who creates the PowerForm.\n\n\n### Signing modes\n\nYou can use one of the following signing modes for a PowerForm:\n\n**`email`**\n\nThis mode verifies the recipient's identity by using email authentication before the recipient can sign a document. The recipient enters their email address on the landing page and then clicks **Begin Signing** to begin the signing process. The system then sends an email message with a validation code to the recipient. If the recipient does not provide a valid email address, they do not receive the email message containing the access code and are not able to open and sign the document.\n\nAlternatively, you can make the process easier for signers by using email authentication only and omitting the access code. To do this, you append the `activateonly` flag to the PowerForm URL and set it to true by passing in the value `1`. When the flag is active, the first recipient receives an email with a link that initiates the signing session without having to enter access code.\n\nExample: `activateonly=1`\n\n**`direct`**\n\nThis mode does not require any verification. After a recipient enters their email address on the landing page and clicks **Begin Signing**, a new browser tab opens and the recipient can immediately begin the signing process.\n\nBecause the `direct` signing mode does not verify the recipient's identity by using email authentication, we strongly recommend that you use this mode only when the PowerForm is accessible behind a secure portal where the recipient's identity is already authenticated, or where another form of authentication is specified for the recipient in the DocuSign template (for example, an access code, phone authentication, or ID check).\n\n**Note**: In the account settings, `enablePowerFormDirect` must be **true** to use `direct` as the `signingMode`.\n\n### Redirect URLs\n\nYou can control the URL to which signers are redirected after signing your PowerForm. However, the URL is specified elsewhere, outside of the PowerForm creation process. For details, see [How do I specify a URL to redirect to when a PowerForm is completed?](https://support.docusign.com/en/articles/How-do-I-specify-a-URL-to-redirect-to-when-a-Powerform-is-completed).\n\n### More information\n\nFor more information about creating PowerForms, see [Create a PowerForm](https://support.docusign.com/en/guides/ndse-user-guide-create-a-powerform).\n\n", "x-ds-in-sdk": true }, - "post": { + "delete": { "tags": [ - "SigningGroups" + "PowerForms" ], - "summary": "Creates a signing group. ", - "description": "Creates one or more signing groups. \n\nMultiple signing groups can be created in one call. Only users with account administrator privileges can create signing groups. \n\nAn account can have a maximum of 50 signing groups. Each signing group can have a maximum of 50 group members.\n \nSigning groups can be used by any account user.", - "operationId": "SigningGroups_PostSigningGroups", + "summary": "Deletes one or more PowerForms.", + "operationId": "PowerForms_DeletePowerFormsList", "consumes": [], "produces": [], "parameters": [ @@ -12106,20 +12704,20 @@ "type": "string" }, { - "name": "signingGroupInformation", + "name": "powerFormsRequest", "in": "body", "required": false, "schema": { - "$ref": "#/definitions/signingGroupInformation" + "$ref": "#/definitions/powerFormsRequest" }, "description": "" } ], "responses": { - "201": { + "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/signingGroupInformation" + "$ref": "#/definitions/powerFormsResponse" } }, "400": { @@ -12130,18 +12728,21 @@ } }, "deprecated": false, - "x-ds-methodname": "createList", - "x-ds-method": "create", - "x-ds-service": "SigningGroups", + "x-ds-methodname": "deletePowerForms", + "x-ds-method": "deleteList", + "x-ds-service": "PowerForms", + "description": "This method deletes one or more PowerForms. The request body takes an array of PowerForm objects that are deleted based on the `powerFormId`.", "x-ds-in-sdk": true }, - "delete": { + "parameters": [] + }, + "/v2.1/accounts/{accountId}/powerforms/{powerFormId}": { + "get": { "tags": [ - "SigningGroups" + "PowerForms" ], - "summary": "Deletes one or more signing groups.", - "description": "Deletes one or more signing groups in the specified account.", - "operationId": "SigningGroups_DeleteSigningGroups", + "summary": "Returns a single PowerForm.", + "operationId": "PowerForms_GetPowerForm", "consumes": [], "produces": [], "parameters": [ @@ -12153,20 +12754,18 @@ "type": "string" }, { - "name": "signingGroupInformation", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/signingGroupInformation" - }, - "description": "" + "name": "powerFormId", + "in": "path", + "required": true, + "type": "string", + "description": "The id of the PowerForm." } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/signingGroupInformation" + "$ref": "#/definitions/powerForm" } }, "400": { @@ -12177,21 +12776,18 @@ } }, "deprecated": false, - "x-ds-methodname": "deleteList", - "x-ds-method": "delete", - "x-ds-service": "SigningGroups", + "x-ds-methodname": "getPowerForm", + "x-ds-method": "get", + "x-ds-service": "PowerForms", + "description": "This method returns detailed information about a specific PowerForm.", "x-ds-in-sdk": true }, - "parameters": [] - }, - "/v2.1/accounts/{accountId}/signing_groups/{signingGroupId}": { - "get": { + "put": { "tags": [ - "SigningGroups" + "PowerForms" ], - "summary": "Gets information about a signing group. ", - "description": "Retrieves information, including group member information, for the specified signing group. ", - "operationId": "SigningGroups_GetSigningGroup", + "summary": "Updates an existing PowerForm.", + "operationId": "PowerForms_PutPowerForm", "consumes": [], "produces": [], "parameters": [ @@ -12203,18 +12799,27 @@ "type": "string" }, { - "name": "signingGroupId", + "name": "powerFormId", "in": "path", "required": true, "type": "string", - "description": "The id of the signing group of which the recipient is a member, if applicable." + "description": "The id of the PowerForm." + }, + { + "name": "powerForm", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/powerForm" + }, + "description": "Information about any PowerForms that are included in the envelope." } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/SigningGroups" + "$ref": "#/definitions/powerForm" } }, "400": { @@ -12225,18 +12830,18 @@ } }, "deprecated": false, - "x-ds-methodname": "get", - "x-ds-method": "get", - "x-ds-service": "SigningGroups", + "x-ds-methodname": "updatePowerForm", + "x-ds-method": "update", + "x-ds-service": "PowerForms", + "description": "This method updates an existing PowerForm.", "x-ds-in-sdk": true }, - "put": { + "delete": { "tags": [ - "SigningGroups" + "PowerForms" ], - "summary": "Updates a signing group. ", - "description": "Updates signing group name and member information. You can also add new members to the signing group. A signing group can have a maximum of 50 members. ", - "operationId": "SigningGroups_PutSigningGroup", + "summary": "Deletes a PowerForm.", + "operationId": "PowerForms_DeletePowerForm", "consumes": [], "produces": [], "parameters": [ @@ -12248,28 +12853,16 @@ "type": "string" }, { - "name": "signingGroupId", + "name": "powerFormId", "in": "path", "required": true, "type": "string", - "description": "The id of the signing group of which the recipient is a member, if applicable." - }, - { - "name": "SigningGroups", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/SigningGroups" - }, - "description": "" + "description": "The id of the PowerForm." } ], "responses": { "200": { - "description": "Successful response.", - "schema": { - "$ref": "#/definitions/SigningGroups" - } + "description": "Successful response." }, "400": { "description": "Error encountered.", @@ -12279,21 +12872,21 @@ } }, "deprecated": false, - "x-ds-methodname": "update", - "x-ds-method": "update", - "x-ds-service": "SigningGroups", + "x-ds-methodname": "deletePowerForm", + "x-ds-method": "delete", + "x-ds-service": "PowerForms", + "description": "This method deletes a PowerForm.", "x-ds-in-sdk": true }, "parameters": [] }, - "/v2.1/accounts/{accountId}/signing_groups/{signingGroupId}/users": { + "/v2.1/accounts/{accountId}/powerforms/{powerFormId}/form_data": { "get": { "tags": [ - "SigningGroupUsers" + "PowerFormData" ], - "summary": "Gets a list of members in a Signing Group.", - "description": "Retrieves the list of members in the specified Signing Group.", - "operationId": "SigningGroups_GetSigningGroupUsers", + "summary": "Returns the data that users entered in a PowerForm.", + "operationId": "PowerForms_GetPowerFormFormData", "consumes": [], "produces": [], "parameters": [ @@ -12305,18 +12898,39 @@ "type": "string" }, { - "name": "signingGroupId", + "name": "powerFormId", "in": "path", "required": true, "type": "string", - "description": "The id of the signing group of which the recipient is a member, if applicable." + "description": "The id of the PowerForm." + }, + { + "name": "data_layout", + "in": "query", + "required": false, + "type": "string", + "description": "The layout in which to return the PowerForm data. Valid values are:\n\n- `Native`\n- `Csv_Classic`\n- `Csv_One_Envelope_Per_Line`\n- `Xml_Classic`" + }, + { + "name": "from_date", + "in": "query", + "required": false, + "type": "string", + "description": "The start date for a date range in UTC DateTime format.\n\n**Note**: If this property is null, no date filtering is applied." + }, + { + "name": "to_date", + "in": "query", + "required": false, + "type": "string", + "description": "The end date of a date range in UTC DateTime format. The default value is `UtcNow`." } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/SigningGroupUsers" + "$ref": "#/definitions/powerFormsFormDataResponse" } }, "400": { @@ -12327,18 +12941,21 @@ } }, "deprecated": false, - "x-ds-methodname": "listUsers", + "x-ds-methodname": "getPowerFormData", "x-ds-method": "list", - "x-ds-service": "SigningGroups", + "x-ds-service": "PowerForms", + "description": "This method enables Powerform Administrators or the sender of a PowerForm to download the data that recipients have entered into a PowerForm.\n\nYou specify the format in which you want to retrieve the data in the `Accept` header. This header accepts the following values:\n\n\n- `application/json`: JSON format\n- `application/xml`: XML format\n- `text/csv`: Comma-separated value (CSV) format\n\n**Note**: Only PowerForm Administrators or the PowerForm Sender can download the data associated with a PowerForm.", "x-ds-in-sdk": true }, - "put": { + "parameters": [] + }, + "/v2.1/accounts/{accountId}/powerforms/senders": { + "get": { "tags": [ - "SigningGroupUsers" + "PowerForms" ], - "summary": "Adds members to a signing group. ", - "description": "Adds one or more new members to a signing group. A signing group can have a maximum of 50 members. ", - "operationId": "SigningGroups_PutSigningGroupUsers", + "summary": "Gets PowerForm senders.", + "operationId": "PowerForms_GetPowerFormsSenders", "consumes": [], "produces": [], "parameters": [ @@ -12350,27 +12967,18 @@ "type": "string" }, { - "name": "signingGroupId", - "in": "path", - "required": true, - "type": "string", - "description": "The id of the signing group of which the recipient is a member, if applicable." - }, - { - "name": "SigningGroupUsers", - "in": "body", + "name": "start_position", + "in": "query", "required": false, - "schema": { - "$ref": "#/definitions/SigningGroupUsers" - }, - "description": "" + "type": "string", + "description": "The position within the total result set from which to start returning values. The value **thumbnail** may be used to return the page image." } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/SigningGroupUsers" + "$ref": "#/definitions/powerFormSendersResponse" } }, "400": { @@ -12381,50 +12989,45 @@ } }, "deprecated": false, - "x-ds-methodname": "updateUsers", - "x-ds-method": "update", - "x-ds-service": "SigningGroups", + "x-ds-methodname": "listPowerFormSenders", + "x-ds-method": "listSenders", + "x-ds-service": "PowerForms", + "description": "This method returns a list of users who have sent PowerForms.", "x-ds-in-sdk": true }, - "delete": { + "parameters": [] + }, + "/v2.1/accounts/{accountId}/recipient_names": { + "get": { "tags": [ - "SigningGroupUsers" + "Accounts" ], - "summary": "Deletes one or more members from a signing group.", - "description": "Deletes one or more members from the specified signing group. ", - "operationId": "SigningGroups_DeleteSigningGroupUsers", + "summary": "Gets the recipient names associated with an email address.", + "description": "Retrieves a list of all of the names associated with the email address that you pass in. This list can include variants of a single recipient's name that are used for signing, as well as the names of multiple different recipients.", + "operationId": "RecipientNames_GetRecipientNames", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", - "description": "The external account number (int) or account ID GUID.", + "description": "(Required) The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { - "name": "signingGroupId", - "in": "path", - "required": true, - "type": "string", - "description": "The id of the signing group of which the recipient is a member, if applicable." - }, - { - "name": "SigningGroupUsers", - "in": "body", + "name": "email", + "in": "query", + "description": "The email address for which you want to retrieve recipient names.", "required": false, - "schema": { - "$ref": "#/definitions/SigningGroupUsers" - }, - "description": "" + "type": "string" } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/SigningGroupUsers" + "$ref": "#/definitions/recipientNamesResponse" } }, "400": { @@ -12435,20 +13038,20 @@ } }, "deprecated": false, - "x-ds-methodname": "deleteUsers", - "x-ds-method": "delete", - "x-ds-service": "SigningGroups", + "x-ds-methodname": "listRecipientNamesByEmail", + "x-ds-method": "listRecipientNamesByEmail", + "x-ds-service": "Accounts", "x-ds-in-sdk": true }, "parameters": [] }, - "/v2.1/accounts/{accountId}/supported_languages": { + "/v2.1/accounts/{accountId}/reports": { "get": { "tags": [ - "Accounts" + "Reports" ], - "summary": "List supported languages for the recipient language setting", - "operationId": "SupportedLanguages_GetSupportedLanguages", + "summary": "Gets the descriptors for all of\nan account's active reports (for listings).", + "operationId": "ReportsInProduct_GetReportInProductList", "consumes": [], "produces": [], "parameters": [ @@ -12464,7 +13067,7 @@ "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/supportedLanguages" + "$ref": "#/definitions/reportInProductList" } }, "400": { @@ -12475,22 +13078,68 @@ } }, "deprecated": false, - "x-ds-methodname": "getSupportedLanguages", - "x-ds-method": "listSupportedLanguages", - "x-ds-service": "Accounts", - "description": "List supported languages for the recipient language setting", + "x-ds-methodname": "getReportInProductList", + "x-ds-method": "getReportInProductList", + "x-ds-service": "Uncategorized", + "description": "", + "x-ds-in-sdk": true + }, + "post": { + "tags": [ + "Reports" + ], + "summary": "Creates a customized report.", + "operationId": "ReportsInProduct_PostReportInProductCreate", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "The external account number (int) or account ID GUID.", + "required": true, + "type": "string" + }, + { + "name": "reportInProductRunRequest", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/reportInProductRunRequest" + }, + "description": "" + } + ], + "responses": { + "201": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/reportInProductSaveResponse" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "createReportInProductCreate", + "x-ds-method": "createReportInProductCreate", + "x-ds-service": "Uncategorized", + "description": "", "x-ds-in-sdk": true }, "parameters": [] }, - "/v2.1/accounts/{accountId}/tab_definitions": { + "/v2.1/accounts/{accountId}/reports/{id}": { "get": { "tags": [ - "CustomTabs" + "Reports" ], - "summary": "Gets a list of all account tabs.", - "description": "Retrieves a list of all tabs associated with the account.", - "operationId": "Tabs_GetTabDefinitions", + "summary": "Gets the specified report.", + "operationId": "ReportsInProduct_GetReportInProduct", "consumes": [], "produces": [], "parameters": [ @@ -12502,18 +13151,18 @@ "type": "string" }, { - "name": "custom_tab_only", - "in": "query", - "description": "When set to **true**, only custom tabs are returned in the response. ", - "required": false, - "type": "string" + "name": "id", + "in": "path", + "required": true, + "type": "string", + "description": "A unique ID for the Salesforce object." } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/tabMetadataList" + "$ref": "#/definitions/reportInProductGet" } }, "400": { @@ -12524,18 +13173,18 @@ } }, "deprecated": false, - "x-ds-methodname": "list", - "x-ds-method": "list", - "x-ds-service": "CustomTabs", + "x-ds-methodname": "getReportInProduct", + "x-ds-method": "getReportInProduct", + "x-ds-service": "Uncategorized", + "description": "", "x-ds-in-sdk": true }, - "post": { + "put": { "tags": [ - "CustomTabs" + "Reports" ], - "summary": "Creates a custom tab.", - "description": "Creates a tab with pre-defined properties, such as a text tab with a certain font type and validation pattern. Users can access the custom tabs when sending documents through the DocuSign web application.\n\nCustom tabs can be created for approve, checkbox, company, date, date signed, decline, email, email address, envelope ID, first name, formula, full name, initial here, last name, list, note, number, radio, sign here, signer attachment, SSN, text, title, and zip tabs.", - "operationId": "Tabs_PostTabDefinitions", + "summary": "Saves a customized report.", + "operationId": "ReportsInProduct_PutReportInProductSave", "consumes": [], "produces": [], "parameters": [ @@ -12547,20 +13196,27 @@ "type": "string" }, { - "name": "CustomTabs", + "name": "id", + "in": "path", + "required": true, + "type": "string", + "description": "A unique ID for the Salesforce object." + }, + { + "name": "reportInProductRunRequest", "in": "body", "required": false, "schema": { - "$ref": "#/definitions/CustomTabs" + "$ref": "#/definitions/reportInProductRunRequest" }, "description": "" } ], "responses": { - "201": { + "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/CustomTabs" + "$ref": "#/definitions/reportInProductSaveResponse" } }, "400": { @@ -12571,21 +13227,18 @@ } }, "deprecated": false, - "x-ds-methodname": "create", - "x-ds-method": "create", - "x-ds-service": "CustomTabs", + "x-ds-methodname": "updateReportInProductSave", + "x-ds-method": "updateReportInProductSave", + "x-ds-service": "Uncategorized", + "description": "", "x-ds-in-sdk": true }, - "parameters": [] - }, - "/v2.1/accounts/{accountId}/tab_definitions/{customTabId}": { - "get": { + "delete": { "tags": [ - "CustomTabs" + "Reports" ], - "summary": "Gets custom tab information.", - "description": "Retrieves information about the requested custom tab on the specified account.", - "operationId": "Tab_GetCustomTab", + "summary": "Removes a customized report.", + "operationId": "ReportsInProduct_DeleteReportInProduct", "consumes": [], "produces": [], "parameters": [ @@ -12597,18 +13250,18 @@ "type": "string" }, { - "name": "customTabId", + "name": "id", "in": "path", "required": true, "type": "string", - "description": "The DocuSign-generated custom tab id for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties." + "description": "A unique ID for the Salesforce object." } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/CustomTabs" + "$ref": "#/definitions/reportInProductSaveResponse" } }, "400": { @@ -12619,18 +13272,21 @@ } }, "deprecated": false, - "x-ds-methodname": "get", - "x-ds-method": "get", - "x-ds-service": "CustomTabs", + "x-ds-methodname": "deleteReportInProduct", + "x-ds-method": "deleteReportInProduct", + "x-ds-service": "Uncategorized", + "description": "", "x-ds-in-sdk": true }, + "parameters": [] + }, + "/v2.1/accounts/{accountId}/reports/report_results": { "put": { "tags": [ - "CustomTabs" + "Reports" ], - "summary": "Updates custom tab information.\n\n", - "description": "Updates the information in a custom tab for the specified account.", - "operationId": "Tab_PutCustomTab", + "summary": "Returns the result set from running the specified report.", + "operationId": "ReportsInProduct_PutReportInProductRunResults", "consumes": [], "produces": [], "parameters": [ @@ -12642,18 +13298,11 @@ "type": "string" }, { - "name": "customTabId", - "in": "path", - "required": true, - "type": "string", - "description": "The DocuSign-generated custom tab id for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties." - }, - { - "name": "CustomTabs", + "name": "reportInProductRunRequest", "in": "body", "required": false, "schema": { - "$ref": "#/definitions/CustomTabs" + "$ref": "#/definitions/reportInProductRunRequest" }, "description": "" } @@ -12662,7 +13311,7 @@ "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/CustomTabs" + "$ref": "#/definitions/reportInProductRunResponse" } }, "400": { @@ -12673,18 +13322,21 @@ } }, "deprecated": false, - "x-ds-methodname": "update", - "x-ds-method": "update", - "x-ds-service": "CustomTabs", + "x-ds-methodname": "updateReportInProductRunResults", + "x-ds-method": "updateReportInProductRunResults", + "x-ds-service": "Uncategorized", + "description": "", "x-ds-in-sdk": true }, - "delete": { + "parameters": [] + }, + "/v2.1/accounts/{accountId}/reports/report_results_csv": { + "put": { "tags": [ - "CustomTabs" + "Reports" ], - "summary": "Deletes custom tab information.", - "description": "Deletes the custom from the specified account.", - "operationId": "Tab_DeleteCustomTab", + "summary": "Returns the specified report as a CSV string.", + "operationId": "ReportsInProduct_PutReportResultsCsv", "consumes": [], "produces": [], "parameters": [ @@ -12696,11 +13348,13 @@ "type": "string" }, { - "name": "customTabId", - "in": "path", - "required": true, - "type": "string", - "description": "The DocuSign-generated custom tab id for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties." + "name": "reportInProductCsvRunRequest", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/reportInProductCsvRunRequest" + }, + "description": "" } ], "responses": { @@ -12715,21 +13369,21 @@ } }, "deprecated": false, - "x-ds-methodname": "delete", - "x-ds-method": "delete", - "x-ds-service": "CustomTabs", + "x-ds-methodname": "updateReportResultsCsv", + "x-ds-method": "updateReportResultsCsv", + "x-ds-service": "Uncategorized", + "description": "", "x-ds-in-sdk": true }, "parameters": [] }, - "/v2.1/accounts/{accountId}/templates": { + "/v2.1/accounts/{accountId}/seals": { "get": { "tags": [ - "Templates" + "AccountSealProviders" ], - "summary": "Gets the definition of a template.", - "description": "Retrieves the list of templates for the specified account. The request can be limited to a specific folder.", - "operationId": "Templates_GetTemplates", + "summary": "Returns available seals for specified account.", + "operationId": "AccountSignatureProviders_GetSealProviders", "consumes": [], "produces": [], "parameters": [ @@ -12739,167 +13393,118 @@ "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/AccountSealProviders" + } }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "getSealProviders", + "x-ds-method": "list", + "x-ds-service": "Uncategorized", + "description": "", + "x-ds-in-sdk": true + }, + "parameters": [] + }, + "/v2.1/accounts/{accountId}/search_folders/{searchFolderId}": { + "get": { + "tags": [ + "Folders" + ], + "summary": "Gets a list of envelopes in folders matching the specified criteria.", + "description": "**This method is deprecated in API v2.1.**\n\nUse [Envelopes::listStatusChanges](https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/Envelopes/listStatusChanges) instead.\n\nRetrieves a list of items that match the criteria specified in the query.\n\nIf the user ID of the user making the call is the same as the user ID for any returned recipient, then the userId property is added to the returned information for those recipients.", + "operationId": "SearchFolders_GetSearchFolderContents", + "consumes": [], + "produces": [], + "parameters": [ { - "name": "count", - "in": "query", - "description": "Number of records to return in the cache.", - "required": false, + "name": "accountId", + "in": "path", + "description": "The external account number (int) or account ID GUID.", + "required": true, "type": "string" }, { - "name": "created_from_date", - "in": "query", - "required": false, - "type": "string", - "description": "List templates created on or after this date." - }, - { - "name": "created_to_date", - "in": "query", - "required": false, - "type": "string", - "description": "List templates modified before this date." + "name": "searchFolderId", + "in": "path", + "description": "Specifies the envelope group that is searched by the request. These are logical groupings, not actual folder names. Valid values are: drafts, awaiting_my_signature, completed, out_for_signature.", + "required": true, + "type": "string" }, { - "name": "folder_ids", + "name": "all", "in": "query", - "description": "A comma separated list of folder ID GUIDs.", + "description": "Specifies that all envelopes that match the criteria are returned.", "required": false, "type": "string" }, { - "name": "folder_types", + "name": "count", "in": "query", + "description": "Specifies the number of records returned in the cache. The number must be greater than 0 and less than or equal to 100.", "required": false, - "type": "string", - "description": "The type of folder to return templates for. Possible values are:\n\n- `templates`: Templates in the **My Templates** folder.\n Templates in the **Shared Templates** and **All Template** folders (if the request id from and Admin) are excluded.\n- `templates_root`: Templates in the root level of the **My Templates** folder, but not in an actual folder. Note that the **My Templates** folder is not a real folder.\n- `recylebin`: Templates that have been deleted.\n" + "type": "string" }, { "name": "from_date", "in": "query", - "description": "Start of the search date range. Only returns templates created on or after this date/time. If no value is specified, there is no limit on the earliest date created.", + "description": "Specifies the start of the date range to return. If no value is provided, the default search is the previous 30 days.", "required": false, "type": "string" }, { - "name": "include", + "name": "include_recipients", "in": "query", - "description": "A comma-separated list\nof additional template attributes\nto include in the response.\nValid values are:\n\n- `advanced_templates`\n- `custom_fields`\n- `documents`\n- `folders`\n- `notifications`\n- `pathExtended`\n- `powerforms`\n- `recipients`\n- `shared_template_folders`\n\n`pathExtended`: Includes SalesForce configuration data for merge fields\nthat can be used to optimize upload template\nby eliminating the need to connect to SalesForce.", + "description": "When set to **true**, the recipient information is returned in the response.", "required": false, "type": "string" }, - { - "name": "is_download", - "in": "query", - "required": false, - "type": "string", - "description": "When **true**, download the templates listed in `template_ids` as a ZIP file.\n\nThe `Content-Disposition` header is set in the response. The value of the header provides the filename of the file.\n\nDefault is **false**." - }, - { - "name": "modified_from_date", - "in": "query", - "required": false, - "type": "string", - "description": "List templates modified on or after this date." - }, - { - "name": "modified_to_date", - "in": "query", - "required": false, - "type": "string", - "description": "List templates modified before this date." - }, { "name": "order", "in": "query", - "description": "Specifies the sort order of the search results.\nValid values are:\n\n- `asc`: Ascending (A to Z)\n- `desc`: Descending (Z to A)", + "description": "Specifies the order in which the list is returned. Valid values are: `asc` for ascending order, and `desc` for descending order.", "required": false, "type": "string" }, { "name": "order_by", "in": "query", - "description": "Specifies how the search results are listed.\nValid values are:\n\n- `name`: template name\n- `modified`: date/time template was last modified\n- `used`: date/time the template was last used.", - "required": false, - "type": "string" - }, - { - "name": "search_fields", - "in": "query", - "required": false, - "type": "string", - "description": "A comma-separated list of additional template properties to search.\n\n\n- `sender`: Include sender name and email in the search.\n- `recipients`: Include recipient names and emails in the search.\n- `envelope`: Not used in template searches.\n" - }, - { - "name": "search_text", - "in": "query", - "description": "The search text used to search the names of templates.", - "required": false, - "type": "string" - }, - { - "name": "shared_by_me", - "in": "query", - "description": "If true, the response only includes templates shared by the user. If false, the response only returns template not shared by the user. If not specified, the response is not affected.", + "description": "Specifies the property used to sort the list. Valid values are: `action_required`, `created`, `completed`, `sent`, `signer_list`, `status`, or `subject`.", "required": false, "type": "string" }, { "name": "start_position", "in": "query", - "description": "The starting index for the first template shown in the response. This must be greater than or equal to 0 (zero).", + "description": "Specifies the the starting location in the result set of the items that are returned.", "required": false, "type": "string" }, - { - "name": "template_ids", - "in": "query", - "required": false, - "type": "string", - "description": "A comma-separated list of template IDs to download. This value is valid only when `is_download` is **true**." - }, { "name": "to_date", "in": "query", - "description": "End of the search date range. Only returns templates created up to this date/time. If no value is provided, this defaults to the current date.", - "required": false, - "type": "string" - }, - { - "name": "used_from_date", - "in": "query", - "description": "Start of the search date range. Only returns templates used or edited on or after this date/time. If no value is specified, there is no limit on the earliest date used.", - "required": false, - "type": "string" - }, - { - "name": "used_to_date", - "in": "query", - "description": "End of the search date range. Only returns templates used or edited up to this date/time. If no value is provided, this defaults to the current date.", - "required": false, - "type": "string" - }, - { - "name": "user_filter", - "in": "query", - "description": "Filters the templates in the response. Valid values are: \n\n- `owned_by_me`: Results include only templates owned by the user.\n- `shared_with_me`: Results include only templates owned by the user. \n- `all`: Results include all templates owned or shared with the user.", + "description": "Specifies the end of the date range to return.", "required": false, "type": "string" - }, - { - "name": "user_id", - "in": "query", - "required": false, - "type": "string", - "description": "The user ID." } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/envelopeTemplateResults" + "$ref": "#/definitions/folderItemResponse" } }, "400": { @@ -12910,18 +13515,21 @@ } }, "deprecated": false, - "x-ds-methodname": "ListTemplates", - "x-ds-method": "list", - "x-ds-service": "Templates", + "x-ds-methodname": "search", + "x-ds-method": "search", + "x-ds-service": "Folders", "x-ds-in-sdk": true }, - "post": { + "parameters": [] + }, + "/v2.1/accounts/{accountId}/settings": { + "get": { "tags": [ - "Templates" + "Accounts" ], - "summary": "Creates a template.", - "description": "Creates a template definition using a multipart request.\n\n### Template Email Subject Merge Fields\n\nCall this endpoint to insert a recipient name and email address merge fields into the email subject line when creating or sending from a template.\n\nThe merge fields, based on the recipient's role name, are added to the `emailSubject` property when the template is created or when the template is used to create an envelope. After a template sender adds the name and email information for the recipient and sends the envelope, the recipient information is automatically merged into the appropriate fields in the email subject line.\n\nBoth the sender and the recipients will see the information in the email subject line for any emails associated with the template. This provides an easy way for senders to organize their envelope emails without having to open an envelope to check the recipient.\n\n\n###### If merging the recipient information into the subject line causes the subject line to exceed 100 characters, then any characters over the 100 character limit are not included in the subject line. For cases where the recipient name or email is expected to be long, you should consider placing the merge field at the start of the email subject.\n\nTo add a recipient's name in the subject line add the following text in the `emailSubject` property when creating the template or when sending an envelope from a template:\n\n`[[_UserName]]`\n\nExample:\n\n`\"emailSubject\":\"[[Signer 1_UserName]], Please sign this NDA\",`\n\nTo add a recipient's email address in the subject line add the following text in the `emailSubject` property when creating the template or when sending an envelope from a template:\n\n`[[_Email]]`\n\nExample:\n\n`\"emailSubject\":\"[[Signer 1_Email]], Please sign this NDA\",`\n\n\nIn both cases the is the recipient's contents of the `roleName` property in the template.\n\nFor cases where another recipient (such as an Agent, Editor, or Intermediary recipient) is entering the name and email information for the recipient included in the email subject, then `[[_UserName]]` or `[[_Email]]` is shown in the email subject.", - "operationId": "Templates_PostTemplates", + "summary": "Gets account settings information.", + "description": "Retrieves the account settings information for the specified account.", + "operationId": "Settings_GetSettings", "consumes": [], "produces": [], "parameters": [ @@ -12931,22 +13539,13 @@ "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" - }, - { - "name": "Templates", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/Templates" - }, - "description": "" } ], "responses": { - "201": { + "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/templateSummary" + "$ref": "#/definitions/accountSettingsInformation" } }, "400": { @@ -12957,21 +13556,18 @@ } }, "deprecated": false, - "x-ds-methodname": "createTemplate", - "x-ds-method": "create", - "x-ds-service": "Templates", + "x-ds-methodname": "listSettings", + "x-ds-method": "listSettings", + "x-ds-service": "Accounts", "x-ds-in-sdk": true }, - "parameters": [] - }, - "/v2.1/accounts/{accountId}/templates/{templateId}": { - "get": { + "put": { "tags": [ - "Templates" + "Accounts" ], - "summary": "Gets a specific template associated with a specified account.", - "description": "Retrieves the definition of the specified template.", - "operationId": "Templates_GetTemplate", + "summary": "Updates the account settings for an account.", + "description": "Updates the account settings for the specified account.", + "operationId": "Settings_PutSettings", "consumes": [], "produces": [], "parameters": [ @@ -12983,26 +13579,18 @@ "type": "string" }, { - "name": "templateId", - "in": "path", - "description": "The ID of the template.", - "required": true, - "type": "string" - }, - { - "name": "include", - "in": "query", - "required": false, - "type": "string", - "description": "A comma-separated list of additional template attributes to include in the response. Valid values are:\n\n- `recipients`\n- `folders`\n- `documents`\n- `custom_fields`\n- `notifications`\n- `powerforms`" + "name": "accountSettingsInformation", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/accountSettingsInformation" + }, + "description": "" } ], "responses": { "200": { - "description": "Successful response.", - "schema": { - "$ref": "#/definitions/Templates" - } + "description": "Successful response." }, "400": { "description": "Error encountered.", @@ -13012,18 +13600,20 @@ } }, "deprecated": false, - "x-ds-methodname": "get", - "x-ds-method": "get", - "x-ds-service": "Templates", + "x-ds-methodname": "updateSettings", + "x-ds-method": "updateSettings", + "x-ds-service": "Accounts", "x-ds-in-sdk": true }, - "put": { + "parameters": [] + }, + "/v2.1/accounts/{accountId}/settings/bcc_email_archives": { + "get": { "tags": [ - "Templates" + "BCCEmailArchive" ], - "summary": "Updates an existing template.", - "description": "Updates an existing template.", - "operationId": "Templates_PutTemplate", + "summary": "Gets the BCC email archive configurations for an account.", + "operationId": "BCCEmailArchive_GetBCCEmailArchiveList", "consumes": [], "produces": [], "parameters": [ @@ -13035,27 +13625,25 @@ "type": "string" }, { - "name": "templateId", - "in": "path", - "description": "The ID of the template.", - "required": true, - "type": "string" + "name": "count", + "in": "query", + "required": false, + "type": "string", + "description": "(Optional) The maximum number of results to return." }, { - "name": "Templates", - "in": "body", + "name": "start_position", + "in": "query", "required": false, - "schema": { - "$ref": "#/definitions/Templates" - }, - "description": "" + "type": "string", + "description": "(Optional) The index position within the total result set from which to start returning values. The default value is `0`." } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/templateUpdateSummary" + "$ref": "#/definitions/bccEmailArchiveList" } }, "400": { @@ -13066,21 +13654,18 @@ } }, "deprecated": false, - "x-ds-methodname": "update", - "x-ds-method": "update", - "x-ds-service": "Templates", + "x-ds-methodname": "list", + "x-ds-method": "list", + "x-ds-service": "Uncategorized", + "description": "This method retrieves all of the BCC email archive configurations associated with an account.", "x-ds-in-sdk": true }, - "parameters": [] - }, - "/v2.1/accounts/{accountId}/templates/{templateId}/{templatePart}": { - "put": { + "post": { "tags": [ - "Templates" + "BCCEmailArchive" ], - "summary": "Shares a template with a group", - "description": "Shares a template with the specified members group.", - "operationId": "Templates_PutTemplatePart", + "summary": "Creates a BCC email archive configuration.", + "operationId": "BCCEmailArchive_PostBCCEmailArchive", "consumes": [], "produces": [], "parameters": [ @@ -13092,34 +13677,20 @@ "type": "string" }, { - "name": "templateId", - "in": "path", - "description": "The ID of the template.", - "required": true, - "type": "string" - }, - { - "name": "templatePart", - "in": "path", - "description": "Currently, the only defined part is **groups**.", - "required": true, - "type": "string" - }, - { - "name": "Groups", + "name": "bccEmailArchive", "in": "body", "required": false, "schema": { - "$ref": "#/definitions/Groups" + "$ref": "#/definitions/bccEmailArchive" }, - "description": "" + "description": "Boolean that specifies whether BCC for Email Archive is enabled for the account. BCC for Email Archive allows you to set up an archive email address so that a BCC copy of an envelope is sent only to that address." } ], "responses": { - "200": { + "201": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/Groups" + "$ref": "#/definitions/bccEmailArchive" } }, "400": { @@ -13130,18 +13701,21 @@ } }, "deprecated": false, - "x-ds-methodname": "updateGroupShare", - "x-ds-method": "updateGroupShare", - "x-ds-service": "Templates", + "x-ds-methodname": "create", + "x-ds-method": "create", + "x-ds-service": "Uncategorized", + "description": "This method creates a BCC email archive configuration for an account (adds a BCC email address to the account for archiving the emails that DocuSign generates).\n\nThe only property that you must set in the request body is the BCC email address that you want to use.\n\n**Note**: An account can have up to five active and pending email archive addresses combined, but you must use this method to add them to the account one at a time. Each email address is considered a separate BCC email archive configuration.\n", "x-ds-in-sdk": true }, - "delete": { + "parameters": [] + }, + "/v2.1/accounts/{accountId}/settings/bcc_email_archives/{bccEmailArchiveId}": { + "get": { "tags": [ - "Templates" + "BCCEmailArchive" ], - "summary": "Removes a member group's sharing permissions for a template.", - "description": "Removes a member group's sharing permissions for a specified template.", - "operationId": "Templates_DeleteTemplatePart", + "summary": "Gets a BCC email archive configuration and its history.", + "operationId": "BCCEmailArchive_GetBCCEmailArchiveHistoryList", "consumes": [], "produces": [], "parameters": [ @@ -13153,34 +13727,32 @@ "type": "string" }, { - "name": "templateId", + "name": "bccEmailArchiveId", "in": "path", - "description": "The ID of the template.", "required": true, - "type": "string" + "type": "string", + "description": "The id of the BCC email archive configuration." }, { - "name": "templatePart", - "in": "path", - "description": "Currently, the only defined part is **groups**.", - "required": true, - "type": "string" + "name": "count", + "in": "query", + "required": false, + "type": "string", + "description": "(Optional) The maximum number of results (changes) to return." }, { - "name": "Groups", - "in": "body", + "name": "start_position", + "in": "query", "required": false, - "schema": { - "$ref": "#/definitions/Groups" - }, - "description": "" + "type": "string", + "description": "(Optional) The index position within the total result set from which to start returning values. The default value is `0`." } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/Groups" + "$ref": "#/definitions/bccEmailArchiveHistoryList" } }, "400": { @@ -13191,21 +13763,18 @@ } }, "deprecated": false, - "x-ds-methodname": "deleteGroupShare", - "x-ds-method": "deleteGroupShare", - "x-ds-service": "Templates", + "x-ds-methodname": "get", + "x-ds-method": "get", + "x-ds-service": "Uncategorized", + "description": "This method returns a specific BCC email archive configuration for an account, as well as the history of changes to the email address.", "x-ds-in-sdk": true }, - "parameters": [] - }, - "/v2.1/accounts/{accountId}/templates/{templateId}/custom_fields": { - "get": { + "delete": { "tags": [ - "TemplateCustomFields" + "BCCEmailArchive" ], - "summary": "Gets the custom document fields from a template.", - "description": "Retrieves the custom document field information from an existing template.", - "operationId": "CustomFields_GetTemplateCustomFields", + "summary": "Deletes a BCC email archive configuration.", + "operationId": "BCCEmailArchive_DeleteBCCEmailArchive", "consumes": [], "produces": [], "parameters": [ @@ -13217,19 +13786,16 @@ "type": "string" }, { - "name": "templateId", + "name": "bccEmailArchiveId", "in": "path", - "description": "The ID of the template.", "required": true, - "type": "string" + "type": "string", + "description": "The id of the BCC email archive configuration." } ], "responses": { "200": { - "description": "Successful response.", - "schema": { - "$ref": "#/definitions/TemplateCustomFields" - } + "description": "Successful response." }, "400": { "description": "Error encountered.", @@ -13239,18 +13805,21 @@ } }, "deprecated": false, - "x-ds-methodname": "listCustomFields", - "x-ds-method": "list", - "x-ds-service": "Templates", + "x-ds-methodname": "delete", + "x-ds-method": "delete", + "x-ds-service": "Uncategorized", + "description": "This method deletes a BCC email archive configuration from an account.\n\nWhen you use this method, the status of the BCC email archive configuration switches to `closed` and the BCC email address is no longer used to archive DocuSign-generated email messages.\n", "x-ds-in-sdk": true }, - "put": { + "parameters": [] + }, + "/v2.1/accounts/{accountId}/settings/enote_configuration": { + "get": { "tags": [ - "TemplateCustomFields" + "ENoteConfigurations" ], - "summary": "Updates envelope custom fields in a template.", - "description": "Updates the custom fields in a template.\n\nEach custom field used in a template must have a unique name.", - "operationId": "CustomFields_PutTemplateCustomFields", + "summary": "Returns the configuration information for the eNote eOriginal integration.", + "operationId": "ENoteConfiguration_GetENoteConfiguration", "consumes": [], "produces": [], "parameters": [ @@ -13260,29 +13829,13 @@ "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" - }, - { - "name": "templateId", - "in": "path", - "description": "The ID of the template.", - "required": true, - "type": "string" - }, - { - "name": "templateCustomFields", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/templateCustomFields" - }, - "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/TemplateCustomFields" + "$ref": "#/definitions/eNoteConfiguration" } }, "400": { @@ -13293,18 +13846,19 @@ } }, "deprecated": false, - "x-ds-methodname": "updateCustomFields", - "x-ds-method": "update", - "x-ds-service": "Templates", + "x-ds-methodname": "getENoteConfiguration", + "x-ds-api-status": "beta", + "x-ds-method": "get", + "x-ds-service": "Accounts", + "description": "", "x-ds-in-sdk": true }, - "post": { + "put": { "tags": [ - "TemplateCustomFields" + "ENoteConfigurations" ], - "summary": "Creates custom document fields in an existing template document.", - "description": "Creates custom document fields in an existing template document.", - "operationId": "CustomFields_PostTemplateCustomFields", + "summary": "Updates configuration information for the eNote eOriginal integration.", + "operationId": "ENoteConfiguration_PutENoteConfiguration", "consumes": [], "produces": [], "parameters": [ @@ -13316,27 +13870,20 @@ "type": "string" }, { - "name": "templateId", - "in": "path", - "description": "The ID of the template.", - "required": true, - "type": "string" - }, - { - "name": "templateCustomFields", + "name": "eNoteConfiguration", "in": "body", "required": false, "schema": { - "$ref": "#/definitions/templateCustomFields" + "$ref": "#/definitions/eNoteConfiguration" }, "description": "" } ], "responses": { - "201": { + "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/TemplateCustomFields" + "$ref": "#/definitions/eNoteConfiguration" } }, "400": { @@ -13347,18 +13894,19 @@ } }, "deprecated": false, - "x-ds-methodname": "createCustomFields", - "x-ds-method": "create", - "x-ds-service": "Templates", + "x-ds-methodname": "updateENoteConfiguration", + "x-ds-api-status": "beta", + "x-ds-method": "update", + "x-ds-service": "Accounts", + "description": "", "x-ds-in-sdk": true }, "delete": { "tags": [ - "TemplateCustomFields" + "ENoteConfigurations" ], - "summary": "Deletes envelope custom fields in a template.", - "description": "Deletes envelope custom fields in a template.", - "operationId": "CustomFields_DeleteTemplateCustomFields", + "summary": "Deletes configuration information for the eNote eOriginal integration.", + "operationId": "ENoteConfiguration_DeleteENoteConfiguration", "consumes": [], "produces": [], "parameters": [ @@ -13368,30 +13916,11 @@ "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" - }, - { - "name": "templateId", - "in": "path", - "description": "The ID of the template.", - "required": true, - "type": "string" - }, - { - "name": "templateCustomFields", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/templateCustomFields" - }, - "description": "" } ], "responses": { "200": { - "description": "Successful response.", - "schema": { - "$ref": "#/definitions/TemplateCustomFields" - } + "description": "Successful response." }, "400": { "description": "Error encountered.", @@ -13401,21 +13930,22 @@ } }, "deprecated": false, - "x-ds-methodname": "deleteCustomFields", + "x-ds-methodname": "deleteENoteConfiguration", + "x-ds-api-status": "beta", "x-ds-method": "delete", - "x-ds-service": "Templates", + "x-ds-service": "Accounts", + "description": "", "x-ds-in-sdk": true }, "parameters": [] }, - "/v2.1/accounts/{accountId}/templates/{templateId}/documents": { + "/v2.1/accounts/{accountId}/settings/envelope_purge_configuration": { "get": { "tags": [ - "TemplateDocuments" + "Accounts" ], - "summary": "Gets a list of documents associated with a template.", - "description": "Retrieves a list of documents associated with the specified template.", - "operationId": "Documents_GetTemplateDocuments", + "summary": "Gets the envelope purge configuration for an account.", + "operationId": "EnvelopePurgeConfiguration_GetEnvelopePurgeConfiguration", "consumes": [], "produces": [], "parameters": [ @@ -13425,27 +13955,13 @@ "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" - }, - { - "name": "templateId", - "in": "path", - "description": "The ID of the template.", - "required": true, - "type": "string" - }, - { - "name": "include_tabs", - "in": "query", - "required": false, - "type": "string", - "description": "Reserved for DocuSign." } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/TemplateDocuments" + "$ref": "#/definitions/envelopePurgeConfiguration" } }, "400": { @@ -13456,18 +13972,19 @@ } }, "deprecated": false, - "x-ds-methodname": "listDocuments", - "x-ds-method": "list", - "x-ds-service": "Templates", + "x-ds-methodname": "getEnvelopePurgeConfiguration", + "x-ds-api-status": "beta", + "x-ds-method": "getEnvelopePurgeConfiguration", + "x-ds-service": "Uncategorized", + "description": "An envelope purge configuration enables account administrators to permanently remove documents and their field data from completed and voided envelopes after a specified retention period (`retentionDays`). This method retrieves the current envelope purge configuration for your account.\n\n**Note**: To use this method, you must be an account administrator.", "x-ds-in-sdk": true }, "put": { "tags": [ - "TemplateDocuments" + "Accounts" ], - "summary": "Adds documents to a template document.", - "description": "Adds one or more documents to an existing template document.", - "operationId": "Documents_PutTemplateDocuments", + "summary": "Sets the envelope purge configuration for an account.", + "operationId": "EnvelopePurgeConfiguration_PutEnvelopePurgeConfiguration", "consumes": [], "produces": [], "parameters": [ @@ -13479,18 +13996,11 @@ "type": "string" }, { - "name": "templateId", - "in": "path", - "description": "The ID of the template.", - "required": true, - "type": "string" - }, - { - "name": "envelopeDefinition", + "name": "envelopePurgeConfiguration", "in": "body", "required": false, "schema": { - "$ref": "#/definitions/envelopeDefinition" + "$ref": "#/definitions/envelopePurgeConfiguration" }, "description": "" } @@ -13499,7 +14009,7 @@ "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/TemplateDocuments" + "$ref": "#/definitions/envelopePurgeConfiguration" } }, "400": { @@ -13510,18 +14020,22 @@ } }, "deprecated": false, - "x-ds-methodname": "updateDocuments", - "x-ds-method": "updateList", - "x-ds-service": "Templates", + "x-ds-methodname": "updateEnvelopePurgeConfiguration", + "x-ds-api-status": "beta", + "x-ds-method": "updateEnvelopePurgeConfiguration", + "x-ds-service": "Uncategorized", + "description": "An envelope purge configuration enables account administrators to permanently remove documents and their field data from completed and voided envelopes after a specified retention period (`retentionDays`). This method sets the envelope purge configuration for your account.\n\n**Note**: To use this method, you must be an account administrator.\n\nFor more information, see [Purge Envelopes](https://support.docusign.com/en/guides/ndse-user-guide-purge-envelopes).", "x-ds-in-sdk": true }, - "delete": { + "parameters": [] + }, + "/v2.1/accounts/{accountId}/settings/notification_defaults": { + "get": { "tags": [ - "TemplateDocuments" + "Accounts" ], - "summary": "Deletes documents from a template.", - "description": "Deletes one or more documents from an existing template.\n\nTo delete a document, use only the relevant parts of the [`envelopeDefinition`](#envelopeDefinition).\nFor example, this request body specifies that you want to delete the document whose `documentId` is \"1\".\n\n\n```text\n{\n \"documents\": [\n {\n \"documentId\": \"1\"\n }\n ]\n}\n```", - "operationId": "Documents_DeleteTemplateDocuments", + "summary": "Gets envelope notification defaults.", + "operationId": "NotificationDefaults_GetNotificationDefaults", "consumes": [], "produces": [], "parameters": [ @@ -13531,20 +14045,51 @@ "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/notificationDefaults" + } }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "getNotificationDefaults", + "x-ds-method": "getNotificationDefaults", + "x-ds-service": "Uncategorized", + "description": "This method returns the default settings for the email notifications that signers and senders receive about envelopes.", + "x-ds-in-sdk": true + }, + "put": { + "tags": [ + "Accounts" + ], + "summary": "Updates envelope notification default settings.", + "operationId": "NotificationDefaults_PutNotificationDefaults", + "consumes": [], + "produces": [], + "parameters": [ { - "name": "templateId", + "name": "accountId", "in": "path", - "description": "The ID of the template.", + "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { - "name": "envelopeDefinition", + "name": "notificationDefaults", "in": "body", "required": false, "schema": { - "$ref": "#/definitions/envelopeDefinition" + "$ref": "#/definitions/notificationDefaults" }, "description": "" } @@ -13553,7 +14098,7 @@ "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/TemplateDocuments" + "$ref": "#/definitions/notificationDefaults" } }, "400": { @@ -13564,25 +14109,23 @@ } }, "deprecated": false, - "x-ds-methodname": "deleteDocuments", - "x-ds-method": "delete", - "x-ds-service": "Templates", + "x-ds-methodname": "updateNotificationDefaults", + "x-ds-method": "updateNotificationDefaults", + "x-ds-service": "Uncategorized", + "description": "This method changes the default settings for the email notifications that signers and senders receive about envelopes.", "x-ds-in-sdk": true }, "parameters": [] }, - "/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}": { + "/v2.1/accounts/{accountId}/settings/password_rules": { "get": { "tags": [ - "TemplateDocuments" + "AccountPasswordRules" ], - "summary": "Gets PDF documents from a template.", - "description": "Retrieves one or more PDF documents from the specified template.\n\nYou can specify the ID of the document to retrieve or can specify `combined` to retrieve all documents in the template as one pdf.", - "operationId": "Documents_GetTemplateDocument", + "summary": "Gets the password rules for an account.", + "operationId": "AccountPasswordRules_GetAccountPasswordRules", "consumes": [], - "produces": [ - "application/pdf" - ], + "produces": [], "parameters": [ { "name": "accountId", @@ -13590,41 +14133,13 @@ "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" - }, - { - "name": "documentId", - "in": "path", - "description": "Integer that identifies the document in the envelope.", - "required": true, - "type": "string" - }, - { - "name": "templateId", - "in": "path", - "description": "The ID of the template.", - "required": true, - "type": "string" - }, - { - "name": "encrypt", - "in": "query", - "required": false, - "type": "string", - "description": "" - }, - { - "name": "show_changes", - "in": "query", - "required": false, - "type": "string", - "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { - "type": "file" + "$ref": "#/definitions/accountPasswordRules" } }, "400": { @@ -13635,18 +14150,18 @@ } }, "deprecated": false, - "x-ds-methodname": "getDocument", + "x-ds-methodname": "getAccountPasswordRules", "x-ds-method": "get", - "x-ds-service": "Templates", + "x-ds-service": "Accounts", + "description": "This method retrieves the password rules for an account.", "x-ds-in-sdk": true }, "put": { "tags": [ - "TemplateDocuments" + "AccountPasswordRules" ], - "summary": "Adds a document to a template document.", - "description": "Adds the specified document to an existing template document.", - "operationId": "Documents_PutTemplateDocument", + "summary": "Updates the password rules for an account.", + "operationId": "AccountPasswordRules_PutAccountPasswordRules", "consumes": [], "produces": [], "parameters": [ @@ -13658,32 +14173,11 @@ "type": "string" }, { - "name": "documentId", - "in": "path", - "description": "Integer that identifies the document in the envelope.", - "required": true, - "type": "string" - }, - { - "name": "templateId", - "in": "path", - "description": "The ID of the template.", - "required": true, - "type": "string" - }, - { - "name": "is_envelope_definition", - "in": "query", - "required": false, - "type": "string", - "description": "" - }, - { - "name": "envelopeDefinition", + "name": "accountPasswordRules", "in": "body", "required": false, "schema": { - "$ref": "#/definitions/envelopeDefinition" + "$ref": "#/definitions/accountPasswordRules" }, "description": "" } @@ -13692,7 +14186,7 @@ "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/envelopeDocument" + "$ref": "#/definitions/accountPasswordRules" } }, "400": { @@ -13703,21 +14197,21 @@ } }, "deprecated": false, - "x-ds-methodname": "updateDocument", + "x-ds-methodname": "updateAccountPasswordRules", "x-ds-method": "update", - "x-ds-service": "Templates", + "x-ds-service": "Accounts", + "description": "This method updates the password rules for an account.\n\n**Note**: To update the password rules for an account, you must be an account administrator.", "x-ds-in-sdk": true }, "parameters": [] }, - "/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/fields": { + "/v2.1/accounts/{accountId}/settings/tabs": { "get": { "tags": [ - "TemplateDocumentFields" + "AccountTabSettings" ], - "summary": "Gets the custom document fields for a an existing template document.", - "description": "This method retrieves the custom document fields for an existing template document.", - "operationId": "DocumentFields_GetTemplateDocumentFields", + "summary": "Returns tab settings list for specified account", + "operationId": "TabSettings_GetTabSettings", "consumes": [], "produces": [], "parameters": [ @@ -13727,27 +14221,13 @@ "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" - }, - { - "name": "documentId", - "in": "path", - "description": "Integer that identifies the document in the envelope.", - "required": true, - "type": "string" - }, - { - "name": "templateId", - "in": "path", - "description": "The ID of the template.", - "required": true, - "type": "string" } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/TemplateDocumentFields" + "$ref": "#/definitions/tabAccountSettings" } }, "400": { @@ -13758,18 +14238,18 @@ } }, "deprecated": false, - "x-ds-methodname": "listDocumentFields", - "x-ds-method": "list", - "x-ds-service": "Templates", + "x-ds-methodname": "getAccountTabSettings", + "x-ds-method": "get", + "x-ds-service": "Accounts", + "description": "This method returns information about the tab types and tab functionality that is currently enabled for an account.", "x-ds-in-sdk": true }, "put": { "tags": [ - "TemplateDocumentFields" + "AccountTabSettings" ], - "summary": "Updates existing custom document fields in an existing template document.", - "description": "Updates existing custom document fields in an existing template document.", - "operationId": "DocumentFields_PutTemplateDocumentFields", + "summary": "Modifies tab settings for specified account", + "operationId": "TabSettings_PutSettings", "consumes": [], "produces": [], "parameters": [ @@ -13781,34 +14261,20 @@ "type": "string" }, { - "name": "documentId", - "in": "path", - "description": "Integer that identifies the document in the envelope.", - "required": true, - "type": "string" - }, - { - "name": "templateId", - "in": "path", - "description": "The ID of the template.", - "required": true, - "type": "string" - }, - { - "name": "TemplateDocumentFields", + "name": "tabAccountSettings", "in": "body", "required": false, "schema": { - "$ref": "#/definitions/TemplateDocumentFields" + "$ref": "#/definitions/tabAccountSettings" }, - "description": "" + "description": "Account-wide tab settings." } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/TemplateDocumentFields" + "$ref": "#/definitions/tabAccountSettings" } }, "400": { @@ -13819,18 +14285,22 @@ } }, "deprecated": false, - "x-ds-methodname": "updateDocumentFields", + "x-ds-methodname": "updateAccountTabSettings", "x-ds-method": "update", - "x-ds-service": "Templates", + "x-ds-service": "Accounts", + "description": "This method modifies the tab types and tab functionality that is enabled for an account.", "x-ds-in-sdk": true }, - "post": { + "parameters": [] + }, + "/v2.1/accounts/{accountId}/shared_access": { + "get": { "tags": [ - "TemplateDocumentFields" + "Accounts" ], - "summary": "Creates custom document fields in an existing template document.", - "description": "Creates custom document fields in an existing template document.", - "operationId": "DocumentFields_PostTemplateDocumentFields", + "summary": "Reserved: Gets the shared item status for one or more users.", + "description": "Retrieves shared item status for one or more users and types of items.\n\nUsers with account administration privileges can retrieve shared access information for all account users. Users without account administrator privileges can only retrieve shared access information for themselves, and the returned information is limited to retrieving the status of the members of the account that are sharing their folders to the user. This is equivalent to setting the `shared` parameter to `shared_from`.", + "operationId": "SharedAccess_GetSharedAccess", "consumes": [], "produces": [], "parameters": [ @@ -13842,56 +14312,89 @@ "type": "string" }, { - "name": "documentId", - "in": "path", - "description": "Integer that identifies the document in the envelope.", - "required": true, + "name": "count", + "in": "query", + "description": "Specifies the maximum number of results included in the response. If no value is specified, this defaults to 1000.", + "required": false, "type": "string" }, { - "name": "templateId", - "in": "path", - "description": "The ID of the template.", - "required": true, + "name": "envelopes_not_shared_user_status", + "in": "query", + "required": false, + "type": "string", + "description": "This query parameter works in conjunction with `user_ids`. When you specify one of the following user statuses, the query limits the results to only users that match the specified status:\n- `ActivationRequired`: Membership Activation required\n- `ActivationSent`: Membership activation sent to user\n- `Active`: User Membership is active\n- `Closed`: User Membership is closed\n- `Disabled`: User Membership is disabled" + }, + { + "name": "folder_ids", + "in": "query", + "required": false, + "type": "string", + "description": "A comma-separated list of folder IDs for which to return shared item information. If `item_type` is set to `folders`, at least one folder ID is required." + }, + { + "name": "item_type", + "in": "query", + "description": "Specifies the type of shared item being requested. The possible values are:\n\n- `envelopes`: Get information about envelope sharing between users.\n- `templates`: Get information about template sharing among users and groups.\n- `folders`: Get information about folder sharing among users and groups.\n", + "required": false, "type": "string" }, { - "name": "TemplateDocumentFields", - "in": "body", + "name": "search_text", + "in": "query", + "description": "Filter user names based on the specified string. The wild-card '*' (asterisk) can be used in the string.", "required": false, - "schema": { - "$ref": "#/definitions/TemplateDocumentFields" - }, - "description": "" - } - ], - "responses": { - "201": { - "description": "Successful response.", - "schema": { - "$ref": "#/definitions/TemplateDocumentFields" - } + "type": "string" }, - "400": { - "description": "Error encountered.", - "schema": { - "$ref": "#/definitions/errorDetails" - } + { + "name": "shared", + "in": "query", + "description": "A comma-separated list of sharing filters that specifies which users appear in the response. \n\n- `not_shared`: The response lists users who do not share items of `item_type` with the current user.\n\n- `shared_to`: The response lists users in `user_list` who are sharing items to current user.\n\n- `shared_from`: The response lists users in `user_list` who are sharing items from the current user.\n\n- `shared_to_and_from`: The response lists users in `user_list` who are sharing items to and from the current user.\n\nIf the current user does not have administrative privileges, only the `shared_to` option is valid.", + "required": false, + "type": "string" + }, + { + "name": "start_position", + "in": "query", + "description": "If the number of responses is greater than `count`, this specifies the number of responses to skip. Typically this value is a multiple of `count`. The default is 0.", + "required": false, + "type": "string" + }, + { + "name": "user_ids", + "in": "query", + "description": "A comma-separated list of user IDs for whom the shared item information is being requested.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/accountSharedAccess" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } } }, "deprecated": false, - "x-ds-methodname": "createDocumentFields", - "x-ds-method": "create", - "x-ds-service": "Templates", + "x-ds-methodname": "listSharedAccess", + "x-ds-method": "listSharedAccess", + "x-ds-service": "Accounts", "x-ds-in-sdk": true }, - "delete": { + "put": { "tags": [ - "TemplateDocumentFields" + "Accounts" ], - "summary": "Deletes custom document fields from an existing template document.", - "description": "Deletes custom document fields from an existing template document.", - "operationId": "DocumentFields_DeleteTemplateDocumentFields", + "summary": "Reserved: Sets the shared access information for users.", + "description": "This sets the shared access status for one or more users or templates.\n\nWhen setting user shared access, only users with account administration privileges can set shared access status for envelopes.\n\nWhen setting template shared access, only users who own a template and have sharing permission or with account administration privileges can set shared access for templates.\n\nChanges to the shared items status are not additive. The change always replaces the current status.\n\nTo change template shared access, add the query parameter `item_type` = `templates` to the request. When this is set, the user and envelopes properties are not required.\n\n**Note**: This functionality is a newer version of the [Update Group Share](https://developers.docusign.com/docs/esign-rest-api/reference/Templates/Templates/updateGroupShare) functionality.\n\n", + "operationId": "SharedAccess_PutSharedAccess", "consumes": [], "produces": [], "parameters": [ @@ -13903,25 +14406,32 @@ "type": "string" }, { - "name": "documentId", - "in": "path", - "description": "Integer that identifies the document in the envelope.", - "required": true, - "type": "string" + "name": "item_type", + "in": "query", + "required": false, + "type": "string", + "description": "Specifies the type of shared item being set:\n- `envelopes`: Set envelope sharing between users.\n- `templates`: Set information about template sharing among users and groups.\n- `folders`: Get information about folder sharing among users and groups.\n" }, { - "name": "templateId", - "in": "path", - "description": "The ID of the template.", - "required": true, - "type": "string" + "name": "preserve_existing_shared_access", + "in": "query", + "required": false, + "type": "string", + "description": "When **true**, preserve the existing shared access settings." + }, + { + "name": "user_ids", + "in": "query", + "required": false, + "type": "string", + "description": "A comma-separated list of IDs for users whose shared item access is being set." }, { - "name": "TemplateDocumentFields", + "name": "accountSharedAccess", "in": "body", "required": false, "schema": { - "$ref": "#/definitions/TemplateDocumentFields" + "$ref": "#/definitions/accountSharedAccess" }, "description": "" } @@ -13930,7 +14440,7 @@ "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/TemplateDocumentFields" + "$ref": "#/definitions/accountSharedAccess" } }, "400": { @@ -13941,20 +14451,20 @@ } }, "deprecated": false, - "x-ds-methodname": "deleteDocumentFields", - "x-ds-method": "delete", - "x-ds-service": "Templates", + "x-ds-methodname": "updateSharedAccess", + "x-ds-method": "updateSharedAccess", + "x-ds-service": "Accounts", "x-ds-in-sdk": true }, "parameters": [] }, - "/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/html_definitions": { + "/v2.1/accounts/{accountId}/signatureProviders": { "get": { "tags": [ - "TemplateDocumentHtmlDefinitions" + "AccountSignatureProviders" ], - "summary": "", - "operationId": "ResponsiveHtml_GetTemplateDocumentHtmlDefinitions", + "summary": "Gets the available signature providers for an account.", + "operationId": "AccountSignatureProviders_GetSignatureProviders", "consumes": [], "produces": [], "parameters": [ @@ -13964,27 +14474,13 @@ "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" - }, - { - "name": "documentId", - "in": "path", - "description": "Integer that identifies the document in the envelope.", - "required": true, - "type": "string" - }, - { - "name": "templateId", - "in": "path", - "description": "The ID of the template.", - "required": true, - "type": "string" } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/EnvelopeDocumentHtmlDefinitions" + "$ref": "#/definitions/accountSignatureProviders" } }, "400": { @@ -13995,100 +14491,58 @@ } }, "deprecated": false, - "x-ds-methodname": "getTemplateDocumentHtmlDefinitions", + "x-ds-methodname": "listSignatureProviders", "x-ds-method": "list", - "x-ds-service": "Uncategorized", - "description": "", + "x-ds-service": "Accounts", + "description": "Returns a list of signature providers that the specified account can use.", "x-ds-in-sdk": true }, "parameters": [] }, - "/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages": { + "/v2.1/accounts/{accountId}/signatures": { "get": { "tags": [ - "Templates" + "AccountSignatures" ], - "summary": "Returns document page image(s) based on input.", - "operationId": "Pages_GetTemplatePageImages", + "summary": "Returns the managed signature definitions for the account", + "operationId": "AccountSignatures_GetAccountSignatures", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", - "description": "(Required) The external account number (int) or account ID GUID.", - "required": true, - "type": "string" - }, - { - "name": "documentId", - "in": "path", - "description": "(Required) The ID of the document.", - "required": true, - "type": "string" - }, - { - "name": "templateId", - "in": "path", - "description": "(Required) The ID of the template.", + "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { - "name": "count", - "in": "query", - "required": false, - "type": "string", - "description": "The maximum number of results to return." - }, - { - "name": "dpi", - "in": "query", - "required": false, - "type": "string", - "description": "The number of dots per inch (DPI) for the resulting images. Valid values are 1-310 DPI. The default value is 94." - }, - { - "name": "max_height", - "in": "query", - "required": false, - "type": "string", - "description": "Sets the maximum height of the returned images in pixels." - }, - { - "name": "max_width", - "in": "query", - "required": false, - "type": "string", - "description": "Sets the maximum width of the returned images in pixels." - }, - { - "name": "nocache", + "name": "stamp_format", "in": "query", "required": false, "type": "string", - "description": "If **true**, using cache is disabled and image information is retrieved from a database. **True** is the default value. " + "description": "" }, { - "name": "show_changes", + "name": "stamp_name", "in": "query", "required": false, "type": "string", - "description": "If **true**, changes display in the user interface." + "description": "" }, { - "name": "start_position", + "name": "stamp_type", "in": "query", "required": false, "type": "string", - "description": "The position within the total result set from which to start returning values. The value **thumbnail** may be used to return the page image." + "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/pageImages" + "$ref": "#/definitions/accountSignaturesInformation" } }, "400": { @@ -14099,22 +14553,18 @@ } }, "deprecated": false, - "x-ds-methodname": "getDocumentPageImages", - "x-ds-method": "getPageImages", - "x-ds-service": "Templates", - "description": "Returns images of the pages in a template document for display based on the parameters that you specify.", + "x-ds-methodname": "getAccountSignatures", + "x-ds-method": "getAccountSignatures", + "x-ds-service": "Uncategorized", + "description": "", "x-ds-in-sdk": true }, - "parameters": [] - }, - "/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages/{pageNumber}": { - "delete": { + "put": { "tags": [ - "Templates" + "AccountSignatures" ], - "summary": "Deletes a page from a document in an template.", - "description": "Deletes a page from a document in a template based on the page number.", - "operationId": "Pages_DeleteTemplatePage", + "summary": "Updates an account signature.\n", + "operationId": "AccountSignatures_PutAccountSignature", "consumes": [], "produces": [], "parameters": [ @@ -14126,39 +14576,21 @@ "type": "string" }, { - "name": "documentId", - "in": "path", - "description": "Integer that identifies the document in the envelope.", - "required": true, - "type": "string" - }, - { - "name": "pageNumber", - "in": "path", - "description": "The page number being accessed.", - "required": true, - "type": "string" - }, - { - "name": "templateId", - "in": "path", - "description": "The ID of the template.", - "required": true, - "type": "string" - }, - { - "name": "pageRequest", + "name": "accountSignaturesInformation", "in": "body", "required": false, "schema": { - "$ref": "#/definitions/pageRequest" + "$ref": "#/definitions/accountSignaturesInformation" }, "description": "" } ], "responses": { "200": { - "description": "Successful response." + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/accountSignaturesInformation" + } }, "400": { "description": "Error encountered.", @@ -14168,25 +14600,20 @@ } }, "deprecated": false, - "x-ds-methodname": "deleteDocumentPage", - "x-ds-method": "deleteDocumentPage", - "x-ds-service": "Templates", + "x-ds-methodname": "updateAccountSignature", + "x-ds-method": "updateAccountSignature", + "x-ds-service": "Uncategorized", + "description": "", "x-ds-in-sdk": true }, - "parameters": [] - }, - "/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages/{pageNumber}/page_image": { - "get": { + "post": { "tags": [ - "Templates" + "AccountSignatures" ], - "summary": "Gets a page image from a template for display.", - "description": "Retrieves a page image for display from the specified template.", - "operationId": "Pages_GetTemplatePageImage", + "summary": "Adds or updates one or more account signatures.\nThis request may include images in multi-part format.", + "operationId": "AccountSignatures_PostAccountSignatures", "consumes": [], - "produces": [ - "image/png" - ], + "produces": [], "parameters": [ { "name": "accountId", @@ -14196,60 +14623,27 @@ "type": "string" }, { - "name": "documentId", - "in": "path", - "description": "Integer that identifies the document in the envelope.", - "required": true, - "type": "string" - }, - { - "name": "pageNumber", - "in": "path", - "description": "The page number being accessed.", - "required": true, - "type": "string" - }, - { - "name": "templateId", - "in": "path", - "description": "The ID of the template.", - "required": true, - "type": "string" - }, - { - "name": "dpi", - "in": "query", - "required": false, - "type": "string", - "description": "The number of dots per inch (DPI) for the resulting images. Valid values are 1-310 DPI. The default value is 94." - }, - { - "name": "max_height", - "in": "query", - "required": false, - "type": "string", - "description": "Sets the maximum height of the returned images in pixels." - }, - { - "name": "max_width", + "name": "decode_only", "in": "query", "required": false, "type": "string", - "description": "Sets the maximum width of the returned images in pixels." + "description": "" }, { - "name": "show_changes", - "in": "query", + "name": "accountSignaturesInformation", + "in": "body", "required": false, - "type": "string", + "schema": { + "$ref": "#/definitions/accountSignaturesInformation" + }, "description": "" } ], "responses": { - "200": { + "201": { "description": "Successful response.", "schema": { - "type": "file" + "$ref": "#/definitions/accountSignaturesInformation" } }, "400": { @@ -14260,18 +14654,21 @@ } }, "deprecated": false, - "x-ds-methodname": "getDocumentPageImage", - "x-ds-method": "getDocumentPageImage", - "x-ds-service": "Templates", + "x-ds-methodname": "createAccountSignatures", + "x-ds-method": "createAccountSignatures", + "x-ds-service": "Uncategorized", + "description": "", "x-ds-in-sdk": true }, - "put": { + "parameters": [] + }, + "/v2.1/accounts/{accountId}/signatures/{signatureId}": { + "get": { "tags": [ - "Templates" + "AccountSignatures" ], - "summary": "Rotates page image from a template for display.", - "description": "Rotates page image from a template for display. The page image can be rotated to the left or right.", - "operationId": "Pages_PutTemplatePageImage", + "summary": "Returns information about the specified signature.", + "operationId": "AccountSignatures_GetAccountSignature", "consumes": [], "produces": [], "parameters": [ @@ -14283,39 +14680,19 @@ "type": "string" }, { - "name": "documentId", - "in": "path", - "description": "Integer that identifies the document in the envelope.", - "required": true, - "type": "string" - }, - { - "name": "pageNumber", - "in": "path", - "description": "The page number being accessed.", - "required": true, - "type": "string" - }, - { - "name": "templateId", + "name": "signatureId", "in": "path", - "description": "The ID of the template.", + "description": "The ID of the signature being accessed.", "required": true, "type": "string" - }, - { - "name": "pageRequest", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/pageRequest" - }, - "description": "" } ], "responses": { "200": { - "description": "Successful response." + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/accountSignature" + } }, "400": { "description": "Error encountered.", @@ -14325,20 +14702,18 @@ } }, "deprecated": false, - "x-ds-methodname": "rotateDocumentPage", - "x-ds-method": "rotateDocumentPage", - "x-ds-service": "Templates", + "x-ds-methodname": "getAccountSignature", + "x-ds-method": "getAccountSignature", + "x-ds-service": "Uncategorized", + "description": "", "x-ds-in-sdk": true }, - "parameters": [] - }, - "/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages/{pageNumber}/tabs": { - "get": { + "put": { "tags": [ - "TemplateDocumentTabs" + "AccountSignatures" ], - "summary": "Returns tabs on the specified page.", - "operationId": "Tabs_GetTemplatePageTabs", + "summary": "Updates an account signature.", + "operationId": "AccountSignatures_PutAccountSignatureById", "consumes": [], "produces": [], "parameters": [ @@ -14350,32 +14725,34 @@ "type": "string" }, { - "name": "documentId", + "name": "signatureId", "in": "path", - "description": "Integer that identifies the document in the envelope.", + "description": "The ID of the signature being accessed.", "required": true, "type": "string" }, { - "name": "pageNumber", - "in": "path", - "description": "The page number being accessed.", - "required": true, - "type": "string" + "name": "close_existing_signature", + "in": "query", + "required": false, + "type": "string", + "description": "When set to **true**, closes the current signature." }, { - "name": "templateId", - "in": "path", - "description": "The ID of the template.", - "required": true, - "type": "string" + "name": "accountSignatureDefinition", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/accountSignatureDefinition" + }, + "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/TemplateDocumentTabs" + "$ref": "#/definitions/accountSignature" } }, "400": { @@ -14386,21 +14763,18 @@ } }, "deprecated": false, - "x-ds-methodname": "getPageTabs", - "x-ds-method": "getByPage", - "x-ds-service": "Templates", + "x-ds-methodname": "updateAccountSignatureById", + "x-ds-method": "updateAccountSignatureById", + "x-ds-service": "Uncategorized", "description": "", "x-ds-in-sdk": true }, - "parameters": [] - }, - "/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/responsive_html_preview": { - "post": { + "delete": { "tags": [ - "TemplateDocumentResponsiveHtmlPreview" + "AccountSignatures" ], - "summary": "", - "operationId": "ResponsiveHtml_PostTemplateDocumentResponsiveHtmlPreview", + "summary": "Close the specified signature by ID.", + "operationId": "AccountSignatures_DeleteAccountSignature", "consumes": [], "produces": [], "parameters": [ @@ -14412,35 +14786,16 @@ "type": "string" }, { - "name": "documentId", - "in": "path", - "description": "Integer that identifies the document in the envelope.", - "required": true, - "type": "string" - }, - { - "name": "templateId", + "name": "signatureId", "in": "path", - "description": "The ID of the template.", + "description": "The ID of the signature being accessed.", "required": true, "type": "string" - }, - { - "name": "documentHtmlDefinition", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/documentHtmlDefinition" - }, - "description": "" } ], "responses": { - "201": { - "description": "Successful response.", - "schema": { - "$ref": "#/definitions/DocumentResponsiveHtmlPreview" - } + "200": { + "description": "Successful response." }, "400": { "description": "Error encountered.", @@ -14450,23 +14805,25 @@ } }, "deprecated": false, - "x-ds-methodname": "createTemplateDocumentResponsiveHtmlPreview", - "x-ds-method": "create", + "x-ds-methodname": "deleteAccountSignature", + "x-ds-method": "deleteAccountSignature", "x-ds-service": "Uncategorized", "description": "", "x-ds-in-sdk": true }, "parameters": [] }, - "/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/tabs": { + "/v2.1/accounts/{accountId}/signatures/{signatureId}/{imageType}": { "get": { "tags": [ - "TemplateDocumentTabs" + "AccountSignatures" ], - "summary": "Returns tabs on the document.", - "operationId": "Tabs_GetTemplateDocumentTabs", + "summary": "Returns a signature image, initials, or stamp.", + "operationId": "AccountSignatures_GetAccountSignatureImage", "consumes": [], - "produces": [], + "produces": [ + "image/gif" + ], "parameters": [ { "name": "accountId", @@ -14476,32 +14833,32 @@ "type": "string" }, { - "name": "documentId", + "name": "imageType", "in": "path", - "description": "Integer that identifies the document in the envelope.", + "description": "Specificies the type of image. Valid values are:\n\n- `signature_image`\n- `initials_image`", "required": true, "type": "string" }, { - "name": "templateId", + "name": "signatureId", "in": "path", - "description": "The ID of the template.", + "description": "The ID of the signature being accessed.", "required": true, "type": "string" }, { - "name": "page_numbers", + "name": "include_chrome", "in": "query", "required": false, "type": "string", - "description": "Filters for tabs that occur on the pages that you specify. Enter as a comma-separated list of page Guids.\n\nExample: `page_numbers=2,6`" + "description": "When **true**, the chrome (or frame containing the added line and identifier) is included with the signature image." } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/TemplateDocumentTabs" + "type": "file" } }, "400": { @@ -14512,19 +14869,21 @@ } }, "deprecated": false, - "x-ds-methodname": "getDocumentTabs", - "x-ds-method": "get", - "x-ds-service": "Templates", + "x-ds-methodname": "getAccountSignatureImage", + "x-ds-method": "getAccountSignatureImage", + "x-ds-service": "Uncategorized", "description": "", "x-ds-in-sdk": true }, "put": { "tags": [ - "TemplateDocumentTabs" + "AccountSignatures" + ], + "summary": "Sets a signature image, initials, or stamp.", + "operationId": "AccountSignatures_PutAccountSignatureImage", + "consumes": [ + "image/gif" ], - "summary": "", - "operationId": "Tabs_PutTemplateDocumentTabs", - "consumes": [], "produces": [], "parameters": [ { @@ -14535,26 +14894,24 @@ "type": "string" }, { - "name": "documentId", + "name": "imageType", "in": "path", - "description": "Integer that identifies the document in the envelope.", + "description": "Specificies the type of image. Valid values are:\n\n- `signature_image`\n- `initials_image`", "required": true, "type": "string" }, { - "name": "templateId", + "name": "signatureId", "in": "path", - "description": "The ID of the template.", + "description": "The ID of the signature being accessed.", "required": true, "type": "string" }, { - "name": "templateTabs", - "in": "body", + "name": "transparent_png", + "in": "query", "required": false, - "schema": { - "$ref": "#/definitions/templateTabs" - }, + "type": "string", "description": "" } ], @@ -14562,7 +14919,7 @@ "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/TemplateRecipientTabs" + "$ref": "#/definitions/accountSignature" } }, "400": { @@ -14573,18 +14930,18 @@ } }, "deprecated": false, - "x-ds-methodname": "updateTemplateDocumentTabs", - "x-ds-method": "updateTemplateDocumentTabs", + "x-ds-methodname": "updateAccountSignatureImage", + "x-ds-method": "updateAccountSignatureImage", "x-ds-service": "Uncategorized", "description": "", "x-ds-in-sdk": true }, - "post": { + "delete": { "tags": [ - "TemplateDocumentTabs" + "AccountSignatures" ], - "summary": "Create Template Document Tabs", - "operationId": "Tabs_PostTemplateDocumentTabs", + "summary": "Deletes a signature image, initials, or stamp.", + "operationId": "AccountSignatures_DeleteAccountSignatureImage", "consumes": [], "produces": [], "parameters": [ @@ -14596,34 +14953,25 @@ "type": "string" }, { - "name": "documentId", + "name": "imageType", "in": "path", - "description": "Integer that identifies the document in the envelope.", + "description": "Specificies the type of image. Valid values are:\n\n- `signature_image`\n- `initials_image`", "required": true, "type": "string" }, { - "name": "templateId", + "name": "signatureId", "in": "path", - "description": "The ID of the template.", + "description": "The ID of the signature being accessed.", "required": true, "type": "string" - }, - { - "name": "templateTabs", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/templateTabs" - }, - "description": "" } ], "responses": { - "201": { + "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/TemplateRecipientTabs" + "$ref": "#/definitions/accountSignature" } }, "400": { @@ -14634,18 +14982,22 @@ } }, "deprecated": false, - "x-ds-methodname": "createTemplateDocumentTabs", - "x-ds-method": "createTemplateDocumentTabs", + "x-ds-methodname": "deleteAccountSignatureImage", + "x-ds-method": "deleteAccountSignatureImage", "x-ds-service": "Uncategorized", - "description": "This method creates Template Document Tabs.", + "description": "", "x-ds-in-sdk": true }, - "delete": { + "parameters": [] + }, + "/v2.1/accounts/{accountId}/signing_groups": { + "get": { "tags": [ - "TemplateDocumentTabs" + "SigningGroups" ], - "summary": "", - "operationId": "Tabs_DeleteTemplateDocumentTabs", + "summary": "Gets a list of the Signing Groups in an account.", + "description": "Retrieves a list of all signing groups in the specified account.", + "operationId": "SigningGroups_GetSigningGroups", "consumes": [], "produces": [], "parameters": [ @@ -14657,34 +15009,25 @@ "type": "string" }, { - "name": "documentId", - "in": "path", - "description": "Integer that identifies the document in the envelope.", - "required": true, - "type": "string" - }, - { - "name": "templateId", - "in": "path", - "description": "The ID of the template.", - "required": true, - "type": "string" + "name": "group_type", + "in": "query", + "required": false, + "type": "string", + "description": "" }, { - "name": "templateTabs", - "in": "body", + "name": "include_users", + "in": "query", + "description": "When set to **true**, the response includes the signing group members. ", "required": false, - "schema": { - "$ref": "#/definitions/templateTabs" - }, - "description": "" + "type": "string" } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/TemplateRecipientTabs" + "$ref": "#/definitions/signingGroupInformation" } }, "400": { @@ -14695,21 +15038,18 @@ } }, "deprecated": false, - "x-ds-methodname": "deleteTemplateDocumentTabs", - "x-ds-method": "deleteTemplateDocumentTabs", - "x-ds-service": "Uncategorized", - "description": "", + "x-ds-methodname": "list", + "x-ds-method": "list", + "x-ds-service": "SigningGroups", "x-ds-in-sdk": true }, - "parameters": [] - }, - "/v2.1/accounts/{accountId}/templates/{templateId}/html_definitions": { - "get": { + "put": { "tags": [ - "TemplateHtmlDefinitions" + "SigningGroups" ], - "summary": "", - "operationId": "ResponsiveHtml_GetTemplateHtmlDefinitions", + "summary": "Updates signing group names.", + "description": "Updates the name of one or more existing signing groups. ", + "operationId": "SigningGroups_PutSigningGroups", "consumes": [], "produces": [], "parameters": [ @@ -14721,18 +15061,20 @@ "type": "string" }, { - "name": "templateId", - "in": "path", - "description": "The ID of the template.", - "required": true, - "type": "string" + "name": "signingGroupInformation", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/signingGroupInformation" + }, + "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/EnvelopeDocumentHtmlDefinitions" + "$ref": "#/definitions/signingGroupInformation" } }, "400": { @@ -14743,22 +15085,18 @@ } }, "deprecated": false, - "x-ds-methodname": "getTemplateHtmlDefinitions", - "x-ds-method": "list", - "x-ds-service": "Uncategorized", - "description": "", + "x-ds-methodname": "updateList", + "x-ds-method": "updateList", + "x-ds-service": "SigningGroups", "x-ds-in-sdk": true }, - "parameters": [] - }, - "/v2.1/accounts/{accountId}/templates/{templateId}/lock": { - "get": { + "post": { "tags": [ - "TemplateLocks" + "SigningGroups" ], - "summary": "Gets template lock information.", - "description": "Retrieves general information about the template lock.\n\nIf the call is made by the user who has the lock and the request has the same integrator key as original, then the `X-DocuSign-Edit` header field and additional lock information is included in the response. This allows users to recover a lost editing session token and the `X-DocuSign-Edit` header.", - "operationId": "Lock_GetTemplateLock", + "summary": "Creates a signing group. ", + "description": "Creates one or more signing groups. \n\nMultiple signing groups can be created in one call. Only users with account administrator privileges can create signing groups. \n\nAn account can have a maximum of 50 signing groups. Each signing group can have a maximum of 50 group members.\n \nSigning groups can be used by any account user.", + "operationId": "SigningGroups_PostSigningGroups", "consumes": [], "produces": [], "parameters": [ @@ -14770,18 +15108,20 @@ "type": "string" }, { - "name": "templateId", - "in": "path", - "description": "The ID of the template.", - "required": true, - "type": "string" + "name": "signingGroupInformation", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/signingGroupInformation" + }, + "description": "" } ], "responses": { - "200": { + "201": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/TemplateLocks" + "$ref": "#/definitions/signingGroupInformation" } }, "400": { @@ -14792,18 +15132,18 @@ } }, "deprecated": false, - "x-ds-methodname": "getLock", - "x-ds-method": "get", - "x-ds-service": "Templates", + "x-ds-methodname": "createList", + "x-ds-method": "create", + "x-ds-service": "SigningGroups", "x-ds-in-sdk": true }, - "put": { + "delete": { "tags": [ - "TemplateLocks" + "SigningGroups" ], - "summary": "Updates a template lock.", - "description": "Updates the lock duration time or update the `lockedByApp` property information for the specified template. The user and integrator key must match the user specified by the `lockByUser` property and integrator key information and the `X-DocuSign-Edit` header must be included or an error will be generated.", - "operationId": "Lock_PutTemplateLock", + "summary": "Deletes one or more signing groups.", + "description": "Deletes one or more signing groups in the specified account.", + "operationId": "SigningGroups_DeleteSigningGroups", "consumes": [], "produces": [], "parameters": [ @@ -14815,18 +15155,11 @@ "type": "string" }, { - "name": "templateId", - "in": "path", - "description": "The ID of the template.", - "required": true, - "type": "string" - }, - { - "name": "lockRequest", + "name": "signingGroupInformation", "in": "body", "required": false, "schema": { - "$ref": "#/definitions/lockRequest" + "$ref": "#/definitions/signingGroupInformation" }, "description": "" } @@ -14835,7 +15168,7 @@ "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/TemplateLocks" + "$ref": "#/definitions/signingGroupInformation" } }, "400": { @@ -14846,18 +15179,21 @@ } }, "deprecated": false, - "x-ds-methodname": "updateLock", - "x-ds-method": "update", - "x-ds-service": "Templates", + "x-ds-methodname": "deleteList", + "x-ds-method": "delete", + "x-ds-service": "SigningGroups", "x-ds-in-sdk": true }, - "post": { + "parameters": [] + }, + "/v2.1/accounts/{accountId}/signing_groups/{signingGroupId}": { + "get": { "tags": [ - "TemplateLocks" + "SigningGroups" ], - "summary": "Lock a template.", - "description": "Locks the specified template, and sets the time until the lock expires, to prevent other users or recipients from accessing and changing the template.\n\n###### Note: Users must have envelope locking capability enabled to use this function (the userSetting property `canLockEnvelopes` must be set to **true** for the user).", - "operationId": "Lock_PostTemplateLock", + "summary": "Gets information about a signing group. ", + "description": "Retrieves information, including group member information, for the specified signing group. ", + "operationId": "SigningGroups_GetSigningGroup", "consumes": [], "produces": [], "parameters": [ @@ -14869,27 +15205,18 @@ "type": "string" }, { - "name": "templateId", + "name": "signingGroupId", "in": "path", - "description": "The ID of the template.", "required": true, - "type": "string" - }, - { - "name": "lockRequest", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/lockRequest" - }, - "description": "" + "type": "string", + "description": "Optional. The ID of the [signing group](https://support.docusign.com/en/guides/ndse-user-guide-signing-groups).\n\n**Note**: When you send an envelope to a signing group, anyone in the group can open it and sign it with their own signature. For this reason, we recommend that you do not include non-signer recipients (such as carbon copy recipients) in the same signing group as signer recipients. However, you could create a second signing group for the non-signer recipients and change the default action of Needs to Sign to a different value, such as Receives a Copy. " } ], "responses": { - "201": { + "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/TemplateLocks" + "$ref": "#/definitions/signingGroup" } }, "400": { @@ -14900,18 +15227,18 @@ } }, "deprecated": false, - "x-ds-methodname": "createLock", - "x-ds-method": "create", - "x-ds-service": "Templates", + "x-ds-methodname": "get", + "x-ds-method": "get", + "x-ds-service": "SigningGroups", "x-ds-in-sdk": true }, - "delete": { + "put": { "tags": [ - "TemplateLocks" + "SigningGroups" ], - "summary": "Deletes a template lock.", - "description": "Deletes the lock from the specified template. The `X-DocuSign-Edit` header must be included in the request.", - "operationId": "Lock_DeleteTemplateLock", + "summary": "Updates a signing group. ", + "description": "Updates signing group name and member information. You can also add new members to the signing group. A signing group can have a maximum of 50 members. ", + "operationId": "SigningGroups_PutSigningGroup", "consumes": [], "produces": [], "parameters": [ @@ -14923,18 +15250,18 @@ "type": "string" }, { - "name": "templateId", + "name": "signingGroupId", "in": "path", - "description": "The ID of the template.", "required": true, - "type": "string" + "type": "string", + "description": "Optional. The ID of the [signing group](https://support.docusign.com/en/guides/ndse-user-guide-signing-groups).\n\n**Note**: When you send an envelope to a signing group, anyone in the group can open it and sign it with their own signature. For this reason, we recommend that you do not include non-signer recipients (such as carbon copy recipients) in the same signing group as signer recipients. However, you could create a second signing group for the non-signer recipients and change the default action of Needs to Sign to a different value, such as Receives a Copy. " }, { - "name": "lockRequest", + "name": "signingGroup", "in": "body", "required": false, "schema": { - "$ref": "#/definitions/lockRequest" + "$ref": "#/definitions/signingGroup" }, "description": "" } @@ -14943,7 +15270,7 @@ "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/TemplateLocks" + "$ref": "#/definitions/signingGroup" } }, "400": { @@ -14954,21 +15281,21 @@ } }, "deprecated": false, - "x-ds-methodname": "deleteLock", - "x-ds-method": "delete", - "x-ds-service": "Templates", + "x-ds-methodname": "update", + "x-ds-method": "update", + "x-ds-service": "SigningGroups", "x-ds-in-sdk": true }, "parameters": [] }, - "/v2.1/accounts/{accountId}/templates/{templateId}/notification": { + "/v2.1/accounts/{accountId}/signing_groups/{signingGroupId}/users": { "get": { "tags": [ - "Templates" + "SigningGroupUsers" ], - "summary": "Gets template notification information.", - "description": "Retrieves the envelope notification, reminders and expirations, information for an existing template.", - "operationId": "Notification_GetTemplatesTemplateIdNotification", + "summary": "Gets a list of members in a Signing Group.", + "description": "Retrieves the list of members in the specified Signing Group.", + "operationId": "SigningGroups_GetSigningGroupUsers", "consumes": [], "produces": [], "parameters": [ @@ -14980,18 +15307,18 @@ "type": "string" }, { - "name": "templateId", + "name": "signingGroupId", "in": "path", - "description": "The ID of the template.", "required": true, - "type": "string" + "type": "string", + "description": "Optional. The ID of the [signing group](https://support.docusign.com/en/guides/ndse-user-guide-signing-groups).\n\n**Note**: When you send an envelope to a signing group, anyone in the group can open it and sign it with their own signature. For this reason, we recommend that you do not include non-signer recipients (such as carbon copy recipients) in the same signing group as signer recipients. However, you could create a second signing group for the non-signer recipients and change the default action of Needs to Sign to a different value, such as Receives a Copy. " } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/notification" + "$ref": "#/definitions/signingGroupUsers" } }, "400": { @@ -15002,18 +15329,18 @@ } }, "deprecated": false, - "x-ds-methodname": "getNotificationSettings", - "x-ds-method": "getNotificationSettings", - "x-ds-service": "Templates", + "x-ds-methodname": "listUsers", + "x-ds-method": "list", + "x-ds-service": "SigningGroups", "x-ds-in-sdk": true }, "put": { "tags": [ - "Templates" + "SigningGroupUsers" ], - "summary": "Updates the notification structure for an existing template.", - "description": "Updates the notification structure for an existing template. Use this endpoint to set reminder and expiration notifications.", - "operationId": "Notification_PutTemplatesTemplateIdNotification", + "summary": "Adds members to a signing group. ", + "description": "Adds one or more new members to a signing group. A signing group can have a maximum of 50 members. ", + "operationId": "SigningGroups_PutSigningGroupUsers", "consumes": [], "produces": [], "parameters": [ @@ -15025,96 +15352,27 @@ "type": "string" }, { - "name": "templateId", + "name": "signingGroupId", "in": "path", - "description": "The ID of the template.", "required": true, - "type": "string" + "type": "string", + "description": "Optional. The ID of the [signing group](https://support.docusign.com/en/guides/ndse-user-guide-signing-groups).\n\n**Note**: When you send an envelope to a signing group, anyone in the group can open it and sign it with their own signature. For this reason, we recommend that you do not include non-signer recipients (such as carbon copy recipients) in the same signing group as signer recipients. However, you could create a second signing group for the non-signer recipients and change the default action of Needs to Sign to a different value, such as Receives a Copy. " }, { - "name": "templateNotificationRequest", + "name": "signingGroupUsers", "in": "body", "required": false, "schema": { - "$ref": "#/definitions/templateNotificationRequest" + "$ref": "#/definitions/signingGroupUsers" }, - "description": "" - } - ], - "responses": { - "200": { - "description": "Successful response.", - "schema": { - "$ref": "#/definitions/notification" - } - }, - "400": { - "description": "Error encountered.", - "schema": { - "$ref": "#/definitions/errorDetails" - } - } - }, - "deprecated": false, - "x-ds-methodname": "updateNotificationSettings", - "x-ds-method": "updateNotificationSettings", - "x-ds-service": "Templates", - "x-ds-in-sdk": true - }, - "parameters": [] - }, - "/v2.1/accounts/{accountId}/templates/{templateId}/recipients": { - "get": { - "tags": [ - "TemplateRecipients" - ], - "summary": "Gets recipient information from a template.", - "description": "Retrieves the information for all recipients in the specified template.", - "operationId": "Recipients_GetTemplateRecipients", - "consumes": [], - "produces": [], - "parameters": [ - { - "name": "accountId", - "in": "path", - "description": "The external account number (int) or account ID GUID.", - "required": true, - "type": "string" - }, - { - "name": "templateId", - "in": "path", - "description": "The ID of the template.", - "required": true, - "type": "string" - }, - { - "name": "include_anchor_tab_locations", - "in": "query", - "description": " When set to **true** and `include_tabs` is set to **true**, all tabs with anchor tab properties are included in the response. ", - "required": false, - "type": "string" - }, - { - "name": "include_extended", - "in": "query", - "description": " When set to **true**, the extended properties are included in the response. ", - "required": false, - "type": "string" - }, - { - "name": "include_tabs", - "in": "query", - "description": "When set to **true**, the tab information associated with the recipient is included in the response. If you do not specify this parameter, the effect is the default behavior (**false**).", - "required": false, - "type": "string" + "description": "A complex type that contains information about users in the signing group." } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/TemplateRecipients" + "$ref": "#/definitions/signingGroupUsers" } }, "400": { @@ -15125,18 +15383,18 @@ } }, "deprecated": false, - "x-ds-methodname": "listRecipients", - "x-ds-method": "list", - "x-ds-service": "Templates", + "x-ds-methodname": "updateUsers", + "x-ds-method": "update", + "x-ds-service": "SigningGroups", "x-ds-in-sdk": true }, - "put": { + "delete": { "tags": [ - "TemplateRecipients" + "SigningGroupUsers" ], - "summary": "Updates recipients in a template.", - "description": "Updates recipients in a template. \n\nYou can edit the following properties: `email`, `userName`, `routingOrder`, `faxNumber`, `deliveryMethod`, `accessCode`, and `requireIdLookup`.", - "operationId": "Recipients_PutTemplateRecipients", + "summary": "Deletes one or more members from a signing group.", + "description": "Deletes one or more members from the specified signing group. ", + "operationId": "SigningGroups_DeleteSigningGroupUsers", "consumes": [], "produces": [], "parameters": [ @@ -15148,34 +15406,27 @@ "type": "string" }, { - "name": "templateId", + "name": "signingGroupId", "in": "path", - "description": "The ID of the template.", "required": true, - "type": "string" - }, - { - "name": "resend_envelope", - "in": "query", - "required": false, "type": "string", - "description": "When set to **true**, resends the envelope if the new recipient's routing order is before or the same as the envelope's next recipient." + "description": "Optional. The ID of the [signing group](https://support.docusign.com/en/guides/ndse-user-guide-signing-groups).\n\n**Note**: When you send an envelope to a signing group, anyone in the group can open it and sign it with their own signature. For this reason, we recommend that you do not include non-signer recipients (such as carbon copy recipients) in the same signing group as signer recipients. However, you could create a second signing group for the non-signer recipients and change the default action of Needs to Sign to a different value, such as Receives a Copy. " }, { - "name": "templateRecipients", + "name": "signingGroupUsers", "in": "body", "required": false, "schema": { - "$ref": "#/definitions/templateRecipients" + "$ref": "#/definitions/signingGroupUsers" }, - "description": "" + "description": "A complex type that contains information about users in the signing group." } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/recipientsUpdateSummary" + "$ref": "#/definitions/signingGroupUsers" } }, "400": { @@ -15186,18 +15437,20 @@ } }, "deprecated": false, - "x-ds-methodname": "updateRecipients", - "x-ds-method": "update", - "x-ds-service": "Templates", + "x-ds-methodname": "deleteUsers", + "x-ds-method": "delete", + "x-ds-service": "SigningGroups", "x-ds-in-sdk": true }, - "post": { + "parameters": [] + }, + "/v2.1/accounts/{accountId}/supported_languages": { + "get": { "tags": [ - "TemplateRecipients" + "Accounts" ], - "summary": "Adds tabs for a recipient.", - "description": "Adds one or more recipients to a template.", - "operationId": "Recipients_PostTemplateRecipients", + "summary": "Gets the supported languages for envelope recipients.", + "operationId": "SupportedLanguages_GetSupportedLanguages", "consumes": [], "produces": [], "parameters": [ @@ -15207,36 +15460,13 @@ "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" - }, - { - "name": "templateId", - "in": "path", - "description": "The ID of the template.", - "required": true, - "type": "string" - }, - { - "name": "resend_envelope", - "in": "query", - "required": false, - "type": "string", - "description": "When set to **true**, resends the envelope if the new recipient's routing order is before or the same as the envelope's next recipient." - }, - { - "name": "templateRecipients", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/templateRecipients" - }, - "description": "" } ], "responses": { - "201": { + "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/TemplateRecipients" + "$ref": "#/definitions/supportedLanguages" } }, "400": { @@ -15247,18 +15477,22 @@ } }, "deprecated": false, - "x-ds-methodname": "createRecipients", - "x-ds-method": "create", - "x-ds-service": "Templates", + "x-ds-methodname": "getSupportedLanguages", + "x-ds-method": "listSupportedLanguages", + "x-ds-service": "Accounts", + "description": "Retrieves a list of supported languages that you can set for an individual recipient when creating an envelope, as well as their simple type enumeration values. These are the languages that you can set for the standard email format and signing view for each recipient.\n\nFor example, in the recipient's email notification, this setting affects elements such as the standard introductory text describing the request to sign. It also determines the language used for buttons and tabs in both the email notification and the signing experience.\n\n**Note**: Setting a language for a recipient affects only the DocuSign standard text. Any custom text that you enter for the `emailBody` and `emailSubject` of the notification is not translated, and appears exactly as you enter it.\n\nFor more information, see [Set Recipient Language and Specify Custom Email Messages](https://support.docusign.com/en/guides/ndse-user-guide-recipient-language).", "x-ds-in-sdk": true }, - "delete": { + "parameters": [] + }, + "/v2.1/accounts/{accountId}/tab_definitions": { + "get": { "tags": [ - "TemplateRecipients" + "CustomTabs" ], - "summary": "Deletes recipients from a template.", - "description": "Deletes one or more recipients from a template. Recipients to be deleted are listed in the request, with the `recipientId` being used as the key for deleting recipients.", - "operationId": "Recipients_DeleteTemplateRecipients", + "summary": "Gets a list of all account tabs.", + "description": "Retrieves a list of all tabs associated with the account.", + "operationId": "Tabs_GetTabDefinitions", "consumes": [], "produces": [], "parameters": [ @@ -15270,27 +15504,18 @@ "type": "string" }, { - "name": "templateId", - "in": "path", - "description": "The ID of the template.", - "required": true, - "type": "string" - }, - { - "name": "templateRecipients", - "in": "body", + "name": "custom_tab_only", + "in": "query", + "description": "When set to **true**, only custom tabs are returned in the response. ", "required": false, - "schema": { - "$ref": "#/definitions/templateRecipients" - }, - "description": "" + "type": "string" } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/TemplateRecipients" + "$ref": "#/definitions/tabMetadataList" } }, "400": { @@ -15301,21 +15526,18 @@ } }, "deprecated": false, - "x-ds-methodname": "deleteRecipients", - "x-ds-method": "deleteList", - "x-ds-service": "Templates", + "x-ds-methodname": "list", + "x-ds-method": "list", + "x-ds-service": "CustomTabs", "x-ds-in-sdk": true }, - "parameters": [] - }, - "/v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}": { - "delete": { + "post": { "tags": [ - "TemplateRecipients" + "CustomTabs" ], - "summary": "Deletes the specified recipient file from a template.", - "description": "Deletes the specified recipient file from the specified template.", - "operationId": "Recipients_DeleteTemplateRecipient", + "summary": "Creates a custom tab.", + "description": "Creates a tab with pre-defined properties, such as a text tab with a certain font type and validation pattern. Users can access the custom tabs when sending documents through the DocuSign web application.\n\nCustom tabs can be created for approve, checkbox, company, date, date signed, decline, email, email address, envelope ID, first name, formula, full name, initial here, last name, list, note, number, radio, sign here, signer attachment, SSN, text, title, and zip tabs.", + "operationId": "Tabs_PostTabDefinitions", "consumes": [], "produces": [], "parameters": [ @@ -15327,34 +15549,20 @@ "type": "string" }, { - "name": "recipientId", - "in": "path", - "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", - "required": true, - "type": "string" - }, - { - "name": "templateId", - "in": "path", - "description": "The ID of the template.", - "required": true, - "type": "string" - }, - { - "name": "templateRecipients", + "name": "tabMetadata", "in": "body", "required": false, "schema": { - "$ref": "#/definitions/templateRecipients" + "$ref": "#/definitions/tabMetadata" }, "description": "" } ], "responses": { - "200": { + "201": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/TemplateRecipients" + "$ref": "#/definitions/tabMetadata" } }, "400": { @@ -15365,21 +15573,21 @@ } }, "deprecated": false, - "x-ds-methodname": "deleteRecipient", - "x-ds-method": "delete", - "x-ds-service": "Templates", + "x-ds-methodname": "create", + "x-ds-method": "create", + "x-ds-service": "CustomTabs", "x-ds-in-sdk": true }, "parameters": [] }, - "/v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/bulk_recipients": { + "/v2.1/accounts/{accountId}/tab_definitions/{customTabId}": { "get": { "tags": [ - "TemplateBulkRecipients" + "CustomTabs" ], - "summary": "Gets the bulk recipient file from a template.", - "description": "Retrieves the bulk recipient file information from a template that has a bulk recipient.", - "operationId": "Recipients_GetTemplateBulkRecipients", + "summary": "Gets custom tab information.", + "description": "Retrieves information about the requested custom tab on the specified account.", + "operationId": "Tab_GetCustomTab", "consumes": [], "produces": [], "parameters": [ @@ -15391,39 +15599,18 @@ "type": "string" }, { - "name": "recipientId", - "in": "path", - "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", - "required": true, - "type": "string" - }, - { - "name": "templateId", + "name": "customTabId", "in": "path", - "description": "The ID of the template.", "required": true, - "type": "string" - }, - { - "name": "include_tabs", - "in": "query", - "required": false, "type": "string", - "description": "When set to **true**, the tab information associated with the recipient is included in the response. If you do not specify this parameter, the effect is the default behavior (**false**)." - }, - { - "name": "start_position", - "in": "query", - "required": false, - "type": "string", - "description": "The starting position of the results set." + "description": "The DocuSign-generated custom tab id for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties." } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/TemplateBulkRecipients" + "$ref": "#/definitions/tabMetadata" } }, "400": { @@ -15434,18 +15621,18 @@ } }, "deprecated": false, - "x-ds-methodname": "listBulkRecipients", - "x-ds-method": "list", - "x-ds-service": "Templates", + "x-ds-methodname": "get", + "x-ds-method": "get", + "x-ds-service": "CustomTabs", "x-ds-in-sdk": true }, "put": { "tags": [ - "TemplateBulkRecipients" + "CustomTabs" ], - "summary": "Adds or replaces the bulk recipients list in a template.", - "description": "Updates the bulk recipients in a template using a file upload. The Content-Type supported for uploading a bulk recipient file is CSV (text/csv).\n\nThe REST API does not support modifying individual rows or values in the bulk recipients file. It only allows the entire file to be added or replaced with a new file.", - "operationId": "Recipients_PutTemplateBulkRecipients", + "summary": "Updates custom tab information.\n\n", + "description": "Updates the information in a custom tab for the specified account.", + "operationId": "Tab_PutCustomTab", "consumes": [], "produces": [], "parameters": [ @@ -15457,25 +15644,18 @@ "type": "string" }, { - "name": "recipientId", - "in": "path", - "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", - "required": true, - "type": "string" - }, - { - "name": "templateId", + "name": "customTabId", "in": "path", - "description": "The ID of the template.", "required": true, - "type": "string" + "type": "string", + "description": "The DocuSign-generated custom tab id for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties." }, { - "name": "bulkRecipientsRequest", + "name": "tabMetadata", "in": "body", "required": false, "schema": { - "$ref": "#/definitions/bulkRecipientsRequest" + "$ref": "#/definitions/tabMetadata" }, "description": "" } @@ -15484,7 +15664,7 @@ "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/bulkRecipientsSummaryResponse" + "$ref": "#/definitions/tabMetadata" } }, "400": { @@ -15495,18 +15675,18 @@ } }, "deprecated": false, - "x-ds-methodname": "updateBulkRecipients", + "x-ds-methodname": "update", "x-ds-method": "update", - "x-ds-service": "Templates", + "x-ds-service": "CustomTabs", "x-ds-in-sdk": true }, "delete": { "tags": [ - "TemplateBulkRecipients" + "CustomTabs" ], - "summary": "Deletes the bulk recipient list on a template.", - "description": "Deletes the bulk recipient list on a template.", - "operationId": "Recipients_DeleteTemplateBulkRecipientsFile", + "summary": "Deletes custom tab information.", + "description": "Deletes the custom from the specified account.", + "operationId": "Tab_DeleteCustomTab", "consumes": [], "produces": [], "parameters": [ @@ -15518,26 +15698,16 @@ "type": "string" }, { - "name": "recipientId", - "in": "path", - "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", - "required": true, - "type": "string" - }, - { - "name": "templateId", + "name": "customTabId", "in": "path", - "description": "The ID of the template.", "required": true, - "type": "string" + "type": "string", + "description": "The DocuSign-generated custom tab id for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties." } ], "responses": { "200": { - "description": "Successful response.", - "schema": { - "$ref": "#/definitions/bulkRecipientsUpdateResponse" - } + "description": "Successful response." }, "400": { "description": "Error encountered.", @@ -15547,20 +15717,21 @@ } }, "deprecated": false, - "x-ds-methodname": "deleteBulkRecipients", + "x-ds-methodname": "delete", "x-ds-method": "delete", - "x-ds-service": "Templates", + "x-ds-service": "CustomTabs", "x-ds-in-sdk": true }, "parameters": [] }, - "/v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/document_visibility": { + "/v2.1/accounts/{accountId}/templates": { "get": { "tags": [ - "TemplateDocumentVisibility" + "Templates" ], - "summary": "Returns document visibility for a template recipient", - "operationId": "Recipients_GetTemplateRecipientDocumentVisibility", + "summary": "Gets template definitions.", + "description": "Retrieves the list of templates for the specified account. The request can be limited to a specific folder.", + "operationId": "Templates_GetTemplates", "consumes": [], "produces": [], "parameters": [ @@ -15572,86 +15743,219 @@ "type": "string" }, { - "name": "recipientId", - "in": "path", - "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", - "required": true, + "name": "count", + "in": "query", + "description": "The number of records to return in the cache.", + "required": false, "type": "string" }, { - "name": "templateId", - "in": "path", - "description": "The ID of the template.", - "required": true, + "name": "created_from_date", + "in": "query", + "required": false, + "type": "string", + "description": "Lists templates created on or after this date." + }, + { + "name": "created_to_date", + "in": "query", + "required": false, + "type": "string", + "description": "Lists templates modified before this date." + }, + { + "name": "folder_ids", + "in": "query", + "description": "A comma-separated list of folder id GUIDs.", + "required": false, "type": "string" - } - ], - "responses": { - "200": { - "description": "Successful response.", - "schema": { - "$ref": "#/definitions/EnvelopeDocumentVisibility" - } }, - "400": { - "description": "Error encountered.", - "schema": { - "$ref": "#/definitions/errorDetails" - } - } - }, - "deprecated": false, - "x-ds-methodname": "getTemplateRecipientDocumentVisibility", - "x-ds-method": "get", - "x-ds-service": "Envelopes", - "description": "This method returns information about document visibility for a template recipient.", + { + "name": "folder_types", + "in": "query", + "required": false, + "type": "string", + "description": "The type of folder to return templates for. Possible values are:\n\n- `templates`: Templates in the **My Templates** folder.\n Templates in the **Shared Templates** and **All Template** folders (if the request id from and Admin) are excluded.\n- `templates_root`: Templates in the root level of the **My Templates** folder, but not in an actual folder. Note that the **My Templates** folder is not a real folder.\n- `recylebin`: Templates that have been deleted.\n" + }, + { + "name": "from_date", + "in": "query", + "description": "Start of the search date range. Only returns templates created on or after this date/time. If no value is specified, there is no limit on the earliest date created.", + "required": false, + "type": "string" + }, + { + "name": "include", + "in": "query", + "description": "A comma-separated list\nof additional template attributes\nto include in the response.\nValid values are:\n\n- `powerforms`: Includes details about the PowerForms associated with the templates.\n- `documents`: Includes information about template documents.\n- `folders`: Includes information about the folder that holds the template.\n- `favorite_template_status`: Includes the template `favoritedByMe` property. **Note**: You can mark a template as a favorite only in eSignature v2.1.\n- `advanced_templates`: Includes information about advanced templates.\n- `recipients`: Includes information about template recipients.\n- `custom_fields`: Includes information about template custom fields.\n- `notifications`: Includes information about the notification settings for templates.", + "required": false, + "type": "string" + }, + { + "name": "is_deleted_template_only", + "in": "query", + "required": false, + "type": "string", + "description": "" + }, + { + "name": "is_download", + "in": "query", + "required": false, + "type": "string", + "description": "When set to **true**, downloads the templates listed in `template_ids` as a collection of JSON definitions in a single zip file.\n\nThe `Content-Disposition` header is set in the response. The value of the header provides the filename of the file.\n\nThe default is **false**.\n\n**Note**: This parameter only works when you specify a list of templates in the `template_ids` parameter." + }, + { + "name": "modified_from_date", + "in": "query", + "required": false, + "type": "string", + "description": "Lists templates modified on or after this date." + }, + { + "name": "modified_to_date", + "in": "query", + "required": false, + "type": "string", + "description": "Lists templates modified before this date." + }, + { + "name": "order", + "in": "query", + "description": "Specifies the sort order of the search results.\nValid values are:\n\n- `asc`: Ascending (A to Z)\n- `desc`: Descending (Z to A)", + "required": false, + "type": "string" + }, + { + "name": "order_by", + "in": "query", + "description": "Specifies how the search results are listed.\nValid values are:\n\n- `name`: template name\n- `modified`: date/time template was last modified\n- `used`: date/time the template was last used.", + "required": false, + "type": "string" + }, + { + "name": "search_fields", + "in": "query", + "required": false, + "type": "string", + "description": "A comma-separated list of additional template properties to search.\n\n\n- `sender`: Include sender name and email in the search.\n- `recipients`: Include recipient names and emails in the search.\n- `envelope`: Not used in template searches.\n" + }, + { + "name": "search_text", + "in": "query", + "description": "The search text to use to search the names of templates.", + "required": false, + "type": "string" + }, + { + "name": "shared_by_me", + "in": "query", + "description": "If **true**, the response only includes templates shared by the user. If false, the response only returns template not shared by the user. If not specified, the response is not affected.", + "required": false, + "type": "string" + }, + { + "name": "start_position", + "in": "query", + "description": "The starting zero-based index position for the first template to show in the response. This value must be greater than or equal to `0` (zero).", + "required": false, + "type": "string" + }, + { + "name": "template_ids", + "in": "query", + "required": false, + "type": "string", + "description": "A comma-separated list of template ids to download. This value is valid only when `is_download` is **true**." + }, + { + "name": "to_date", + "in": "query", + "description": "The end of a search date range in UTC DateTime format. When you use this parameter, only templates created up to this date and time are returned.\n\n**Note**: If this property is null, the value defaults to the current date.", + "required": false, + "type": "string" + }, + { + "name": "used_from_date", + "in": "query", + "description": "Start of the search date range. Only returns templates used or edited on or after this date/time. If no value is specified, there is no limit on the earliest date used.", + "required": false, + "type": "string" + }, + { + "name": "used_to_date", + "in": "query", + "description": "End of the search date range. Only returns templates used or edited up to this date/time. If no value is provided, this defaults to the current date.", + "required": false, + "type": "string" + }, + { + "name": "user_filter", + "in": "query", + "description": "Filters the templates in the response. Valid values are: \n\n- `owned_by_me`: Results include only templates owned by the user.\n- `shared_with_me`: Results include only templates owned by the user. \n- `all`: Results include all templates owned or shared with the user.", + "required": false, + "type": "string" + }, + { + "name": "user_id", + "in": "query", + "required": false, + "type": "string", + "description": "The id of the user." + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/envelopeTemplateResults" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "ListTemplates", + "x-ds-method": "list", + "x-ds-service": "Templates", "x-ds-in-sdk": true }, - "put": { + "post": { "tags": [ - "TemplateDocumentVisibility" + "Templates" ], - "summary": "Updates document visibility for a template recipient", - "operationId": "Recipients_PutTemplateRecipientDocumentVisibility", + "summary": "Creates one or more templates.", + "description": "Creates one or more template definitions, using a multipart request for each template.\n\nTemplates help streamline the sending process when you frequently send the same or similar documents, or send different documents to the same group of people.\n\nWhen you create a template, you define placeholder roles. Rather than specifying a person, you specify a role that regularly participates in a transaction that uses the template. Then, when you create or send an envelope based on the template, you assign actual recipients to the template roles. The recipients automatically inherit all of the workflow that is defined for that role in the template, such as the tabs and routing information.\n\nFor code examples and more information, see [REST API Templates](https://developers.docusign.com/esign-rest-api/guides/features/templates#sending-from-a-template).\n\n## Template Email Subject Merge Fields\n\nPlaceholder roles have associated merge fields that personalize the email notification that DocuSign sends. For example, the template automatically personalizes the email message by adding placeholders for the recipient's name and email address within the email subject line, based on the recipient's role. When the sender adds the name and email information for the recipient and sends the envelope, the recipient information is automatically merged into the appropriate fields in the email subject line.\n\nBoth the sender and the recipients will see the information in the email subject line for any emails associated with the template. This provides an easy way for senders to organize their envelope emails without having to open an envelope to find out who the recipient is.\n\n**Warning: If merging the recipient information into the subject line causes the subject line to exceed 100 characters, then any characters over the 100 character limit are not included in the subject line. For cases where you expect the recipient name or email to be long, you should consider placing the merge field at the start of the email subject.**\n\nTo insert a recipient's name into the subject line, add the following text in the `emailSubject` property when you create the template:\n\n`[[_UserName]]`\n\nExample:\n\n`\"emailSubject\":\"[[Signer 1_UserName]], Please sign this NDA\",`\n\nTo add a recipient's email address in the subject line, add the following text in the `emailSubject` property when you create the template or send an envelope from the template:\n\n`[[_Email]]`\n\nExample:\n\n`\"emailSubject\":\"[[Signer 1_Email]], Please sign this NDA\",`\n\nIn these examples, the role name specified in the template is “Signer 1”. When the envelope is sent, the placeholder will be dynamically substituted with the recipient's name or email.\n\n## Creating multiple templates\n\nTo create multiple templates, you provide a zip file of JSON files. You can also use the Templates::ListTemplates method with the `is_download` query parameter to download a zip file containing your existing templates and use that as a guide. The API supports both .zip and .gzip file formats as input.\n\nYou also need to set the following headers:\n\n- `Content-Length`\n- `Content-Type`\n- `Content-Disposition`\n\nExample: \n\n`Content-Length: 71068`\n\n`Content-Type: application/zip`\n\n`Content-Disposition: file; filename=\"DocuSignTemplates_Nov_25_2019_20_40_21.zip\"; fileExtension=.zip`", + "operationId": "Templates_PostTemplates", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", - "description": "The external account number (int) or account ID GUID.", - "required": true, - "type": "string" - }, - { - "name": "recipientId", - "in": "path", - "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", - "required": true, - "type": "string" - }, - { - "name": "templateId", - "in": "path", - "description": "The ID of the template.", + "description": "(Required) The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { - "name": "TemplateDocumentVisibility", + "name": "envelopeTemplate", "in": "body", "required": false, "schema": { - "$ref": "#/definitions/TemplateDocumentVisibility" + "$ref": "#/definitions/envelopeTemplate" }, "description": "" } ], "responses": { - "200": { + "201": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/TemplateDocumentVisibility" + "$ref": "#/definitions/templateSummary" } }, "400": { @@ -15662,22 +15966,21 @@ } }, "deprecated": false, - "x-ds-methodname": "updateTemplateRecipientDocumentVisibility", - "x-ds-method": "update", - "x-ds-service": "Envelopes", - "description": "This method updates the document visibility for a template recipient.\n\n**Note**: A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents.", + "x-ds-methodname": "createTemplate", + "x-ds-method": "create", + "x-ds-service": "Templates", "x-ds-in-sdk": true }, "parameters": [] }, - "/v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/tabs": { + "/v2.1/accounts/{accountId}/templates/{templateId}": { "get": { "tags": [ - "TemplateRecipientTabs" + "Templates" ], - "summary": "Gets the tabs information for a signer or sign-in-person recipient in a template.", - "description": "Gets the tabs information for a signer or sign-in-person recipient in a template.", - "operationId": "Recipients_GetTemplateRecipientTabs", + "summary": "Gets a specific template associated with a specified account.", + "description": "Retrieves the definition of the specified template.", + "operationId": "Templates_GetTemplate", "consumes": [], "produces": [], "parameters": [ @@ -15688,40 +15991,26 @@ "required": true, "type": "string" }, - { - "name": "recipientId", - "in": "path", - "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", - "required": true, - "type": "string" - }, { "name": "templateId", "in": "path", - "description": "The ID of the template.", + "description": "The id of the template.", "required": true, "type": "string" }, { - "name": "include_anchor_tab_locations", - "in": "query", - "description": "When set to **true**, all tabs with anchor tab properties are included in the response. If you do not specify this parameter, the effect is the default behavior (**false**).", - "required": false, - "type": "string" - }, - { - "name": "include_metadata", + "name": "include", "in": "query", "required": false, "type": "string", - "description": "When set to **true**, the response includes metadata indicating which properties are editable." + "description": "A comma-separated list\nof additional template attributes\nto include in the response.\nValid values are:\n\n- `powerforms`: Includes information about PowerForms.\n- `tabs`: Includes information about tabs.\n- `documents`: Includes information about documents.\n- `favorite_template_status`: : Includes the template `favoritedByMe` property in the response. **Note**: You can mark a template as a favorite only in eSignature v2.1." } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/TemplateRecipientTabs" + "$ref": "#/definitions/envelopeTemplate" } }, "400": { @@ -15732,18 +16021,18 @@ } }, "deprecated": false, - "x-ds-methodname": "listTabs", - "x-ds-method": "list", + "x-ds-methodname": "get", + "x-ds-method": "get", "x-ds-service": "Templates", "x-ds-in-sdk": true }, "put": { "tags": [ - "TemplateRecipientTabs" + "Templates" ], - "summary": "Updates the tabs for a recipient.", - "description": "Updates one or more tabs for a recipient in a template.", - "operationId": "Recipients_PutTemplateRecipientTabs", + "summary": "Updates an existing template.", + "description": "Updates an existing template.", + "operationId": "Templates_PutTemplate", "consumes": [], "produces": [], "parameters": [ @@ -15754,26 +16043,19 @@ "required": true, "type": "string" }, - { - "name": "recipientId", - "in": "path", - "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", - "required": true, - "type": "string" - }, { "name": "templateId", "in": "path", - "description": "The ID of the template.", + "description": "The id of the template.", "required": true, "type": "string" }, { - "name": "templateTabs", + "name": "envelopeTemplate", "in": "body", "required": false, "schema": { - "$ref": "#/definitions/templateTabs" + "$ref": "#/definitions/envelopeTemplate" }, "description": "" } @@ -15782,7 +16064,7 @@ "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/TemplateRecipientTabs" + "$ref": "#/definitions/templateUpdateSummary" } }, "400": { @@ -15793,18 +16075,21 @@ } }, "deprecated": false, - "x-ds-methodname": "updateTabs", + "x-ds-methodname": "update", "x-ds-method": "update", "x-ds-service": "Templates", "x-ds-in-sdk": true }, - "post": { + "parameters": [] + }, + "/v2.1/accounts/{accountId}/templates/{templateId}/{templatePart}": { + "put": { "tags": [ - "TemplateRecipientTabs" + "Templates" ], - "summary": "Adds tabs for a recipient.", - "description": "Adds one or more tabs for a recipient.", - "operationId": "Recipients_PostTemplateRecipientTabs", + "summary": "Shares a template with a group.", + "description": "Shares a template with the specified members group.\n\n**Note**: For a newer version of this functionality, see [Accounts::Update Shared Access](https://developers.docusign.com/docs/esign-rest-api/reference/Accounts/Accounts/updateSharedAccess).", + "operationId": "Templates_PutTemplatePart", "consumes": [], "produces": [], "parameters": [ @@ -15816,34 +16101,34 @@ "type": "string" }, { - "name": "recipientId", + "name": "templateId", "in": "path", - "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", + "description": "The id of the template.", "required": true, "type": "string" }, { - "name": "templateId", + "name": "templatePart", "in": "path", - "description": "The ID of the template.", + "description": "Currently, the only defined part is **groups**.", "required": true, "type": "string" }, { - "name": "templateTabs", + "name": "groupInformation", "in": "body", "required": false, "schema": { - "$ref": "#/definitions/templateTabs" + "$ref": "#/definitions/groupInformation" }, "description": "" } ], "responses": { - "201": { + "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/TemplateRecipientTabs" + "$ref": "#/definitions/groupInformation" } }, "400": { @@ -15854,18 +16139,18 @@ } }, "deprecated": false, - "x-ds-methodname": "createTabs", - "x-ds-method": "create", + "x-ds-methodname": "updateGroupShare", + "x-ds-method": "updateGroupShare", "x-ds-service": "Templates", "x-ds-in-sdk": true }, "delete": { "tags": [ - "TemplateRecipientTabs" + "Templates" ], - "summary": "Deletes the tabs associated with a recipient in a template.", - "description": "Deletes one or more tabs associated with a recipient in a template.", - "operationId": "Recipients_DeleteTemplateRecipientTabs", + "summary": "Removes a member group's sharing permissions for a template.", + "description": "Removes a member group's sharing permissions for a specified template.", + "operationId": "Templates_DeleteTemplatePart", "consumes": [], "produces": [], "parameters": [ @@ -15877,25 +16162,25 @@ "type": "string" }, { - "name": "recipientId", + "name": "templateId", "in": "path", - "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", + "description": "The id of the template.", "required": true, "type": "string" }, { - "name": "templateId", + "name": "templatePart", "in": "path", - "description": "The ID of the template.", + "description": "Currently, the only defined part is **groups**.", "required": true, "type": "string" }, { - "name": "templateTabs", + "name": "groupInformation", "in": "body", "required": false, "schema": { - "$ref": "#/definitions/templateTabs" + "$ref": "#/definitions/groupInformation" }, "description": "" } @@ -15904,7 +16189,7 @@ "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/TemplateRecipientTabs" + "$ref": "#/definitions/groupInformation" } }, "400": { @@ -15915,20 +16200,21 @@ } }, "deprecated": false, - "x-ds-methodname": "deleteTabs", - "x-ds-method": "delete", + "x-ds-methodname": "deleteGroupShare", + "x-ds-method": "deleteGroupShare", "x-ds-service": "Templates", "x-ds-in-sdk": true }, "parameters": [] }, - "/v2.1/accounts/{accountId}/templates/{templateId}/recipients/document_visibility": { - "put": { + "/v2.1/accounts/{accountId}/templates/{templateId}/custom_fields": { + "get": { "tags": [ - "TemplateDocumentVisibility" + "TemplateCustomFields" ], - "summary": "Updates document visibility for template recipients", - "operationId": "Recipients_PutTemplateRecipientsDocumentVisibility", + "summary": "Gets the custom document fields from a template.", + "description": "Retrieves the custom document field information from an existing template.", + "operationId": "CustomFields_GetTemplateCustomFields", "consumes": [], "produces": [], "parameters": [ @@ -15942,25 +16228,16 @@ { "name": "templateId", "in": "path", - "description": "The ID of the template.", + "description": "The id of the template.", "required": true, "type": "string" - }, - { - "name": "TemplateDocumentVisibility", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/TemplateDocumentVisibility" - }, - "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/TemplateDocumentVisibility" + "$ref": "#/definitions/customFields" } }, "400": { @@ -15971,21 +16248,18 @@ } }, "deprecated": false, - "x-ds-methodname": "updateTemplateRecipientsDocumentVisibility", - "x-ds-method": "updateList", - "x-ds-service": "Envelopes", - "description": "This method updates document visibility for one or more template recipients based on the `recipientId` and `visible` values that you include in the request body.\n\n\n**Note**: A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents.", + "x-ds-methodname": "listCustomFields", + "x-ds-method": "list", + "x-ds-service": "Templates", "x-ds-in-sdk": true }, - "parameters": [] - }, - "/v2.1/accounts/{accountId}/templates/{templateId}/responsive_html_preview": { - "post": { + "put": { "tags": [ - "TemplateResponsiveHtmlPreview" + "TemplateCustomFields" ], - "summary": "", - "operationId": "ResponsiveHtml_PostTemplateResponsiveHtmlPreview", + "summary": "Updates envelope custom fields in a template.", + "description": "Updates the custom fields in a template.\n\nEach custom field used in a template must have a unique name.", + "operationId": "CustomFields_PutTemplateCustomFields", "consumes": [], "produces": [], "parameters": [ @@ -15999,25 +16273,25 @@ { "name": "templateId", "in": "path", - "description": "The ID of the template.", + "description": "The id of the template.", "required": true, "type": "string" }, { - "name": "documentHtmlDefinition", + "name": "templateCustomFields", "in": "body", "required": false, "schema": { - "$ref": "#/definitions/documentHtmlDefinition" + "$ref": "#/definitions/templateCustomFields" }, "description": "" } ], "responses": { - "201": { + "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/DocumentResponsiveHtmlPreview" + "$ref": "#/definitions/customFields" } }, "400": { @@ -16028,21 +16302,18 @@ } }, "deprecated": false, - "x-ds-methodname": "createTemplateResponsiveHtmlPreview", - "x-ds-method": "create", - "x-ds-service": "Uncategorized", - "description": "", + "x-ds-methodname": "updateCustomFields", + "x-ds-method": "update", + "x-ds-service": "Templates", "x-ds-in-sdk": true }, - "parameters": [] - }, - "/v2.1/accounts/{accountId}/templates/{templateId}/views/edit": { "post": { "tags": [ - "TemplateViews" + "TemplateCustomFields" ], - "summary": "Provides a URL to start an edit view of the Template UI", - "operationId": "Views_PostTemplateEditView", + "summary": "Creates custom document fields in an existing template document.", + "description": "Creates custom document fields in an existing template document.", + "operationId": "CustomFields_PostTemplateCustomFields", "consumes": [], "produces": [], "parameters": [ @@ -16056,16 +16327,16 @@ { "name": "templateId", "in": "path", - "description": "The ID of the template.", + "description": "The id of the template.", "required": true, "type": "string" }, { - "name": "returnUrlRequest", + "name": "templateCustomFields", "in": "body", "required": false, "schema": { - "$ref": "#/definitions/returnUrlRequest" + "$ref": "#/definitions/templateCustomFields" }, "description": "" } @@ -16074,7 +16345,7 @@ "201": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/TemplateViews" + "$ref": "#/definitions/customFields" } }, "400": { @@ -16085,21 +16356,18 @@ } }, "deprecated": false, - "x-ds-methodname": "createEditView", - "x-ds-method": "createEdit", + "x-ds-methodname": "createCustomFields", + "x-ds-method": "create", "x-ds-service": "Templates", - "description": "", "x-ds-in-sdk": true }, - "parameters": [] - }, - "/v2.1/accounts/{accountId}/templates/{templateId}/views/recipient_preview": { - "post": { + "delete": { "tags": [ - "EnvelopeViews" + "TemplateCustomFields" ], - "summary": "", - "operationId": "Views_PostTemplateRecipientPreview", + "summary": "Deletes envelope custom fields in a template.", + "description": "Deletes envelope custom fields in a template.", + "operationId": "CustomFields_DeleteTemplateCustomFields", "consumes": [], "produces": [], "parameters": [ @@ -16113,25 +16381,25 @@ { "name": "templateId", "in": "path", - "description": "The ID of the template.", + "description": "The id of the template.", "required": true, "type": "string" }, { - "name": "recipientPreviewRequest", + "name": "templateCustomFields", "in": "body", "required": false, "schema": { - "$ref": "#/definitions/recipientPreviewRequest" + "$ref": "#/definitions/templateCustomFields" }, "description": "" } ], "responses": { - "201": { + "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/TemplateViews" + "$ref": "#/definitions/customFields" } }, "400": { @@ -16142,22 +16410,21 @@ } }, "deprecated": false, - "x-ds-methodname": "createTemplateRecipientPreview", - "x-ds-method": "createTemplateRecipientPreview", - "x-ds-service": "Uncategorized", - "description": "", + "x-ds-methodname": "deleteCustomFields", + "x-ds-method": "delete", + "x-ds-service": "Templates", "x-ds-in-sdk": true }, "parameters": [] }, - "/v2.1/accounts/{accountId}/unsupported_file_types": { + "/v2.1/accounts/{accountId}/templates/{templateId}/documents": { "get": { "tags": [ - "Accounts" + "TemplateDocuments" ], - "summary": "Gets a list of unsupported file types.", - "description": "Retrieves a list of file types (mime-types and file-extensions) that are not supported for upload through the DocuSign system.", - "operationId": "UnsupportedFileTypes_GetUnsupportedFileTypes", + "summary": "Gets a list of documents associated with a template.", + "description": "Retrieves a list of documents associated with the specified template.", + "operationId": "Documents_GetTemplateDocuments", "consumes": [], "produces": [], "parameters": [ @@ -16167,13 +16434,27 @@ "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" + }, + { + "name": "templateId", + "in": "path", + "description": "The id of the template.", + "required": true, + "type": "string" + }, + { + "name": "include_tabs", + "in": "query", + "required": false, + "type": "string", + "description": "Reserved for DocuSign." } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/fileTypeList" + "$ref": "#/definitions/templateDocumentsResult" } }, "400": { @@ -16184,21 +16465,18 @@ } }, "deprecated": false, - "x-ds-methodname": "listUnsupportedFileTypes", - "x-ds-method": "listUnsupportedFileTypes", - "x-ds-service": "Accounts", + "x-ds-methodname": "listDocuments", + "x-ds-method": "list", + "x-ds-service": "Templates", "x-ds-in-sdk": true }, - "parameters": [] - }, - "/v2.1/accounts/{accountId}/users": { - "get": { + "put": { "tags": [ - "Users" + "TemplateDocuments" ], - "summary": "Retrieves the list of users for the specified account.", - "description": "Retrieves the list of users for the specified account.\n\nThe response returns the list of users for the account, with information about the result set. If the `additional_info` query is added to the endpoint and set to **true**, full user information is returned for each user.", - "operationId": "Users_GetUsers", + "summary": "Adds documents to a template document.", + "description": "Adds one or more documents to an existing template document.", + "operationId": "Documents_PutTemplateDocuments", "consumes": [], "produces": [], "parameters": [ @@ -16210,88 +16488,27 @@ "type": "string" }, { - "name": "additional_info", - "in": "query", - "description": "When set to **true**, the custom settings information is returned for each user in the account. If this parameter is omitted, the default behavior is **false**.", - "required": false, - "type": "string" - }, - { - "name": "count", - "in": "query", - "description": "Number of records to return. The number must be greater than 0 and less than or equal to 100. ", - "required": false, - "type": "string" - }, - { - "name": "email", - "in": "query", - "required": false, - "type": "string", - "description": "Reserved for DocuSign." - }, - { - "name": "email_substring", - "in": "query", - "description": "Reserved for DocuSign.", - "required": false, - "type": "string" - }, - { - "name": "group_id", - "in": "query", - "description": "Filters returned user records by one or more group IDs.", - "required": false, - "type": "string" - }, - { - "name": "include_usersettings_for_csv", - "in": "query", - "required": false, - "type": "string", - "description": "Return the `userSettings` object data in CSV format." - }, - { - "name": "login_status", - "in": "query", - "required": false, - "type": "string", - "description": "Return the login status of each user." - }, - { - "name": "not_group_id", - "in": "query", - "required": false, - "type": "string", - "description": "Return user records excluding the specified group IDs." - }, - { - "name": "start_position", - "in": "query", - "description": "The position within the total result set from which to start returning values.", - "required": false, + "name": "templateId", + "in": "path", + "description": "The id of the template.", + "required": true, "type": "string" }, { - "name": "status", - "in": "query", - "required": false, - "type": "string", - "description": "Filters the user records by account status. One of:\n\n* ActivationRequired\n* ActivationSent\n* Active\n* Closed\n* Disabled\n" - }, - { - "name": "user_name_substring", - "in": "query", - "description": "Filters returned user records by full user name or a substring of user name.", + "name": "envelopeDefinition", + "in": "body", "required": false, - "type": "string" + "schema": { + "$ref": "#/definitions/envelopeDefinition" + }, + "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/userInformationList" + "$ref": "#/definitions/templateDocumentsResult" } }, "400": { @@ -16302,17 +16519,18 @@ } }, "deprecated": false, - "x-ds-methodname": "list", - "x-ds-method": "list", - "x-ds-service": "Users", + "x-ds-methodname": "updateDocuments", + "x-ds-method": "updateList", + "x-ds-service": "Templates", "x-ds-in-sdk": true }, - "put": { + "delete": { "tags": [ - "Users" + "TemplateDocuments" ], - "summary": "Change one or more user in the specified account.", - "operationId": "Users_PutUsers", + "summary": "Deletes documents from a template.", + "description": "This method deletes one or more documents from an existing template.\n\nTo delete a document, use only the relevant parts of the [`envelopeDefinition`](#envelopeDefinition).\nFor example, this request body specifies that you want to delete the document whose `documentId` is \"1\".\n\n\n```text\n{\n \"documents\": [\n {\n \"documentId\": \"1\"\n }\n ]\n}\n```", + "operationId": "Documents_DeleteTemplateDocuments", "consumes": [], "produces": [], "parameters": [ @@ -16324,11 +16542,18 @@ "type": "string" }, { - "name": "userInformationList", + "name": "templateId", + "in": "path", + "description": "The id of the template.", + "required": true, + "type": "string" + }, + { + "name": "envelopeDefinition", "in": "body", "required": false, "schema": { - "$ref": "#/definitions/userInformationList" + "$ref": "#/definitions/envelopeDefinition" }, "description": "" } @@ -16337,7 +16562,7 @@ "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/userInformationList" + "$ref": "#/definitions/templateDocumentsResult" } }, "400": { @@ -16348,21 +16573,25 @@ } }, "deprecated": false, - "x-ds-methodname": "updateUsers", - "x-ds-method": "updateList", - "x-ds-service": "Users", - "description": "", + "x-ds-methodname": "deleteDocuments", + "x-ds-method": "delete", + "x-ds-service": "Templates", "x-ds-in-sdk": true }, - "post": { + "parameters": [] + }, + "/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}": { + "get": { "tags": [ - "Users" + "TemplateDocuments" ], - "summary": "Adds new users to the specified account.", - "description": "Adds new users to an account.\n\nThe body of this request is an array of [`Users`][usersobject] objects. For each new user, you must provide at least the `userName` object and an `email` object.\n\nThe `userSettings` property, defined by the [userSettingsInformation](https://developers.docusign.com/esign-rest-api/reference/Users/Users/get#userSettingsInformation) object, specifies the actions users can perform. In the example below, Tal Mason will be able to send envelopes, and the activation email will be in French because the `locale` is set to `fr`.\n\n```\nPOST /restapi/v2.1/accounts/{accountId}/users\nContent-Type: application/json\n```\n```\n{\n \"newUsers\": [\n {\n \"userName\": \"Claire Horace\",\n \"email\": \"claire@example.com.com\"\n },\n {\n \"userName\": \"Tal Mason\",\n \"email\": \"tal@example.com.com\",\n \"userSettings\": [\n {\n \"name\": \"canSendEnvelope\",\n \"value\": \"true\"\n },\n {\n \"name\": \"locale\",\n \"value\": \"fr\"\n }\n ]\n }\n ]\n}\n```\n\nA successful response is a `newUsers` array with information about the newly created users. If there was a problem in creating a user, that user entry will contain an `errorDetails` property that describes what went wrong.\n\n```json\n{\n \"newUsers\": [\n {\n \"userId\": \"e064a4fc-c0da-c0c0-95fa-8bac87ede98a\",\n \"uri\": \"/users/e064a4fc-c0da-c0c0-95fa-8bac87ede98a\",\n \"email\": \"claire@example.com\",\n \"userName\": \"Claire Horace\",\n \"createdDateTime\": \"0001-01-01T08:00:00.0000000Z\",\n \"errorDetails\": {\n \"errorCode\": \"USER_ALREADY_EXISTS_IN_ACCOUNT\",\n \"message\": \"Username and email combination already exists for this account.\"\n }\n },\n {\n \"userId\": \"a0e6c64b-feed-cafe-9af0-805ff3c8cffd\",\n \"uri\": \"/users/a0e6c64b-feed-cafe-9af0-805ff3c8cffd\",\n \"email\": \"tal@example.com\",\n \"userName\": \"Tal Mason\",\n \"userStatus\": \"ActivationSent\",\n \"createdDateTime\": \"2017-09-15T05:54:36.1265683Z\"\n }\n ]\n}\n```\n", - "operationId": "Users_PostUsers", + "summary": "Gets PDF documents from a template.", + "description": "This method retrieves one or more PDF documents from the template that you specify.\n\nYou can specify the ID of the document to retrieve, or pass in the value `combined` to retrieve all documents in the template as a single PDF file.", + "operationId": "Documents_GetTemplateDocument", "consumes": [], - "produces": [], + "produces": [ + "application/pdf" + ], "parameters": [ { "name": "accountId", @@ -16372,20 +16601,39 @@ "type": "string" }, { - "name": "newUsersDefinition", - "in": "body", + "name": "documentId", + "in": "path", + "description": "The `documentId` is set by the API client. It is an integer that falls between `1` and 2,147,483,647. The value is encoded as a string without commas. The values `1`, `2`, `3`, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a `documentId` property that specifies the document on which to place the tab.", + "required": true, + "type": "string" + }, + { + "name": "templateId", + "in": "path", + "description": "The id of the template.", + "required": true, + "type": "string" + }, + { + "name": "encrypt", + "in": "query", "required": false, - "schema": { - "$ref": "#/definitions/newUsersDefinition" - }, - "description": "" + "type": "string", + "description": "When set to **true**, the PDF bytes returned in the response are encrypted for all the key managers configured on your DocuSign account. You can decrypt the documents by using the Key Manager DecryptDocument API method. For more information about Key Manager, see the DocuSign Security Appliance Installation Guide that your organization received from DocuSign." + }, + { + "name": "show_changes", + "in": "query", + "required": false, + "type": "string", + "description": "When set to **true**, any document fields that a recipient changed are highlighted in yellow in the returned PDF document, and optional signatures or initials are outlined in red." } ], "responses": { - "201": { + "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/newUsersSummary" + "type": "file" } }, "400": { @@ -16396,18 +16644,18 @@ } }, "deprecated": false, - "x-ds-methodname": "create", - "x-ds-method": "create", - "x-ds-service": "Users", + "x-ds-methodname": "getDocument", + "x-ds-method": "get", + "x-ds-service": "Templates", "x-ds-in-sdk": true }, - "delete": { + "put": { "tags": [ - "Users" + "TemplateDocuments" ], - "summary": "Removes users account privileges.", - "description": "Closes one or more user records in the account. Users are never deleted from an account, but closing a user prevents them from using account functions.\n\nThe response whether whether the API execution succeeded (200 - OK) or failed (400 - Error). The response contains a user structure similar to the request and includes the user changes. If an error occurred during the DELETE operation for any of the users, the response for that user contains an `errorDetails` node with `errorCode` and `message` properties.", - "operationId": "Users_DeleteUsers", + "summary": "Updates a template document.", + "description": "This methods updates an existing template document.", + "operationId": "Documents_PutTemplateDocument", "consumes": [], "produces": [], "parameters": [ @@ -16419,18 +16667,32 @@ "type": "string" }, { - "name": "delete", + "name": "documentId", + "in": "path", + "description": "The `documentId` is set by the API client. It is an integer that falls between `1` and 2,147,483,647. The value is encoded as a string without commas. The values `1`, `2`, `3`, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a `documentId` property that specifies the document on which to place the tab.", + "required": true, + "type": "string" + }, + { + "name": "templateId", + "in": "path", + "description": "The id of the template.", + "required": true, + "type": "string" + }, + { + "name": "is_envelope_definition", "in": "query", "required": false, "type": "string", - "description": "ID of the user to delete." + "description": "" }, { - "name": "userInfoList", + "name": "envelopeDefinition", "in": "body", "required": false, "schema": { - "$ref": "#/definitions/userInfoList" + "$ref": "#/definitions/envelopeDefinition" }, "description": "" } @@ -16439,7 +16701,7 @@ "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/GroupUsers" + "$ref": "#/definitions/envelopeDocument" } }, "400": { @@ -16450,21 +16712,21 @@ } }, "deprecated": false, - "x-ds-methodname": "delete", - "x-ds-method": "delete", - "x-ds-service": "Users", + "x-ds-methodname": "updateDocument", + "x-ds-method": "update", + "x-ds-service": "Templates", "x-ds-in-sdk": true }, "parameters": [] }, - "/v2.1/accounts/{accountId}/users/{userId}": { + "/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/fields": { "get": { "tags": [ - "Users" + "TemplateDocumentFields" ], - "summary": "Gets the user information for a specified user.", - "description": "Retrieves the user information for the specified user. \n\nTo return additional user information that details the last login date, login status, and the user's password expiration date, set the optional `additional_info` query string parameter to **true**.", - "operationId": "User_GetUser", + "summary": "Gets the custom document fields for a an existing template document.", + "description": "This method retrieves the custom document fields for an existing template document.", + "operationId": "DocumentFields_GetTemplateDocumentFields", "consumes": [], "produces": [], "parameters": [ @@ -16476,32 +16738,25 @@ "type": "string" }, { - "name": "userId", + "name": "documentId", "in": "path", - "description": "The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.\n", + "description": "The `documentId` is set by the API client. It is an integer that falls between `1` and 2,147,483,647. The value is encoded as a string without commas. The values `1`, `2`, `3`, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a `documentId` property that specifies the document on which to place the tab.", "required": true, "type": "string" }, { - "name": "additional_info", - "in": "query", - "description": "Setting this parameter has no effect in this operation.", - "required": false, + "name": "templateId", + "in": "path", + "description": "The id of the template.", + "required": true, "type": "string" - }, - { - "name": "email", - "in": "query", - "required": false, - "type": "string", - "description": "Setting this parameter has no effect in this operation." } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/Users" + "$ref": "#/definitions/documentFieldsInformation" } }, "400": { @@ -16512,17 +16767,18 @@ } }, "deprecated": false, - "x-ds-methodname": "getInformation", - "x-ds-method": "get", - "x-ds-service": "Users", + "x-ds-methodname": "listDocumentFields", + "x-ds-method": "list", + "x-ds-service": "Templates", "x-ds-in-sdk": true }, "put": { "tags": [ - "Users" + "TemplateDocumentFields" ], - "summary": "Updates user information for the specified user.", - "operationId": "User_PutUser", + "summary": "Updates existing custom document fields in an existing template document.", + "description": "Updates existing custom document fields in an existing template document.", + "operationId": "DocumentFields_PutTemplateDocumentFields", "consumes": [], "produces": [], "parameters": [ @@ -16534,18 +16790,25 @@ "type": "string" }, { - "name": "userId", + "name": "documentId", "in": "path", - "description": "The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.\n", + "description": "The `documentId` is set by the API client. It is an integer that falls between `1` and 2,147,483,647. The value is encoded as a string without commas. The values `1`, `2`, `3`, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a `documentId` property that specifies the document on which to place the tab.", + "required": true, + "type": "string" + }, + { + "name": "templateId", + "in": "path", + "description": "The id of the template.", "required": true, "type": "string" }, { - "name": "Users", + "name": "documentFieldsInformation", "in": "body", "required": false, "schema": { - "$ref": "#/definitions/Users" + "$ref": "#/definitions/documentFieldsInformation" }, "description": "" } @@ -16554,7 +16817,7 @@ "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/Users" + "$ref": "#/definitions/documentFieldsInformation" } }, "400": { @@ -16565,22 +16828,18 @@ } }, "deprecated": false, - "x-ds-methodname": "updateUser", + "x-ds-methodname": "updateDocumentFields", "x-ds-method": "update", - "x-ds-service": "Users", - "description": "To update user information for a specific user, submit a [Users](#Users) object with updated field values in the request body of this operation.", + "x-ds-service": "Templates", "x-ds-in-sdk": true }, - "parameters": [] - }, - "/v2.1/accounts/{accountId}/users/{userId}/cloud_storage": { - "get": { + "post": { "tags": [ - "CloudStorageProviders" + "TemplateDocumentFields" ], - "summary": "Get the Cloud Storage Provider configuration for the specified user.", - "description": "Retrieves the list of cloud storage providers enabled for the account and the configuration information for the user.\n", - "operationId": "CloudStorage_GetCloudStorageProviders", + "summary": "Creates custom document fields in an existing template document.", + "description": "Creates custom document fields in an existing template document.", + "operationId": "DocumentFields_PostTemplateDocumentFields", "consumes": [], "produces": [], "parameters": [ @@ -16592,25 +16851,34 @@ "type": "string" }, { - "name": "userId", + "name": "documentId", "in": "path", - "description": "The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.\n", + "description": "The `documentId` is set by the API client. It is an integer that falls between `1` and 2,147,483,647. The value is encoded as a string without commas. The values `1`, `2`, `3`, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a `documentId` property that specifies the document on which to place the tab.", "required": true, "type": "string" }, { - "name": "redirectUrl", - "in": "query", - "description": " The URL the user is redirected to after the cloud storage provider authenticates the user. Using this will append the redirectUrl to the authenticationUrl.\n\nThe redirectUrl is restricted to URLs in the docusign.com or docusign.net domains.\n ", - "required": false, + "name": "templateId", + "in": "path", + "description": "The id of the template.", + "required": true, "type": "string" + }, + { + "name": "documentFieldsInformation", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/documentFieldsInformation" + }, + "description": "" } ], "responses": { - "200": { + "201": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/CloudStorageProviders" + "$ref": "#/definitions/documentFieldsInformation" } }, "400": { @@ -16621,18 +16889,18 @@ } }, "deprecated": false, - "x-ds-methodname": "listProviders", - "x-ds-method": "list", - "x-ds-service": "CloudStorage", + "x-ds-methodname": "createDocumentFields", + "x-ds-method": "create", + "x-ds-service": "Templates", "x-ds-in-sdk": true }, - "post": { + "delete": { "tags": [ - "CloudStorageProviders" + "TemplateDocumentFields" ], - "summary": "Configures the redirect URL information for one or more cloud storage providers for the specified user.", - "description": "Configures the redirect URL information for one or more cloud storage providers for the specified user. The redirect URL is added to the authentication URL to complete the return route.", - "operationId": "CloudStorage_PostCloudStorage", + "summary": "Deletes custom document fields from an existing template document.", + "description": "Deletes custom document fields from an existing template document.", + "operationId": "DocumentFields_DeleteTemplateDocumentFields", "consumes": [], "produces": [], "parameters": [ @@ -16644,27 +16912,34 @@ "type": "string" }, { - "name": "userId", + "name": "documentId", "in": "path", - "description": "The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.\n", + "description": "The `documentId` is set by the API client. It is an integer that falls between `1` and 2,147,483,647. The value is encoded as a string without commas. The values `1`, `2`, `3`, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a `documentId` property that specifies the document on which to place the tab.", + "required": true, + "type": "string" + }, + { + "name": "templateId", + "in": "path", + "description": "The id of the template.", "required": true, "type": "string" }, { - "name": "CloudStorageProviders", + "name": "documentFieldsInformation", "in": "body", "required": false, "schema": { - "$ref": "#/definitions/CloudStorageProviders" + "$ref": "#/definitions/documentFieldsInformation" }, "description": "" } ], "responses": { - "201": { + "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/CloudStorageProviders" + "$ref": "#/definitions/documentFieldsInformation" } }, "400": { @@ -16675,18 +16950,20 @@ } }, "deprecated": false, - "x-ds-methodname": "createProvider", - "x-ds-method": "create", - "x-ds-service": "CloudStorage", + "x-ds-methodname": "deleteDocumentFields", + "x-ds-method": "delete", + "x-ds-service": "Templates", "x-ds-in-sdk": true }, - "delete": { + "parameters": [] + }, + "/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/html_definitions": { + "get": { "tags": [ - "CloudStorageProviders" + "TemplateDocumentHtmlDefinitions" ], - "summary": "Deletes the user authentication information for one or more cloud storage providers.", - "description": "Deletes the user authentication information for one or more cloud storage providers. The next time the user tries to access the cloud storage provider, they must pass normal authentication.", - "operationId": "CloudStorage_DeleteCloudStorageProviders", + "summary": "Gets the Original HTML Definition used to generate the Responsive HTML for a given document in a template.", + "operationId": "ResponsiveHtml_GetTemplateDocumentHtmlDefinitions", "consumes": [], "produces": [], "parameters": [ @@ -16698,27 +16975,25 @@ "type": "string" }, { - "name": "userId", + "name": "documentId", "in": "path", - "description": "The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.\n", + "description": "The `documentId` is set by the API client. It is an integer that falls between `1` and 2,147,483,647. The value is encoded as a string without commas. The values `1`, `2`, `3`, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a `documentId` property that specifies the document on which to place the tab.", "required": true, "type": "string" }, { - "name": "CloudStorageProviders", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/CloudStorageProviders" - }, - "description": "" + "name": "templateId", + "in": "path", + "description": "The id of the template.", + "required": true, + "type": "string" } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/CloudStorageProviders" + "$ref": "#/definitions/documentHtmlDefinitionOriginals" } }, "400": { @@ -16729,58 +17004,100 @@ } }, "deprecated": false, - "x-ds-methodname": "deleteProviders", - "x-ds-method": "deleteList", - "x-ds-service": "CloudStorage", + "x-ds-methodname": "getTemplateDocumentHtmlDefinitions", + "x-ds-method": "list", + "x-ds-service": "Uncategorized", + "description": "", "x-ds-in-sdk": true }, "parameters": [] }, - "/v2.1/accounts/{accountId}/users/{userId}/cloud_storage/{serviceId}": { + "/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages": { "get": { "tags": [ - "CloudStorageProviders" + "Templates" ], - "summary": "Gets the specified Cloud Storage Provider configuration for the User.", - "description": "Retrieves the list of cloud storage providers enabled for the account and the configuration information for the user.", - "operationId": "CloudStorage_GetCloudStorage", + "summary": "Returns document page image(s) based on input.", + "operationId": "Pages_GetTemplatePageImages", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", - "description": "The external account number (int) or account ID GUID.", + "description": "(Required) The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { - "name": "serviceId", + "name": "documentId", "in": "path", - "description": "The ID of the service to access. \n\nValid values are the service name (\"Box\") or the numerical serviceId (\"4136\").", + "description": "(Required) The ID of the document.", "required": true, "type": "string" }, { - "name": "userId", + "name": "templateId", "in": "path", - "description": "The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.\n", + "description": "(Required) The ID of the template.", "required": true, "type": "string" }, { - "name": "redirectUrl", + "name": "count", "in": "query", - "description": " The URL the user is redirected to after the cloud storage provider authenticates the user. Using this will append the redirectUrl to the authenticationUrl.\n\nThe redirectUrl is restricted to URLs in the docusign.com or docusign.net domains.\n ", "required": false, - "type": "string" + "type": "string", + "description": "The maximum number of results to return." + }, + { + "name": "dpi", + "in": "query", + "required": false, + "type": "string", + "description": "The number of dots per inch (DPI) for the resulting images. Valid values are 1-310 DPI. The default value is 94." + }, + { + "name": "max_height", + "in": "query", + "required": false, + "type": "string", + "description": "Sets the maximum height of the returned images in pixels." + }, + { + "name": "max_width", + "in": "query", + "required": false, + "type": "string", + "description": "Sets the maximum width of the returned images in pixels." + }, + { + "name": "nocache", + "in": "query", + "required": false, + "type": "string", + "description": "If **true**, using cache is disabled and image information is retrieved from a database. **True** is the default value. " + }, + { + "name": "show_changes", + "in": "query", + "required": false, + "type": "string", + "description": "If **true**, changes display in the user interface." + }, + { + "name": "start_position", + "in": "query", + "required": false, + "type": "string", + "description": "The position within the total result set from which to start returning values. The value **thumbnail** may be used to return the page image." } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/CloudStorageProviders" + "$ref": "#/definitions/pageImages" } }, "400": { @@ -16791,18 +17108,22 @@ } }, "deprecated": false, - "x-ds-methodname": "getProvider", - "x-ds-method": "get", - "x-ds-service": "CloudStorage", + "x-ds-methodname": "getDocumentPageImages", + "x-ds-method": "getPageImages", + "x-ds-service": "Templates", + "description": "Returns images of the pages in a template document for display based on the parameters that you specify.", "x-ds-in-sdk": true }, + "parameters": [] + }, + "/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages/{pageNumber}": { "delete": { "tags": [ - "CloudStorageProviders" + "Templates" ], - "summary": "Deletes the user authentication information for the specified cloud storage provider.", - "description": "Deletes the user authentication information for the specified cloud storage provider. The next time the user tries to access the cloud storage provider, they must pass normal authentication for this cloud storage provider.", - "operationId": "CloudStorage_DeleteCloudStorage", + "summary": "Deletes a page from a document in an template.", + "description": "Deletes a page from a document in a template based on the page number.", + "operationId": "Pages_DeleteTemplatePage", "consumes": [], "produces": [], "parameters": [ @@ -16814,26 +17135,39 @@ "type": "string" }, { - "name": "serviceId", + "name": "documentId", "in": "path", - "description": "The ID of the service to access. \n\nValid values are the service name (\"Box\") or the numerical serviceId (\"4136\").", + "description": "The `documentId` is set by the API client. It is an integer that falls between `1` and 2,147,483,647. The value is encoded as a string without commas. The values `1`, `2`, `3`, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a `documentId` property that specifies the document on which to place the tab.", "required": true, "type": "string" }, { - "name": "userId", + "name": "pageNumber", "in": "path", - "description": "The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.\n", + "description": "The page number being accessed.", + "required": true, + "type": "string" + }, + { + "name": "templateId", + "in": "path", + "description": "The id of the template.", "required": true, "type": "string" + }, + { + "name": "pageRequest", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/pageRequest" + }, + "description": "" } ], "responses": { "200": { - "description": "Successful response.", - "schema": { - "$ref": "#/definitions/CloudStorageProviders" - } + "description": "Successful response." }, "400": { "description": "Error encountered.", @@ -16843,23 +17177,25 @@ } }, "deprecated": false, - "x-ds-methodname": "deleteProvider", - "x-ds-method": "delete", - "x-ds-service": "CloudStorage", + "x-ds-methodname": "deleteDocumentPage", + "x-ds-method": "deleteDocumentPage", + "x-ds-service": "Templates", "x-ds-in-sdk": true }, "parameters": [] }, - "/v2.1/accounts/{accountId}/users/{userId}/cloud_storage/{serviceId}/folders": { + "/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages/{pageNumber}/page_image": { "get": { "tags": [ - "CloudStorage" + "Templates" ], - "summary": "Retrieves a list of all the items in a specified folder from the specified cloud storage provider.", - "description": "Retrieves a list of all the items in a specified folder from the specified cloud storage provider. ", - "operationId": "CloudStorageFolder_GetCloudStorageFolderAll", + "summary": "Gets a page image from a template for display.", + "description": "Retrieves a page image for display from the specified template.", + "operationId": "Pages_GetTemplatePageImage", "consumes": [], - "produces": [], + "produces": [ + "image/png" + ], "parameters": [ { "name": "accountId", @@ -16869,67 +17205,60 @@ "type": "string" }, { - "name": "serviceId", + "name": "documentId", "in": "path", - "description": "The ID of the service to access. \n\nValid values are the service name (\"Box\") or the numerical serviceId (\"4136\").", + "description": "The `documentId` is set by the API client. It is an integer that falls between `1` and 2,147,483,647. The value is encoded as a string without commas. The values `1`, `2`, `3`, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a `documentId` property that specifies the document on which to place the tab.", "required": true, "type": "string" }, { - "name": "userId", + "name": "pageNumber", "in": "path", - "description": "The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.\n", + "description": "The page number being accessed.", "required": true, "type": "string" }, { - "name": "cloud_storage_folder_path", - "in": "query", - "description": "A comma separated list of folder IDs included in the request. ", - "required": false, + "name": "templateId", + "in": "path", + "description": "The id of the template.", + "required": true, "type": "string" }, { - "name": "count", + "name": "dpi", "in": "query", - "description": "An optional value that sets how many items are included in the response. \n\nThe default setting for this is 25. ", "required": false, - "type": "string" + "type": "string", + "description": "The number of dots per inch (DPI) for the resulting images. Valid values are 1-310 DPI. The default value is 94." }, { - "name": "order", + "name": "max_height", "in": "query", - "description": "(Optional) The order in which to sort the results.\n\nValid values are: \n\n\n* `asc`: Ascending order.\n* `desc`: Descending order. ", "required": false, - "type": "string" + "type": "string", + "description": "Sets the maximum height of the returned images in pixels." }, { - "name": "order_by", + "name": "max_width", "in": "query", - "description": "(Optional) The file attribute to use to sort the results.\n\nValid values are: \n\n* `modified`\n* `name`", "required": false, - "type": "string" + "type": "string", + "description": "Sets the maximum width of the returned images in pixels." }, { - "name": "search_text", + "name": "show_changes", "in": "query", "required": false, "type": "string", "description": "" - }, - { - "name": "start_position", - "in": "query", - "description": "Indicates the starting point of the first item included in the response set. It uses a 0-based index. The default setting for this is 0. ", - "required": false, - "type": "string" } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/CloudStorage" + "type": "file" } }, "400": { @@ -16940,21 +17269,18 @@ } }, "deprecated": false, - "x-ds-methodname": "listFolders", - "x-ds-method": "listFolders", - "x-ds-service": "CloudStorage", + "x-ds-methodname": "getDocumentPageImage", + "x-ds-method": "getDocumentPageImage", + "x-ds-service": "Templates", "x-ds-in-sdk": true }, - "parameters": [] - }, - "/v2.1/accounts/{accountId}/users/{userId}/cloud_storage/{serviceId}/folders/{folderId}": { - "get": { + "put": { "tags": [ - "CloudStorage" + "Templates" ], - "summary": "Gets a list of all the items from the specified cloud storage provider.", - "description": "Retrieves a list of all the items in all the folders associated with the user from the specified cloud storage provider. You can limit the scope of the returned items by providing a comma separated list of folder IDs in the request.", - "operationId": "CloudStorageFolder_GetCloudStorageFolder", + "summary": "Rotates page image from a template for display.", + "description": "Rotates page image from a template for display. The page image can be rotated to the left or right.", + "operationId": "Pages_PutTemplatePageImage", "consumes": [], "produces": [], "parameters": [ @@ -16966,82 +17292,39 @@ "type": "string" }, { - "name": "folderId", + "name": "documentId", "in": "path", - "description": "Unique identifier for the folder.", + "description": "The `documentId` is set by the API client. It is an integer that falls between `1` and 2,147,483,647. The value is encoded as a string without commas. The values `1`, `2`, `3`, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a `documentId` property that specifies the document on which to place the tab.", "required": true, "type": "string" }, { - "name": "serviceId", + "name": "pageNumber", "in": "path", - "description": "The ID of the service to access. \n\nValid values are the service name (\"Box\") or the numerical serviceId (\"4136\").", + "description": "The page number being accessed.", "required": true, "type": "string" }, { - "name": "userId", + "name": "templateId", "in": "path", - "description": "The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.\n", + "description": "The id of the template.", "required": true, "type": "string" }, { - "name": "cloud_storage_folder_path", - "in": "query", - "required": false, - "type": "string", - "description": "" - }, - { - "name": "cloud_storage_folderid_plain", - "in": "query", - "required": false, - "type": "string", - "description": "" - }, - { - "name": "count", - "in": "query", - "description": "An optional value that sets how many items are included in the response. \n\nThe default setting for this is 25. ", - "required": false, - "type": "string" - }, - { - "name": "order", - "in": "query", - "description": "(Optional) The order in which to sort the results.\n\nValid values are: \n\n\n* `asc`: Ascending order.\n* `desc`: Descending order. ", - "required": false, - "type": "string" - }, - { - "name": "order_by", - "in": "query", - "description": "(Optional) The file attribute to use to sort the results.\n\nValid values are: \n\n* `modified`\n* `name`", - "required": false, - "type": "string" - }, - { - "name": "search_text", - "in": "query", + "name": "pageRequest", + "in": "body", "required": false, - "type": "string", + "schema": { + "$ref": "#/definitions/pageRequest" + }, "description": "" - }, - { - "name": "start_position", - "in": "query", - "description": "Indicates the starting point of the first item included in the response set. It uses a 0-based index. The default setting for this is 0. ", - "required": false, - "type": "string" } ], "responses": { "200": { - "description": "Successful response.", - "schema": { - "$ref": "#/definitions/CloudStorage" - } + "description": "Successful response." }, "400": { "description": "Error encountered.", @@ -17051,21 +17334,20 @@ } }, "deprecated": false, - "x-ds-methodname": "list", - "x-ds-method": "list", - "x-ds-service": "CloudStorage", + "x-ds-methodname": "rotateDocumentPage", + "x-ds-method": "rotateDocumentPage", + "x-ds-service": "Templates", "x-ds-in-sdk": true }, "parameters": [] }, - "/v2.1/accounts/{accountId}/users/{userId}/custom_settings": { + "/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages/{pageNumber}/tabs": { "get": { "tags": [ - "UserCustomSettings" + "TemplateDocumentTabs" ], - "summary": "Retrieves the custom user settings for a specified user.", - "description": "Retrieves a list of custom user settings for a single user.\n\nCustom settings provide a flexible way to store and retrieve custom user information that can be used in your own system.\n\n###### Note: Custom user settings are not the same as user account settings.\n\n###Getting Grouped Custom User Settings###\n\nIf the custom user settings you want to retrieve are grouped, you must include the following information in the header, after Content-Type, in the request:\n\n`X-DocuSign-User-Settings-Key:group_name`\n\nWhere the `group_name` is your designated name for the group of customer user settings.\n\nIf the extra header information is not included, only the custom user settings that were added without a group are retrieved.", - "operationId": "UserCustomSettings_GetCustomSettings", + "summary": "Returns tabs on the specified page.", + "operationId": "Tabs_GetTemplatePageTabs", "consumes": [], "produces": [], "parameters": [ @@ -17077,72 +17359,32 @@ "type": "string" }, { - "name": "userId", + "name": "documentId", "in": "path", - "description": "The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.\n", + "description": "The `documentId` is set by the API client. It is an integer that falls between `1` and 2,147,483,647. The value is encoded as a string without commas. The values `1`, `2`, `3`, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a `documentId` property that specifies the document on which to place the tab.", "required": true, "type": "string" - } - ], - "responses": { - "200": { - "description": "Successful response.", - "schema": { - "$ref": "#/definitions/UserCustomSettings" - } }, - "400": { - "description": "Error encountered.", - "schema": { - "$ref": "#/definitions/errorDetails" - } - } - }, - "deprecated": false, - "x-ds-methodname": "listCustomSettings", - "x-ds-method": "list", - "x-ds-service": "Users", - "x-ds-in-sdk": true - }, - "put": { - "tags": [ - "UserCustomSettings" - ], - "summary": "Adds or updates custom user settings for the specified user.", - "description": "Adds or updates custom user settings for the specified user.\n\n###### Note: Custom user settings are not the same as user account settings.\n\nCustom settings provide a flexible way to store and retrieve custom user information that you can use in your own system.\n\n**Important**: There is a limit on the size for all the custom user settings for a single user. The limit is 4,000 characters, which includes the XML and JSON structure for the settings.\n\n### Grouping Custom User Settings ###\n\nYou can group custom user settings when adding them. Grouping allows you to retrieve settings that are in a specific group, instead of retrieving all the user custom settings.\n\nTo group custom user settings, add the following information in the header, after Content-Type:\n\n`X-DocuSign-User-Settings-Key:group_name`\n\nWhere the `group_name` is your designated name for the group of customer user settings. Grouping is shown in the Example Request Body below.\n\nWhen getting or deleting grouped custom user settings, you must include the extra header information.\n\nGrouping custom user settings is not required and if the extra header information is not included, the custom user settings are added normally and can be retrieved or deleted without including the additional header.", - "operationId": "UserCustomSettings_PutCustomSettings", - "consumes": [], - "produces": [], - "parameters": [ { - "name": "accountId", + "name": "pageNumber", "in": "path", - "description": "The external account number (int) or account ID GUID.", + "description": "The page number being accessed.", "required": true, "type": "string" }, { - "name": "userId", + "name": "templateId", "in": "path", - "description": "The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.\n", + "description": "The id of the template.", "required": true, "type": "string" - }, - { - "name": "UserCustomSettings", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/UserCustomSettings" - }, - "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/UserCustomSettings" + "$ref": "#/definitions/TemplateDocumentTabs" } }, "400": { @@ -17153,18 +17395,21 @@ } }, "deprecated": false, - "x-ds-methodname": "updateCustomSettings", - "x-ds-method": "update", - "x-ds-service": "Users", + "x-ds-methodname": "getPageTabs", + "x-ds-method": "getByPage", + "x-ds-service": "Templates", + "description": "", "x-ds-in-sdk": true }, - "delete": { + "parameters": [] + }, + "/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/responsive_html_preview": { + "post": { "tags": [ - "UserCustomSettings" + "TemplateDocumentResponsiveHtmlPreview" ], - "summary": "Deletes custom user settings for a specified user.", - "description": "Deletes the specified custom user settings for a single user.\n\n###Deleting Grouped Custom User Settings###\n\nIf the custom user settings you want to delete are grouped, you must include the following information in the header, after Content-Type, in the request:\n\n`X-DocuSign-User-Settings-Key:group_name`\n\nWhere the `group_name` is your designated name for the group of customer user settings.\n\nIf the extra header information is not included, only the custom user settings that were added without a group are deleted.", - "operationId": "UserCustomSettings_DeleteCustomSettings", + "summary": "Creates a preview of the responsive version of a template document.", + "operationId": "ResponsiveHtml_PostTemplateDocumentResponsiveHtmlPreview", "consumes": [], "produces": [], "parameters": [ @@ -17176,27 +17421,34 @@ "type": "string" }, { - "name": "userId", + "name": "documentId", "in": "path", - "description": "The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.\n", + "description": "The `documentId` is set by the API client. It is an integer that falls between `1` and 2,147,483,647. The value is encoded as a string without commas. The values `1`, `2`, `3`, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a `documentId` property that specifies the document on which to place the tab.", + "required": true, + "type": "string" + }, + { + "name": "templateId", + "in": "path", + "description": "The id of the template.", "required": true, "type": "string" }, { - "name": "UserCustomSettings", + "name": "documentHtmlDefinition", "in": "body", "required": false, "schema": { - "$ref": "#/definitions/UserCustomSettings" + "$ref": "#/definitions/documentHtmlDefinition" }, "description": "" } ], "responses": { - "200": { + "201": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/UserCustomSettings" + "$ref": "#/definitions/documentHtmlDefinitions" } }, "400": { @@ -17207,21 +17459,21 @@ } }, "deprecated": false, - "x-ds-methodname": "deleteCustomSettings", - "x-ds-method": "delete", - "x-ds-service": "Users", + "x-ds-methodname": "createTemplateDocumentResponsiveHtmlPreview", + "x-ds-method": "create", + "x-ds-service": "Uncategorized", + "description": "Creates a preview of the\n[responsive](https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/responsive/),\nHTML version of a specific template document. This\nmethod enables you to preview a PDF document\nconversion to responsive HTML across device types\nprior to sending.\n\nThe request body is a `documentHtmlDefinition`\nobject, which holds the responsive signing\nparameters that define how to generate the HTML\nversion of the signing document.", "x-ds-in-sdk": true }, "parameters": [] }, - "/v2.1/accounts/{accountId}/users/{userId}/profile": { + "/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/tabs": { "get": { "tags": [ - "UserProfiles" + "TemplateDocumentTabs" ], - "summary": "Retrieves the user profile for a specified user.", - "description": "Retrieves the user profile information, the privacy settings and personal information (address, phone number, etc.) for the specified user.\n\nThe userId parameter specified in the endpoint must match the authenticated user's user ID and the user must be a member of the specified account.", - "operationId": "UserProfile_GetProfile", + "summary": "Returns tabs on the document.", + "operationId": "Tabs_GetTemplateDocumentTabs", "consumes": [], "produces": [], "parameters": [ @@ -17233,18 +17485,32 @@ "type": "string" }, { - "name": "userId", + "name": "documentId", "in": "path", - "description": "The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.\n", + "description": "The `documentId` is set by the API client. It is an integer that falls between `1` and 2,147,483,647. The value is encoded as a string without commas. The values `1`, `2`, `3`, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a `documentId` property that specifies the document on which to place the tab.", + "required": true, + "type": "string" + }, + { + "name": "templateId", + "in": "path", + "description": "The id of the template.", "required": true, "type": "string" + }, + { + "name": "page_numbers", + "in": "query", + "required": false, + "type": "string", + "description": "Filters for tabs that occur on the pages that you specify. Enter as a comma-separated list of page Guids.\n\nExample: `page_numbers=2,6`" } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/UserProfiles" + "$ref": "#/definitions/TemplateDocumentTabs" } }, "400": { @@ -17255,18 +17521,18 @@ } }, "deprecated": false, - "x-ds-methodname": "getProfile", + "x-ds-methodname": "getDocumentTabs", "x-ds-method": "get", - "x-ds-service": "Users", + "x-ds-service": "Templates", + "description": "", "x-ds-in-sdk": true }, "put": { "tags": [ - "UserProfiles" + "TemplateDocumentTabs" ], - "summary": "Updates the user profile information for the specified user.", - "description": "Updates the user's detail information, profile information, privacy settings, and personal information in the user ID card.\n\nYou can also change a user's name by changing the information in the `userDetails` property. When changing a user's name, you can either change the information in the `userName` property OR change the information in `firstName`, `middleName`, `lastName, suffixName`, and `title` properties. Changes to `firstName`, `middleName`, `lastName`, `suffixName`, and `title` properties take precedence over changes to the `userName` property.", - "operationId": "UserProfile_PutProfile", + "summary": "Updates the tabs for a template.", + "operationId": "Tabs_PutTemplateDocumentTabs", "consumes": [], "produces": [], "parameters": [ @@ -17278,25 +17544,35 @@ "type": "string" }, { - "name": "userId", + "name": "documentId", "in": "path", - "description": "The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.\n", + "description": "The `documentId` is set by the API client. It is an integer that falls between `1` and 2,147,483,647. The value is encoded as a string without commas. The values `1`, `2`, `3`, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a `documentId` property that specifies the document on which to place the tab.", + "required": true, + "type": "string" + }, + { + "name": "templateId", + "in": "path", + "description": "The id of the template.", "required": true, "type": "string" }, { - "name": "UserProfiles", + "name": "templateTabs", "in": "body", "required": false, "schema": { - "$ref": "#/definitions/UserProfiles" + "$ref": "#/definitions/templateTabs" }, "description": "" } ], "responses": { "200": { - "description": "Successful response." + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/tabs" + } }, "400": { "description": "Error encountered.", @@ -17306,25 +17582,20 @@ } }, "deprecated": false, - "x-ds-methodname": "updateProfile", + "x-ds-methodname": "putDocumentTabs", "x-ds-method": "update", - "x-ds-service": "Users", + "x-ds-service": "Uncategorized", + "description": "", "x-ds-in-sdk": true }, - "parameters": [] - }, - "/v2.1/accounts/{accountId}/users/{userId}/profile/image": { - "get": { + "post": { "tags": [ - "Users" + "TemplateDocumentTabs" ], - "summary": "Retrieves the user profile image for the specified user.", - "description": "Retrieves the user profile picture for the specified user. The image is returned in the same format as uploaded.\n\nThe userId parameter specified in the endpoint must match the authenticated user's user ID and the user must be a member of the specified account.\n\nIf successful, the response returns a 200 - OK and the user profile image.", - "operationId": "UserProfileImage_GetUserProfileImage", + "summary": "Create Template Document Tabs", + "operationId": "Tabs_PostTemplateDocumentTabs", "consumes": [], - "produces": [ - "image/gif" - ], + "produces": [], "parameters": [ { "name": "accountId", @@ -17334,25 +17605,34 @@ "type": "string" }, { - "name": "userId", + "name": "documentId", "in": "path", - "description": "The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.\n", + "description": "The `documentId` is set by the API client. It is an integer that falls between `1` and 2,147,483,647. The value is encoded as a string without commas. The values `1`, `2`, `3`, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a `documentId` property that specifies the document on which to place the tab.", "required": true, "type": "string" }, { - "name": "encoding", - "in": "query", + "name": "templateId", + "in": "path", + "description": "The id of the template.", + "required": true, + "type": "string" + }, + { + "name": "templateTabs", + "in": "body", "required": false, - "type": "string", + "schema": { + "$ref": "#/definitions/templateTabs" + }, "description": "" } ], "responses": { - "200": { + "201": { "description": "Successful response.", "schema": { - "type": "file" + "$ref": "#/definitions/tabs" } }, "400": { @@ -17363,21 +17643,19 @@ } }, "deprecated": false, - "x-ds-methodname": "getProfileImage", - "x-ds-method": "getProfileImage", - "x-ds-service": "Users", + "x-ds-methodname": "postDocumentTabs", + "x-ds-method": "create", + "x-ds-service": "Uncategorized", + "description": "This method creates Template Document Tabs.", "x-ds-in-sdk": true }, - "put": { + "delete": { "tags": [ - "Users" - ], - "summary": "Updates the user profile image for a specified user.", - "description": "Updates the user profile image by uploading an image to the user profile.\n\nThe supported image formats are: gif, png, jpeg, and bmp. The file must be less than 200K. For best viewing results, DocuSign recommends that the image is no more than 79 pixels wide and high.", - "operationId": "UserProfileImage_PutUserProfileImage", - "consumes": [ - "image/gif" + "TemplateDocumentTabs" ], + "summary": "Deletes tabs from an envelope document.", + "operationId": "Tabs_DeleteTemplateDocumentTabs", + "consumes": [], "produces": [], "parameters": [ { @@ -17388,16 +17666,35 @@ "type": "string" }, { - "name": "userId", + "name": "documentId", "in": "path", - "description": "The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.\n", + "description": "The `documentId` is set by the API client. It is an integer that falls between `1` and 2,147,483,647. The value is encoded as a string without commas. The values `1`, `2`, `3`, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a `documentId` property that specifies the document on which to place the tab.", + "required": true, + "type": "string" + }, + { + "name": "templateId", + "in": "path", + "description": "The id of the template.", "required": true, "type": "string" + }, + { + "name": "templateTabs", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/templateTabs" + }, + "description": "" } ], "responses": { "200": { - "description": "Successful response." + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/tabs" + } }, "400": { "description": "Error encountered.", @@ -17407,18 +17704,21 @@ } }, "deprecated": false, - "x-ds-methodname": "updateProfileImage", - "x-ds-method": "updateProfileImage", - "x-ds-service": "Users", + "x-ds-methodname": "deleteDocumentTabs", + "x-ds-method": "delete", + "x-ds-service": "Uncategorized", + "description": "", "x-ds-in-sdk": true }, - "delete": { + "parameters": [] + }, + "/v2.1/accounts/{accountId}/templates/{templateId}/html_definitions": { + "get": { "tags": [ - "Users" + "TemplateHtmlDefinitions" ], - "summary": "Deletes the user profile image for the specified user.", - "description": "Deletes the user profile image from the specified user's profile.\n\nThe userId parameter specified in the endpoint must match the authenticated user's user ID and the user must be a member of the specified account.", - "operationId": "UserProfileImage_DeleteUserProfileImage", + "summary": "Gets the Original HTML Definition used to generate the Responsive HTML for the template.", + "operationId": "ResponsiveHtml_GetTemplateHtmlDefinitions", "consumes": [], "produces": [], "parameters": [ @@ -17430,16 +17730,19 @@ "type": "string" }, { - "name": "userId", + "name": "templateId", "in": "path", - "description": "The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.\n", + "description": "The id of the template.", "required": true, "type": "string" } ], "responses": { "200": { - "description": "Successful response." + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/documentHtmlDefinitionOriginals" + } }, "400": { "description": "Error encountered.", @@ -17449,21 +17752,22 @@ } }, "deprecated": false, - "x-ds-methodname": "deleteProfileImage", - "x-ds-method": "deleteProfileImage", - "x-ds-service": "Users", + "x-ds-methodname": "getTemplateHtmlDefinitions", + "x-ds-method": "list", + "x-ds-service": "Uncategorized", + "description": "", "x-ds-in-sdk": true }, "parameters": [] }, - "/v2.1/accounts/{accountId}/users/{userId}/settings": { + "/v2.1/accounts/{accountId}/templates/{templateId}/lock": { "get": { "tags": [ - "Users" + "TemplateLocks" ], - "summary": "Gets the user account settings for a specified user.", - "description": "Retrieves a list of the account settings and email notification information for the specified user.\n\nThe response returns the account setting name/value information and the email notification settings for the specified user. For more information about the different user settings, see [User Settings](https://developers.docusign.com/esign-rest-api/reference/Users/Users/create/#user-settings).\n\n\n", - "operationId": "UserSettings_GetUserSettings", + "summary": "Gets template lock information.", + "description": "Retrieves general information about a template lock.\n\nThe user requesting the information must be the same user\nwho locked the template.\n\nYou can use this method to recover the lock information,\nincluding the `lockToken`,\nfor a locked template.\nThe `X-DocuSign-Edit` header is included in the response.\n\nSee\n[TemplateLocks: create](https://developers.docusign.com/docs/esign-rest-api/reference/templates/templatelocks/create/)\nfor a description of the `X-DocuSign-Edit` header.\n", + "operationId": "Lock_GetTemplateLock", "consumes": [], "produces": [], "parameters": [ @@ -17475,9 +17779,9 @@ "type": "string" }, { - "name": "userId", + "name": "templateId", "in": "path", - "description": "The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.\n", + "description": "The id of the template.", "required": true, "type": "string" } @@ -17486,7 +17790,7 @@ "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/userSettingsInformation" + "$ref": "#/definitions/lockInformation" } }, "400": { @@ -17497,18 +17801,18 @@ } }, "deprecated": false, - "x-ds-methodname": "getSettings", - "x-ds-method": "getSettings", - "x-ds-service": "Users", + "x-ds-methodname": "getLock", + "x-ds-method": "get", + "x-ds-service": "Templates", "x-ds-in-sdk": true }, "put": { "tags": [ - "Users" + "TemplateLocks" ], - "summary": "Updates the user account settings for a specified user.", - "description": "Updates the account settings list and email notification types for the specified user.", - "operationId": "UserSettings_PutUserSettings", + "summary": "Updates a template lock.", + "description": "Updates the lock information for a locked template.\n\nYou must include the `X-DocuSign-Edit` header\nas described in\n[TemplateLocks: create](https://developers.docusign.com/docs/esign-rest-api/reference/templates/templatelocks/create/).\n\n\nUse this method to change the duration\nof the lock (`lockDurationInSeconds`)\nor the `lockedByApp` string.\n\nThe request body is a full `lockRequest` object,\nbut you only need to specify the\nproperties that you are updating. For example:\n\n```\n{\n \"lockDurationInSeconds\": \"3600\",\n \"lockedByApp\": \"My Application\"\n}\n```\n\n", + "operationId": "Lock_PutTemplateLock", "consumes": [], "produces": [], "parameters": [ @@ -17520,25 +17824,28 @@ "type": "string" }, { - "name": "userId", + "name": "templateId", "in": "path", - "description": "The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.\n", + "description": "The id of the template.", "required": true, "type": "string" }, { - "name": "userSettingsInformation", + "name": "lockRequest", "in": "body", "required": false, "schema": { - "$ref": "#/definitions/userSettingsInformation" + "$ref": "#/definitions/lockRequest" }, "description": "" } ], "responses": { "200": { - "description": "Successful response." + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/lockInformation" + } }, "400": { "description": "Error encountered.", @@ -17548,21 +17855,18 @@ } }, "deprecated": false, - "x-ds-methodname": "updateSettings", - "x-ds-method": "updateSettings", - "x-ds-service": "Users", + "x-ds-methodname": "updateLock", + "x-ds-method": "update", + "x-ds-service": "Templates", "x-ds-in-sdk": true }, - "parameters": [] - }, - "/v2.1/accounts/{accountId}/users/{userId}/signatures": { - "get": { + "post": { "tags": [ - "UserSignatures" + "TemplateLocks" ], - "summary": "Retrieves a list of user signature definitions for a specified user.", - "description": "Retrieves the signature definitions for the specified user.\n\nThe userId parameter specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account.\n\nThe `signatureId` parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. \n\nFor example encode \"Bob Smith\" as \"Bob%20Smith\".", - "operationId": "UserSignatures_GetUserSignatures", + "summary": "Locks a template.", + "description": "This method locks the specified template and sets the time until\nthe lock expires to prevent other users or recipients from\nchanging the template.\n\n**Note**: To use this method, the envelope locking\ncapability must be enabled for the user; that is, the user setting\n`canLockEnvelopes` must be set to **true**.\n\nThe response to this request includes a `lockToken` parameter\nthat you must use in the `X-DocuSign-Edit` header for\nevery PUT method (typically a method that updates a template)\nwhile the template is locked.\n\n\nIf you do not provide the `lockToken` when accessing\na locked template, you will get the following\nerror:\n\n```\n{\n \"errorCode\": \"EDIT_LOCK_NOT_LOCK_OWNER\",\n \"message\": \"The user is not the owner of the lock. The template is locked by another user or in another application\"\n}\n```\n\n\n### The X-DocuSign-Edit header\n\nThe `X-DocuSign-Edit` header looks like this\nand can be specified in either JSON or XML.\n\n**JSON**\n```\n{\n \"LockToken\": \"token-from-response\",\n \"LockDurationInSeconds\": \"600\"\n}\n```\n\n**XML**\n```\n\n token-from-response\n 600\n\n```\n\nIn the actual HTTP header, you would remove the linebreaks:\n\n```\nX-DocuSign-Edit: {\"LockToken\": \"token-from-response\", \"LockDurationInSeconds\": \"600\" }\n or\nX-DocuSign-Edit:token-from-response600\n```\n\n\n", + "operationId": "Lock_PostTemplateLock", "consumes": [], "produces": [], "parameters": [ @@ -17574,25 +17878,27 @@ "type": "string" }, { - "name": "userId", + "name": "templateId", "in": "path", - "description": "The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.\n", + "description": "The id of the template.", "required": true, "type": "string" }, { - "name": "stamp_type", - "in": "query", + "name": "lockRequest", + "in": "body", "required": false, - "type": "string", + "schema": { + "$ref": "#/definitions/lockRequest" + }, "description": "" } ], "responses": { - "200": { + "201": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/userSignaturesInformation" + "$ref": "#/definitions/lockInformation" } }, "400": { @@ -17603,17 +17909,18 @@ } }, "deprecated": false, - "x-ds-methodname": "listSignatures", - "x-ds-method": "list", - "x-ds-service": "Users", + "x-ds-methodname": "createLock", + "x-ds-method": "create", + "x-ds-service": "Templates", "x-ds-in-sdk": true }, - "put": { + "delete": { "tags": [ - "UserSignatures" + "TemplateLocks" ], - "summary": "Adds/updates a user signature.", - "operationId": "UserSignatures_PutUserSignature", + "summary": "Deletes a template lock.", + "description": "Deletes the lock from the specified template.\nThe user deleting the lock must be the same user\nwho locked the template.\n\nYou must include the `X-DocuSign-Edit` header\nas described in\n[TemplateLocks: create](https://developers.docusign.com/docs/esign-rest-api/reference/templates/templatelocks/create/).\n\nThis method takes an optional query paramter\nthat lets you specify whether\nchanges made while the template was locked\nare kept or discarded.\n\n\n| Query Parameter | Description |\n| :-------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `save_changes` | (Optional) When set to **true** (the default), any changes made while the lock was active are saved. When set to **false**, any changes made while the template was locked are discarded. |\n", + "operationId": "Lock_DeleteTemplateLock", "consumes": [], "produces": [], "parameters": [ @@ -17625,18 +17932,18 @@ "type": "string" }, { - "name": "userId", + "name": "templateId", "in": "path", - "description": "The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.\n", + "description": "The id of the template.", "required": true, "type": "string" }, { - "name": "userSignaturesInformation", + "name": "lockRequest", "in": "body", "required": false, "schema": { - "$ref": "#/definitions/userSignaturesInformation" + "$ref": "#/definitions/lockRequest" }, "description": "" } @@ -17645,7 +17952,7 @@ "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/userSignaturesInformation" + "$ref": "#/definitions/lockInformation" } }, "400": { @@ -17656,19 +17963,21 @@ } }, "deprecated": false, - "x-ds-methodname": "updateSignatures", - "x-ds-method": "updateList", - "x-ds-service": "Users", - "description": "", + "x-ds-methodname": "deleteLock", + "x-ds-method": "delete", + "x-ds-service": "Templates", "x-ds-in-sdk": true }, - "post": { + "parameters": [] + }, + "/v2.1/accounts/{accountId}/templates/{templateId}/notification": { + "get": { "tags": [ - "UserSignatures" + "Templates" ], - "summary": "Adds user Signature and initials images to a Signature.", - "description": "Adds a user signature image and/or user initials image to the specified user. \n\nThe userId property specified in the endpoint must match the authenticated user's userId and the user must be a member of the account.\n\nThe rules and processes associated with this are:\n\n* If Content-Type is set to application/json, then the default behavior for creating a default signature image, based on the name and a DocuSign font, is used.\n* If Content-Type is set to multipart/form-data, then the request must contain a first part with the user signature information, followed by parts that contain the images.\n\nFor each Image part, the Content-Disposition header has a \"filename\" value that is used to map to the `signatureName` and/or `signatureInitials` properties in the JSON to the image. \n\nFor example: \n`Content-Disposition: file; filename=\"Ron Test20121127083900\"`\n\nIf no matching image (by filename value) is found, then the image is not set. One, both, or neither of the signature and initials images can be set with this call.\n\nThe Content-Transfer-Encoding: base64 header, set in the header for the part containing the image, can be set to indicate that the images are formatted as base64 instead of as binary.\n\nIf successful, 200-OK is returned, and a JSON structure containing the signature information is provided, note that the signatureId can change with each API POST, PUT, or DELETE since the changes to the signature structure cause the current signature to be closed, and a new signature record to be created.", - "operationId": "UserSignatures_PostUserSignatures", + "summary": "Gets template notification information.", + "description": "Retrieves the envelope notification, reminders and expirations, information for an existing template.", + "operationId": "Notification_GetTemplatesTemplateIdNotification", "consumes": [], "produces": [], "parameters": [ @@ -17680,27 +17989,18 @@ "type": "string" }, { - "name": "userId", + "name": "templateId", "in": "path", - "description": "The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.\n", + "description": "The id of the template.", "required": true, "type": "string" - }, - { - "name": "userSignaturesInformation", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/userSignaturesInformation" - }, - "description": "" } ], "responses": { - "201": { + "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/userSignaturesInformation" + "$ref": "#/definitions/notification" } }, "400": { @@ -17711,21 +18011,18 @@ } }, "deprecated": false, - "x-ds-methodname": "createSignatures", - "x-ds-method": "create", - "x-ds-service": "Users", + "x-ds-methodname": "getNotificationSettings", + "x-ds-method": "getNotificationSettings", + "x-ds-service": "Templates", "x-ds-in-sdk": true }, - "parameters": [] - }, - "/v2.1/accounts/{accountId}/users/{userId}/signatures/{signatureId}": { - "get": { + "put": { "tags": [ - "UserSignatures" + "Templates" ], - "summary": "Gets the user signature information for the specified user.", - "description": "Retrieves the structure of a single signature with a known signature name.\n\nThe userId specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account.\n\nThe `signatureId` parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. \n\nFor example encode \"Bob Smith\" as \"Bob%20Smith\".", - "operationId": "UserSignatures_GetUserSignature", + "summary": "Updates the notification structure for an existing template.", + "description": "Updates the notification structure for an existing template. Use this endpoint to set reminder and expiration notifications.", + "operationId": "Notification_PutTemplatesTemplateIdNotification", "consumes": [], "produces": [], "parameters": [ @@ -17737,25 +18034,27 @@ "type": "string" }, { - "name": "signatureId", + "name": "templateId", "in": "path", - "description": "The ID of the signature being accessed.", + "description": "The id of the template.", "required": true, "type": "string" }, { - "name": "userId", - "in": "path", - "description": "The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.\n", - "required": true, - "type": "string" + "name": "templateNotificationRequest", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/templateNotificationRequest" + }, + "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/UserSignatures" + "$ref": "#/definitions/notification" } }, "400": { @@ -17766,18 +18065,21 @@ } }, "deprecated": false, - "x-ds-methodname": "getSignature", - "x-ds-method": "get", - "x-ds-service": "Users", + "x-ds-methodname": "updateNotificationSettings", + "x-ds-method": "updateNotificationSettings", + "x-ds-service": "Templates", "x-ds-in-sdk": true }, - "put": { + "parameters": [] + }, + "/v2.1/accounts/{accountId}/templates/{templateId}/recipients": { + "get": { "tags": [ - "UserSignatures" + "TemplateRecipients" ], - "summary": "Updates the user signature for a specified user.", - "description": "Creates, or updates, the signature font and initials for the specified user. When creating a signature, you use this resource to create the signature name and then add the signature and initials images into the signature.\n\n###### Note: This will also create a default signature for the user when one does not exist.\n\nThe userId property specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account.\n\nThe `signatureId` parameter accepts a signature ID. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. \n\nFor example encode \"Bob Smith\" as \"Bob%20Smith\".", - "operationId": "UserSignatures_PutUserSignatureById", + "summary": "Gets recipient information from a template.", + "description": "Retrieves the information for all recipients in the specified template.", + "operationId": "Recipients_GetTemplateRecipients", "consumes": [], "produces": [], "parameters": [ @@ -17789,41 +18091,39 @@ "type": "string" }, { - "name": "signatureId", + "name": "templateId", "in": "path", - "description": "The ID of the signature being accessed.", + "description": "The id of the template.", "required": true, "type": "string" }, { - "name": "userId", - "in": "path", - "description": "The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.\n", - "required": true, + "name": "include_anchor_tab_locations", + "in": "query", + "description": " When set to **true** and `include_tabs` is set to **true**, all tabs with anchor tab properties are included in the response. ", + "required": false, "type": "string" }, { - "name": "close_existing_signature", + "name": "include_extended", "in": "query", - "description": "When set to **true**, closes the current signature.", + "description": " When set to **true**, the extended properties are included in the response. ", "required": false, "type": "string" }, { - "name": "userSignatureDefinition", - "in": "body", + "name": "include_tabs", + "in": "query", + "description": "When set to **true**, the tab information associated with the recipient is included in the response.", "required": false, - "schema": { - "$ref": "#/definitions/userSignatureDefinition" - }, - "description": "" + "type": "string" } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/UserSignatures" + "$ref": "#/definitions/recipients" } }, "400": { @@ -17834,18 +18134,18 @@ } }, "deprecated": false, - "x-ds-methodname": "updateSignature", - "x-ds-method": "update", - "x-ds-service": "Users", + "x-ds-methodname": "listRecipients", + "x-ds-method": "list", + "x-ds-service": "Templates", "x-ds-in-sdk": true }, - "delete": { + "put": { "tags": [ - "UserSignatures" + "TemplateRecipients" ], - "summary": "Removes removes signature information for the specified user.", - "description": "Removes the signature information for the user.\n\nThe userId parameter specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account.\n\nThe `signatureId` accepts a signature ID or a signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. \n\nFor example encode \"Bob Smith\" as \"Bob%20Smith\".", - "operationId": "UserSignatures_DeleteUserSignature", + "summary": "Updates recipients in a template.", + "description": "Updates recipients in a template. \n\nYou can edit the following properties: `email`, `userName`, `routingOrder`, `faxNumber`, `deliveryMethod`, `accessCode`, and `requireIdLookup`.", + "operationId": "Recipients_PutTemplateRecipients", "consumes": [], "produces": [], "parameters": [ @@ -17857,23 +18157,35 @@ "type": "string" }, { - "name": "signatureId", + "name": "templateId", "in": "path", - "description": "The ID of the signature being accessed.", + "description": "The id of the template.", "required": true, "type": "string" }, { - "name": "userId", - "in": "path", - "description": "The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.\n", - "required": true, - "type": "string" + "name": "resend_envelope", + "in": "query", + "required": false, + "type": "string", + "description": "When set to **true**, resends the envelope to the recipients that you specify in the request body. You use this parameter to resend the envelope to a recipient who deleted the original email notification.\n\n**Note**: Correcting an envelope is a different process. DocuSign always resends an envelope when you correct it, regardless of the value that you enter here." + }, + { + "name": "templateRecipients", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/templateRecipients" + }, + "description": "" } ], "responses": { "200": { - "description": "Successful response." + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/recipientsUpdateSummary" + } }, "400": { "description": "Error encountered.", @@ -17883,25 +18195,20 @@ } }, "deprecated": false, - "x-ds-methodname": "deleteSignature", - "x-ds-method": "delete", - "x-ds-service": "Users", + "x-ds-methodname": "updateRecipients", + "x-ds-method": "update", + "x-ds-service": "Templates", "x-ds-in-sdk": true }, - "parameters": [] - }, - "/v2.1/accounts/{accountId}/users/{userId}/signatures/{signatureId}/{imageType}": { - "get": { + "post": { "tags": [ - "UserSignatures" + "TemplateRecipients" ], - "summary": "Retrieves the user initials image or the user signature image for the specified user.", - "description": "Retrieves the specified initials image or signature image for the specified user. The image is returned in the same format as uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image.\n\nThe userId property specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account.\n\nThe `signatureId` parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. \n\nFor example encode \"Bob Smith\" as \"Bob%20Smith\".\n\n###### Note: Older envelopes might only have chromed images. If getting the non-chromed image fails, try getting the chromed image.", - "operationId": "UserSignatures_GetUserSignatureImage", + "summary": "Adds tabs for a recipient.", + "description": "Adds one or more recipients to a template.", + "operationId": "Recipients_PostTemplateRecipients", "consumes": [], - "produces": [ - "image/gif" - ], + "produces": [], "parameters": [ { "name": "accountId", @@ -17911,39 +18218,34 @@ "type": "string" }, { - "name": "imageType", + "name": "templateId", "in": "path", - "description": "The type of image. Valid values are: \n\n- `signature_image` \n- `initials_image`", + "description": "The id of the template.", "required": true, "type": "string" }, { - "name": "signatureId", - "in": "path", - "description": "The ID of the signature being accessed.", - "required": true, - "type": "string" + "name": "resend_envelope", + "in": "query", + "required": false, + "type": "string", + "description": "When set to **true**, resends the envelope to the recipients that you specify in the request body. You use this parameter to resend the envelope to a recipient who deleted the original email notification.\n\n**Note**: Correcting an envelope is a different process. DocuSign always resends an envelope when you correct it, regardless of the value that you enter here." }, { - "name": "userId", - "in": "path", - "description": "The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.\n", - "required": true, - "type": "string" - }, - { - "name": "include_chrome", - "in": "query", + "name": "templateRecipients", + "in": "body", "required": false, - "type": "string", + "schema": { + "$ref": "#/definitions/templateRecipients" + }, "description": "" } ], "responses": { - "200": { + "201": { "description": "Successful response.", "schema": { - "type": "file" + "$ref": "#/definitions/recipients" } }, "400": { @@ -17954,21 +18256,19 @@ } }, "deprecated": false, - "x-ds-methodname": "getSignatureImage", - "x-ds-method": "getImage", - "x-ds-service": "Users", + "x-ds-methodname": "createRecipients", + "x-ds-method": "create", + "x-ds-service": "Templates", "x-ds-in-sdk": true }, - "put": { + "delete": { "tags": [ - "UserSignatures" - ], - "summary": "Updates the user signature image or user initials image for the specified user.", - "description": "Updates the user signature image or user initials image for the specified user. The supported image formats for this file are: gif, png, jpeg, and bmp. The file must be less than 200K.\n\nThe userId property specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account.\n\nThe `signatureId` parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. \n\nFor example encode \"Bob Smith\" as \"Bob%20Smith\".\n", - "operationId": "UserSignatures_PutUserSignatureImage", - "consumes": [ - "image/gif" + "TemplateRecipients" ], + "summary": "Deletes recipients from a template.", + "description": "Deletes one or more recipients from a template. Recipients to be deleted are listed in the request, with the `recipientId` being used as the key for deleting recipients.", + "operationId": "Recipients_DeleteTemplateRecipients", + "consumes": [], "produces": [], "parameters": [ { @@ -17979,31 +18279,19 @@ "type": "string" }, { - "name": "imageType", - "in": "path", - "description": "The type of image. Valid values are: \n\n- `signature_image` \n- `initials_image`", - "required": true, - "type": "string" - }, - { - "name": "signatureId", - "in": "path", - "description": "The ID of the signature being accessed.", - "required": true, - "type": "string" - }, - { - "name": "userId", + "name": "templateId", "in": "path", - "description": "The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.\n", + "description": "The id of the template.", "required": true, "type": "string" }, { - "name": "transparent_png", - "in": "query", + "name": "templateRecipients", + "in": "body", "required": false, - "type": "string", + "schema": { + "$ref": "#/definitions/templateRecipients" + }, "description": "" } ], @@ -18011,7 +18299,7 @@ "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/UserSignatures" + "$ref": "#/definitions/recipients" } }, "400": { @@ -18022,18 +18310,21 @@ } }, "deprecated": false, - "x-ds-methodname": "updateSignatureImage", - "x-ds-method": "updateImage", - "x-ds-service": "Users", + "x-ds-methodname": "deleteRecipients", + "x-ds-method": "deleteList", + "x-ds-service": "Templates", "x-ds-in-sdk": true }, + "parameters": [] + }, + "/v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}": { "delete": { "tags": [ - "UserSignatures" + "TemplateRecipients" ], - "summary": "Deletes the user initials image or the user signature image for the specified user.", - "description": "Deletes the specified initials image or signature image for the specified user.\n\nThe function deletes one or the other of the image types, to delete both the initials image and signature image you must call the endpoint twice.\n\nThe userId parameter specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account.\n\nThe `signatureId` parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. \n\nFor example encode \"Bob Smith\" as \"Bob%20Smith\".", - "operationId": "UserSignatures_DeleteUserSignatureImage", + "summary": "Deletes the specified recipient file from a template.", + "description": "Deletes the specified recipient file from the specified template.", + "operationId": "Recipients_DeleteTemplateRecipient", "consumes": [], "produces": [], "parameters": [ @@ -18045,32 +18336,34 @@ "type": "string" }, { - "name": "imageType", + "name": "recipientId", "in": "path", - "description": "The type of image. Valid values are: \n\n- `signature_image` \n- `initials_image`", + "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", "required": true, "type": "string" }, { - "name": "signatureId", + "name": "templateId", "in": "path", - "description": "The ID of the signature being accessed.", + "description": "The id of the template.", "required": true, "type": "string" }, { - "name": "userId", - "in": "path", - "description": "The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.\n", - "required": true, - "type": "string" + "name": "templateRecipients", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/templateRecipients" + }, + "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/UserSignatures" + "$ref": "#/definitions/recipients" } }, "400": { @@ -18081,21 +18374,21 @@ } }, "deprecated": false, - "x-ds-methodname": "deleteSignatureImage", - "x-ds-method": "deleteImage", - "x-ds-service": "Users", + "x-ds-methodname": "deleteRecipient", + "x-ds-method": "delete", + "x-ds-service": "Templates", "x-ds-in-sdk": true }, "parameters": [] }, - "/v2.1/accounts/{accountId}/views/console": { - "post": { + "/v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/bulk_recipients": { + "get": { "tags": [ - "EnvelopeViews" + "TemplateBulkRecipients" ], - "summary": "Returns a URL to the authentication view UI.", - "description": "Returns a URL that allows you to embed the authentication view of the DocuSign UI in your applications.", - "operationId": "Views_PostAccountConsoleView", + "summary": "Gets the bulk recipient file from a template.", + "description": "Retrieves the bulk recipient file information from a template that has a bulk recipient.", + "operationId": "Recipients_GetTemplateBulkRecipients", "consumes": [], "produces": [], "parameters": [ @@ -18107,75 +18400,39 @@ "type": "string" }, { - "name": "consoleViewRequest", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/consoleViewRequest" - }, - "description": "" - } - ], - "responses": { - "201": { - "description": "Successful response.", - "schema": { - "$ref": "#/definitions/EnvelopeViews" - } + "name": "recipientId", + "in": "path", + "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", + "required": true, + "type": "string" }, - "400": { - "description": "Error encountered.", - "schema": { - "$ref": "#/definitions/errorDetails" - } - } - }, - "deprecated": false, - "x-ds-methodname": "createConsoleView", - "x-ds-method": "createConsole", - "x-ds-service": "Envelopes", - "x-ds-in-sdk": true, - "x-ds-examples": [ - { - "description": "The response contains the URL\nof the the account's cosole.\n\nThe request body contains\na `returnUrl`.\nThis is the URL\nthat the DocuSign platform\nwill redirect the user to\nwhen the view is closed.\n\n", - "direction": "both", - "format": "json", - "response": { - "url": "https://demo.docusign.net/Member/StartInSession.aspx?StartConsole=1&t=644ea697-2541-46ea-a8a5-d95a5c23340b&accountid=624e3e00-36cb-4bcf-a4af-43918c520dab" - }, - "request": { - "returnUrl": "https://dsapp.example.com/return/from/console/view" - }, - "style": "custom", - "title": "Getting a Console View URL and Setting a Return URL" - } - ] - }, - "parameters": [] - }, - "/v2.1/accounts/{accountId}/watermark": { - "get": { - "tags": [ - "AccountWatermarks" - ], - "summary": "Get watermark information.", - "operationId": "Watermark_GetWatermark", - "consumes": [], - "produces": [], - "parameters": [ { - "name": "accountId", + "name": "templateId", "in": "path", - "description": "The external account number (int) or account ID GUID.", + "description": "The id of the template.", "required": true, "type": "string" + }, + { + "name": "include_tabs", + "in": "query", + "required": false, + "type": "string", + "description": "When set to **true**, the tab information associated with the recipient is included in the response. If you do not specify this parameter, the effect is the default behavior (**false**)." + }, + { + "name": "start_position", + "in": "query", + "required": false, + "type": "string", + "description": "The starting position of the results set." } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/AccountWatermarks" + "$ref": "#/definitions/bulkRecipientsResponse" } }, "400": { @@ -18186,18 +18443,18 @@ } }, "deprecated": false, - "x-ds-methodname": "getWatermark", - "x-ds-method": "get", - "x-ds-service": "Accounts", - "description": "", + "x-ds-methodname": "listBulkRecipients", + "x-ds-method": "list", + "x-ds-service": "Templates", "x-ds-in-sdk": true }, "put": { "tags": [ - "AccountWatermarks" + "TemplateBulkRecipients" ], - "summary": "Update watermark information.", - "operationId": "Watermark_PutWatermark", + "summary": "Adds or replaces the bulk recipients list in a template.", + "description": "Updates the bulk recipients in a template using a file upload. The Content-Type supported for uploading a bulk recipient file is CSV (text/csv).\n\nThe REST API does not support modifying individual rows or values in the bulk recipients file. It only allows the entire file to be added or replaced with a new file.", + "operationId": "Recipients_PutTemplateBulkRecipients", "consumes": [], "produces": [], "parameters": [ @@ -18209,11 +18466,25 @@ "type": "string" }, { - "name": "AccountWatermarks", + "name": "recipientId", + "in": "path", + "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", + "required": true, + "type": "string" + }, + { + "name": "templateId", + "in": "path", + "description": "The id of the template.", + "required": true, + "type": "string" + }, + { + "name": "bulkRecipientsRequest", "in": "body", "required": false, "schema": { - "$ref": "#/definitions/AccountWatermarks" + "$ref": "#/definitions/bulkRecipientsRequest" }, "description": "" } @@ -18222,7 +18493,7 @@ "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/AccountWatermarks" + "$ref": "#/definitions/bulkRecipientsSummaryResponse" } }, "400": { @@ -18233,21 +18504,18 @@ } }, "deprecated": false, - "x-ds-methodname": "updateWatermark", + "x-ds-methodname": "updateBulkRecipients", "x-ds-method": "update", - "x-ds-service": "Accounts", - "description": "", + "x-ds-service": "Templates", "x-ds-in-sdk": true }, - "parameters": [] - }, - "/v2.1/accounts/{accountId}/watermark/preview": { - "put": { + "delete": { "tags": [ - "AccountWatermarks" + "TemplateBulkRecipients" ], - "summary": "Get watermark preview.", - "operationId": "WatermarkPreview_PutWatermarkPreview", + "summary": "Deletes the bulk recipient list on a template.", + "description": "Deletes the bulk recipient list on a template.", + "operationId": "Recipients_DeleteTemplateBulkRecipientsFile", "consumes": [], "produces": [], "parameters": [ @@ -18259,20 +18527,25 @@ "type": "string" }, { - "name": "AccountWatermarks", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/AccountWatermarks" - }, - "description": "" + "name": "recipientId", + "in": "path", + "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", + "required": true, + "type": "string" + }, + { + "name": "templateId", + "in": "path", + "description": "The id of the template.", + "required": true, + "type": "string" } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/AccountWatermarks" + "$ref": "#/definitions/bulkRecipientsUpdateResponse" } }, "400": { @@ -18283,22 +18556,20 @@ } }, "deprecated": false, - "x-ds-methodname": "getWatermarkPreview", - "x-ds-method": "preview", - "x-ds-service": "Accounts", - "description": "", + "x-ds-methodname": "deleteBulkRecipients", + "x-ds-method": "delete", + "x-ds-service": "Templates", "x-ds-in-sdk": true }, "parameters": [] }, - "/v2.1/accounts/{accountId}/workspaces": { + "/v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/document_visibility": { "get": { "tags": [ - "Workspaces" + "TemplateDocumentVisibility" ], - "summary": "List Workspaces", - "description": "Gets information about the Workspaces that have been created.", - "operationId": "Workspace_GetWorkspaces", + "summary": "Returns document visibility for a template recipient", + "operationId": "Recipients_GetTemplateRecipientDocumentVisibility", "consumes": [], "produces": [], "parameters": [ @@ -18308,13 +18579,27 @@ "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" + }, + { + "name": "recipientId", + "in": "path", + "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", + "required": true, + "type": "string" + }, + { + "name": "templateId", + "in": "path", + "description": "The id of the template.", + "required": true, + "type": "string" } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/workspaceList" + "$ref": "#/definitions/documentVisibilityList" } }, "400": { @@ -18325,18 +18610,18 @@ } }, "deprecated": false, - "x-ds-methodname": "listWorkspaces", - "x-ds-method": "list", - "x-ds-service": "Workspaces", + "x-ds-methodname": "getTemplateRecipientDocumentVisibility", + "x-ds-method": "get", + "x-ds-service": "Envelopes", + "description": "This method returns information about document visibility for a template recipient.", "x-ds-in-sdk": true }, - "post": { + "put": { "tags": [ - "Workspaces" + "TemplateDocumentVisibility" ], - "summary": "Create a Workspace", - "description": "Creates a new workspace.", - "operationId": "Workspace_PostWorkspace", + "summary": "Updates document visibility for a template recipient", + "operationId": "Recipients_PutTemplateRecipientDocumentVisibility", "consumes": [], "produces": [], "parameters": [ @@ -18348,20 +18633,34 @@ "type": "string" }, { - "name": "Workspaces", + "name": "recipientId", + "in": "path", + "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", + "required": true, + "type": "string" + }, + { + "name": "templateId", + "in": "path", + "description": "The id of the template.", + "required": true, + "type": "string" + }, + { + "name": "templateDocumentVisibilityList", "in": "body", "required": false, "schema": { - "$ref": "#/definitions/Workspaces" + "$ref": "#/definitions/templateDocumentVisibilityList" }, "description": "" } ], "responses": { - "201": { + "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/Workspaces" + "$ref": "#/definitions/templateDocumentVisibilityList" } }, "400": { @@ -18372,21 +18671,22 @@ } }, "deprecated": false, - "x-ds-methodname": "createWorkspace", - "x-ds-method": "create", - "x-ds-service": "Workspaces", + "x-ds-methodname": "updateTemplateRecipientDocumentVisibility", + "x-ds-method": "update", + "x-ds-service": "Envelopes", + "description": "This method updates the document visibility for a template recipient.\n\n**Note**: A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents.", "x-ds-in-sdk": true }, "parameters": [] }, - "/v2.1/accounts/{accountId}/workspaces/{workspaceId}": { + "/v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/tabs": { "get": { "tags": [ - "Workspaces" + "TemplateRecipientTabs" ], - "summary": "Get Workspace", - "description": "Retrives properties about a workspace given a unique workspaceId. ", - "operationId": "Workspace_GetWorkspace", + "summary": "Gets the tabs information for a signer or sign-in-person recipient in a template.", + "description": "Gets the tabs information for a signer or sign-in-person recipient in a template.", + "operationId": "Recipients_GetTemplateRecipientTabs", "consumes": [], "produces": [], "parameters": [ @@ -18398,18 +18698,39 @@ "type": "string" }, { - "name": "workspaceId", + "name": "recipientId", + "in": "path", + "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", + "required": true, + "type": "string" + }, + { + "name": "templateId", "in": "path", - "description": "Specifies the workspace ID GUID.", + "description": "The id of the template.", "required": true, "type": "string" + }, + { + "name": "include_anchor_tab_locations", + "in": "query", + "description": "When set to **true**, all tabs with anchor tab properties are included in the response. The default value is **false**.", + "required": false, + "type": "string" + }, + { + "name": "include_metadata", + "in": "query", + "required": false, + "type": "string", + "description": "When set to **true**, the response includes metadata indicating which properties are editable." } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/Workspaces" + "$ref": "#/definitions/tabs" } }, "400": { @@ -18420,18 +18741,18 @@ } }, "deprecated": false, - "x-ds-methodname": "getWorkspace", - "x-ds-method": "get", - "x-ds-service": "Workspaces", + "x-ds-methodname": "listTabs", + "x-ds-method": "list", + "x-ds-service": "Templates", "x-ds-in-sdk": true }, "put": { "tags": [ - "Workspaces" + "TemplateRecipientTabs" ], - "summary": "Update Workspace", - "description": "Updates information about a specific workspace.", - "operationId": "Workspace_PutWorkspace", + "summary": "Updates the tabs for a recipient.", + "description": "Updates one or more tabs for a recipient in a template.", + "operationId": "Recipients_PutTemplateRecipientTabs", "consumes": [], "produces": [], "parameters": [ @@ -18443,18 +18764,25 @@ "type": "string" }, { - "name": "workspaceId", + "name": "recipientId", "in": "path", - "description": "Specifies the workspace ID GUID.", + "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", + "required": true, + "type": "string" + }, + { + "name": "templateId", + "in": "path", + "description": "The id of the template.", "required": true, "type": "string" }, { - "name": "Workspaces", + "name": "templateTabs", "in": "body", "required": false, "schema": { - "$ref": "#/definitions/Workspaces" + "$ref": "#/definitions/templateTabs" }, "description": "" } @@ -18463,7 +18791,7 @@ "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/Workspaces" + "$ref": "#/definitions/tabs" } }, "400": { @@ -18474,18 +18802,18 @@ } }, "deprecated": false, - "x-ds-methodname": "updateWorkspace", + "x-ds-methodname": "updateTabs", "x-ds-method": "update", - "x-ds-service": "Workspaces", + "x-ds-service": "Templates", "x-ds-in-sdk": true }, - "delete": { + "post": { "tags": [ - "Workspaces" + "TemplateRecipientTabs" ], - "summary": "Delete Workspace", - "description": "Deletes an existing workspace (logically).", - "operationId": "Workspace_DeleteWorkspace", + "summary": "Adds tabs for a recipient.", + "description": "Adds one or more tabs for a recipient.", + "operationId": "Recipients_PostTemplateRecipientTabs", "consumes": [], "produces": [], "parameters": [ @@ -18497,18 +18825,34 @@ "type": "string" }, { - "name": "workspaceId", + "name": "recipientId", + "in": "path", + "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", + "required": true, + "type": "string" + }, + { + "name": "templateId", "in": "path", - "description": "Specifies the workspace ID GUID.", + "description": "The id of the template.", "required": true, "type": "string" + }, + { + "name": "templateTabs", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/templateTabs" + }, + "description": "" } ], "responses": { - "200": { + "201": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/Workspaces" + "$ref": "#/definitions/tabs" } }, "400": { @@ -18519,21 +18863,18 @@ } }, "deprecated": false, - "x-ds-methodname": "deleteWorkspace", - "x-ds-method": "delete", - "x-ds-service": "Workspaces", + "x-ds-methodname": "createTabs", + "x-ds-method": "create", + "x-ds-service": "Templates", "x-ds-in-sdk": true }, - "parameters": [] - }, - "/v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}": { - "get": { + "delete": { "tags": [ - "WorkspaceItems" + "TemplateRecipientTabs" ], - "summary": "List Workspace Folder Contents", - "description": "Retrieves workspace folder contents, which can include sub folders and files.", - "operationId": "WorkspaceFolder_GetWorkspaceFolder", + "summary": "Deletes the tabs associated with a recipient in a template.", + "description": "Deletes one or more tabs associated with a recipient in a template.", + "operationId": "Recipients_DeleteTemplateRecipientTabs", "consumes": [], "produces": [], "parameters": [ @@ -18545,74 +18886,34 @@ "type": "string" }, { - "name": "folderId", + "name": "recipientId", "in": "path", - "description": "Unique identifier for the folder.", + "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", "required": true, "type": "string" }, { - "name": "workspaceId", + "name": "templateId", "in": "path", - "description": "Specifies the workspace ID GUID.", + "description": "The id of the template.", "required": true, "type": "string" }, { - "name": "count", - "in": "query", - "description": "The maximum number of results to return.", - "required": false, - "type": "string" - }, - { - "name": "include_files", - "in": "query", - "description": "When set to **true**, file information is returned in the response along with folder information. The default is **false**.", - "required": false, - "type": "string" - }, - { - "name": "include_sub_folders", - "in": "query", - "description": "When set to **true**, information about the sub-folders of the current folder is returned. The default is **false**.", - "required": false, - "type": "string" - }, - { - "name": "include_thumbnails", - "in": "query", - "description": "When set to **true**, thumbnails are returned as part of the response. The default is **false**.", - "required": false, - "type": "string" - }, - { - "name": "include_user_detail", - "in": "query", - "description": "Set to **true** to return extended details about the user. The default is **false**.", - "required": false, - "type": "string" - }, - { - "name": "start_position", - "in": "query", - "description": "The position within the total result set from which to start returning values.", - "required": false, - "type": "string" - }, - { - "name": "workspace_user_id", - "in": "query", - "description": "If set, then the results are filtered to those associated with the specified userId.", + "name": "templateTabs", + "in": "body", "required": false, - "type": "string" + "schema": { + "$ref": "#/definitions/templateTabs" + }, + "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/workspaceFolderContents" + "$ref": "#/definitions/tabs" } }, "400": { @@ -18623,17 +18924,20 @@ } }, "deprecated": false, - "x-ds-methodname": "listWorkspaceFolderItems", - "x-ds-method": "listFolderItems", - "x-ds-service": "Workspaces", + "x-ds-methodname": "deleteTabs", + "x-ds-method": "delete", + "x-ds-service": "Templates", "x-ds-in-sdk": true }, - "delete": { + "parameters": [] + }, + "/v2.1/accounts/{accountId}/templates/{templateId}/recipients/document_visibility": { + "put": { "tags": [ - "WorkspaceItems" + "TemplateDocumentVisibility" ], - "summary": "Deletes workspace one or more specific files/folders from the given folder or root.", - "operationId": "WorkspaceFolder_DeleteWorkspaceItems", + "summary": "Updates document visibility for template recipients", + "operationId": "Recipients_PutTemplateRecipientsDocumentVisibility", "consumes": [], "produces": [], "parameters": [ @@ -18645,32 +18949,28 @@ "type": "string" }, { - "name": "folderId", - "in": "path", - "description": "Unique identifier for the folder.", - "required": true, - "type": "string" - }, - { - "name": "workspaceId", + "name": "templateId", "in": "path", - "description": "Specifies the workspace ID GUID.", + "description": "The id of the template.", "required": true, "type": "string" }, { - "name": "workspaceItemList", + "name": "templateDocumentVisibilityList", "in": "body", "required": false, "schema": { - "$ref": "#/definitions/workspaceItemList" + "$ref": "#/definitions/templateDocumentVisibilityList" }, "description": "" } ], "responses": { "200": { - "description": "Successful response." + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/templateDocumentVisibilityList" + } }, "400": { "description": "Error encountered.", @@ -18680,21 +18980,21 @@ } }, "deprecated": false, - "x-ds-methodname": "deleteWorkspaceFolderItems", - "x-ds-method": "deleteFolderItems", - "x-ds-service": "Workspaces", - "description": "", + "x-ds-methodname": "updateTemplateRecipientsDocumentVisibility", + "x-ds-method": "updateList", + "x-ds-service": "Envelopes", + "description": "This method updates document visibility for one or more template recipients based on the `recipientId` and `visible` values that you include in the request body.\n\n\n**Note**: A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents.", "x-ds-in-sdk": true }, "parameters": [] }, - "/v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}/files": { + "/v2.1/accounts/{accountId}/templates/{templateId}/responsive_html_preview": { "post": { "tags": [ - "WorkspaceItems" + "TemplateResponsiveHtmlPreview" ], - "summary": "Creates a workspace file.", - "operationId": "WorkspaceFile_PostWorkspaceFiles", + "summary": "Creates a preview of the responsive versions of all of the documents associated with a template.", + "operationId": "ResponsiveHtml_PostTemplateResponsiveHtmlPreview", "consumes": [], "produces": [], "parameters": [ @@ -18706,25 +19006,27 @@ "type": "string" }, { - "name": "folderId", + "name": "templateId", "in": "path", - "description": "Unique identifier for the folder.", + "description": "The id of the template.", "required": true, "type": "string" }, { - "name": "workspaceId", - "in": "path", - "description": "Specifies the workspace ID GUID.", - "required": true, - "type": "string" + "name": "documentHtmlDefinition", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/documentHtmlDefinition" + }, + "description": "" } ], "responses": { "201": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/WorkspaceItems" + "$ref": "#/definitions/documentHtmlDefinitions" } }, "400": { @@ -18735,22 +19037,21 @@ } }, "deprecated": false, - "x-ds-methodname": "createWorkspaceFile", - "x-ds-method": "createFIle", - "x-ds-service": "Workspaces", - "description": "", + "x-ds-methodname": "createTemplateResponsiveHtmlPreview", + "x-ds-method": "create", + "x-ds-service": "Uncategorized", + "description": "Creates a preview of the\n[responsive](https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/responsive/),\nHTML versions of all of the documents associated\nwith a template. This method enables you to\npreview the PDF document conversions to responsive\nHTML across device types prior to sending.\n\nThe request body is a `documentHtmlDefinition`\nobject, which holds the responsive signing\nparameters that define how to generate the HTML\nversion of the documents.", "x-ds-in-sdk": true }, "parameters": [] }, - "/v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}/files/{fileId}": { - "get": { + "/v2.1/accounts/{accountId}/templates/{templateId}/views/edit": { + "post": { "tags": [ - "WorkspaceItems" + "TemplateViews" ], - "summary": "Get Workspace File", - "description": "Retrieves a workspace file (the binary).", - "operationId": "WorkspaceFile_GetWorkspaceFile", + "summary": "Gets a URL for a template edit view.", + "operationId": "Views_PostTemplateEditView", "consumes": [], "produces": [], "parameters": [ @@ -18762,44 +19063,28 @@ "type": "string" }, { - "name": "fileId", - "in": "path", - "description": "Specifies the room file ID GUID.", - "required": true, - "type": "string" - }, - { - "name": "folderId", - "in": "path", - "description": "Unique identifier for the folder.", - "required": true, - "type": "string" - }, - { - "name": "workspaceId", + "name": "templateId", "in": "path", - "description": "Specifies the workspace ID GUID.", + "description": "The id of the template.", "required": true, "type": "string" }, { - "name": "is_download", - "in": "query", - "description": "When set to **true**, the Content-Disposition header is set in the response. The value of the header provides the filename of the file. Default is **false**.", - "required": false, - "type": "string" - }, - { - "name": "pdf_version", - "in": "query", - "description": "When set to **true** the file returned as a PDF.", + "name": "returnUrlRequest", + "in": "body", "required": false, - "type": "string" + "schema": { + "$ref": "#/definitions/returnUrlRequest" + }, + "description": "" } ], "responses": { - "200": { - "description": "Successful response." + "201": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/viewUrl" + } }, "400": { "description": "Error encountered.", @@ -18809,18 +19094,21 @@ } }, "deprecated": false, - "x-ds-methodname": "getWorkspaceFile", - "x-ds-method": "getFile", - "x-ds-service": "Workspaces", + "x-ds-methodname": "createEditView", + "x-ds-method": "createEdit", + "x-ds-service": "Templates", + "description": "This method returns a URL for starting an edit view of a template that uses the DocuSign Template UI.", "x-ds-in-sdk": true }, - "put": { + "parameters": [] + }, + "/v2.1/accounts/{accountId}/templates/{templateId}/views/recipient_preview": { + "post": { "tags": [ - "WorkspaceItems" + "TemplateRecipients" ], - "summary": "Update Workspace File Metadata", - "description": "Updates workspace item metadata for one or more specific files/folders.", - "operationId": "WorkspaceFile_PutWorkspaceFile", + "summary": "Creates a template recipient preview.", + "operationId": "Views_PostTemplateRecipientPreview", "consumes": [], "produces": [], "parameters": [ @@ -18832,32 +19120,27 @@ "type": "string" }, { - "name": "fileId", - "in": "path", - "description": "Specifies the room file ID GUID.", - "required": true, - "type": "string" - }, - { - "name": "folderId", + "name": "templateId", "in": "path", - "description": "Unique identifier for the folder.", + "description": "The id of the template.", "required": true, "type": "string" }, { - "name": "workspaceId", - "in": "path", - "description": "Specifies the workspace ID GUID.", - "required": true, - "type": "string" + "name": "recipientPreviewRequest", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/recipientPreviewRequest" + }, + "description": "" } ], "responses": { - "200": { + "201": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/WorkspaceItems" + "$ref": "#/definitions/viewUrl" } }, "400": { @@ -18868,21 +19151,21 @@ } }, "deprecated": false, - "x-ds-methodname": "updateWorkspaceFile", - "x-ds-method": "updateFile", - "x-ds-service": "Workspaces", + "x-ds-methodname": "createTemplateRecipientPreview", + "x-ds-method": "createTemplateRecipientPreview", + "x-ds-service": "Uncategorized", + "description": "This method returns a URL for a template recipient preview in the DocuSign UI that you can embed in your application. You use this method to enable the sender to preview the recipients' experience.\n\nFor more information, see [Preview and Send](https://support.docusign.com/en/guides/ndse-user-guide-send-your-documents).", "x-ds-in-sdk": true }, "parameters": [] }, - "/v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}/files/{fileId}/pages": { + "/v2.1/accounts/{accountId}/templates/{templateId}/workflow": { "get": { "tags": [ - "WorkspaceItems" + "EnvelopeWorkflowDefinition" ], - "summary": "List File Pages", - "description": "Retrieves a workspace file as rasterized pages.", - "operationId": "WorkspaceFilePages_GetWorkspaceFilePages", + "summary": "Gets template's workflow definition.", + "operationId": "EnvelopeWorkflowDefinition_GetTemplateWorkflowDefinition", "consumes": [], "produces": [], "parameters": [ @@ -18894,67 +19177,18 @@ "type": "string" }, { - "name": "fileId", - "in": "path", - "description": "Specifies the room file ID GUID.", - "required": true, - "type": "string" - }, - { - "name": "folderId", - "in": "path", - "description": "Unique identifier for the folder.", - "required": true, - "type": "string" - }, - { - "name": "workspaceId", + "name": "templateId", "in": "path", - "description": "Specifies the workspace ID GUID.", + "description": "The id of the template.", "required": true, "type": "string" - }, - { - "name": "count", - "in": "query", - "description": "The maximum number of results to return.", - "required": false, - "type": "string" - }, - { - "name": "dpi", - "in": "query", - "description": "The number of dots per inch (DPI) for the resulting images. Valid values are 1-310 DPI. The default value is 94.", - "required": false, - "type": "string" - }, - { - "name": "max_height", - "in": "query", - "description": "Sets the maximum height of the returned images in pixels.", - "required": false, - "type": "string" - }, - { - "name": "max_width", - "in": "query", - "description": "Sets the maximum width of the returned images in pixels.", - "required": false, - "type": "string" - }, - { - "name": "start_position", - "in": "query", - "description": "The position within the total result set from which to start returning values. The value **thumbnail** may be used to return the page image.", - "required": false, - "type": "string" } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/pageImages" + "$ref": "#/definitions/workflow" } }, "400": { @@ -18965,29 +19199,50 @@ } }, "deprecated": false, - "x-ds-methodname": "listWorkspaceFilePages", - "x-ds-method": "listFilePages", - "x-ds-service": "Workspaces", + "x-ds-methodname": "getTemplateWorkflowDefinition", + "x-ds-method": "getTemplateWorkflowDefinition", + "x-ds-service": "Uncategorized", + "description": "Returns template's workflow definition if the template specified by `templateId` has one.", "x-ds-in-sdk": true }, - "parameters": [] - }, - "/v2.1/accounts/provisioning": { - "get": { + "put": { "tags": [ - "Accounts" + "EnvelopeWorkflowDefinition" ], - "summary": "Retrieves the account provisioning information for the account.", - "description": "Retrieves the account provisioning information for the account.", - "operationId": "Accounts_GetProvisioning", + "summary": "Update a template's workflow definiton.", + "operationId": "EnvelopeWorkflowDefinition_PutTemplateWorkflowDefinition", "consumes": [], "produces": [], - "parameters": [], + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "The external account number (int) or account ID GUID.", + "required": true, + "type": "string" + }, + { + "name": "templateId", + "in": "path", + "description": "The id of the template.", + "required": true, + "type": "string" + }, + { + "name": "workflow", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/workflow" + }, + "description": "" + } + ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/provisioningInformation" + "$ref": "#/definitions/workflow" } }, "400": { @@ -18998,30 +19253,39 @@ } }, "deprecated": false, - "x-ds-methodname": "getProvisioning", - "x-ds-method": "getProvisioning", - "x-ds-service": "Accounts", + "x-ds-methodname": "updateTemplateWorkflowDefinition", + "x-ds-method": "updateTemplateWorkflowDefinition", + "x-ds-service": "Uncategorized", + "description": "Updates the specified template's workflow definition if it has one.", "x-ds-in-sdk": true }, - "parameters": [] - }, - "/v2.1/billing_plans": { - "get": { + "delete": { "tags": [ - "BillingPlans" + "EnvelopeWorkflowDefinition" ], - "summary": "Gets the list of available billing plans.", - "description": "Retrieves a list of the billing plans associated with a distributor.", - "operationId": "BillingPlans_GetBillingPlans", + "summary": "Deletes a template's workflow definition.", + "operationId": "EnvelopeWorkflowDefinition_DeleteTemplateWorkflowDefinition", "consumes": [], "produces": [], - "parameters": [], + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "The external account number (int) or account ID GUID.", + "required": true, + "type": "string" + }, + { + "name": "templateId", + "in": "path", + "description": "The id of the template.", + "required": true, + "type": "string" + } + ], "responses": { "200": { - "description": "Successful response.", - "schema": { - "$ref": "#/definitions/billingPlansResponse" - } + "description": "Successful response." }, "400": { "description": "Error encountered.", @@ -19031,28 +19295,29 @@ } }, "deprecated": false, - "x-ds-methodname": "listBillingPlans", - "x-ds-method": "list", - "x-ds-service": "Billing", + "x-ds-methodname": "deleteTemplateWorkflowDefinition", + "x-ds-method": "deleteTemplateWorkflowDefinition", + "x-ds-service": "Uncategorized", + "description": "Deletes the specified template's workflow definition if it has one.", "x-ds-in-sdk": true }, "parameters": [] }, - "/v2.1/billing_plans/{billingPlanId}": { + "/v2.1/accounts/{accountId}/unsupported_file_types": { "get": { "tags": [ - "BillingPlans" + "Accounts" ], - "summary": "Get the billing plan details.", - "description": "Retrieves the billing plan details for the specified billing plan ID.", - "operationId": "BillingPlans_GetBillingPlan", + "summary": "Gets a list of unsupported file types.", + "description": "Retrieves a list of file types (mime-types and file-extensions) that are not supported for upload through the DocuSign system.", + "operationId": "UnsupportedFileTypes_GetUnsupportedFileTypes", "consumes": [], "produces": [], "parameters": [ { - "name": "billingPlanId", + "name": "accountId", "in": "path", - "description": "The ID of the billing plan being accessed.", + "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" } @@ -19061,7 +19326,7 @@ "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/billingPlanResponse" + "$ref": "#/definitions/fileTypeList" } }, "400": { @@ -19072,50 +19337,114 @@ } }, "deprecated": false, - "x-ds-methodname": "getBillingPlan", - "x-ds-method": "get", - "x-ds-service": "Billing", + "x-ds-methodname": "listUnsupportedFileTypes", + "x-ds-method": "listUnsupportedFileTypes", + "x-ds-service": "Accounts", "x-ds-in-sdk": true }, "parameters": [] }, - "/v2.1/current_user/notary/journals": { + "/v2.1/accounts/{accountId}/users": { "get": { "tags": [ - "NotaryJournals" + "Users" ], - "summary": "", - "operationId": "NotaryJournals_GetNotaryJournals", + "summary": "Retrieves the list of users for the specified account.", + "description": "Retrieves the list of users for the specified account.\n\nThe response returns the list of users for the account, with information about the result set. If the `additional_info` query is added to the endpoint and set to **true**, full user information is returned for each user.", + "operationId": "Users_GetUsers", "consumes": [], "produces": [], "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "(Required) The external account number (int) or account ID GUID.", + "required": true, + "type": "string" + }, + { + "name": "additional_info", + "in": "query", + "description": "When set to **true**, the custom settings information is returned for each user in the account. If this parameter is omitted, the default behavior is **false**.", + "required": false, + "type": "string" + }, { "name": "count", "in": "query", + "description": "The number of records to return. This number must be greater than `0` and less than or equal to `100`. ", + "required": false, + "type": "string" + }, + { + "name": "email", + "in": "query", "required": false, "type": "string", - "description": "The maximum number of results to return." + "description": "Filters results based on the email address associated with the user that you want to return.\n\n**Note**: You can use either this parameter or the `email_substring` parameter, but not both. For older accounts, this parameter might return multiple users who are associated with a single email address. " }, { - "name": "search_text", + "name": "email_substring", + "in": "query", + "description": "Filters results based on a fragment of an email address. For example, you could enter `gmail` to return all users who have Gmail addresses.\n\n**Note**: You do not use a wildcard character with this parameter. You can use either this parameter or the `email` parameter, but not both. ", + "required": false, + "type": "string" + }, + { + "name": "group_id", + "in": "query", + "description": "Filters results based on one or more group IDs.", + "required": false, + "type": "string" + }, + { + "name": "include_usersettings_for_csv", "in": "query", "required": false, "type": "string", - "description": "" + "description": "When set to **true**, the response includes the `userSettings` object data in CSV format." + }, + { + "name": "login_status", + "in": "query", + "required": false, + "type": "string", + "description": "When set to **true**, the response includes the login status of each user." + }, + { + "name": "not_group_id", + "in": "query", + "required": false, + "type": "string", + "description": "Return user records excluding the specified group IDs." }, { "name": "start_position", "in": "query", + "description": "The position within the total result set from which to start returning values.", + "required": false, + "type": "string" + }, + { + "name": "status", + "in": "query", "required": false, "type": "string", - "description": "The position within the total result set from which to start returning values. The value **thumbnail** may be used to return the page image." + "description": "Filters results by user account status. Possible values are:\n\n* `ActivationRequired`\n* `ActivationSent`\n* `Active`\n* `Closed`\n* `Disabled`\n" + }, + { + "name": "user_name_substring", + "in": "query", + "description": "Filters results based on a full or partial user name.\n\n**Note**: When you enter a partial user name, you do not use a wildcard character.", + "required": false, + "type": "string" } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/notaryJournalList" + "$ref": "#/definitions/userInformationList" } }, "400": { @@ -19126,29 +19455,42 @@ } }, "deprecated": false, - "x-ds-methodname": "listNotaryJournals", + "x-ds-methodname": "list", "x-ds-method": "list", - "x-ds-service": "Notary", - "description": "", + "x-ds-service": "Users", "x-ds-in-sdk": true }, - "parameters": [] - }, - "/v2.1/current_user/password_rules": { - "get": { + "put": { "tags": [ - "AccountPasswordRules" + "Users" ], - "summary": "Get membership account password rules", - "operationId": "PasswordRules_GetPasswordRules", + "summary": "Changes one or more users in the specified account.", + "operationId": "Users_PutUsers", "consumes": [], "produces": [], - "parameters": [], + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "The external account number (int) or account ID GUID.", + "required": true, + "type": "string" + }, + { + "name": "userInformationList", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/userInformationList" + }, + "description": "" + } + ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/userPasswordRules" + "$ref": "#/definitions/userInformationList" } }, "400": { @@ -19159,38 +19501,44 @@ } }, "deprecated": false, - "x-ds-methodname": "getPasswordRules", - "x-ds-method": "getForUser", - "x-ds-service": "Accounts", - "description": "", + "x-ds-methodname": "updateUsers", + "x-ds-method": "updateList", + "x-ds-service": "Users", + "description": "This method updates the information about one or more account users.", "x-ds-in-sdk": true }, - "parameters": [] - }, - "/v2.1/diagnostics/request_logs": { - "get": { + "post": { "tags": [ - "RequestLogs" + "Users" ], - "summary": "Gets the API request logging log files.", - "description": "Retrieves a list of log entries as a JSON or xml object or as a zip file containing the entries.\n\nIf the Accept header is set to application/zip, the response is a zip file containing individual text files, each representing an API request.\n\nIf the Accept header is set to `application/json` or `application/xml`, the response returns list of log entries in either JSON or XML. An example JSON response body is shown below. ", - "operationId": "APIRequestLog_GetRequestLogs", + "summary": "Adds new users to the specified account.", + "description": "Adds new users to an account.\n\nThe body of this request is an array of `newUsers` objects. For each new user, you must provide at least the `userName` and `email` properties.\n\nThe `userSettings` property specifies the actions users can perform. In the example below, Tal Mason will be able to send envelopes, and the activation email will be in French because the `locale` is set to `fr`.\n\n\n```\nPOST /restapi/v2.1/accounts/{accountId}/users\nContent-Type: application/json\n```\n```\n{\n \"newUsers\": [\n {\n \"userName\": \"Claire Horace\",\n \"email\": \"claire@example.com\"\n },\n {\n \"userName\": \"Tal Mason\",\n \"email\": \"talmason@example.com\",\n \"company\": \"TeleSel\",\n \"userSettings\": {\n \"locale\": \"fr\",\n \"canSendEnvelope\": true\n }\n }\n ]\n}\n```\n\nA successful response is a `newUsers` array with information about the newly created users. If there was a problem in creating a user, that user entry will contain an `errorDetails` property that describes what went wrong.\n\n```json\n{\n \"newUsers\": [\n {\n \"userId\": \"18f3be12-xxxx-xxxx-xxxx-883d8f9b8ade\",\n \"uri\": \"/users/18f3be12-xxxx-xxxx-xxxx-883d8f9b8ade\",\n \"email\": \"claire@example.com\",\n \"userName\": \"Claire Horace\",\n \"createdDateTime\": \"0001-01-01T08:00:00.0000000Z\",\n \"errorDetails\": {\n \"errorCode\": \"USER_ALREADY_EXISTS_IN_ACCOUNT\",\n \"message\": \"Username and email combination already exists for this account.\"\n }\n },\n {\n \"userId\": \"be9899a3-xxxx-xxxx-xxxx-2c8dd7156e33\",\n \"uri\": \"/users/be9899a3-xxxx-xxxx-xxxx-2c8dd7156e33\",\n \"email\": \"talmason@example.com\",\n \"userName\": \"Tal Mason\",\n \"userStatus\": \"ActivationSent\",\n \"createdDateTime\": \"2020-05-26T23:25:30.7330000Z\"\n }\n ]\n}\n```\n", + "operationId": "Users_PostUsers", "consumes": [], "produces": [], "parameters": [ { - "name": "encoding", - "in": "query", + "name": "accountId", + "in": "path", + "description": "The external account number (int) or account ID GUID.", + "required": true, + "type": "string" + }, + { + "name": "newUsersDefinition", + "in": "body", "required": false, - "type": "string", + "schema": { + "$ref": "#/definitions/newUsersDefinition" + }, "description": "" } ], "responses": { - "200": { + "201": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/apiRequestLogsResult" + "$ref": "#/definitions/newUsersSummary" } }, "400": { @@ -19201,24 +19549,51 @@ } }, "deprecated": false, - "x-ds-methodname": "listRequestLogs", - "x-ds-method": "list", - "x-ds-service": "Diagnostics", + "x-ds-methodname": "create", + "x-ds-method": "create", + "x-ds-service": "Users", "x-ds-in-sdk": true }, "delete": { "tags": [ - "RequestLogs" + "Users" ], - "summary": "Deletes the request log files.", - "description": "Deletes the request log files.", - "operationId": "APIRequestLog_DeleteRequestLogs", + "summary": "Removes users account privileges.", + "description": "Closes one or more user records in the account. Users are never deleted from an account, but closing a user prevents them from using account functions.\n\nThe response specifies whether the API execution succeeded (200 - OK) or failed (400 - Error). The response contains a user structure similar to the request and includes the user changes. If an error occurred during the DELETE operation for any of the users, the response for that user contains an `errorDetails` property with `errorCode` and `message` properties.", + "operationId": "Users_DeleteUsers", "consumes": [], "produces": [], - "parameters": [], + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "The external account number (int) or account ID GUID.", + "required": true, + "type": "string" + }, + { + "name": "delete", + "in": "query", + "required": false, + "type": "string", + "description": "ID of the user to delete. This parameter takes a comma-separated list of values in the format: `Groups,PermissionSet,SigningGroupsEmail`." + }, + { + "name": "userInfoList", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/userInfoList" + }, + "description": "" + } + ], "responses": { "200": { - "description": "Successful response." + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/usersResponse" + } }, "400": { "description": "Error encountered.", @@ -19228,39 +19603,58 @@ } }, "deprecated": false, - "x-ds-methodname": "deleteRequestLogs", + "x-ds-methodname": "delete", "x-ds-method": "delete", - "x-ds-service": "Diagnostics", + "x-ds-service": "Users", "x-ds-in-sdk": true }, "parameters": [] }, - "/v2.1/diagnostics/request_logs/{requestLogId}": { + "/v2.1/accounts/{accountId}/users/{userId}": { "get": { "tags": [ - "RequestLogs" + "Users" ], - "summary": "Gets a request logging log file.", - "description": "Retrieves information for a single log entry.\n\n**Request**\nThe `requestLogfId` property can be retrieved by getting the list of log entries. The Content-Transfer-Encoding header can be set to base64 to retrieve the API request/response as base 64 string. Otherwise the bytes of the request/response are returned.\n\n**Response**\nIf the Content-Transfer-Encoding header was set to base64, the log is returned as a base64 string.", - "operationId": "APIRequestLog_GetRequestLog", + "summary": "Gets the user information for a specified user.", + "description": "Retrieves the user information for the specified user. \n\nTo return additional user information that details the last login date, login status, and the user's password expiration date, set the optional `additional_info` query string parameter to **true**.", + "operationId": "User_GetUser", "consumes": [], - "produces": [ - "text/plain" - ], + "produces": [], "parameters": [ { - "name": "requestLogId", + "name": "accountId", + "in": "path", + "description": "The external account number (int) or account ID GUID.", + "required": true, + "type": "string" + }, + { + "name": "userId", "in": "path", + "description": "The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.\n", "required": true, + "type": "string" + }, + { + "name": "additional_info", + "in": "query", + "description": "Setting this parameter has no effect in this operation.", + "required": false, + "type": "string" + }, + { + "name": "email", + "in": "query", + "required": false, "type": "string", - "description": "" + "description": "Setting this parameter has no effect in this operation." } ], "responses": { "200": { "description": "Successful response.", "schema": { - "type": "file" + "$ref": "#/definitions/userInformation" } }, "400": { @@ -19271,29 +19665,49 @@ } }, "deprecated": false, - "x-ds-methodname": "getRequestLog", + "x-ds-methodname": "getInformation", "x-ds-method": "get", - "x-ds-service": "Diagnostics", + "x-ds-service": "Users", "x-ds-in-sdk": true }, - "parameters": [] - }, - "/v2.1/diagnostics/settings": { - "get": { + "put": { "tags": [ - "RequestLogs" + "Users" ], - "summary": "Gets the API request logging settings.", - "description": "Retrieves the current API request logging setting for the user and remaining log entries.\n\n**Response**\nThe response includes the current API request logging setting for the user, along with the maximum log entries and remaining log entries.", - "operationId": "APIRequestLog_GetRequestLogSettings", + "summary": "Updates user information for the specified user.", + "operationId": "User_PutUser", "consumes": [], "produces": [], - "parameters": [], + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "The external account number (int) or account ID GUID.", + "required": true, + "type": "string" + }, + { + "name": "userId", + "in": "path", + "description": "The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.\n", + "required": true, + "type": "string" + }, + { + "name": "userInformation", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/userInformation" + }, + "description": "" + } + ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/RequestLogs" + "$ref": "#/definitions/userInformation" } }, "400": { @@ -19304,27 +19718,151 @@ } }, "deprecated": false, - "x-ds-methodname": "getRequestLogSettings", - "x-ds-method": "getSettings", - "x-ds-service": "Diagnostics", + "x-ds-methodname": "updateUser", + "x-ds-method": "update", + "x-ds-service": "Users", + "description": "To update user information for a specific user, submit a [Users](#Users) object with updated field values in the request body of this operation.", "x-ds-in-sdk": true }, - "put": { + "parameters": [] + }, + "/v2.1/accounts/{accountId}/users/{userId}/cloud_storage": { + "get": { "tags": [ - "RequestLogs" + "CloudStorageProviders" ], - "summary": "Enables or disables API request logging for troubleshooting.", - "description": "Enables or disables API request logging for troubleshooting.\n\nWhen enabled (`apiRequestLogging` is **true**), REST API requests and responses for the user are added to a log. A log can have up to 50 requests/responses and the current number of log entries can be determined by getting the settings. Logging is automatically disabled when the log limit of 50 is reached.\n\nYou can call [Diagnostics::getRequestLog\n](https://developers.docusign.com/esign-rest-api/reference/Diagnostics/RequestLogs/get) or [Diagnostics::listRequestLogs](https://developers.docusign.com/esign-rest-api/reference/Diagnostics/RequestLogs/list) to download the log files (individually or as a zip file). Call [Diagnostics::deleteRequestLogs\n](https://developers.docusign.com/esign-rest-api/reference/Diagnostics/RequestLogs/delete) to clear the log by deleting current entries.\n\nPrivate information, such as passwords and integrator key information, which is normally located in the call header is omitted from the request/response log.\n\nAPI request logging only captures requests from the authenticated user. Any call that does not authenticate the user and resolve a userId is not logged.\n", - "operationId": "APIRequestLog_PutRequestLogSettings", + "summary": "Get the Cloud Storage Provider configuration for the specified user.", + "description": "Retrieves the list of cloud storage providers enabled for the account and the configuration information for the user.\n", + "operationId": "CloudStorage_GetCloudStorageProviders", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "The external account number (int) or account ID GUID.", + "required": true, + "type": "string" + }, + { + "name": "userId", + "in": "path", + "description": "The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.\n", + "required": true, + "type": "string" + }, + { + "name": "redirectUrl", + "in": "query", + "description": " The URL the user is redirected to after the cloud storage provider authenticates the user. Using this will append the redirectUrl to the authenticationUrl.\n\nThe redirectUrl is restricted to URLs in the docusign.com or docusign.net domains.\n ", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/cloudStorageProviders" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "listProviders", + "x-ds-method": "list", + "x-ds-service": "CloudStorage", + "x-ds-in-sdk": true + }, + "post": { + "tags": [ + "CloudStorageProviders" + ], + "summary": "Configures the redirect URL information for one or more cloud storage providers for the specified user.", + "description": "Configures the redirect URL information for one or more cloud storage providers for the specified user. The redirect URL is added to the authentication URL to complete the return route.", + "operationId": "CloudStorage_PostCloudStorage", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "The external account number (int) or account ID GUID.", + "required": true, + "type": "string" + }, + { + "name": "userId", + "in": "path", + "description": "The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.\n", + "required": true, + "type": "string" + }, + { + "name": "cloudStorageProviders", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/cloudStorageProviders" + }, + "description": "" + } + ], + "responses": { + "201": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/cloudStorageProviders" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "createProvider", + "x-ds-method": "create", + "x-ds-service": "CloudStorage", + "x-ds-in-sdk": true + }, + "delete": { + "tags": [ + "CloudStorageProviders" + ], + "summary": "Deletes the user authentication information for one or more cloud storage providers.", + "description": "Deletes the user authentication information for one or more cloud storage providers. The next time the user tries to access the cloud storage provider, they must pass normal authentication.", + "operationId": "CloudStorage_DeleteCloudStorageProviders", "consumes": [], "produces": [], "parameters": [ { - "name": "RequestLogs", + "name": "accountId", + "in": "path", + "description": "The external account number (int) or account ID GUID.", + "required": true, + "type": "string" + }, + { + "name": "userId", + "in": "path", + "description": "The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.\n", + "required": true, + "type": "string" + }, + { + "name": "cloudStorageProviders", "in": "body", "required": false, "schema": { - "$ref": "#/definitions/RequestLogs" + "$ref": "#/definitions/cloudStorageProviders" }, "description": "" } @@ -19333,7 +19871,329 @@ "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/RequestLogs" + "$ref": "#/definitions/cloudStorageProviders" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "deleteProviders", + "x-ds-method": "deleteList", + "x-ds-service": "CloudStorage", + "x-ds-in-sdk": true + }, + "parameters": [] + }, + "/v2.1/accounts/{accountId}/users/{userId}/cloud_storage/{serviceId}": { + "get": { + "tags": [ + "CloudStorageProviders" + ], + "summary": "Gets the specified Cloud Storage Provider configuration for the User.", + "description": "Retrieves the list of cloud storage providers enabled for the account and the configuration information for the user.", + "operationId": "CloudStorage_GetCloudStorage", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "The external account number (int) or account ID GUID.", + "required": true, + "type": "string" + }, + { + "name": "serviceId", + "in": "path", + "description": "The ID of the service to access. \n\nValid values are the service name (\"Box\") or the numerical serviceId (\"4136\").", + "required": true, + "type": "string" + }, + { + "name": "userId", + "in": "path", + "description": "The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.\n", + "required": true, + "type": "string" + }, + { + "name": "redirectUrl", + "in": "query", + "description": " The URL the user is redirected to after the cloud storage provider authenticates the user. Using this will append the redirectUrl to the authenticationUrl.\n\nThe redirectUrl is restricted to URLs in the docusign.com or docusign.net domains.\n ", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/cloudStorageProviders" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "getProvider", + "x-ds-method": "get", + "x-ds-service": "CloudStorage", + "x-ds-in-sdk": true + }, + "delete": { + "tags": [ + "CloudStorageProviders" + ], + "summary": "Deletes the user authentication information for the specified cloud storage provider.", + "description": "Deletes the user authentication information for the specified cloud storage provider. The next time the user tries to access the cloud storage provider, they must pass normal authentication for this cloud storage provider.", + "operationId": "CloudStorage_DeleteCloudStorage", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "The external account number (int) or account ID GUID.", + "required": true, + "type": "string" + }, + { + "name": "serviceId", + "in": "path", + "description": "The ID of the service to access. \n\nValid values are the service name (\"Box\") or the numerical serviceId (\"4136\").", + "required": true, + "type": "string" + }, + { + "name": "userId", + "in": "path", + "description": "The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.\n", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/cloudStorageProviders" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "deleteProvider", + "x-ds-method": "delete", + "x-ds-service": "CloudStorage", + "x-ds-in-sdk": true + }, + "parameters": [] + }, + "/v2.1/accounts/{accountId}/users/{userId}/cloud_storage/{serviceId}/folders": { + "get": { + "tags": [ + "CloudStorage" + ], + "summary": "Retrieves a list of all the items in a specified folder from the specified cloud storage provider.", + "description": "Retrieves a list of all the items in a specified folder from the specified cloud storage provider. ", + "operationId": "CloudStorageFolder_GetCloudStorageFolderAll", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "The external account number (int) or account ID GUID.", + "required": true, + "type": "string" + }, + { + "name": "serviceId", + "in": "path", + "description": "The ID of the service to access. \n\nValid values are the service name (\"Box\") or the numerical serviceId (\"4136\").", + "required": true, + "type": "string" + }, + { + "name": "userId", + "in": "path", + "description": "The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.\n", + "required": true, + "type": "string" + }, + { + "name": "cloud_storage_folder_path", + "in": "query", + "description": "A comma separated list of folder IDs included in the request. ", + "required": false, + "type": "string" + }, + { + "name": "count", + "in": "query", + "description": "An optional value that sets how many items are included in the response. \n\nThe default setting for this is 25. ", + "required": false, + "type": "string" + }, + { + "name": "order", + "in": "query", + "description": "(Optional) The order in which to sort the results.\n\nValid values are: \n\n\n* `asc`: Ascending order.\n* `desc`: Descending order. ", + "required": false, + "type": "string" + }, + { + "name": "order_by", + "in": "query", + "description": "(Optional) The file attribute to use to sort the results.\n\nValid values are: \n\n* `modified`\n* `name`", + "required": false, + "type": "string" + }, + { + "name": "search_text", + "in": "query", + "required": false, + "type": "string", + "description": "Use this parameter to search for specific text." + }, + { + "name": "start_position", + "in": "query", + "description": "Indicates the starting point of the first item included in the response set. It uses a 0-based index. The default setting for this is 0. ", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/externalFolder" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "listFolders", + "x-ds-method": "listFolders", + "x-ds-service": "CloudStorage", + "x-ds-in-sdk": true + }, + "parameters": [] + }, + "/v2.1/accounts/{accountId}/users/{userId}/cloud_storage/{serviceId}/folders/{folderId}": { + "get": { + "tags": [ + "CloudStorage" + ], + "summary": "Gets a list of items from a cloud storage provider.", + "description": "Retrieves a list of the user's items from the specified cloud storage provider. \n\nTo limit the scope of the items returned, provide a comma-separated list of folder ids in the request.", + "operationId": "CloudStorageFolder_GetCloudStorageFolder", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "The external account number (int) or account ID GUID.", + "required": true, + "type": "string" + }, + { + "name": "folderId", + "in": "path", + "description": "The id of the folder.", + "required": true, + "type": "string" + }, + { + "name": "serviceId", + "in": "path", + "description": "The ID of the service to access. \n\nValid values are the service name (\"Box\") or the numerical serviceId (\"4136\").", + "required": true, + "type": "string" + }, + { + "name": "userId", + "in": "path", + "description": "The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.\n", + "required": true, + "type": "string" + }, + { + "name": "cloud_storage_folder_path", + "in": "query", + "required": false, + "type": "string", + "description": "The file path to a cloud storage folder." + }, + { + "name": "cloud_storage_folderid_plain", + "in": "query", + "required": false, + "type": "string", + "description": "A plain-text folder id that you can use as an alternative to the existing folder id. This property is mainly used for rooms. Enter multiple folder ids as a comma-separated list." + }, + { + "name": "count", + "in": "query", + "description": "An optional value that sets how many items are included in the response. \n\nThe default setting for this is 25. ", + "required": false, + "type": "string" + }, + { + "name": "order", + "in": "query", + "description": "(Optional) The order in which to sort the results.\n\nValid values are: \n\n\n* `asc`: Ascending order.\n* `desc`: Descending order. ", + "required": false, + "type": "string" + }, + { + "name": "order_by", + "in": "query", + "description": "(Optional) The file attribute to use to sort the results.\n\nValid values are: \n\n* `modified`\n* `name`", + "required": false, + "type": "string" + }, + { + "name": "search_text", + "in": "query", + "required": false, + "type": "string", + "description": "Use this parameter to search for specific text." + }, + { + "name": "start_position", + "in": "query", + "description": "The starting index position in the result set from which to start returning values. The default setting is `0`.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/externalFolder" } }, "400": { @@ -19343,4143 +20203,14091 @@ } } }, - "deprecated": false, - "x-ds-methodname": "updateRequestLogSettings", - "x-ds-method": "updateSettings", - "x-ds-service": "Diagnostics", - "x-ds-in-sdk": true - }, - "parameters": [] - } - }, - "definitions": { - "accessCodeFormat": { - "type": "object", - "properties": { - "formatRequired": { - "description": "Boolean specifying whether this format configuration is required.", + "deprecated": false, + "x-ds-methodname": "list", + "x-ds-method": "list", + "x-ds-service": "CloudStorage", + "x-ds-in-sdk": true + }, + "parameters": [] + }, + "/v2.1/accounts/{accountId}/users/{userId}/custom_settings": { + "get": { + "tags": [ + "UserCustomSettings" + ], + "summary": "Retrieves the custom user settings for a specified user.", + "description": "Retrieves a list of custom user settings for a single user.\n\nCustom settings provide a flexible way to store and retrieve custom user information that can be used in your own system.\n\n**Note**: Custom user settings are not the same as user account settings.\n\n###Getting Grouped Custom User Settings###\n\nIf the custom user settings you want to retrieve are grouped, you must include the following information in the header, after Content-Type, in the request:\n\n`X-DocuSign-User-Settings-Key:group_name`\n\nWhere the `group_name` is your designated name for the group of customer user settings.\n\nIf the extra header information is not included, only the custom user settings that were added without a group are retrieved.", + "operationId": "UserCustomSettings_GetCustomSettings", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "The external account number (int) or account ID GUID.", + "required": true, + "type": "string" + }, + { + "name": "userId", + "in": "path", + "description": "The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.\n", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/customSettingsInformation" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "listCustomSettings", + "x-ds-method": "list", + "x-ds-service": "Users", + "x-ds-in-sdk": true + }, + "put": { + "tags": [ + "UserCustomSettings" + ], + "summary": "Adds or updates custom user settings for the specified user.", + "description": "Adds or updates custom user settings for the specified user.\n\n***Note**: Custom user settings are not the same as user account settings.\n\nCustom settings provide a flexible way to store and retrieve custom user information that you can use in your own system.\n\n**Important**: There is a limit on the size for all the custom user settings for a single user. The limit is 4,000 characters, which includes the XML and JSON structure for the settings.\n\n### Grouping Custom User Settings ###\n\nYou can group custom user settings when adding them. Grouping allows you to retrieve settings that are in a specific group, instead of retrieving all the user custom settings.\n\nTo group custom user settings, add the following information in the header, after Content-Type:\n\n`X-DocuSign-User-Settings-Key:group_name`\n\nWhere the `group_name` is your designated name for the group of customer user settings. Grouping is shown in the Example Request Body below.\n\nWhen getting or deleting grouped custom user settings, you must include the extra header information.\n\nGrouping custom user settings is not required and if the extra header information is not included, the custom user settings are added normally and can be retrieved or deleted without including the additional header.", + "operationId": "UserCustomSettings_PutCustomSettings", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "The external account number (int) or account ID GUID.", + "required": true, + "type": "string" + }, + { + "name": "userId", + "in": "path", + "description": "The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.\n", + "required": true, + "type": "string" + }, + { + "name": "customSettingsInformation", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/customSettingsInformation" + }, + "description": "" + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/customSettingsInformation" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "updateCustomSettings", + "x-ds-method": "update", + "x-ds-service": "Users", + "x-ds-in-sdk": true + }, + "delete": { + "tags": [ + "UserCustomSettings" + ], + "summary": "Deletes custom user settings for a specified user.", + "description": "Deletes the specified custom user settings for a single user.\n\n###Deleting Grouped Custom User Settings###\n\nIf the custom user settings you want to delete are grouped, you must include the following information in the header, after Content-Type, in the request:\n\n`X-DocuSign-User-Settings-Key:group_name`\n\nWhere the `group_name` is your designated name for the group of customer user settings.\n\nIf the extra header information is not included, only the custom user settings that were added without a group are deleted.", + "operationId": "UserCustomSettings_DeleteCustomSettings", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "The external account number (int) or account ID GUID.", + "required": true, + "type": "string" + }, + { + "name": "userId", + "in": "path", + "description": "The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.\n", + "required": true, + "type": "string" + }, + { + "name": "customSettingsInformation", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/customSettingsInformation" + }, + "description": "" + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/customSettingsInformation" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "deleteCustomSettings", + "x-ds-method": "delete", + "x-ds-service": "Users", + "x-ds-in-sdk": true + }, + "parameters": [] + }, + "/v2.1/accounts/{accountId}/users/{userId}/profile": { + "get": { + "tags": [ + "UserProfiles" + ], + "summary": "Retrieves the user profile for a specified user.", + "description": "Retrieves the user profile information, the privacy settings and personal information (address, phone number, etc.) for the specified user.\n\nThe userId parameter specified in the endpoint must match the authenticated user's user ID and the user must be a member of the specified account.", + "operationId": "UserProfile_GetProfile", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "The external account number (int) or account ID GUID.", + "required": true, + "type": "string" + }, + { + "name": "userId", + "in": "path", + "description": "The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.\n", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/userProfile" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "getProfile", + "x-ds-method": "get", + "x-ds-service": "Users", + "x-ds-in-sdk": true + }, + "put": { + "tags": [ + "UserProfiles" + ], + "summary": "Updates the user profile information for the specified user.", + "description": "Updates the user's detail information, profile information, privacy settings, and personal information in the user ID card.\n\nYou can also change a user's name by changing the information in the `userDetails` property. When changing a user's name, you can either change the information in the `userName` property OR change the information in `firstName`, `middleName`, `lastName, suffixName`, and `title` properties. Changes to `firstName`, `middleName`, `lastName`, `suffixName`, and `title` properties take precedence over changes to the `userName` property.", + "operationId": "UserProfile_PutProfile", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "The external account number (int) or account ID GUID.", + "required": true, + "type": "string" + }, + { + "name": "userId", + "in": "path", + "description": "The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.\n", + "required": true, + "type": "string" + }, + { + "name": "userProfile", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/userProfile" + }, + "description": "" + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "updateProfile", + "x-ds-method": "update", + "x-ds-service": "Users", + "x-ds-in-sdk": true + }, + "parameters": [] + }, + "/v2.1/accounts/{accountId}/users/{userId}/profile/image": { + "get": { + "tags": [ + "Users" + ], + "summary": "Retrieves the user profile image for the specified user.", + "description": "Retrieves the user profile picture for the specified user. The image is returned in the same format as uploaded.\n\nThe userId parameter specified in the endpoint must match the authenticated user's user ID and the user must be a member of the specified account.\n\nIf successful, the response returns a 200 - OK and the user profile image.", + "operationId": "UserProfileImage_GetUserProfileImage", + "consumes": [], + "produces": [ + "image/gif" + ], + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "The external account number (int) or account ID GUID.", + "required": true, + "type": "string" + }, + { + "name": "userId", + "in": "path", + "description": "The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.\n", + "required": true, + "type": "string" + }, + { + "name": "encoding", + "in": "query", + "required": false, + "type": "string", + "description": "Reserved for DocuSign." + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "type": "file" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "getProfileImage", + "x-ds-method": "getProfileImage", + "x-ds-service": "Users", + "x-ds-in-sdk": true + }, + "put": { + "tags": [ + "Users" + ], + "summary": "Updates the user profile image for a specified user.", + "description": "Updates the user profile image by uploading an image to the user profile.\n\nThe supported image formats are: gif, png, jpeg, and bmp. The file must be less than 200K. For best viewing results, DocuSign recommends that the image is no more than 79 pixels wide and high.", + "operationId": "UserProfileImage_PutUserProfileImage", + "consumes": [ + "image/gif" + ], + "produces": [], + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "The external account number (int) or account ID GUID.", + "required": true, + "type": "string" + }, + { + "name": "userId", + "in": "path", + "description": "The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.\n", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "updateProfileImage", + "x-ds-method": "updateProfileImage", + "x-ds-service": "Users", + "x-ds-in-sdk": true + }, + "delete": { + "tags": [ + "Users" + ], + "summary": "Deletes the user profile image for the specified user.", + "description": "Deletes the user profile image from the specified user's profile.\n\nThe userId parameter specified in the endpoint must match the authenticated user's user ID and the user must be a member of the specified account.", + "operationId": "UserProfileImage_DeleteUserProfileImage", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "The external account number (int) or account ID GUID.", + "required": true, + "type": "string" + }, + { + "name": "userId", + "in": "path", + "description": "The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.\n", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "deleteProfileImage", + "x-ds-method": "deleteProfileImage", + "x-ds-service": "Users", + "x-ds-in-sdk": true + }, + "parameters": [] + }, + "/v2.1/accounts/{accountId}/users/{userId}/settings": { + "get": { + "tags": [ + "Users" + ], + "summary": "Gets the user account settings for a specified user.", + "description": "Retrieves a list of the account settings and email\nnotification information for the specified user.\n\nThe response returns the account setting\nname/value information and the email notification\nsettings for the specified user. For more\ninformation, see\n[Users:create](https://developers.docusign.com/docs/esign-rest-api/reference/Users/Users/create/).\n\n\n", + "operationId": "UserSettings_GetUserSettings", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "The external account number (int) or account ID GUID.", + "required": true, + "type": "string" + }, + { + "name": "userId", + "in": "path", + "description": "The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.\n", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/userSettingsInformation" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "getSettings", + "x-ds-method": "getSettings", + "x-ds-service": "Users", + "x-ds-in-sdk": true + }, + "put": { + "tags": [ + "Users" + ], + "summary": "Updates the user account settings for a specified user.", + "description": "Updates the account settings list and email notification types for the specified user.", + "operationId": "UserSettings_PutUserSettings", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "The external account number (int) or account ID GUID.", + "required": true, + "type": "string" + }, + { + "name": "userId", + "in": "path", + "description": "The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.\n", + "required": true, + "type": "string" + }, + { + "name": "userSettingsInformation", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/userSettingsInformation" + }, + "description": "" + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "updateSettings", + "x-ds-method": "updateSettings", + "x-ds-service": "Users", + "x-ds-in-sdk": true + }, + "parameters": [] + }, + "/v2.1/accounts/{accountId}/users/{userId}/signatures": { + "get": { + "tags": [ + "UserSignatures" + ], + "summary": "Retrieves a list of signature definitions for a user.", + "description": "This method retrieves the signature definitions for the user that you specify.\n\nThe `userId` parameter specified in the endpoint must match the authenticated user's user ID, and the user must be a member of the account.\n\nThe `signatureId` parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. \n\nFor example, encode \"Bob Smith\" as \"Bob%20Smith\".", + "operationId": "UserSignatures_GetUserSignatures", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "The external account number (int) or account ID GUID.", + "required": true, + "type": "string" + }, + { + "name": "userId", + "in": "path", + "description": "The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.\n", + "required": true, + "type": "string" + }, + { + "name": "stamp_type", + "in": "query", + "required": false, + "type": "string", + "description": "The type of stamps to return. Valid values are:\n\n- `signature`: Returns information about signature images only. This is the default value.\n- `stamp`: Returns information about eHanko and custom stamps only.\n- null" + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/userSignaturesInformation" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "listSignatures", + "x-ds-method": "list", + "x-ds-service": "Users", + "x-ds-in-sdk": true + }, + "put": { + "tags": [ + "UserSignatures" + ], + "summary": "Adds/updates a user signature.", + "operationId": "UserSignatures_PutUserSignature", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "The external account number (int) or account ID GUID.", + "required": true, + "type": "string" + }, + { + "name": "userId", + "in": "path", + "description": "The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.\n", + "required": true, + "type": "string" + }, + { + "name": "userSignaturesInformation", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/userSignaturesInformation" + }, + "description": "" + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/userSignaturesInformation" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "updateSignatures", + "x-ds-method": "updateList", + "x-ds-service": "Users", + "description": "", + "x-ds-in-sdk": true + }, + "post": { + "tags": [ + "UserSignatures" + ], + "summary": "Adds user Signature and initials images to a Signature.", + "description": "Adds a user signature image and/or user initials image to the specified user. \n\nThe userId property specified in the endpoint must match the authenticated user's `userId` and the user must be a member of the account.\n\nThe rules and processes associated with this are:\n\n* If `Content-Type` is set to `application/json`, then the default behavior for creating a default signature image, based on the name and a DocuSign font, is used.\n* If `Content-Type` is set to `multipart/form-data`, then the request must contain a first part with the user signature information, followed by parts that contain the images.\n\nFor each Image part, the Content-Disposition header has a \"filename\" value that is used to map to the `signatureName` and/or `signatureInitials` properties in the JSON to the image. \n\nFor example: \n`Content-Disposition: file; filename=\"Ron Test20121127083900\"`\n\nIf no matching image (by filename value) is found, then the image is not set. One, both, or neither of the signature and initials images can be set with this call.\n\nThe Content-Transfer-Encoding: base64 header, set in the header for the part containing the image, can be set to indicate that the images are formatted as base64 instead of as binary.\n\nIf successful, 200-OK is returned, and a JSON structure containing the signature information is provided, note that the signatureId can change with each API POST, PUT, or DELETE since the changes to the signature structure cause the current signature to be closed, and a new signature record to be created.", + "operationId": "UserSignatures_PostUserSignatures", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "The external account number (int) or account ID GUID.", + "required": true, + "type": "string" + }, + { + "name": "userId", + "in": "path", + "description": "The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.\n", + "required": true, + "type": "string" + }, + { + "name": "userSignaturesInformation", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/userSignaturesInformation" + }, + "description": "" + } + ], + "responses": { + "201": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/userSignaturesInformation" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "createSignatures", + "x-ds-method": "create", + "x-ds-service": "Users", + "x-ds-in-sdk": true + }, + "parameters": [] + }, + "/v2.1/accounts/{accountId}/users/{userId}/signatures/{signatureId}": { + "get": { + "tags": [ + "UserSignatures" + ], + "summary": "Gets the user signature information for the specified user.", + "description": "Retrieves the structure of a single signature with a known signature name.\n\nThe userId specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account.\n\nThe `signatureId` parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. \n\nFor example encode \"Bob Smith\" as \"Bob%20Smith\".", + "operationId": "UserSignatures_GetUserSignature", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "The external account number (int) or account ID GUID.", + "required": true, + "type": "string" + }, + { + "name": "signatureId", + "in": "path", + "description": "The ID of the signature being accessed.", + "required": true, + "type": "string" + }, + { + "name": "userId", + "in": "path", + "description": "The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.\n", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/userSignature" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "getSignature", + "x-ds-method": "get", + "x-ds-service": "Users", + "x-ds-in-sdk": true + }, + "put": { + "tags": [ + "UserSignatures" + ], + "summary": "Updates the user signature for a specified user.", + "description": "Creates, or updates, the signature font and initials for the specified user. When creating a signature, you use this resource to create the signature name and then add the signature and initials images into the signature.\n\n**Note**: This will also create a default signature for the user when one does not exist.\n\nThe userId property specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account.\n\nThe `signatureId` parameter accepts a signature ID. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint.\n\nFor example encode \"Bob Smith\" as \"Bob%20Smith\".", + "operationId": "UserSignatures_PutUserSignatureById", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "The external account number (int) or account ID GUID.", + "required": true, + "type": "string" + }, + { + "name": "signatureId", + "in": "path", + "description": "The ID of the signature being accessed.", + "required": true, + "type": "string" + }, + { + "name": "userId", + "in": "path", + "description": "The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.\n", + "required": true, + "type": "string" + }, + { + "name": "close_existing_signature", + "in": "query", + "description": "When set to **true**, closes the current signature.", + "required": false, + "type": "string" + }, + { + "name": "userSignatureDefinition", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/userSignatureDefinition" + }, + "description": "" + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/userSignature" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "updateSignature", + "x-ds-method": "update", + "x-ds-service": "Users", + "x-ds-in-sdk": true + }, + "delete": { + "tags": [ + "UserSignatures" + ], + "summary": "Removes removes signature information for the specified user.", + "description": "Removes the signature information for the user.\n\nThe userId parameter specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account.\n\nThe `signatureId` accepts a signature ID or a signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. \n\nFor example encode \"Bob Smith\" as \"Bob%20Smith\".", + "operationId": "UserSignatures_DeleteUserSignature", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "The external account number (int) or account ID GUID.", + "required": true, + "type": "string" + }, + { + "name": "signatureId", + "in": "path", + "description": "The ID of the signature being accessed.", + "required": true, + "type": "string" + }, + { + "name": "userId", + "in": "path", + "description": "The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.\n", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "deleteSignature", + "x-ds-method": "delete", + "x-ds-service": "Users", + "x-ds-in-sdk": true + }, + "parameters": [] + }, + "/v2.1/accounts/{accountId}/users/{userId}/signatures/{signatureId}/{imageType}": { + "get": { + "tags": [ + "UserSignatures" + ], + "summary": "Retrieves the user initials image or the user signature image for the specified user.", + "description": "Retrieves the specified initials image or signature image for the specified user. The image is returned in the same format in which it was uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image.\n\nThe userId property specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account.\n\nThe `signatureId` parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint.\n\nFor example encode \"Bob Smith\" as \"Bob%20Smith\".\n\n**Note**: Older envelopes might only have chromed images. If getting the non-chromed image fails, try getting the chromed image.", + "operationId": "UserSignatures_GetUserSignatureImage", + "consumes": [], + "produces": [ + "image/gif" + ], + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "The external account number (int) or account ID GUID.", + "required": true, + "type": "string" + }, + { + "name": "imageType", + "in": "path", + "description": "Specificies the type of image. Valid values are:\n\n- `signature_image`\n- `initials_image`", + "required": true, + "type": "string" + }, + { + "name": "signatureId", + "in": "path", + "description": "The ID of the signature being accessed.", + "required": true, + "type": "string" + }, + { + "name": "userId", + "in": "path", + "description": "The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.\n", + "required": true, + "type": "string" + }, + { + "name": "include_chrome", + "in": "query", + "required": false, + "type": "string", + "description": "When **true**, the chrome (or frame containing the added line and identifier) is included with the signature image." + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "type": "file" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "getSignatureImage", + "x-ds-method": "getImage", + "x-ds-service": "Users", + "x-ds-in-sdk": true + }, + "put": { + "tags": [ + "UserSignatures" + ], + "summary": "Updates the user signature image or user initials image for the specified user.", + "description": "Updates the user signature image or user initials image for the specified user. The supported image formats for this file are: gif, png, jpeg, and bmp. The file must be less than 200K.\n\nThe userId property specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account.\n\nThe `signatureId` parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. \n\nFor example encode \"Bob Smith\" as \"Bob%20Smith\".\n", + "operationId": "UserSignatures_PutUserSignatureImage", + "consumes": [ + "image/gif" + ], + "produces": [], + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "The external account number (int) or account ID GUID.", + "required": true, + "type": "string" + }, + { + "name": "imageType", + "in": "path", + "description": "Specificies the type of image. Valid values are:\n\n- `signature_image`\n- `initials_image`", + "required": true, + "type": "string" + }, + { + "name": "signatureId", + "in": "path", + "description": "The ID of the signature being accessed.", + "required": true, + "type": "string" + }, + { + "name": "userId", + "in": "path", + "description": "The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.\n", + "required": true, + "type": "string" + }, + { + "name": "transparent_png", + "in": "query", + "required": false, + "type": "string", + "description": "" + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/userSignature" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "updateSignatureImage", + "x-ds-method": "updateImage", + "x-ds-service": "Users", + "x-ds-in-sdk": true + }, + "delete": { + "tags": [ + "UserSignatures" + ], + "summary": "Deletes the user initials image or the user signature image for the specified user.", + "description": "Deletes the specified initials image or signature image for the specified user.\n\nThe function deletes one or the other of the image types, to delete both the initials image and signature image you must call the endpoint twice.\n\nThe userId parameter specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account.\n\nThe `signatureId` parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. \n\nFor example encode \"Bob Smith\" as \"Bob%20Smith\".", + "operationId": "UserSignatures_DeleteUserSignatureImage", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "The external account number (int) or account ID GUID.", + "required": true, + "type": "string" + }, + { + "name": "imageType", + "in": "path", + "description": "Specificies the type of image. Valid values are:\n\n- `signature_image`\n- `initials_image`", + "required": true, + "type": "string" + }, + { + "name": "signatureId", + "in": "path", + "description": "The ID of the signature being accessed.", + "required": true, + "type": "string" + }, + { + "name": "userId", + "in": "path", + "description": "The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.\n", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/userSignature" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "deleteSignatureImage", + "x-ds-method": "deleteImage", + "x-ds-service": "Users", + "x-ds-in-sdk": true + }, + "parameters": [] + }, + "/v2.1/accounts/{accountId}/views/console": { + "post": { + "tags": [ + "EnvelopeViews" + ], + "summary": "Returns a URL to the authentication view UI.", + "description": "Returns a URL that enables you to embed the authentication view of the DocuSign UI in your applications.\n\n**Note**: You can revoke this URL by making the DELETE call to the same URL with no request body. \n\n
\n

Information Security notice: This method provides full administrator access to the account.

", + "operationId": "Views_PostAccountConsoleView", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "The external account number (int) or account ID GUID.", + "required": true, + "type": "string" + }, + { + "name": "consoleViewRequest", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/consoleViewRequest" + }, + "description": "" + } + ], + "responses": { + "201": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/EnvelopeViews" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "createConsoleView", + "x-ds-method": "createConsole", + "x-ds-service": "Envelopes", + "x-ds-in-sdk": true, + "x-ds-examples": [ + { + "description": "The response contains the URL\nof the the account's cosole.\n\nThe request body contains\na `returnUrl`.\nThis is the URL\nthat the DocuSign platform\nwill redirect the user to\nwhen the view is closed.\n\n", + "direction": "both", + "format": "json", + "response": { + "url": "https://demo.docusign.net/Member/StartInSession.aspx?StartConsole=1&t=644ea697-xxxx-xxxx-xxxx-d95a5c23340b&accountid=624e3e00-xxxx-xxxx-xxxx-43918c520dab" + }, + "request": { + "returnUrl": "https://dsapp.example.com/return/from/console/view" + }, + "style": "custom", + "title": "Getting a Console View URL and Setting a Return URL" + } + ] + }, + "parameters": [] + }, + "/v2.1/accounts/{accountId}/watermark": { + "get": { + "tags": [ + "AccountWatermarks" + ], + "summary": "Get watermark information.", + "operationId": "Watermark_GetWatermark", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "The external account number (int) or account ID GUID.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/watermark" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "getWatermark", + "x-ds-method": "get", + "x-ds-service": "Accounts", + "description": "", + "x-ds-in-sdk": true + }, + "put": { + "tags": [ + "AccountWatermarks" + ], + "summary": "Update watermark information.", + "operationId": "Watermark_PutWatermark", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "The external account number (int) or account ID GUID.", + "required": true, + "type": "string" + }, + { + "name": "watermark", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/watermark" + }, + "description": "When set to **true**, the account has the watermark feature enabled, and the envelope is not complete, then the watermark for the account is added to the PDF documents. This option can remove the watermark. " + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/watermark" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "updateWatermark", + "x-ds-method": "update", + "x-ds-service": "Accounts", + "description": "", + "x-ds-in-sdk": true + }, + "parameters": [] + }, + "/v2.1/accounts/{accountId}/watermark/preview": { + "put": { + "tags": [ + "AccountWatermarks" + ], + "summary": "Get watermark preview.", + "operationId": "WatermarkPreview_PutWatermarkPreview", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "The external account number (int) or account ID GUID.", + "required": true, + "type": "string" + }, + { + "name": "watermark", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/watermark" + }, + "description": "When set to **true**, the account has the watermark feature enabled, and the envelope is not complete, then the watermark for the account is added to the PDF documents. This option can remove the watermark. " + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/watermark" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "getWatermarkPreview", + "x-ds-method": "preview", + "x-ds-service": "Accounts", + "description": "", + "x-ds-in-sdk": true + }, + "parameters": [] + }, + "/v2.1/accounts/{accountId}/workspaces": { + "get": { + "tags": [ + "Workspaces" + ], + "summary": "List Workspaces", + "description": "Gets information about the Workspaces that have been created.", + "operationId": "Workspace_GetWorkspaces", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "The external account number (int) or account ID GUID.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/workspaceList" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "listWorkspaces", + "x-ds-method": "list", + "x-ds-service": "Workspaces", + "x-ds-in-sdk": true + }, + "post": { + "tags": [ + "Workspaces" + ], + "summary": "Create a Workspace", + "description": "This method creates a new workspace.", + "operationId": "Workspace_PostWorkspace", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "The external account number (int) or account ID GUID.", + "required": true, + "type": "string" + }, + { + "name": "workspace", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/workspace" + }, + "description": "" + } + ], + "responses": { + "201": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/workspace" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "createWorkspace", + "x-ds-method": "create", + "x-ds-service": "Workspaces", + "x-ds-in-sdk": true + }, + "parameters": [] + }, + "/v2.1/accounts/{accountId}/workspaces/{workspaceId}": { + "get": { + "tags": [ + "Workspaces" + ], + "summary": "Get Workspace", + "description": "Retrives properties about a workspace given a unique workspaceId. ", + "operationId": "Workspace_GetWorkspace", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "The external account number (int) or account ID GUID.", + "required": true, + "type": "string" + }, + { + "name": "workspaceId", + "in": "path", + "description": "The id of the workspace.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/workspace" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "getWorkspace", + "x-ds-method": "get", + "x-ds-service": "Workspaces", + "x-ds-in-sdk": true + }, + "put": { + "tags": [ + "Workspaces" + ], + "summary": "Update Workspace", + "description": "Updates information about a specific workspace.", + "operationId": "Workspace_PutWorkspace", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "The external account number (int) or account ID GUID.", + "required": true, + "type": "string" + }, + { + "name": "workspaceId", + "in": "path", + "description": "The id of the workspace.", + "required": true, + "type": "string" + }, + { + "name": "workspace", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/workspace" + }, + "description": "" + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/workspace" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "updateWorkspace", + "x-ds-method": "update", + "x-ds-service": "Workspaces", + "x-ds-in-sdk": true + }, + "delete": { + "tags": [ + "Workspaces" + ], + "summary": "Delete Workspace", + "description": "Deletes an existing workspace (logically).", + "operationId": "Workspace_DeleteWorkspace", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "The external account number (int) or account ID GUID.", + "required": true, + "type": "string" + }, + { + "name": "workspaceId", + "in": "path", + "description": "The id of the workspace.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/workspace" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "deleteWorkspace", + "x-ds-method": "delete", + "x-ds-service": "Workspaces", + "x-ds-in-sdk": true + }, + "parameters": [] + }, + "/v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}": { + "get": { + "tags": [ + "WorkspaceItems" + ], + "summary": "List workspace folder contents", + "description": "This method returns the contents of a workspace folder, which can include sub-folders and files.", + "operationId": "WorkspaceFolder_GetWorkspaceFolder", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "The external account number (int) or account ID GUID.", + "required": true, + "type": "string" + }, + { + "name": "folderId", + "in": "path", + "description": "The id of the folder.", + "required": true, + "type": "string" + }, + { + "name": "workspaceId", + "in": "path", + "description": "The id of the workspace.", + "required": true, + "type": "string" + }, + { + "name": "count", + "in": "query", + "description": "The maximum number of results to be returned by this request.", + "required": false, + "type": "string" + }, + { + "name": "include_files", + "in": "query", + "description": "When set to **true**, the response includes file information (in addition to folder information). The default is **false**.", + "required": false, + "type": "string" + }, + { + "name": "include_sub_folders", + "in": "query", + "description": "When set to **true**, the response includes information about the sub-folders of the current folder. The default is **false**.", + "required": false, + "type": "string" + }, + { + "name": "include_thumbnails", + "in": "query", + "description": "When set to **true**, the response returns thumbnails. The default is **false**.", + "required": false, + "type": "string" + }, + { + "name": "include_user_detail", + "in": "query", + "description": "When set to **true**, the response includes extended details about the user. The default is **false**.", + "required": false, + "type": "string" + }, + { + "name": "start_position", + "in": "query", + "description": "The position within the total result set from which to start returning values.", + "required": false, + "type": "string" + }, + { + "name": "workspace_user_id", + "in": "query", + "description": "If set, the response only includes results associated with the `userId` that you specify.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/workspaceFolderContents" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "listWorkspaceFolderItems", + "x-ds-method": "listFolderItems", + "x-ds-service": "Workspaces", + "x-ds-in-sdk": true + }, + "delete": { + "tags": [ + "WorkspaceItems" + ], + "summary": "Deletes files or sub-folders from a workspace.", + "operationId": "WorkspaceFolder_DeleteWorkspaceItems", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "The external account number (int) or account ID GUID.", + "required": true, + "type": "string" + }, + { + "name": "folderId", + "in": "path", + "description": "The id of the folder.", + "required": true, + "type": "string" + }, + { + "name": "workspaceId", + "in": "path", + "description": "The id of the workspace.", + "required": true, + "type": "string" + }, + { + "name": "workspaceItemList", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/workspaceItemList" + }, + "description": "" + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "deleteWorkspaceFolderItems", + "x-ds-method": "deleteFolderItems", + "x-ds-service": "Workspaces", + "description": "This method deletes one or more files or sub-folders from a workspace folder or root.\n\nNote: To delete items from a workspace, the `status` of the workspace must be `active`.", + "x-ds-in-sdk": true + }, + "parameters": [] + }, + "/v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}/files": { + "post": { + "tags": [ + "WorkspaceItems" + ], + "summary": "Creates a workspace file.", + "operationId": "WorkspaceFile_PostWorkspaceFiles", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "The external account number (int) or account ID GUID.", + "required": true, + "type": "string" + }, + { + "name": "folderId", + "in": "path", + "description": "The id of the folder.", + "required": true, + "type": "string" + }, + { + "name": "workspaceId", + "in": "path", + "description": "The id of the workspace.", + "required": true, + "type": "string" + } + ], + "responses": { + "201": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/workspaceItem" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "createWorkspaceFile", + "x-ds-method": "createFIle", + "x-ds-service": "Workspaces", + "description": "This method adds a file to a workspace.", + "x-ds-in-sdk": true + }, + "parameters": [] + }, + "/v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}/files/{fileId}": { + "get": { + "tags": [ + "WorkspaceItems" + ], + "summary": "Gets a workspace file", + "description": "This method returns a binary version of a file in a workspace.", + "operationId": "WorkspaceFile_GetWorkspaceFile", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "The external account number (int) or account ID GUID.", + "required": true, + "type": "string" + }, + { + "name": "fileId", + "in": "path", + "description": "The id of the file.", + "required": true, + "type": "string" + }, + { + "name": "folderId", + "in": "path", + "description": "The id of the folder.", + "required": true, + "type": "string" + }, + { + "name": "workspaceId", + "in": "path", + "description": "The id of the workspace.", + "required": true, + "type": "string" + }, + { + "name": "is_download", + "in": "query", + "description": "When set to **true**, the `Content-Disposition` header is set in the response. The value of the header provides the filename of the file. The default is **false**.", + "required": false, + "type": "string" + }, + { + "name": "pdf_version", + "in": "query", + "description": "When set to **true** the file is returned in PDF format.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "getWorkspaceFile", + "x-ds-method": "getFile", + "x-ds-service": "Workspaces", + "x-ds-in-sdk": true + }, + "put": { + "tags": [ + "WorkspaceItems" + ], + "summary": "Update workspace file or folder metadata", + "description": "This method updates the metadata for one or more specific files or folders in a workspace.", + "operationId": "WorkspaceFile_PutWorkspaceFile", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "The external account number (int) or account ID GUID.", + "required": true, + "type": "string" + }, + { + "name": "fileId", + "in": "path", + "description": "The id of the file.", + "required": true, + "type": "string" + }, + { + "name": "folderId", + "in": "path", + "description": "The id of the folder.", + "required": true, + "type": "string" + }, + { + "name": "workspaceId", + "in": "path", + "description": "The id of the workspace.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/workspaceItem" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "updateWorkspaceFile", + "x-ds-method": "updateFile", + "x-ds-service": "Workspaces", + "x-ds-in-sdk": true + }, + "parameters": [] + }, + "/v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}/files/{fileId}/pages": { + "get": { + "tags": [ + "WorkspaceItems" + ], + "summary": "List File Pages", + "description": "This method returns a workspace file as rasterized pages.", + "operationId": "WorkspaceFilePages_GetWorkspaceFilePages", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "The external account number (int) or account ID GUID.", + "required": true, + "type": "string" + }, + { + "name": "fileId", + "in": "path", + "description": "The id of the file.", + "required": true, + "type": "string" + }, + { + "name": "folderId", + "in": "path", + "description": "The id of the folder.", + "required": true, + "type": "string" + }, + { + "name": "workspaceId", + "in": "path", + "description": "The id of the workspace.", + "required": true, + "type": "string" + }, + { + "name": "count", + "in": "query", + "description": "The maximum number of results to be returned by this request.", + "required": false, + "type": "string" + }, + { + "name": "dpi", + "in": "query", + "description": "The number of dots per inch (DPI) for the resulting images. Valid values are 1-310 DPI. The default value is 94.", + "required": false, + "type": "string" + }, + { + "name": "max_height", + "in": "query", + "description": "Sets the maximum height of the returned images in pixels.", + "required": false, + "type": "string" + }, + { + "name": "max_width", + "in": "query", + "description": "Sets the maximum width of the returned images in pixels.", + "required": false, + "type": "string" + }, + { + "name": "start_position", + "in": "query", + "description": "The position within the total result set from which to start returning values. The value **thumbnail** may be used to return the page image.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/pageImages" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "listWorkspaceFilePages", + "x-ds-method": "listFilePages", + "x-ds-service": "Workspaces", + "x-ds-in-sdk": true + }, + "parameters": [] + }, + "/v2.1/accounts/provisioning": { + "get": { + "tags": [ + "Accounts" + ], + "summary": "Retrieves the account provisioning information for the account.", + "description": "Retrieves the account provisioning information for the account.", + "operationId": "Accounts_GetProvisioning", + "consumes": [], + "produces": [], + "parameters": [], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/provisioningInformation" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "getProvisioning", + "x-ds-method": "getProvisioning", + "x-ds-service": "Accounts", + "x-ds-in-sdk": true + }, + "parameters": [] + }, + "/v2.1/billing_plans": { + "get": { + "tags": [ + "BillingPlans" + ], + "summary": "Gets a list of available billing plans.", + "description": "Retrieves a list of the billing plans associated with a distributor.", + "operationId": "BillingPlans_GetBillingPlans", + "consumes": [], + "produces": [], + "parameters": [], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/billingPlansResponse" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "listBillingPlans", + "x-ds-method": "list", + "x-ds-service": "Billing", + "x-ds-in-sdk": true + }, + "parameters": [] + }, + "/v2.1/billing_plans/{billingPlanId}": { + "get": { + "tags": [ + "BillingPlans" + ], + "summary": "Gets billing plan details.", + "description": "Retrieves the billing plan details for the specified billing plan ID.", + "operationId": "BillingPlans_GetBillingPlan", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "billingPlanId", + "in": "path", + "description": "The ID of the billing plan being accessed.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/billingPlanResponse" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "getBillingPlan", + "x-ds-method": "get", + "x-ds-service": "Billing", + "x-ds-in-sdk": true + }, + "parameters": [] + }, + "/v2.1/current_user/notary": { + "get": { + "tags": [ + "Notary" + ], + "summary": "Gets settings for a notary user.", + "operationId": "Notary_GetNotary", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "include_jurisdictions", + "in": "query", + "required": false, + "type": "string", + "description": "If **true**, the response will include a `jurisdiction` property that contains an array of all supported jurisdictions for the current user." + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/notaryResult" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "getNotary", + "x-ds-method": "getNotary", + "x-ds-service": "Uncategorized", + "description": "Gets settings for a notary user.\nThe current user must be a notary.", + "x-ds-in-sdk": true + }, + "put": { + "tags": [ + "Notary" + ], + "summary": "Updates notary information for the current user.", + "operationId": "Notary_PutNotary", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "notary", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/notary" + }, + "description": "" + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/notary" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "updateNotary", + "x-ds-method": "updateNotary", + "x-ds-service": "Uncategorized", + "description": "Updates notary information for the current user.", + "x-ds-in-sdk": true + }, + "post": { + "tags": [ + "Notary" + ], + "summary": "Registers the current user as a notary.", + "operationId": "Notary_PostNotary", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "notary", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/notary" + }, + "description": "" + } + ], + "responses": { + "201": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/notary" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "createNotary", + "x-ds-method": "createNotary", + "x-ds-service": "Uncategorized", + "description": "Registers the current user as a notary.", + "x-ds-in-sdk": true + }, + "parameters": [] + }, + "/v2.1/current_user/notary/journals": { + "get": { + "tags": [ + "NotaryJournals" + ], + "summary": "Gets notary jurisdictions for a user.", + "operationId": "NotaryJournals_GetNotaryJournals", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "count", + "in": "query", + "required": false, + "type": "string", + "description": "The maximum number of results to return." + }, + { + "name": "search_text", + "in": "query", + "required": false, + "type": "string", + "description": "Use this parameter to search for specific text." + }, + { + "name": "start_position", + "in": "query", + "required": false, + "type": "string", + "description": "The position within the total result set from which to start returning values. The value **thumbnail** may be used to return the page image." + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/notaryJournalList" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "listNotaryJournals", + "x-ds-method": "list", + "x-ds-service": "Notary", + "description": "", + "x-ds-in-sdk": true + }, + "parameters": [] + }, + "/v2.1/current_user/notary/jurisdictions": { + "get": { + "tags": [ + "NotaryJurisdiction" + ], + "summary": "Returns a list of jurisdictions that the notary is registered in.", + "operationId": "NotaryJurisdictions_GetNotaryJurisdictions", + "consumes": [], + "produces": [], + "parameters": [], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/notaryJurisdictionList" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "getNotaryJurisdictions", + "x-ds-method": "getNotaryJurisdictions", + "x-ds-service": "Uncategorized", + "description": "Returns a list of jurisdictions that the notary is registered in.\nThe current user must be a notary.", + "x-ds-in-sdk": true + }, + "post": { + "tags": [ + "NotaryJurisdiction" + ], + "summary": "Creates a jurisdiction object.", + "operationId": "NotaryJurisdictions_PostNotaryJurisdictions", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "notaryJurisdiction", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/notaryJurisdiction" + }, + "description": "" + } + ], + "responses": { + "201": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/notaryJurisdiction" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "createNotaryJurisdictions", + "x-ds-method": "createNotaryJurisdictions", + "x-ds-service": "Uncategorized", + "description": "Creates a jurisdiction object.", + "x-ds-in-sdk": true + }, + "parameters": [] + }, + "/v2.1/current_user/notary/jurisdictions/{jurisdictionId}": { + "get": { + "tags": [ + "NotaryJurisdiction" + ], + "summary": "Gets a jurisdiction object for the current user. The user must be a notary.", + "operationId": "NotaryJurisdictions_GetNotaryJurisdiction", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "jurisdictionId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the jurisdiction.\nThe following jurisdictions\nare supported:\n\n- `5 - California`\n- `6 - Colorado`\n- `9 - Florida`\n- `10 - Georgia`\n- `12 - Idaho`\n- `13 - Illinois`\n- `14 - Indiana`\n- `15 - Iowa`\n- `17 - Kentucky`\n- `23 - Minnesota`\n- `25 - Missouri`\n- `30 - New Jersey`\n- `32 - New York`\n- `33 - North Carolina`\n- `35 - Ohio`\n- `37 - Oregon`\n- `38 - Pennsylvania`\n- `40 - South Carolina`\n- `43 - Texas`\n- `44 - Utah`\n- `47 - Washington`\n- `48 - West Virginia`\n- `49 - Wisconsin`\n- `62 - Florida Commissioner of Deeds`\n" + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/notaryJurisdiction" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "getNotaryJurisdiction", + "x-ds-method": "getNotaryJurisdiction", + "x-ds-service": "Uncategorized", + "description": "Gets a jurisdiction object for the current user. The following restrictions apply:\n\n- The current user must be a notary.\n- The `jurisdictionId` must be a jurisdiction that the notary is registered for.\n", + "x-ds-in-sdk": true + }, + "put": { + "tags": [ + "NotaryJurisdiction" + ], + "summary": "Updates the jurisdiction information about a notary.", + "operationId": "NotaryJurisdictions_PutNotaryJurisdiction", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "jurisdictionId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the jurisdiction.\nThe following jurisdictions\nare supported:\n\n- `5 - California`\n- `6 - Colorado`\n- `9 - Florida`\n- `10 - Georgia`\n- `12 - Idaho`\n- `13 - Illinois`\n- `14 - Indiana`\n- `15 - Iowa`\n- `17 - Kentucky`\n- `23 - Minnesota`\n- `25 - Missouri`\n- `30 - New Jersey`\n- `32 - New York`\n- `33 - North Carolina`\n- `35 - Ohio`\n- `37 - Oregon`\n- `38 - Pennsylvania`\n- `40 - South Carolina`\n- `43 - Texas`\n- `44 - Utah`\n- `47 - Washington`\n- `48 - West Virginia`\n- `49 - Wisconsin`\n- `62 - Florida Commissioner of Deeds`\n" + }, + { + "name": "notaryJurisdiction", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/notaryJurisdiction" + }, + "description": "" + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/notaryJurisdiction" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "updateNotaryJurisdiction", + "x-ds-method": "updateNotaryJurisdiction", + "x-ds-service": "Uncategorized", + "description": "Updates the jurisdiction information about a notary.\n\nThe following restrictions apply:\n\n- The current user must be a notary.\n- The `jurisdictionId` path parameter must be a jurisdiction that the notary is registered for.\n- The `jurisdictionId` path parameter must match the request body's `jurisdiction.jurisdictionId`.\n\nThe request body must have a full `jurisdiction` object for the jurisdiction property.\nThe best way to do this is to use `getNotaryJurisdiction` to obtain the current values and update the properties you want to change.\n\nFor example, assume `getNotaryJurisdiction` returns this:\n\n```\n{\n \"jurisdiction\": {\n \"jurisdictionId\": \"15\",\n \"name\": \"Iowa\",\n \"county\": \"\",\n \"enabled\": \"true\",\n \"countyInSeal\": \"false\",\n \"commissionIdInSeal\": \"true\",\n \"stateNameInSeal\": \"true\",\n \"notaryPublicInSeal\": \"true\",\n \"allowSystemCreatedSeal\": \"true\",\n \"allowUserUploadedSeal\": \"false\"\n },\n \"commissionId\": \"123456\",\n \"commissionExpiration\": \"2020-08-31T07:00:00.0000000Z\",\n \"registeredName\": \"Bob Notary\",\n \"county\": \"Adams\",\n \"sealType\": \"system_created\"\n}\n```\n\nIf you want to change the name of the notary from \"Bob Notary\" to \"Robert Notary\", your request body would be:\n\n```\n{\n \"jurisdiction\": {\n \"jurisdictionId\": \"15\",\n \"name\": \"Iowa\",\n \"county\": \"\",\n \"enabled\": \"true\",\n \"countyInSeal\": \"false\",\n \"commissionIdInSeal\": \"true\",\n \"stateNameInSeal\": \"true\",\n \"notaryPublicInSeal\": \"true\",\n \"allowSystemCreatedSeal\": \"true\",\n \"allowUserUploadedSeal\": \"false\"\n },\n \"commissionId\": \"123456\",\n \"commissionExpiration\": \"2020-08-31T07:00:00.0000000Z\",\n \"registeredName\": \"Robert Notary\",\n \"county\": \"Adams\",\n \"sealType\": \"system_created\"\n}\n```\n", + "x-ds-in-sdk": true + }, + "delete": { + "tags": [ + "NotaryJurisdiction" + ], + "summary": "Deletes the specified jurisdiction.", + "operationId": "NotaryJurisdictions_DeleteNotaryJurisdiction", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "jurisdictionId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the jurisdiction.\nThe following jurisdictions\nare supported:\n\n- `5 - California`\n- `6 - Colorado`\n- `9 - Florida`\n- `10 - Georgia`\n- `12 - Idaho`\n- `13 - Illinois`\n- `14 - Indiana`\n- `15 - Iowa`\n- `17 - Kentucky`\n- `23 - Minnesota`\n- `25 - Missouri`\n- `30 - New Jersey`\n- `32 - New York`\n- `33 - North Carolina`\n- `35 - Ohio`\n- `37 - Oregon`\n- `38 - Pennsylvania`\n- `40 - South Carolina`\n- `43 - Texas`\n- `44 - Utah`\n- `47 - Washington`\n- `48 - West Virginia`\n- `49 - Wisconsin`\n- `62 - Florida Commissioner of Deeds`\n" + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "deleteNotaryJurisdiction", + "x-ds-method": "deleteNotaryJurisdiction", + "x-ds-service": "Uncategorized", + "description": "Deletes the specified jurisdiction.", + "x-ds-in-sdk": true + }, + "parameters": [] + }, + "/v2.1/current_user/password_rules": { + "get": { + "tags": [ + "AccountPasswordRules" + ], + "summary": "Gets membership account password rules.", + "operationId": "PasswordRules_GetPasswordRules", + "consumes": [], + "produces": [], + "parameters": [], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/userPasswordRules" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "getPasswordRules", + "x-ds-method": "getForUser", + "x-ds-service": "Accounts", + "description": "", + "x-ds-in-sdk": true + }, + "parameters": [] + }, + "/v2.1/diagnostics/request_logs": { + "get": { + "tags": [ + "RequestLogs" + ], + "summary": "Gets the API request logging log files.", + "description": "Retrieves a list of log entries as a JSON or xml object or as a zip file containing the entries.\n\nIf the Accept header is set to application/zip, the response is a zip file containing individual text files, each representing an API request.\n\nIf the Accept header is set to `application/json` or `application/xml`, the response returns list of log entries in either JSON or XML. An example JSON response body is shown below. ", + "operationId": "APIRequestLog_GetRequestLogs", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "encoding", + "in": "query", + "required": false, + "type": "string", + "description": "Reserved for DocuSign." + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/apiRequestLogsResult" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "listRequestLogs", + "x-ds-method": "list", + "x-ds-service": "Diagnostics", + "x-ds-in-sdk": true + }, + "delete": { + "tags": [ + "RequestLogs" + ], + "summary": "Deletes the request log files.", + "description": "Deletes the request log files.", + "operationId": "APIRequestLog_DeleteRequestLogs", + "consumes": [], + "produces": [], + "parameters": [], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "deleteRequestLogs", + "x-ds-method": "delete", + "x-ds-service": "Diagnostics", + "x-ds-in-sdk": true + }, + "parameters": [] + }, + "/v2.1/diagnostics/request_logs/{requestLogId}": { + "get": { + "tags": [ + "RequestLogs" + ], + "summary": "Gets a request logging log file.", + "description": "Retrieves information for a single log entry.\n\n**Request**\nThe `requestLogfId` property can be retrieved by getting the list of log entries. The Content-Transfer-Encoding header can be set to base64 to retrieve the API request/response as base 64 string. Otherwise the bytes of the request/response are returned.\n\n**Response**\nIf the Content-Transfer-Encoding header was set to base64, the log is returned as a base64 string.", + "operationId": "APIRequestLog_GetRequestLog", + "consumes": [], + "produces": [ + "text/plain" + ], + "parameters": [ + { + "name": "requestLogId", + "in": "path", + "required": true, + "type": "string", + "description": "" + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "type": "file" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "getRequestLog", + "x-ds-method": "get", + "x-ds-service": "Diagnostics", + "x-ds-in-sdk": true + }, + "parameters": [] + }, + "/v2.1/diagnostics/settings": { + "get": { + "tags": [ + "RequestLogs" + ], + "summary": "Gets the API request logging settings.", + "description": "Retrieves the current API request logging setting for the user and remaining log entries.\n\n**Response**\nThe response includes the current API request logging setting for the user, along with the maximum log entries and remaining log entries.", + "operationId": "APIRequestLog_GetRequestLogSettings", + "consumes": [], + "produces": [], + "parameters": [], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/diagnosticsSettingsInformation" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "getRequestLogSettings", + "x-ds-method": "getSettings", + "x-ds-service": "Diagnostics", + "x-ds-in-sdk": true + }, + "put": { + "tags": [ + "RequestLogs" + ], + "summary": "Enables or disables API request logging for troubleshooting.", + "description": "Enables or disables API request logging for troubleshooting.\n\nWhen enabled (`apiRequestLogging` is **true**), REST API requests and responses for the user are added to a log. A log can have up to 50 requests/responses and the current number of log entries can be determined by getting the settings. Logging is automatically disabled when the log limit of 50 is reached.\n\nYou can call [Diagnostics::getRequestLog\n](https://developers.docusign.com/esign-rest-api/reference/Diagnostics/RequestLogs/get) or [Diagnostics::listRequestLogs](https://developers.docusign.com/esign-rest-api/reference/Diagnostics/RequestLogs/list) to download the log files (individually or as a zip file). Call [Diagnostics::deleteRequestLogs\n](https://developers.docusign.com/esign-rest-api/reference/Diagnostics/RequestLogs/delete) to clear the log by deleting current entries.\n\nPrivate information, such as passwords and integrator key information, which is normally located in the call header is omitted from the request/response log.\n\nAPI request logging only captures requests from the authenticated user. Any call that does not authenticate the user and resolve a userId is not logged.\n", + "operationId": "APIRequestLog_PutRequestLogSettings", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "diagnosticsSettingsInformation", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/diagnosticsSettingsInformation" + }, + "description": "" + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/diagnosticsSettingsInformation" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "updateRequestLogSettings", + "x-ds-method": "updateSettings", + "x-ds-service": "Diagnostics", + "x-ds-in-sdk": true + }, + "parameters": [] + }, + "/v2.1/display_appliance_info/error": { + "post": { + "tags": [ + "ApplianceInfo" + ], + "summary": "Uploads Kazmon error for Display Appliance.", + "operationId": "EnvelopeApplianceInfo_PostError", + "consumes": [], + "produces": [], + "parameters": [], + "responses": { + "201": { + "description": "Successful response." + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "createError", + "x-ds-method": "createError", + "x-ds-service": "Uncategorized", + "description": "", + "x-ds-in-sdk": true + }, + "parameters": [] + }, + "/v2.1/display_appliance_info/redeem": { + "post": { + "tags": [ + "ApplianceInfo" + ], + "summary": "Returns signing URL for Display Appliance.", + "operationId": "EnvelopeApplianceInfo_PostRedeem", + "consumes": [], + "produces": [], + "parameters": [], + "responses": { + "201": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/displayApplianceInfo" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "createRedeem", + "x-ds-method": "createRedeem", + "x-ds-service": "Uncategorized", + "description": "", + "x-ds-in-sdk": true + }, + "parameters": [] + }, + "/v2.1/organization_exports/{organizationId}/account_settings/{resultId}": { + "get": { + "tags": [ + "Accounts" + ], + "summary": "Retrieves an account settings comparison.", + "operationId": "OrganizationExports_GetAccountSettingsExport", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "organizationId", + "in": "path", + "required": true, + "type": "string", + "description": "" + }, + { + "name": "resultId", + "in": "path", + "required": true, + "type": "string", + "description": "" + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "getAccountSettingsExport", + "x-ds-api-status": "beta", + "x-ds-method": "getAccountSettingsExport", + "x-ds-service": "Uncategorized", + "description": "", + "x-ds-in-sdk": true + }, + "parameters": [] + } + }, + "definitions": { + "accessCodeFormat": { + "type": "object", + "properties": { + "formatRequired": { + "description": "Boolean specifying whether this format configuration is required.", + "type": "string" + }, + "formatRequiredMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata indicating whether the `formatRequired` property is editable." + }, + "letterRequired": { + "description": "Boolean specifying whether alphabetical characters are required in the access code string.", + "type": "string" + }, + "letterRequiredMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata indicating whether the `letterRequired` property is editable." + }, + "minimumLength": { + "description": "Minimum length of the access code string.", + "type": "string" + }, + "minimumLengthMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata indicating whether the `minimumLength` property is editable." + }, + "numberRequired": { + "description": "Boolean specifying whether numerical characters (0-9) are required in the access code string.", + "type": "string" + }, + "numberRequiredMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata indicating whether the `numberRequired` property is editable." + }, + "specialCharacterRequired": { + "description": "Boolean specifying whether special characters are required in the access code string. The string cannot contain the special characters '<', '>', '&', or '#'.", + "type": "string" + }, + "specialCharacterRequiredMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata indicating whether the `specialCharacterRequired` property is editable." + } + }, + "x-ds-definition-name": "accessCodeFormat", + "description": "Object specifying the format of the string provided to a recipient in order to access an envelope.", + "x-ms-summary": "Object specifying the format of the string provided to a recipient in order to access an envelope." + }, + "accountAddress": { + "description": "Contains information about the address associated with the account.", + "type": "object", + "properties": { + "address1": { + "description": "The first line of the address. Maximum length: 100 characters.", + "type": "string" + }, + "address2": { + "description": "The second line of the address. Maximum length: 100 characters.", + "type": "string" + }, + "city": { + "description": "The city associated with the address. Maximum length: 40 characters.", + "type": "string" + }, + "country": { + "description": "The country associated with the address. Maximum length: 50 characters.", + "type": "string" + }, + "email": { + "description": "The email address associated with the account.", + "type": "string" + }, + "fax": { + "description": "The fax number associated with the account.", + "type": "string" + }, + "firstName": { + "description": "The first name of the user associated with the account. Maximum Length: 50 characters.", + "type": "string" + }, + "lastName": { + "description": "The last name of the user associated with the account.", + "type": "string" + }, + "phone": { + "description": "The phone number associated with the account.", + "type": "string" + }, + "postalCode": { + "description": "The postal code associated with the address. Maximum length: 20 characters.", + "type": "string" + }, + "state": { + "description": "The state or province associated with the address. Maximum length: 40 characters.", + "type": "string" + }, + "supportedCountries": { + "description": "An array of supported countries associated with the account.", + "type": "array", + "items": { + "$ref": "#/definitions/country" + } + } + }, + "x-ds-definition-name": "accountAddress", + "x-ms-summary": "Contains information about the address associated with the account." + }, + "accountBillingPlan": { + "description": "Contains information about an account billing plan.", + "type": "object", + "properties": { + "addOns": { + "description": "Reserved for DocuSign.", + "type": "array", + "items": { + "$ref": "#/definitions/addOn" + } + }, + "appStoreReceiptExpirationDate": { + "description": "", + "type": "string" + }, + "appStoreReceiptPurchaseDate": { + "description": "", + "type": "string" + }, + "canCancelRenewal": { + "description": "Reserved for DocuSign.", + "type": "string" + }, + "canUpgrade": { + "description": "When set to **true**, specifies that you can upgrade the account through the API. For GET methods, you must set the `include_metadata` query parameter to **true** for this property to appear in the response.", + "type": "string" + }, + "currencyCode": { + "description": "Specifies the ISO currency code to use for the account.", + "type": "string" + }, + "downgradePlanInformation": { + "$ref": "#/definitions/downgradePlanUpdateResponse", + "description": "" + }, + "enableSupport": { + "description": "When set to **true**, customer support is provided as part of the account plan.", + "type": "string" + }, + "includedSeats": { + "description": "The number of seats (users) included in the plan.", + "type": "string" + }, + "incrementalSeats": { + "description": "Reserved for DocuSign.", + "type": "string" + }, + "isDowngrade": { + "description": "When **true**, the account has been downgraded from a premium account type. Otherwise **false**.", + "type": "string" + }, + "notificationType": { + "description": "", + "type": "string" + }, + "otherDiscountPercent": { + "description": " Any other percentage discount for the plan. ", + "type": "string" + }, + "paymentCycle": { + "description": "The payment cycle associated with the plan. The possible values are: \n\n- `Monthly`\n- `Annually` ", + "type": "string" + }, + "paymentMethod": { + "description": " The payment method used with the plan. The possible values are: CreditCard, PurchaseOrder, Premium, or Freemium. ", + "type": "string" + }, + "perSeatPrice": { + "description": "The per-seat price associated with the plan.\n\nExample: `\"456.0000\"`", + "type": "string" + }, + "planClassification": { + "description": "Identifies the type of plan. Examples include:\n\n- `business`\n- `corporate`\n- `enterprise` \n- `free`", + "type": "string" + }, + "planFeatureSets": { + "description": "A complex type that sets the feature sets for the account. It contains the following information (all string content):\n\n* currencyFeatureSetPrices - Contains the currencyCode and currencySymbol for the alternate currency values for envelopeFee, fixedFee, seatFee that are configured for this plan feature set.\n* envelopeFee - An incremental envelope cost for plans with envelope overages (when isEnabled=true).\n* featureSetId - A unique ID for the feature set.\n* fixedFee - A one-time fee associated with the plan (when isEnabled=true).\n* isActive - Specifies whether the feature set is actively set as part of the plan.\n* isEnabled - Specifies whether the feature set is actively enabled as part of the plan.\n* name - The name of the feature set.\n* seatFee - An incremental seat cost for seat-based plans (when isEnabled=true).\n", + "type": "array", + "items": { + "$ref": "#/definitions/featureSet" + } + }, + "planId": { + "description": "DocuSign's id for the account plan.", + "type": "string" + }, + "planName": { + "description": "The name of the billing plan used for the account.\n\nExamples: \n\n- `Personal - Annual`\n- `Unlimited Envelope Subscription - Annual Billing`", + "type": "string" + }, + "renewalStatus": { + "description": "The renewal status for the account. Valid values are:\n\n* `auto`: The account automatically renews.\n* `queued_for_close`: The account will be closed at the `billingPeriodEndDate`.\n* `queued_for_downgrade`: The account will be downgraded at the `billingPeriodEndDate`.\n\n**Note**: For GET methods, you must set the `include_metadata` query parameter to **true** for this property to appear in the response.", + "type": "string" + }, + "seatDiscounts": { + "description": "\n ", + "type": "array", + "items": { + "$ref": "#/definitions/seatDiscount" + } + }, + "supportIncidentFee": { + "description": "The support incident fee charged for each support incident.\n\nExample: `\"$0.00\"`", + "type": "string" + }, + "supportPlanFee": { + "description": "The support plan fee charged for this plan.\n\nExample: `\"$0.00\"`", + "type": "string" + } + }, + "x-ds-definition-name": "accountBillingPlan", + "x-ms-summary": "Contains information about an account billing plan." + }, + "accountBillingPlanResponse": { + "description": "Defines an account billing plan response object.", + "type": "object", + "properties": { + "billingAddress": { + "$ref": "#/definitions/accountAddress", + "description": "The billing address for the account." + }, + "billingAddressIsCreditCardAddress": { + "description": "When set to **true**, the credit card address information is the same as that returned as the billing address. If false, then the billing address is considered a billing contact address, and the credit card address can be different.", + "type": "string" + }, + "billingPlan": { + "$ref": "#/definitions/accountBillingPlan", + "description": "An object that contains details about the billing plan." + }, + "creditCardInformation": { + "$ref": "#/definitions/creditCardInformation", + "description": "A complex type that has information about the credit card used to pay for this account." + }, + "directDebitProcessorInformation": { + "$ref": "#/definitions/directDebitProcessorInformation", + "description": "Information about the bank that processes direct debits for the payment plan." + }, + "downgradePlanInformation": { + "$ref": "#/definitions/downgradePlanUpdateResponse", + "description": "" + }, + "paymentMethod": { + "description": "The payment method used for the billing plan. Valid values are:\n\n- `NotSupported`\n- `CreditCard`\n- `PurchaseOrder`\n- `Premium`\n- `Freemium`\n- `FreeTrial`\n- `AppStore`\n- `DigitalExternal`\n- `DirectDebit`", + "type": "string" + }, + "paymentProcessorInformation": { + "$ref": "#/definitions/paymentProcessorInformation", + "description": "Information about the entity that processes payments for the billing plan." + }, + "referralInformation": { + "$ref": "#/definitions/referralInformation", + "description": "A complex type that contains properties for entering referral and discount information." + }, + "successorPlans": { + "description": "A list of billing plans that the current billing plan can be rolled into.", + "type": "array", + "items": { + "$ref": "#/definitions/billingPlan" + } + } + }, + "x-ds-definition-name": "accountBillingPlanResponse", + "x-ms-summary": "Defines an account billing plan response object." + }, + "accountIdentityInputOption": { + "type": "object", + "properties": { + "isRequired": { + "description": "", + "type": "boolean" + }, + "optionName": { + "description": "", + "type": "string" + }, + "valueType": { + "description": "", + "type": "string" + } + }, + "x-ds-definition-name": "accountIdentityInputOption", + "description": "", + "x-ms-summary": "" + }, + "accountIdentityVerificationResponse": { + "type": "object", + "properties": { + "identityVerification": { + "description": " ", + "type": "array", + "items": { + "$ref": "#/definitions/accountIdentityVerificationWorkflow" + } + } + }, + "x-ds-definition-name": "accountIdentityVerificationResponse", + "description": "", + "x-ms-summary": "" + }, + "accountIdentityVerificationStep": { + "type": "object", + "properties": { + "name": { + "description": "The name of the Identity Verification workflow step.", + "type": "string" + }, + "type": { + "description": "Reserved for DocuSign.", + "type": "string" + } + }, + "x-ds-definition-name": "accountIdentityVerificationStep", + "description": "Information about a specific step in an Identity Verification workflow.", + "x-ms-summary": "Information about a specific step in an Identity Verification workflow." + }, + "accountIdentityVerificationWorkflow": { + "type": "object", + "properties": { + "defaultDescription": { + "description": "Text describing the purpose of the Identity Verification workflow.", + "type": "string" + }, + "defaultName": { + "description": "The name of the Identity Verification workflow.", + "type": "string" + }, + "inputOptions": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/accountIdentityInputOption" + } + }, + "signatureProvider": { + "$ref": "#/definitions/accountSignatureProvider", + "description": "The signature provider associated with the Identity Verification workflow." + }, + "workflowId": { + "description": "Workflow unique ID
This is the ID you must specify when setting ID Verification in an envelope using the `identityVerification`\n[core recipient parameter](https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipients#core-recipient-parameters)", + "type": "string" + }, + "workflowResourceKey": { + "description": "Reserved for DocuSign.", + "type": "string" + } + }, + "x-ds-definition-name": "accountIdentityVerificationWorkflow", + "description": "Specifies an Identity Verification workflow.", + "x-ms-summary": "Specifies an Identity Verification workflow." + }, + "accountInformation": { + "description": "Contains account Information.", + "type": "object", + "properties": { + "accountIdGuid": { + "description": "The GUID associated with the account ID.", + "type": "string" + }, + "accountName": { + "description": "The name on the account.", + "type": "string" + }, + "accountSettings": { + "$ref": "#/definitions/accountSettingsInformation", + "description": "The list of\naccount settings accountsettings\nthat determine\nthe features available for the account.\nNote that some features are determined\nby the plan used to create the account and cannot be overridden.\n\n" + }, + "allowTransactionRooms": { + "description": "When set to **true**, the transaction rooms feature exposed through the Workspaces API is enabled.", + "type": "string" + }, + "billingPeriodDaysRemaining": { + "description": "Number of days remaining in the current billing period.", + "type": "string" + }, + "billingPeriodEndDate": { + "description": "The billing period end date in UTC timedate format.", + "type": "string" + }, + "billingPeriodEnvelopesAllowed": { + "description": "The number of envelopes that can be sent in the current billing period (can be unlimited).", + "type": "string" + }, + "billingPeriodEnvelopesSent": { + "description": "The number of envelopes that have been sent in the current billing period.", + "type": "string" + }, + "billingPeriodStartDate": { + "description": "The billing period start date in UTC timedate format.", + "type": "string" + }, + "billingProfile": { + "description": "The type of billing method on the account. Valid values are: \n\n- `direct`\n- `web`", + "type": "string" + }, + "canUpgrade": { + "description": "When set to **true**, specifies that you can upgrade the account through the API. For GET methods, you must set the `include_metadata` query parameter to **true** for this property to appear in the response.", + "type": "string" + }, + "connectPermission": { + "description": "", + "type": "string" + }, + "createdDate": { + "description": "The creation date of the account in UTC timedate format.", + "type": "string" + }, + "currencyCode": { + "description": "The currency code for the account, based on the [ISO 4217 currency code](https://www.iso.org/iso-4217-currency-codes.html).", + "type": "string" + }, + "currentPlanId": { + "description": "ID of the plan used to create this account.", + "type": "string" + }, + "displayApplianceStartUrl": { + "description": "", + "type": "string" + }, + "displayApplianceUrl": { + "description": "", + "type": "string" + }, + "distributorCode": { + "description": "The code that identifies the billing plan groups and plans for the new account.", + "type": "string" + }, + "docuSignLandingUrl": { + "description": "URL of the landing page used to create the account.", + "type": "string" + }, + "dssValues": { + "description": "", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "envelopeSendingBlocked": { + "description": "When **true**, the ability to send envelopes is blocked. When **false**, envelopes can be sent.", + "type": "string" + }, + "envelopeUnitPrice": { + "description": "The price of sending an envelope, represented in the account's local currency.", + "type": "string" + }, + "externalAccountId": { + "description": "The Account ID displayed on the user's Account page.", + "type": "string" + }, + "forgottenPasswordQuestionsCount": { + "description": " A complex element that contains up to four Question/Answer pairs for forgotten password information for a user.", + "type": "string" + }, + "isDowngrade": { + "description": "When **true**, the account has been downgraded from a premium account type. Otherwise **false**.", + "type": "string" + }, + "paymentMethod": { + "description": "The payment method used for the billing plan. Valid values are:\n\n- `NotSupported`\n- `CreditCard`\n- `PurchaseOrder`\n- `Premium`\n- `Freemium`\n- `FreeTrial`\n- `AppStore`\n- `DigitalExternal`\n- `DirectDebit`", + "type": "string" + }, + "planClassification": { + "description": "Identifies the type of plan. Examples include:\n\n- `business`\n- `corporate`\n- `enterprise` \n- `free`", + "type": "string" + }, + "planEndDate": { + "description": "The date that the current plan will end.", + "type": "string" + }, + "planName": { + "description": "The name of the billing plan used for the account.\n\nExamples: \n\n- `Personal - Annual`\n- `Unlimited Envelope Subscription - Annual Billing`", + "type": "string" + }, + "planStartDate": { + "description": "The date that the Account started using the current plan.", + "type": "string" + }, + "recipientDomains": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/recipientDomain" + } + }, + "seatsAllowed": { + "description": "The number of active users the account can have at one time.", + "type": "string" + }, + "seatsInUse": { + "description": "The number of users currently active on the account.", + "type": "string" + }, + "status21CFRPart11": { + "description": "The status of the account content per (Title 21 CFR Part 11)[https://www.fda.gov/regulatory-information/search-fda-guidance-documents/part-11-electronic-records-electronic-signatures-scope-and-application]. This regulation defines the criteria under which electronic records and electronic signatures are considered trustworthy.", + "type": "string" + }, + "suspensionDate": { + "description": "The date on which the account was suspended.", + "type": "string" + }, + "suspensionStatus": { + "description": "Indicates whether the account is currently suspended.", + "type": "string" + }, + "useDisplayAppliance": { + "description": "", + "type": "boolean" + } + }, + "x-ds-definition-name": "accountInformation", + "x-ms-summary": "Contains account Information." + }, + "accountMinimumPasswordLength": { + "type": "object", + "properties": { + "maximumLength": { + "description": "The maximum number of entry characters supported by the custom tab.", + "type": "string" + }, + "minimumLength": { + "description": "Minimum length of the access code string.", + "type": "string" + } + }, + "x-ds-definition-name": "accountMinimumPasswordLength", + "description": "", + "x-ms-summary": "" + }, + "accountNotification": { + "type": "object", + "properties": { + "expirations": { + "$ref": "#/definitions/expirations", + "description": "A complex element that specifies the expiration settings for the envelope." + }, + "reminders": { + "$ref": "#/definitions/reminders", + "description": "A complex element that specifies reminder settings for the envelope" + }, + "userOverrideEnabled": { + "description": "When **true**, the user can override envelope expirations.", + "type": "string" + } + }, + "x-ds-definition-name": "accountNotification", + "description": "A complex element that specifies notifications (expirations and reminders) for the envelope.", + "x-ms-summary": "A complex element that specifies notifications (expirations and reminders) for the envelope." + }, + "accountPasswordExpirePasswordDays": { + "type": "object", + "properties": { + "maximumDays": { + "description": "", + "type": "string" + }, + "minimumDays": { + "description": "", + "type": "string" + } + }, + "x-ds-definition-name": "accountPasswordExpirePasswordDays", + "description": "", + "x-ms-summary": "" + }, + "accountPasswordLockoutDurationMinutes": { + "type": "object", + "properties": { + "maximumMinutes": { + "description": "", + "type": "string" + }, + "minimumMinutes": { + "description": "", + "type": "string" + } + }, + "x-ds-definition-name": "accountPasswordLockoutDurationMinutes", + "description": "", + "x-ms-summary": "" + }, + "accountPasswordLockoutDurationType": { + "type": "object", + "properties": { + "options": { + "description": "An array of option strings supported by this setting.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ds-definition-name": "accountPasswordLockoutDurationType", + "description": "", + "x-ms-summary": "" + }, + "accountPasswordMinimumPasswordAgeDays": { + "type": "object", + "properties": { + "maximumAge": { + "description": "", + "type": "string" + }, + "minimumAge": { + "description": "", + "type": "string" + } + }, + "x-ds-definition-name": "accountPasswordMinimumPasswordAgeDays", + "description": "", + "x-ms-summary": "" + }, + "accountPasswordQuestionsRequired": { + "type": "object", + "properties": { + "maximumQuestions": { + "description": "The maximum number of password reset questions allowed for the account. This number must be between `0` and `4`, and equal to or greater than `minimumQuestions`.", + "type": "string" + }, + "minimumQuestions": { + "description": "The minimum number of password reset questions allowed for the account. This number must be between `0` and `4`, and equal to or less than `maximumQuestions`.", + "type": "string" + } + }, + "x-ds-definition-name": "accountPasswordQuestionsRequired", + "description": "Information about the number of password questions required (0 to 4) to confirm a user's identity when a user needs to reset their password.", + "x-ms-summary": "Information about the number of password questions required (0 to 4) to confirm a user's identity when a user needs to reset their password." + }, + "accountPasswordRules": { + "type": "object", + "properties": { + "expirePassword": { + "description": "When set to **true**, passwords expire. The default value is `false`.", + "type": "string" + }, + "expirePasswordDays": { + "description": "The number of days before passwords expire. To use this property, the `expirePassword` property must be set to **true**.", + "type": "string" + }, + "expirePasswordDaysMetadata": { + "$ref": "#/definitions/accountPasswordExpirePasswordDays", + "description": "Metadata that indicates whether the `expirePasswordDays` property is editable.\n" + }, + "lockoutDurationMinutes": { + "description": "The number of minutes a user is locked out of the system after three (?) failed login attempts. The default value is `2`.", + "type": "string" + }, + "lockoutDurationMinutesMetadata": { + "$ref": "#/definitions/accountPasswordLockoutDurationMinutes", + "description": "Metadata that indicates whether the `lockoutDurationMinutes` property is editable.\n" + }, + "lockoutDurationType": { + "description": "The interval associated with the user lockout after a failed login attempt.\n\nPossible values are: (?????)\n\n- `minutes` (default)\n- `hours`\n- `days`", + "type": "string" + }, + "lockoutDurationTypeMetadata": { + "$ref": "#/definitions/accountPasswordLockoutDurationType", + "description": "Metadata that indicates whether the `lockoutDurationType` property is editable.\n" + }, + "minimumPasswordAgeDays": { + "description": "The minimum number of days after a password is set before it can be changed. This value can be `0` or more days. The default value is `0`.", + "type": "string" + }, + "minimumPasswordAgeDaysMetadata": { + "$ref": "#/definitions/accountPasswordMinimumPasswordAgeDays", + "description": "Metadata that indicates whether the `minimumPasswordAgeDays` property is editable.\n" + }, + "minimumPasswordLength": { + "description": "The minimum number of characters in the password. This value must be a number between `6` and `15`. The default value is `6`.", + "type": "string" + }, + "minimumPasswordLengthMetadata": { + "$ref": "#/definitions/accountMinimumPasswordLength", + "description": "Metadata that indicates whether the `minimumPasswordLength` property is editable.\n" + }, + "passwordIncludeDigit": { + "description": "When set to **true**, passwords must include a digit. The default value is `false`.", + "type": "string" + }, + "passwordIncludeDigitOrSpecialCharacter": { + "description": "When set to **true**, passwords must include either a digit or a special character. The default value is `false`.\n\n**Note**: Passwords cannot include angle brackets (`<` `>`) or spaces.", + "type": "string" + }, + "passwordIncludeLowerCase": { + "description": "When set to **true**, passwords must include a lowercase letter. The default value is `false`.", + "type": "string" + }, + "passwordIncludeSpecialCharacter": { + "description": "When set to **true**, passwords must include a special character. The default value is `false`.\n\n**Note**: Passwords cannot include angle brackets (`<` `>`) or spaces.", + "type": "string" + }, + "passwordIncludeUpperCase": { + "description": "When set to **true**, passwords must include an uppercase letter. The default value is `false`.", + "type": "string" + }, + "passwordStrengthType": { + "description": "The type of password strength. Possible values are:\n\n- `basic`: The minimum password length is 6 characters with no other password requirements.\n- `medium`: The minimum password length is 7 characters. Passwords must also have one uppercase letter, one lowercase letter, and one number or special character.\n- `strong`: The minimum password length is 9 characters. Passwords must also have one uppercase letter, one lowercase letter, one number, and one special character.\n- `custom`: This option enables you to customize password requirements, including the following properties:\n\n - `minimumPasswordLength`\n - `minimumPasswordAgeDays`\n - `passwordIncludeDigit`\n - `passwordIncludeDigitOrSpecialCharacter`\n - `passwordIncludeLowerCase`\n - `passwordIncludeSpecialCharacter`\n - `passwordIncludeUpperCase`\n - `questionsRequired`", + "type": "string" + }, + "passwordStrengthTypeMetadata": { + "$ref": "#/definitions/accountPasswordStrengthType", + "description": "Metadata that indicates whether the `passwordStrengthType` property is editable.\n" + }, + "questionsRequired": { + "description": "The number of security questions required to confirm the user’s identity before the user can reset their password. The default value is `0`.", + "type": "string" + }, + "questionsRequiredMetadata": { + "$ref": "#/definitions/accountPasswordQuestionsRequired", + "description": "Metadata that indicates whether the `questionsRequired` property is editable.\n" + } + }, + "x-ds-definition-name": "accountPasswordRules", + "description": "", + "x-ms-summary": "" + }, + "accountPasswordStrengthType": { + "type": "object", + "properties": { + "options": { + "description": "An array of option strings supported by this setting.", + "type": "array", + "items": { + "$ref": "#/definitions/accountPasswordStrengthTypeOption" + } + } + }, + "x-ds-definition-name": "accountPasswordStrengthType", + "description": "", + "x-ms-summary": "" + }, + "accountPasswordStrengthTypeOption": { + "type": "object", + "properties": { + "minimumLength": { + "description": "Minimum length of the access code string.", + "type": "string" + }, + "name": { + "description": "", + "type": "string" + }, + "passwordIncludeDigit": { + "description": "When set to **true**, passwords must include a digit. The default value is `false`.", + "type": "string" + }, + "passwordIncludeDigitOrSpecialCharacter": { + "description": "When set to **true**, passwords must include either a digit or a special character. The default value is `false`.\n\n**Note**: Passwords cannot include angle brackets (`<` `>`) or spaces.", + "type": "string" + }, + "passwordIncludeLowerCase": { + "description": "When set to **true**, passwords must include a lowercase letter. The default value is `false`.", + "type": "string" + }, + "passwordIncludeSpecialCharacter": { + "description": "When set to **true**, passwords must include a special character. The default value is `false`.\n\n**Note**: Passwords cannot include angle brackets (`<` `>`) or spaces.", + "type": "string" + }, + "passwordIncludeUpperCase": { + "description": "When set to **true**, passwords must include an uppercase letter. The default value is `false`.", + "type": "string" + } + }, + "x-ds-definition-name": "accountPasswordStrengthTypeOption", + "description": "", + "x-ms-summary": "" + }, + "accountRoleSettings": { + "type": "object", + "properties": { + "allowAccountManagement": { + "description": "When **true**, users have full administrative access to the account.", + "type": "string" + }, + "allowAccountManagementMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `allowAccountManagement` property is editable.\n" + }, + "allowApiAccess": { + "description": "When **true**, users can manage documents by using the API.", + "type": "string" + }, + "allowApiAccessMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `allowApiAccess` property is editable.\n" + }, + "allowApiAccessToAccount": { + "description": "When **true**, users can access the account by using the eSignature API.", + "type": "string" + }, + "allowApiAccessToAccountMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `allowApiAccessToAccount` property is editable.\n" + }, + "allowApiSendingOnBehalfOfOthers": { + "description": "When **true**, users can send envelopes on behalf of others.", + "type": "string" + }, + "allowApiSendingOnBehalfOfOthersMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `allowApiSendingOnBehalfOfOthers` property is editable.\n" + }, + "allowApiSequentialSigning": { + "description": "When **true**, users may specify sequential signing recipients when they send documents by using the API.", + "type": "string" + }, + "allowApiSequentialSigningMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `allowApiSequentialSigning` property is editable.\n" + }, + "allowAutoTagging": { + "description": " If **true**, auto-tagging is enabled for the account.", + "type": "string" + }, + "allowAutoTaggingMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `allowAutoTagging` property is editable." + }, + "allowBulkSending": { + "description": "When **true**, bulk sending is enabled for users.", + "type": "string" + }, + "allowBulkSendingMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `allowBulkSending` property is editable.\n" + }, + "allowDocuSignDesktopClient": { + "description": "When **true**, the DocuSign Desktop Client is enabled for users.\n", + "type": "string" + }, + "allowDocuSignDesktopClientMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `allowDocuSignDesktopClient` property is editable.\n" + }, + "allowedAddressBookAccess": { + "description": "Specifies the level of access that users have to the account's address book. Valid values are:\n\n- `personal`\n- `useShared`\n- `usePersonalAndShared`\n- `personalAndShared`\n", + "type": "string" + }, + "allowedAddressBookAccessMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `allowedAddressBookAccess` property is editable.\n" + }, + "allowedClickwrapsAccess": { + "description": "", + "type": "string" + }, + "allowedClickwrapsAccessMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "" + }, + "allowedTemplateAccess": { + "description": "Specifies the level of access that users have to account templates. Valid values are: \n\n- `none` \n- `use`\n- `create`\n- `share`", + "type": "string" + }, + "allowedTemplateAccessMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `allowedTemplateAccess` property is editable.\n" + }, + "allowedToBeEnvelopeTransferRecipient": { + "description": "When **true**, users can be recipients of envelopes transferred to them by administrators of other accounts. ", + "type": "string" + }, + "allowedToBeEnvelopeTransferRecipientMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `allowedToBeEnvelopeTransferRecipient` property is editable.\n" + }, + "allowEnvelopeSending": { + "description": "When **true**, users can send envelopes.", + "type": "string" + }, + "allowEnvelopeSendingMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `allowEnvelopeSending` property is editable.\n" + }, + "allowESealRecipients": { + "description": "When **true**, users can add electronic seal ([eSeal](https://support.docusign.com/en/guides/ndse-user-guide-apply-electronic-seals)) recipients.", + "type": "string" + }, + "allowESealRecipientsMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `allowESealRecipients` property is editable." + }, + "allowPowerFormsAdminToAccessAllPowerFormEnvelopes": { + "description": "When **true**, PowerForm Administrators can access all of the PowerForm envelopes associated with the account.", + "type": "string" + }, + "allowPowerFormsAdminToAccessAllPowerFormEnvelopesMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `allowPowerFormsAdminToAccessAllPowerFormEnvelopes` property is editable." + }, + "allowSendersToSetRecipientEmailLanguage": { + "description": "When **true**, senders can set the language of the email that is sent to recipients.", + "type": "string" + }, + "allowSendersToSetRecipientEmailLanguageMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `allowSendersToSetRecipientEmailLanguage` property is editable.\n" + }, + "allowSignerAttachments": { + "description": "When **true**, users can add requests for attachments from signers.", + "type": "string" + }, + "allowSignerAttachmentsMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `allowSignerAttachments` property is editable.\n" + }, + "allowSupplementalDocuments": { + "description": "When **true**, senders can include supplemental documents.", + "type": "string" + }, + "allowSupplementalDocumentsMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `allowSupplementalDocuments` property is editable." + }, + "allowTaggingInSendAndCorrect": { + "description": "When **true**, the tagger palette is visible during the sending and correct flows and users can add tabs to documents.", + "type": "string" + }, + "allowTaggingInSendAndCorrectMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `allowTaggingInSendAndCorrect` property is editable.\n" + }, + "allowVaulting": { + "description": "Reserved for DocuSign.", + "type": "string" + }, + "allowVaultingMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Reserved for DocuSign." + }, + "allowWetSigningOverride": { + "description": "When **true**, users can override the default account setting that controls whether recipients can sign documents on paper. The option to overrride this setting occurs during the sending process on a per-envelope basis.", + "type": "string" + }, + "allowWetSigningOverrideMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `allowWetSigningOverride` property is editable.\n" + }, + "canCreateWorkspaces": { + "description": "Reserved for DocuSign.", + "type": "string" + }, + "canCreateWorkspacesMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Reserved for DocuSign." + }, + "disableDocumentUpload": { + "description": "When **true**, users cannot upload documents.", + "type": "string" + }, + "disableDocumentUploadMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `disableDocumentUpload` property is editable.\n" + }, + "disableOtherActions": { + "description": "When **true**, users can access the **Other Actions** menu.", + "type": "string" + }, + "disableOtherActionsMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `disableOtherActions` property is editable.\n" + }, + "enableApiRequestLogging": { + "description": "When **true**, API request logging is enabled.\n\n**Note**: Logging limits apply.", + "type": "string" + }, + "enableApiRequestLoggingMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `enableApiRequestLogging` property is editable.\n" + }, + "enableRecipientViewingNotifications": { + "description": "When **true**, senders are notified when recipients view the documents that they send.", + "type": "string" + }, + "enableRecipientViewingNotificationsMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `enableRecipientViewingNotifications` property is editable.\n" + }, + "enableSequentialSigningInterface": { + "description": "When **true**, the sequential signing user interface is enabled.", + "type": "string" + }, + "enableSequentialSigningInterfaceMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `enableSequentialSigningInterface` property is editable.\n" + }, + "enableTransactionPointIntegration": { + "description": "Reserved for DocuSign.", + "type": "string" + }, + "enableTransactionPointIntegrationMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Reserved for DocuSign." + }, + "powerFormRole": { + "description": "The PowerForms rights associated with the account permission profile. Valid values are:\n\n- `none` \n- `user` \n- `admin`\n", + "type": "string" + }, + "powerFormRoleMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `powerFormRole` property is editable.\n" + }, + "receiveCompletedSelfSignedDocumentsAsEmailLinks": { + "description": "When **true**, senders receive emails about completed, self-signed documents that contain links to the completed documents instead of PDF attachments.", + "type": "string" + }, + "receiveCompletedSelfSignedDocumentsAsEmailLinksMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `receiveCompletedSelfSignedDocumentsAsEmailLinks` property is editable.\n" + }, + "signingUiVersionMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Reserved for DocuSign." + }, + "supplementalDocumentsMustAccept": { + "description": "When **true**, senders can require recipients to accept supplemental documents.", + "type": "string" + }, + "supplementalDocumentsMustAcceptMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `supplementalDocumentsMustAccept` property is editable.\n" + }, + "supplementalDocumentsMustRead": { + "description": "When **true**, senders can require recipients to read supplemental documents.", + "type": "string" + }, + "supplementalDocumentsMustReadMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `supplementalDocumentsMustRead` property is editable.\n" + }, + "supplementalDocumentsMustView": { + "description": "When **true**, users can require recipients to view supplemental documents.", + "type": "string" + }, + "supplementalDocumentsMustViewMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `supplementalDocumentsMustView` property is editable.\n" + }, + "useNewDocuSignExperienceInterface": { + "description": "Reserved for DocuSign.", + "type": "string" + }, + "useNewDocuSignExperienceInterfaceMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Reserved for DocuSign." + }, + "useNewSendingInterface": { + "description": "Reserved for DocuSign.", + "type": "string" + }, + "useNewSendingInterfaceMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Reserved for DocuSign." + }, + "vaultingMode": { + "description": "Reserved for DocuSign.", + "type": "string" + }, + "vaultingModeMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Reserved for DocuSign." + } + }, + "x-ds-definition-name": "accountRoleSettings", + "description": "This object defines account permissions for users who are associated with the account permission profile. ", + "x-ms-summary": "This object defines account permissions for users who are associated with the account permission profile. " + }, + "accountSeals": { + "type": "object", + "properties": { + "seals": { + "description": "A list of electronic seals to apply to documents.", + "type": "array", + "items": { + "$ref": "#/definitions/sealIdentifier" + } + } + }, + "x-ds-definition-name": "accountSeals", + "description": "", + "x-ms-summary": "" + }, + "accountSettingsInformation": { + "description": "Contains account settings information. Used in requests to set property values. Used in responses to report property values.", + "type": "object", + "properties": { + "accessCodeFormat": { + "$ref": "#/definitions/accessCodeFormat", + "description": "Format of the string provided to a recipient in order to access an envelope." + }, + "accountDateTimeFormat": { + "description": "UTC date/time format for the account.", + "type": "string" + }, + "accountDateTimeFormatMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `accountDateTimeFormat` property is editable." + }, + "accountDefaultLanguage": { + "description": "", + "type": "string" + }, + "accountDefaultLanguageMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "" + }, + "accountName": { + "description": "The name on the account.", + "type": "string" + }, + "accountNameMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `accountName` property is editable." + }, + "accountNotification": { + "$ref": "#/definitions/accountNotification", + "description": "An object that specifies notifications (expirations and reminders) for the envelope." + }, + "accountUISettings": { + "$ref": "#/definitions/accountUISettings", + "description": "An object that defines the settings to use in the UI." + }, + "adoptSigConfig": { + "description": "When set to **true**, [Signature Adoption Configuration](https://support.docusign.com/en/guides/ndse-admin-guide-signature-adopt-config) is enabled. \n\n**Note**: Only Admin users can change this setting.", + "type": "string" + }, + "adoptSigConfigMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `adoptSigConfig` property is editable.\n" + }, + "advancedCorrect": { + "description": "If **true**, the Advanced Correction feature is enabled for this account.", + "type": "string" + }, + "advancedCorrectMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `advancedCorrect` property is editable.\n" + }, + "allowAccessCodeFormat": { + "description": "When **true**, the configured [Access Code Format](https://developers.docusign.com/docs/esign-rest-api/reference/Accounts/Accounts/get#accessCodeFormat) page is enabled for account administrators.\n\n**Note**: Only Admin users can change this setting.", + "type": "string" + }, + "allowAccessCodeFormatMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `allowAccessCodeFormat` property is editable.\n" + }, + "allowAccountManagementGranular": { + "description": "When **true**, the account can be managed on a per-user basis.\n\n**Note**: Only Admin users can change this setting.", + "type": "string" + }, + "allowAccountManagementGranularMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `allowAccountManagementGranular` property is editable.\n" + }, + "allowAccountMemberNameChange": { + "description": "Boolean that specifies whether member names can be changed in the account.", + "type": "string" + }, + "allowAccountMemberNameChangeMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `allowAccountMemberNameChange` property is editable.\n" + }, + "allowAdvancedRecipientRoutingConditional": { + "description": "When set to **true**, [Conditional Routing](https://support.docusign.com/en/guides/ndse-user-guide-conditional-recipients) is enabled for the account as part of DocuSign's Advanced Recipient Routing feature.", + "type": "string" + }, + "allowAdvancedRecipientRoutingConditionalMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the ` allowAdvancedRecipientRoutingConditional` property is editable." + }, + "allowAgentNameEmailEdit": { + "description": " If **true**, an agent recipient can change the email addresses of recipients later in the signing order.\n", + "type": "string" + }, + "allowAgentNameEmailEditMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `allowAgentNameEmailEdit` property is editable.\n" + }, + "allowAgreementActions": { + "description": "", + "type": "string" + }, + "allowAgreementActionsMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata about the `allowAgreementActions` property." + }, + "allowAutoNavSettings": { + "description": " If **true**, auto-navigation can be enabled for this account.\n", + "type": "string" + }, + "allowAutoNavSettingsMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `allowAutoNavSettings` property is editable.\n" + }, + "allowAutoTagging": { + "description": " If **true**, auto-tagging is enabled for the account.", + "type": "string" + }, + "allowAutoTaggingMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `allowAutoTagging` property is editable." + }, + "allowBulkSend": { + "description": "When set to **true**, bulk send functionality is enabled for the account.\n\n**Note**: Only Admin users can change this setting.", + "type": "string" + }, + "allowBulkSendMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `allowBulkSend` property is editable.\n" + }, + "allowCDWithdraw": { + "description": "When set to **true**, indicates that the customer can withdraw their consent to the consumer disclosure when they decline to sign documents. If these recipients sign documents sent to them from your account in the future, they will be required to agree to the terms in the disclosure. The default value is **false**.\n**Note**: Only Admin users can change this setting.", + "type": "string" + }, + "allowCDWithdrawMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `allowCDWithdraw` property is editable.\n" + }, + "allowConnectHttpListenerConfigs": { + "description": "Boolean that specifies whether a Connect configuration can use HTTP listeners.", + "type": "string" + }, + "allowConnectSendFinishLater": { + "description": "Reserved for DocuSign.", + "type": "string" + }, + "allowConnectSendFinishLaterMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `allowConnectSendFinishLater` property is editable.\n" + }, + "allowConnectUnifiedPayloadUI": { + "description": "", + "type": "string" + }, + "allowConsumerDisclosureOverride": { + "description": "If **true**,\nthe account has the ability to change the\n[Consumer Disclosure](https://support.docusign.com/en/guides/ndse-admin-guide-legal-disclosure)\nsetting.\n", + "type": "string" + }, + "allowConsumerDisclosureOverrideMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `allowConsumerDisclosureOverride` property is editable.\n" + }, + "allowDataDownload": { + "description": "When set to **true**, senders can download form data from the envelopes that they send.\n\n**Note**: Only Admin users can change this setting.\n", + "type": "string" + }, + "allowDataDownloadMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `allowDataDownload` property is editable.\n" + }, + "allowDocumentDisclosures": { + "description": "Boolean that specifies whether disclosure documents can be included in envelopes.", + "type": "string" + }, + "allowDocumentDisclosuresMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `allowDocumentDisclosures` property is editable.\n" + }, + "allowDocumentsOnSignedEnvelopes": { + "description": "Boolean that specifies whether notifications can include the envelope's signed document.", + "type": "string" + }, + "allowDocumentsOnSignedEnvelopesMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `allowDocumentsOnSignedEnvelopes` property is editable.\n" + }, + "allowDocumentVisibility": { + "description": "When **true**, the [Document Visibility](https://support.docusign.com/guides/ndse-user-guide-document-visibility) feature is enabled for the account.\n", + "type": "string" + }, + "allowDocumentVisibilityMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `allowDocumentVisibility` property is editable.\n" + }, + "allowEHankoStamps": { + "description": "When **true**,\n[eHanko stamps](https://support.docusign.com/en/guides/ndse-user-guide-manage-your-stamps)\nare enabled.\n", + "type": "string" + }, + "allowEHankoStampsMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `allowEHankoStamps` property is editable.\n" + }, + "allowENoteEOriginal": { + "description": "Specifies whether eNote eOriginal integration is enabled.\n", + "type": "string" + }, + "allowENoteEOriginalMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `allowENoteEOriginal` property is editable.\n" + }, + "allowEnvelopeCorrect": { + "description": "When set to **true**, the envelope correction feature is enabled.\n\n**Note**: Only Admin users can change this setting.\n", + "type": "string" + }, + "allowEnvelopeCorrectMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `allowEnvelopeCorrect` property is editable.\n" + }, + "allowEnvelopeCustodyTransfer": { + "description": "Specifies whether the account is able to\nmanage rules that [transfer ownership](https://support.docusign.com/en/guides/ndse-admin-guide-custody-transfer)\nof envelopes within the same account.\n\n\n\n", + "type": "string" + }, + "allowEnvelopeCustodyTransferMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `allowEnvelopeCustodyTransfer` property is editable.\n" + }, + "allowEnvelopeCustomFields": { + "description": "Specifies whether\n[envelope custom fields](https://support.docusign.com/en/guides/ndse-user-guide-manage-custom-fields)\nare enabled.\n", + "type": "string" + }, + "allowEnvelopeCustomFieldsMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `allowEnvelopeCustomFields` property is editable.\n" + }, + "allowEnvelopePublishReporting": { + "description": "When set to **true**, envelope publishing reporting is enabled.\n\n**Note**: Only Admin users can change this setting.\n", + "type": "string" + }, + "allowEnvelopePublishReportingMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `allowEnvelopePublishReporting` property is editable.\n" + }, + "allowEnvelopeReporting": { + "description": "Specifies whether the account has access to reports.\n", + "type": "string" + }, + "allowEnvelopeReportingMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `allowEnvelopeReporting` property is editable.\n" + }, + "allowExpression": { + "description": "If the account plan does not include calculated fields, this setting allows an account to use them.\n\n", + "type": "string" + }, + "allowExpressionMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `allowExpression` property is editable.\n" + }, + "allowExpressSignerCertificate": { + "description": "When set to **true**, signers are required to use Express Digital Signatures.\n\n**Note**: Only Admin users can change this setting.\n", + "type": "string" + }, + "allowExpressSignerCertificateMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `allowExpressSignerCertificate` property is editable.\n" + }, + "allowExtendedSendingResourceFile": { + "description": "Boolean that specifies whether resource files can be used for extended sending.", + "type": "string" + }, + "allowExtendedSendingResourceFileMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `allowExtendedSendingResourceFile` property is editable.\n" + }, + "allowExternalSignaturePad": { + "description": "When set to **true**, the account can\nconfigure and use signature pads for their recipients.\n\n**Note**: Only Admin users can change this setting.\n", + "type": "string" + }, + "allowExternalSignaturePadMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `allowExternalSignaturePad` property is editable.\n" + }, + "allowIDVLevel1": { + "description": "When set to **true**, IDV Level 1 is allowed. The default value is **false**.", + "type": "string" + }, + "allowIDVLevel1Metadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `allowIDVLevel1` property is editable." + }, + "allowIDVLevel2": { + "description": "", + "type": "string" + }, + "allowIDVLevel2Metadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "" + }, + "allowIDVLevel3": { + "description": "", + "type": "string" + }, + "allowIDVLevel3Metadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "" + }, + "allowIDVPlatform": { + "description": "", + "type": "string" + }, + "allowIDVPlatformMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `allowIDVPlatform` property is editable." + }, + "allowInPerson": { + "description": "When set to **true**, the account administrator can enable in-person signing.\n\n**Note**: Only SysAdmin users can change this setting.\n\n", + "type": "string" + }, + "allowInPersonMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `allowInPerson` property is editable.\n" + }, + "allowManagedStamps": { + "description": "When **true**, [Managed Stamps](https://support.docusign.com/en/guides/ndse-admin-guide-managed-stamps) are enabled.", + "type": "string" + }, + "allowManagedStampsMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `allowManagedStamps` property is editable.\n" + }, + "allowMarkup": { + "description": "When set to **true**, the Document Markup feature is enabled.\n\n**Note**: To use this feature, Document Markup must be enabled at both the account and envelope levels. Only Admin users can change this setting for at the account level.", + "type": "string" + }, + "allowMarkupMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `allowMarkup` property is editable.\n" + }, + "allowMemberTimeZone": { + "description": "When set to **true**, account users can set their own\n[time zone settings](https://support.docusign.com/en/articles/How-do-I-modify-time-zone-settings-for-my-account).\n\n**Note**: Only Admin users can change this setting.\n", + "type": "string" + }, + "allowMemberTimeZoneMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `allowMemberTimeZone` property is editable.\n" + }, + "allowMergeFields": { + "description": "When set to **true**, the account can use\n[merge fields](https://support.docusign.com/en/guides/dfs-user-guide-merge-fields-user)\nwith DocuSign for Salesforce.\n", + "type": "string" + }, + "allowMergeFieldsMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `allowMergeFields` property is editable.\n" + }, + "allowMultipleBrandProfiles": { + "description": "Specifies whether the account supports multiple brands.\n", + "type": "string" + }, + "allowMultipleBrandProfilesMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `allowMultipleBrandProfiles` property is editable.\n" + }, + "allowMultipleSignerAttachments": { + "description": "When set to **true**, recipients can\nupload multiple signer attachments with a single attachment.\n\n**Note**: Only Admin users can change this setting.", + "type": "string" + }, + "allowMultipleSignerAttachmentsMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `allowMultipleSignerAttachments` property is editable.\n" + }, + "allowNonUSPhoneAuth": { + "description": "Specifies whether users can use\ninternational numbers\nfor phone authentication.\n", + "type": "string" + }, + "allowNonUSPhoneAuthMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `allowNonUSPhoneAuth` property is editable.\n" + }, + "allowOcrOfEnvelopeDocuments": { + "description": "", + "type": "string" + }, + "allowOcrOfEnvelopeDocumentsMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "" + }, + "allowOfflineSigning": { + "description": "When set to **true**,\n[offline signing](https://support.docusign.com/articles/Offline-access-with-the-DocuSign-Mobile-App-for-iOS-iPad-iPhone-iPod-Touch)\nis enabled for the account.\n\n**Note**: Only Admin users can change this setting.", + "type": "string" + }, + "allowOfflineSigningMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `allowOfflineSigning` property is editable.\n" + }, + "allowOpenTrustSignerCertificate": { + "description": "When set to **true**, senders can use OpenTrust signer certificates.\n\n**Note**: Only Admin users can change this setting.", + "type": "string" + }, + "allowOpenTrustSignerCertificateMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `allowOpenTrustSignerCertificate` property is editable.\n" + }, + "allowOrganizations": { + "description": "Boolean that specifies whether [DocuSign Admin](https://developers.docusign.com/orgadmin-api) is enabled for the account.", + "type": "string" + }, + "allowOrganizationsMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `allowOrganizations` property is editable.\n" + }, + "allowPaymentProcessing": { + "description": "When set to **true**, payment processing is enabled for the account.\n\n**Note**: Only Admin users can change this setting.", + "type": "string" + }, + "allowPaymentProcessingMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `allowPaymentProcessing` property is editable.\n" + }, + "allowPersonalSignerCertificate": { + "description": "When set to **true**, signers can use personal signer certificates.\n\n**Note**: Only Admin users can change this setting.", + "type": "string" + }, + "allowPersonalSignerCertificateMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `allowPersonalSignerCertificate` property is editable.\n" + }, + "allowPhoneAuthentication": { + "description": "Boolean that specifies whether phone authentication is enabled for the account.", + "type": "string" + }, + "allowPhoneAuthenticationMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `allowPhoneAuthentication` property is editable.\n" + }, + "allowPhoneAuthOverride": { + "description": "Boolean that specifies whether users can override phone authentication.", + "type": "string" + }, + "allowPhoneAuthOverrideMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `allowPhoneAuthOverride` property is editable.\n" + }, + "allowPrivateSigningGroups": { + "description": "Reserved for DocuSign. This property returns the value **false** when listing account settings. Read only.", + "type": "string" + }, + "allowPrivateSigningGroupsMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `allowPrivateSigningGroups` property is editable.\n" + }, + "allowRecipientConnect": { + "description": "", + "type": "string" + }, + "allowRecipientConnectMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "" + }, + "allowReminders": { + "description": "When set to **true**,\nan account administrator can to turn on reminders\nand expiration defaults for the account.\n\n**Note**: Only Admin users can change this setting.\n", + "type": "string" + }, + "allowRemindersMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `allowReminders` property is editable.\n" + }, + "allowRemoteNotary": { + "description": "", + "type": "string" + }, + "allowRemoteNotaryMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "" + }, + "allowResourceFileBranding": { + "description": "If **true**,\nresource files can be uploaded in branding.\n", + "type": "string" + }, + "allowResourceFileBrandingMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `allowResourceFileBranding` property is editable.\n" + }, + "allowSafeBioPharmaSignerCertificate": { + "description": "When set to **true**,\naccount administrators can\nspecify that signers are\nrequired to use SAFE-BioPharma digital signatures.\n\n**Note**: Only Admin users can change this setting.\n", + "type": "string" + }, + "allowSafeBioPharmaSignerCertificateMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `allowSafeBioPharmaSignerCertificate` property is editable.\n" + }, + "allowSecurityAppliance": { + "description": "Boolean that specifies whether a DocuSign Signature Appliance can be used with the account.", + "type": "string" + }, + "allowSecurityApplianceMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `allowSecurityAppliance` property is editable.\n" + }, + "allowSendToCertifiedDelivery": { + "description": "If **true**,\nthe account admin can enable the\nSend to Certified Delivery\nfeature on the account.\n", + "type": "string" + }, + "allowSendToCertifiedDeliveryMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `allowSendToCertifiedDelivery` property is editable.\n" + }, + "allowSendToIntermediary": { + "description": "If **true**,\nthe account admin can enable the Send to Intermediary\nfeature on the account.\n", + "type": "string" + }, + "allowSendToIntermediaryMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `allowSendToIntermediary` property is editable.\n" + }, + "allowServerTemplates": { + "description": "If **true**,\nthe account can use templates.\n", + "type": "string" + }, + "allowServerTemplatesMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `allowServerTemplates` property is editable.\n" + }, + "allowSetEmbeddedRecipientStartURL": { + "description": "", + "type": "string" + }, + "allowSetEmbeddedRecipientStartURLMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "" + }, + "allowSharedTabs": { + "description": "When set to **true**,\nshared tabs are enabled for the account.\n\n**Note**: Only Admin users can change this setting.\n", + "type": "string" + }, + "allowSharedTabsMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `allowSharedTabs` property is editable.\n" + }, + "allowSignatureStamps": { + "description": "When set to **true**, Signature Stamps are enabled.\n\n**Note**: Only Admin users can change this setting.", + "type": "string" + }, + "allowSignatureStampsMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `allowSignatureStamps` property is editable.\n" + }, + "allowSignDocumentFromHomePage": { + "description": "When set to **true**, recipients can sign documents from the home page.\n\n**Note**: Only Admin users can change this setting.", + "type": "string" + }, + "allowSignDocumentFromHomePageMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `allowSignDocumentFromHomePage` property is editable.\n" + }, + "allowSignerReassign": { + "description": "When set to **true**, the recipient of an envelope sent from this account can reassign it to another person.\n\n**Note**: Only Admin users can change this setting.\n", + "type": "string" + }, + "allowSignerReassignMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `allowSignerReassign` property is editable.\n" + }, + "allowSignerReassignOverride": { + "description": "When set to **true**, an account administrator can override the ability of an envelope recipient to reassign it to another person.\n\n**Note**: Only Admin users can change this setting.", + "type": "string" + }, + "allowSignerReassignOverrideMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `allowSignerReassignOverride` property is editable.\n" + }, + "allowSigningExtensions": { + "description": "Boolean that specifies whether Signing and App Extensions are allowed.", + "type": "string" + }, + "allowSigningExtensionsMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `allowSigningExtensions` property is editable.\n" + }, + "allowSigningGroups": { + "description": "When set to **true**, the account allows signing groups. This setting is only shown in responses that list account settings. Read only.", + "type": "string" + }, + "allowSigningGroupsMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `allowSigningGroups` property is editable.\n" + }, + "allowSigningInsights": { + "description": "", + "type": "string" + }, + "allowSigningInsightsMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "" + }, + "allowSigningRadioDeselect": { + "description": "Boolean that specifies whether the account supports radio buttons on tabs [Radio CustomTabType](https://developers.docusign.com/esign-soap-api/reference/Sending-Group/Tab).", + "type": "string" + }, + "allowSigningRadioDeselectMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `allowSigningRadioDeselect` property is editable.\n" + }, + "allowSignNow": { + "description": "If **true**,\nthe account administrator can enable\nthe Sign Now feature.\n", + "type": "string" + }, + "allowSignNowMetadata": { + "description": "Metadata that indicates whether the `allowSignNow` property is editable.\n", + "type": "string" + }, + "allowSMSDelivery": { + "description": "", + "type": "string" + }, + "allowSMSDeliveryMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "" + }, + "allowSocialIdLogin": { + "description": "Deprecated.", + "type": "string" + }, + "allowSocialIdLoginMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Deprecated." + }, + "allowSupplementalDocuments": { + "description": "When **true**, this user can include supplemental documents.", + "type": "string" + }, + "allowSupplementalDocumentsMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `allowSupplementalDocuments` property is editable." + }, + "allowUsersToAccessDirectory": { + "description": "", + "type": "string" + }, + "allowUsersToAccessDirectoryMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "" + }, + "allowValueInsights": { + "description": "", + "type": "string" + }, + "allowValueInsightsMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "" + }, + "anchorPopulationScope": { + "description": "This property determines how template anchor tabs are applied.\n\nValid values are:\n\n- `document`: Anchor tabs are applied only to the document that you specify. \n- `envelope`: Anchor tabs are applied to all of the documents in the envelope associated with the template.\n\n**Note**: When you are using the `anchorPopulationScope` property with a Composite Template, the value `document` is supported only with a single server template and a single inline template.\n\n", + "type": "string" + }, + "anchorPopulationScopeMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `anchorPopulationScope` property is editable.\n" + }, + "anchorTagVersionedPlacementEnabled": { + "description": "Reserved for DocuSign.\n", + "type": "string" + }, + "anchorTagVersionedPlacementMetadataEnabled": { + "$ref": "#/definitions/settingsMetadata", + "description": "" + }, + "attachCompletedEnvelope": { + "description": "When set to **true**, envelope documents are included as a PDF file attachment to \"signing completed\" emails.\n\n**Note**: Only SysAdmin users can change this setting.", + "type": "string" + }, + "attachCompletedEnvelopeMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `attachCompletedEnvelope` property is editable." + }, + "authenticationCheck": { + "description": "Sets when authentication checks are applied for recipient envelope access. This setting only applies to the following ID checks: \n\n- Phone Authentication\n- SMS Authentication\n- Knowledge-Based ID\n\nThis setting takes one of the following options: \n\n- `initial_access`: The authentication check always applies the first time a recipient accesses the documents. Recipients are not asked to authenticate again when they access the documents from the same browser on the same device. If the recipient attempts to access the documents from a different browser or a different device, the recipient must pass authentication again. Once authenticated, that recipient is not challenged again on the new device or browser. The ability for a recipient to skip authentication for documents is limited to documents sent from the same sending account.\n- `each_access`: Authentication checks apply every time a recipient attempts to access the envelope. However, you can configure the Authentication Expiration setting to allow recipients to skip authentication when they have recently passed authentication by setting a variable time frame.\n\n**Note**: Only Admin users can change this setting.\n", + "type": "string" + }, + "authenticationCheckMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `authenticationCheck` property is editable.\n" + }, + "autoNavRule": { + "description": "Specifies how auto-navigation works.\nValid values are:\n\n- `off`\n- `required_fields`\n- `required_and_blank_fields`\n- `all_fields`\n- `page_then_required_fields`\n- `page_then_required_and_blank_fields`\n- `page_then_all_fields`\n", + "type": "string" + }, + "autoNavRuleMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `autoNavRule` property is editable.\n" + }, + "autoProvisionSignerAccount": { + "description": "Boolean that specifies whether to automatically provision a user membership in the account for accountless recipients. (Also known as Just-in-Time provisioning.)", + "type": "string" + }, + "autoProvisionSignerAccountMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `autoProvisionSignerAccount` property is editable.\n" + }, + "bccEmailArchive": { + "description": "Boolean that specifies whether BCC for Email Archive is enabled for the account. BCC for Email Archive allows you to set up an archive email address so that a BCC copy of an envelope is sent only to that address.", + "type": "string" + }, + "bccEmailArchiveMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `bccEmailArchive` property is editable.\n" + }, + "betaSwitchConfiguration": { + "description": "Reserved for DocuSign.\n", + "type": "string" + }, + "betaSwitchConfigurationMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Reserved for DocuSign." + }, + "billingAddress": { + "$ref": "#/definitions/addressInformation", + "description": "The billing address for the account." + }, + "billingAddressMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `billingAddress` property is editable.\n" + }, + "bulkSend": { + "description": "When **true**, this user can use the bulk send feature for the account.", + "type": "string" + }, + "bulkSendMaxCopiesInBatch": { + "description": "", + "type": "string" + }, + "bulkSendMaxUnprocessedEnvelopesCount": { + "description": "", + "type": "string" + }, + "bulkSendMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `bulkSend` property is editable.\n" + }, + "canSelfBrandSend": { + "description": "When set to **true**, account administrators can self-brand their sending console through the DocuSign console.", + "type": "string" + }, + "canSelfBrandSendMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `canSelfBrandSend` property is editable.\n" + }, + "canSelfBrandSign": { + "description": "When set to **true**, account administrators can self-brand their signing console through the DocuSign console.", + "type": "string" + }, + "canSelfBrandSignMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `canSelfBrandSign` property is editable.\n" + }, + "canUseSalesforceOAuth": { + "description": "", + "type": "string" + }, + "canUseSalesforceOAuthMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "" + }, + "captureVoiceRecording": { + "description": "Reserved for DocuSign.", + "type": "string" + }, + "captureVoiceRecordingMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Reserved for DocuSign." + }, + "cfrUseWideImage": { + "description": "Boolean that specifies whether to use a shorter/wider format when generating the CFR Part 11 signature image.", + "type": "string" + }, + "cfrUseWideImageMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `cfrUseWideImage` property is editable.\n" + }, + "checkForMultipleAdminsOnAccount": { + "description": "", + "type": "string" + }, + "checkForMultipleAdminsOnAccountMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `checkForMultipleAdminsOnAccount` property is editable." + }, + "chromeSignatureEnabled": { + "description": "Boolean that specifies whether the signers of the envelopes from this account use a signature with a DocuSign chrome around it or not.", + "type": "string" + }, + "chromeSignatureEnabledMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `chromeSignatureEnabled` property is editable.\n" + }, + "commentEmailShowMessageText": { + "description": "When set to **true**, the text of comments is included in email notifications when a comment is posted.\n\n**Note**: If the envelope requires additional recipient authentication, comment text is not included.", + "type": "string" + }, + "commentEmailShowMessageTextMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `commentEmailShowMessageText` property is editable.\n" + }, + "commentsAllowEnvelopeOverride": { + "description": "When set to **true** and comments are enabled for the account, senders can disable comments for an envelope through the **Advanced Options** menu that appears during the sending process.", + "type": "string" + }, + "commentsAllowEnvelopeOverrideMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `commentsAllowEnvelopeOverride` property is editable.\n" + }, + "conditionalFieldsEnabled": { + "description": "When set to **true**, conditional fields can be used in documents.\n\n**Note**: Only Admin users can change this setting.", + "type": "string" + }, + "conditionalFieldsEnabledMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `conditionalFieldsEnabled` property is editable.\n" + }, + "consumerDisclosureFrequency": { + "description": "Speficies how often to display the consumer disclosure.\n\nValid values are:\n\n- `once`: Per account, the supplemental document is displayed once only per `userId`. \n- `always`: Per envelope, the supplemental document is displayed once only per `userId`. \n- `each_access`: Per envelope, the supplemental document is displayed once only per `recipientId`.\n", + "type": "string" + }, + "consumerDisclosureFrequencyMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `consumerDisclosureFrequency` property is editable.\n" + }, + "convertPdfFields": { + "description": "Boolean that specifies whether to enable PDF form fields to get converted to DocuSign secure fields when the document is added or uploaded to an envelope.", + "type": "string" + }, + "convertPdfFieldsMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `convertPdfFields` property is editable.\n" + }, + "dataPopulationScope": { + "description": "Specifies how data is shared for tabs with the same tabLabel. Valid values are:\n\n- `document`: Tabs in a document with the same label populate with the same data.\n- `envelope`: Tabs in all documents in the envelope with the same label populate with the same data.\n\nThis setting applies to the following tab types: \n\n- Check box \n- Company\n- Data field\n- Drop-down list\n- Full name \n- Formula\n- Note\n- Title\n\n**Note**: Only Admin users can change this setting. Changing this setting affects envelopes that have been sent but not completed. ", + "type": "string" + }, + "dataPopulationScopeMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `dataPopulationScope` property is editable.\n" + }, + "disableAutoTemplateMatching": { + "description": "", + "type": "string" + }, + "disableAutoTemplateMatchingMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "" + }, + "disableMobileApp": { + "description": "When **true**, the mobile app distributor key is prevented from connecting for account users.", + "type": "string" + }, + "disableMobileAppMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `disableMobileApp` property is editable.\n" + }, + "disableMobilePushNotifications": { + "description": "When set to **true**, push notifications are disabled for the account.\n\n**Note**: Only Admin users can change this setting.", + "type": "string" + }, + "disableMobilePushNotificationsMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `disableMobilePushNotifications` property is editable.\n" + }, + "disableMobileSending": { + "description": "When set to **true**, sending from a mobile application is disabled.\n\n**Note**: Only Admin users can change this setting.", + "type": "string" + }, + "disableMobileSendingMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `disableMobileSending` property is editable.\n" + }, + "disableMultipleSessions": { + "description": "When set to **true**, account users cannot be logged into multiple sessions at the same time.\n\n**Note**: Only Admin users can change this setting.", + "type": "string" + }, + "disableMultipleSessionsMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `disableMultipleSessions` property is editable.\n" + }, + "disablePurgeNotificationsForSenderMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Reserved for DocuSign." + }, + "disableSignerCertView": { + "description": "When **true**, signers cannot view certificates of completion.", + "type": "string" + }, + "disableSignerCertViewMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `disableSignerCertView` property is editable.\n" + }, + "disableSignerHistoryView": { + "description": "When **true**, signers cannot view envelope history.", + "type": "string" + }, + "disableSignerHistoryViewMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `disableSignerHistoryView` property is editable.\n" + }, + "disableStyleSignature": { + "description": "When **true**, the **Select Style** option is hidden from signers and they must draw their signature instead. ", + "type": "string" + }, + "disableStyleSignatureMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `disableStyleSignature` property is editable.\n" + }, + "disableUploadSignature": { + "description": "When set to **true**, signers cannot upload custom image files of their signature and initials.\n\n**Note**: Only Admin users can change this setting.", + "type": "string" + }, + "disableUploadSignatureMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `disableUploadSignature` property is editable.\n" + }, + "disableUserSharing": { + "description": "When **true**, the User Sharing feature is disabled for the account.", + "type": "string" + }, + "disableUserSharingMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `disableUserSharing` property is editable.\n" + }, + "displayBetaSwitch": { + "description": "Boolean that specifies whether to display a Beta switch for your app.", + "type": "string" + }, + "displayBetaSwitchMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `displayBetaSwitch` property is editable.\n" + }, + "documentConversionRestrictions": { + "description": "Sets the account document upload restriction for non-account administrators. Valid values are:\n\n- `no_restrictions`: There are no restrictions on the type of documents that can be uploaded.\n- `allow_pdf_only`: Non-administrators can only upload PDF files.\n- `no_upload`: Non-administrators cannot upload files.\n\n**Note**: Only Admin users can change this setting.\n", + "type": "string" + }, + "documentConversionRestrictionsMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `documentConversionRestrictions` property is editable.\n" + }, + "documentRetention": { + "description": "Sets a document retention period, which controls the number of days that DocuSign retains documents after they have reached a completed,declined, or voided state. When document retention is enabled for the account, the default value is `356` days.", + "type": "string" + }, + "documentRetentionMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `documentRetention` property is editable.\n" + }, + "documentRetentionPurgeTabs": { + "description": "When set to **true** and `documentRetention` is set, document fields and metadata are also purged after the document retention period ends. The default value is **false**.\n\n**Note**: Only Admins can change this setting.", + "type": "string" + }, + "documentVisibility": { + "description": "Configures the Document Visibility feature for the account. Valid values are:\n\n- `Off`: Document Visibility is not active for the account.\n- `MustSignToViewUnlessSenderAccount`: Document Visibility is enabled for all envelopes sent from the account. Any member of the sending account can view all of the documents in an envelope.\n- `MustSignToViewUnlessSender`: Document Visibility is enabled for all envelopes sent from the account. Only the sender can view all of the documents in an envelope.\n- `SenderCanSetMustSignToViewUnlessSenderAccount`: The sender has the option to enable Document Visibility for an envelope. When enabled for an envelope, all of the documents within it are still visible to any member of the sending account.\nVd- `SenderCanSetMustSignToViewUnlessSender`: The sender has the option to enable Document Visibility for an envelope. When enabled for an envelope, all of the documents in the envelope are visible only to the sender.\n\n**Note**: For this configuration to take effect, `allowDocumentVisibility` must be set to **true**.", + "type": "string" + }, + "documentVisibilityMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `documentVisibility` property is editable.\n" + }, + "emailTemplateVersion": { + "description": "Specifies the version of the email templates used in an account. If new signing is selected in a member's Admin page, the user is updated to the newest version (1.1), the minimum version of email supported for the account.", + "type": "string" + }, + "emailTemplateVersionMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `emailTemplateVersion` property is editable.\n" + }, + "enableAccessCodeGenerator": { + "description": "When **true**, enables Access Code Generator on the account.", + "type": "string" + }, + "enableAccessCodeGeneratorMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `enableAccessCodeGenerator` property is editable.\n" + }, + "enableAdvancedPayments": { + "description": "When **true**, enables Advanced Payments for the account.", + "type": "string" + }, + "enableAdvancedPaymentsMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `enableAdvancedPayments` property is editable.\n" + }, + "enableAdvancedPowerForms": { + "description": "When **true**, enables advanced PowerForms for the account.", + "type": "string" + }, + "enableAdvancedPowerFormsMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `enableAdvancedPowerForms` property is editable.\n" + }, + "enableAgreementActionsForCLM": { + "description": "", + "type": "string" + }, + "enableAgreementActionsForCLMMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "" + }, + "enableAgreementActionsForESign": { + "description": "", + "type": "string" + }, + "enableAgreementActionsForESignMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "" + }, + "enableAutoNav": { + "description": "When **true**, enables the account to set the AutoNav rule setting, which enables a sender to override the auto-navigation setting per envelope.\n\n**Note**: To change this setting, you must be a SysAdmin user or `EnableAutoNavByDSAdmin must be set.", + "type": "string" + }, + "enableAutoNavMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `enableAutoNav` property is editable.\n" + }, + "enableCalculatedFields": { + "description": "When set to **true**, calculated fields are enabled for the account. \n\n**Note**: This setting can be changed only by Admin users, and only if the account-level setting `allowExpression` is set to **true**.", + "type": "string" + }, + "enableCalculatedFieldsMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `enableCalculatedFields` property is editable.\n" + }, + "enableClickwraps": { + "description": "Boolean that specifies whether clickwraps are enabled in your app. A [clickwrap](https://developers.docusign.com/click-api/guides/) is an iframe that you embed in your own website or app.", + "type": "string" + }, + "enableClickwrapsMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `enableClickwraps` property is editable.\n" + }, + "enableCommentsHistoryDownloadInSigning": { + "description": "", + "type": "string" + }, + "enableCommentsHistoryDownloadInSigningMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "" + }, + "enableCustomerSatisfactionMetricTracking": { + "description": "When **true**, enables customer satisfaction metric tracking for the account.", + "type": "string" + }, + "enableCustomerSatisfactionMetricTrackingMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `enableCustomerSatisfactionMetricTracking` property is editable.\n" + }, + "enableDSPro": { + "description": "Reserved for DocuSign.", + "type": "string" + }, + "enableDSProMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `enableDSPro` property is editable.\n" + }, + "enableEnvelopeStampingByAccountAdmin": { + "description": "When set to **true**, enables the account administrator to control envelope stamping for an account (stamping the `envelopeId` in the the document margins).\n\n**Note**: This setting can be changed only by Admin users, and only if the account-level setting `enableEnvelopeStampingByDSAdmin` is set to **true**.", + "type": "string" + }, + "enableEnvelopeStampingByAccountAdminMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `enableEnvelopeStampingByAccountAdmin` property is editable.\n" + }, + "enableEnvelopeStampingByDSAdmin": { + "description": "When **true**, enables the DocuSign administrator to control envelope stamping for an account (placement of the `envelopeId`).", + "type": "string" + }, + "enableEnvelopeStampingByDSAdminMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `enableEnvelopeStampingByDSAdmin` property is editable.\n" + }, + "enableEsignCommunities": { + "description": "", + "type": "string" + }, + "enableEsignCommunitiesMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "" + }, + "enableInBrowserEditor": { + "description": "", + "type": "string" + }, + "enableInBrowserEditorMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "" + }, + "enablePaymentProcessing": { + "description": "When set to **true**, payment processing is enabled for this account.\n\n**Note**: This setting can be changed only by Admin users, and only if the account-level setting `allowPaymentProcessing` is set.", + "type": "string" + }, + "enablePaymentProcessingMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `enablePaymentProcessing` property is editable.\n" + }, + "enablePowerForm": { + "description": "When set to **true**, enables PowerForms for the account.\n\n**Note**: Only SysAdmin users can change this setting.", + "type": "string" + }, + "enablePowerFormDirect": { + "description": "When set to **true**, enables direct PowerForms for an account. Direct PowerForms are in-session PowerForms.\n\n**Note**: Only Admin users can change this setting.", + "type": "string" + }, + "enablePowerFormDirectMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `enablePowerFormDirect` property is editable.\n" + }, + "enablePowerFormMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `enablePowerForm` property is editable.\n" + }, + "enableRecipientDomainValidation": { + "description": "Reserved for DocuSign.", + "type": "string" + }, + "enableRecipientDomainValidationMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `enableRecipientDomainValidation` property is editable.\n" + }, + "enableReportLinks": { + "description": "Enables direct links to envelopes in reports for administrators in the following scopes:\n- `NoEnvelopes`\n- `AllEnvelopes`\n- `OnlyOwnEnvelopes`", + "type": "string" + }, + "enableReportLinksMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `enableReportLinks` property is editable.\n" + }, + "enableRequireSignOnPaper": { + "description": "When set to **true**, the account can use the `requireSignOnPaper` option.\n\n**Note**: Only Admin users can change this setting.\n", + "type": "string" + }, + "enableRequireSignOnPaperMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `enableRequireSignOnPaper` property is editable.\n" + }, + "enableReservedDomain": { + "description": "When **true**, account administrators can reserve a web domain and users. Domains are organization-specific reserved internet domains, such as `@exampledomain.com`. You can define policy settings for users of each reserved domain within your organization, export lists of domain users for audit purposes, and manage domain users.\n\n- Domains may be claimed by an organization.\n- When a domain is claimed by an organization, all users within that domain are added to the organization, even if they have trial or free accounts.\n- You can set domain controls for all users of the domain.\n- You can export information about your organization’s users that are associated with your reserved domains.\n\n**Note**: Only SysAdmin users can change this setting.", + "type": "string" + }, + "enableReservedDomainMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `enableReservedDomain` property is editable.\n" + }, + "enableResponsiveSigning": { + "description": "When **true**, enables responsive signing.", + "type": "string" + }, + "enableResponsiveSigningMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `enableResponsiveSigning` property is editable.\n" + }, + "enableScheduledRelease": { + "description": "When set to **true**, scheduled releases are enabled. The default value is **false**.", + "type": "string" + }, + "enableScheduledReleaseMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `enableScheduledRelease` property is editable.\n" + }, + "enableSearch": { + "description": "", + "type": "string" + }, + "enableSearchMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "" + }, + "enableSearchUI": { + "description": "", + "type": "string" + }, + "enableSearchUIMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "" + }, + "enableSendingTagsFontSettings": { + "description": "When **true**, enables fonts to be set on tags for the account.", + "type": "string" + }, + "enableSendingTagsFontSettingsMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `enableSendingTagsFontSettings` property is editable.\n" + }, + "enableSendToAgent": { + "description": "When **true**, this account can use the Agent recipient type.\n\n**Note**: Only SysAdmin users can change this setting.\n", + "type": "string" + }, + "enableSendToAgentMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `enableSendToAgent` property is editable.\n" + }, + "enableSendToIntermediary": { + "description": "When set to **true**, this account can use the Intermediary recipient type.\n\n**Note**: Only Admin users can change this setting, and only if `allowSendToIntermediary` is set.\n", + "type": "string" + }, + "enableSendToIntermediaryMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `enableSendToIntermediary` property is editable.\n" + }, + "enableSendToManage": { + "description": "When set to **true**, this account can use the Editor recipient type.\n\n**Note**: Only Admin users can change this setting.\n", + "type": "string" + }, + "enableSendToManageMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `enableSendToManage` property is editable.\n" + }, + "enableSequentialSigningAPI": { + "description": "When set to **true**, the account can define the routing\norder of recipients for envelopes sent by using the eSignature API.\n\n**Note**: Only SysAdmin users can change this setting.", + "type": "string" + }, + "enableSequentialSigningAPIMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `enableSequentialSigningAPI` property is editable.\n" + }, + "enableSequentialSigningUI": { + "description": "When set to **true**, the account can define the routing order\nof recipients for envelopes sent by using the DocuSign application.\n\n**Note**: Only SysAdmin users can change this setting.\n", + "type": "string" + }, + "enableSequentialSigningUIMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `enableSequentialSigningUI` property is editable.\n" + }, + "enableSignerAttachments": { + "description": "When set to **true**, users can use the signing attachments feature to request attachments from signers.\n\n**Note**: Only Admin users can change this setting.", + "type": "string" + }, + "enableSignerAttachmentsMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `enableSignerAttachments` property is editable.\n" + }, + "enableSigningExtensionComments": { + "description": "When set to **true**, enables comments for the account so that signers and recipients can make and respond to comments in documents belonging to the envelopes that they are sent.", + "type": "string" + }, + "enableSigningExtensionCommentsMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `enableSigningExtensionComments` property is editable.\n" + }, + "enableSigningExtensionConversations": { + "description": "When **true**, enables conversation functionality.", + "type": "string" + }, + "enableSigningExtensionConversationsMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `enableSigningExtensionConversations` property is editable.\n" + }, + "enableSigningOrderSettingsForAccount": { + "description": "When **true**, switches Signing Order to On by default for new envelopes.", + "type": "string" + }, + "enableSigningOrderSettingsForAccountMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `enableSigningOrderSettingsForAccount` property is editable.\n" + }, + "enableSignOnPaper": { + "description": "When set to **true**, a sender can allow signers to use the sign on paper option.\n\n**Note**: Only Admin users can change this setting.\n", + "type": "string" + }, + "enableSignOnPaperMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `enableSignOnPaper` property is editable.\n" + }, + "enableSignOnPaperOverride": { + "description": "When set to **true**, a user can override the default default account setting for the Sign on Paper option, which specifies whether signers can sign documents on paper as an option to signing electronically.\n\n**Note**: Only Admin users can change this setting.", + "type": "string" + }, + "enableSignOnPaperOverrideMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `enableSignOnPaperOverride` property is editable.\n" + }, + "enableSignWithNotary": { + "description": "When set to **true**, Sign with Notary functionality is enabled for the account.\n\n**Note**: Only Admin users can change this setting.", + "type": "string" + }, + "enableSignWithNotaryMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `enableSignWithNotary` property is editable.\n" + }, + "enableSmartContracts": { + "description": "When set to **true**, blockchain-based [Smart Contracts](https://www.docusign.com/products/blockchain) are enabled. The default value is **false**.", + "type": "string" + }, + "enableSmartContractsMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `enableSmartContracts` property is editable." + }, + "enableSMSAuthentication": { + "description": "When set to **true**, the account can use SMS authentication.\n\n**Note**: Only Admin users can change this setting.\n", + "type": "string" + }, + "enableSMSAuthenticationMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `enableSMSAuthentication` property is editable.\n" + }, + "enableSocialIdLogin": { + "description": "Deprecated.", + "type": "string" + }, + "enableSocialIdLoginMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Deprecated." + }, + "enableStrikeThrough": { + "description": "When **true**, enables strikethrough formatting in documents.", + "type": "string" + }, + "enableStrikeThroughMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `enableStrikeThrough` property is editable.\n" + }, + "enableTransactionPoint": { + "description": "Reserved for DocuSign.", + "type": "string" + }, + "enableTransactionPointMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Reserved for DocuSign." + }, + "enableVaulting": { + "description": "When set to **true**, Vaulting is enabled for the account.", + "type": "string" + }, + "enableVaultingMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `enableVaulting` property is editable.\n" + }, + "enableWitnessing": { + "description": "Reserved for DocuSign.", + "type": "string" + }, + "enableWitnessingMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `enableWitnessing` property is editable.\n" + }, + "enforceTemplateNameUniqueness": { + "description": "When **true**, the template name must be unique.", + "type": "string" + }, + "enforceTemplateNameUniquenessMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `enforceTemplateNameUniqueness` property is editable.\n" + }, + "envelopeIntegrationAllowed": { + "description": "Shows the envelope integration rule for the account, which indicates whether custom admins can enable Connect for their accounts. Enumeration values are: \n\n- `not_allowed`\n- `full` \n\n**Note**: Only SysAdmin users can change this setting. ", + "type": "string" + }, + "envelopeIntegrationAllowedMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `envelopeIntegrationAllowed` property is editable.\n" + }, + "envelopeIntegrationEnabled": { + "description": "When **true**, enables Connect for an account. Note that Connect integration requires additional configuration that must be set up for it to take effect; this switch is only the on/off control for the account.\n\n**Note**: Only Admin users can change this setting, and only when `envelopeIntegrationAllowed` is set.", + "type": "string" + }, + "envelopeIntegrationEnabledMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `envelopeIntegrationEnabled` property is editable.\n" + }, + "envelopeStampingDefaultValue": { + "description": "When set to **true**, envelopes sent by this account automatically have the envelope ID stamped in the document margins, unless the sender selects not to have the documents stamped.", + "type": "string" + }, + "envelopeStampingDefaultValueMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `envelopeStampingDefaultValue` property is editable.\n" + }, + "expressSend": { + "description": "Boolean that specifies whether a member of an account can express send (without tags) or must send with tags on documents.", + "type": "string" + }, + "expressSendAllowTabs": { + "description": "Boolean that specifies whether a member of an account can send templates without the tags being stripped out, even when the account is configured to let its users express send only (they cannot use the tagger).", + "type": "string" + }, + "expressSendAllowTabsMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `expressSendAllowTabs` property is editable.\n" + }, + "expressSendMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `expressSend` property is editable.\n" + }, + "externalDocumentSources": { + "$ref": "#/definitions/externalDocumentSources", + "description": "A list of external document sources such as DropBox and OneDrive." + }, + "externalSignaturePadType": { + "description": "Specifies the signature pad type.\nValid values are:\n\n- `none`\n- `topaz`\n- `e_padv9`\n- `e_pad_integrisign`\n- `topaz_sigplusextlite`\n\n**Note**: Only Admin users can change this setting.\n", + "type": "string" + }, + "externalSignaturePadTypeMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `externalSignaturePadType` property is editable.\n" + }, + "faxOutEnabled": { + "description": "When set to **true**, fax delivery to recipients is allowed for the account.\n\n**Note**: Only Admin users can change this setting.", + "type": "string" + }, + "faxOutEnabledMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `faxOutEnabled` property is editable.\n" + }, + "guidedFormsHtmlAllowed": { + "description": "When set to **true**, HTML used to implement [Guided Forms](https://www.docusign.com/products/guided-forms) is enabled for the account.", + "type": "string" + }, + "guidedFormsHtmlAllowedMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "" + }, + "hideAccountAddressInCoC": { + "description": "Boolean that specifies whether to hide the account address in the Certificate of Completion.", + "type": "string" + }, + "hideAccountAddressInCoCMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `hideAccountAddressInCoC` property is editable.\n" + }, + "hidePricing": { + "description": "Boolean that specifies whether to hide the pricing functionality for an account.", + "type": "string" + }, + "hidePricingMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `hidePricing` property is editable.\n" + }, + "idCheckConfigurations": { + "description": "A list of ID check configuration objects.", + "type": "array", + "items": { + "$ref": "#/definitions/idCheckConfiguration" + } + }, + "idCheckExpire": { + "description": "Determines when a user's authentication with the account expires. Valid values are:\n\n- `always`: Users are required to authenticate each time.\n- `variable`: If the authentication for a user is valid and falls within the value for the `idCheckExpireDays` property, the user is not required to authenticate again.\n\n**Note**: Only Admin users can change this setting.", + "type": "string" + }, + "idCheckExpireDays": { + "description": "The number of days before user authentication credentials expire. A value of `0` specifies that users must re-authenticate for each new session.\n\n**Note**: Only Admin users can change this setting.", + "type": "string" + }, + "idCheckExpireDaysMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `idCheckExpireDays` property is editable.\n" + }, + "idCheckExpireMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `idCheckExpire` property is editable.\n" + }, + "idCheckExpireMinutes": { + "description": "The number of minutes before user authentication credentials expire.", + "type": "string" + }, + "idCheckExpireMinutesMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `idCheckExpireMinutes` property is editable.\n" + }, + "idCheckRequired": { + "description": "Indicates if authentication is configured for the account. Valid values are:\n\n- `always`: Authentication checks are performed on every envelope.\n- `never`: Authentication checks are not performed on any envelopes.\n- `optional`: Authentication is configurable per envelope.\n\n**Note**: Only Admin users can change this setting.", + "type": "string" + }, + "idCheckRequiredMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `idCheckRequired` property is editable.\n" + }, + "identityVerification": { + "description": " ", + "type": "array", + "items": { + "$ref": "#/definitions/accountIdentityVerificationWorkflow" + } + }, + "identityVerificationMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `identityVerification` property is editable.\n" + }, + "ignoreErrorIfAnchorTabNotFound": { + "description": "Reserved for DocuSign.", + "type": "string" + }, + "ignoreErrorIfAnchorTabNotFoundMetadataEnabled": { + "$ref": "#/definitions/settingsMetadata", + "description": "Reserved for DocuSign." + }, + "inPersonIDCheckQuestion": { + "description": "A text field containing the question that an in-person signing host uses to collect personal information from the recipient. The recipient's response to this question is saved and can be viewed in the certificate associated with the envelope.\n\n**Note**: Only Admin users can change this setting.", + "type": "string" + }, + "inPersonIDCheckQuestionMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `inPersonIDCheckQuestion` property is editable.\n" + }, + "inPersonSigningEnabled": { + "description": "When **true**, in-person signing is enabled for the account.", + "type": "string" + }, + "inPersonSigningEnabledMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `inPersonSigningEnabled` property is editable.\n" + }, + "inSessionEnabled": { + "description": "When **true**, the account can send in-session (embedded) envelopes.\n\n**Note**: Only Admin users can change this setting.", + "type": "string" + }, + "inSessionEnabledMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `inSessionEnabled` property is editable.\n" + }, + "inSessionSuppressEmails": { + "description": "When set to **true**, emails are not sent to the in-session (embedded) recipients on an envelope.\n\n**Note**: Only Admin users can change this setting.", + "type": "string" + }, + "inSessionSuppressEmailsMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `inSessionSuppressEmails` property is editable.\n" + }, + "maximumSigningGroups": { + "description": "The maximum number of signing groups allowed on the account. The default value is `50`. This setting is only shown in responses that list account settings.\n\n**Note**: Only SysAdmin users can change this setting.", + "type": "string" + }, + "maximumSigningGroupsMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `maximumSigningGroups` property is editable.\n" + }, + "maximumUsersPerSigningGroup": { + "description": "The maximum number of users per signing group. The default value is `50`. This setting is only shown in responses that list account settings.\n\n**Note**: Only SysAdmin users can change this setting.", + "type": "string" + }, + "maximumUsersPerSigningGroupMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `maximumUsersPerSigningGroup` property is editable.\n" + }, + "maxNumberOfCustomStamps": { + "description": "The maximum number of custom stamps.", + "type": "string" + }, + "mobileSessionTimeout": { + "description": "The number of minutes of inactivity before a mobile user is automatically logged out of the system. Valid values are `1` to `120` minutes. The default value is `20` minutes.\n\n**Note**: Only Admin users can change this setting.", + "type": "string" + }, + "mobileSessionTimeoutMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `mobileSessionTimeout` property is editable.\n" + }, + "numberOfActiveCustomStamps": { + "description": "The number of active custom stamps associated with the account. DocuSign calculates this number automatically. This property is only visible to the DocuSign account manager.", + "type": "string" + }, + "optInMobileSigningV02": { + "description": "Boolean that specifies whether to opt in for Signing v02 on Mobile Devices functionality.", + "type": "string" + }, + "optInMobileSigningV02Metadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `optInMobileSigningV02` property is editable.\n" + }, + "optOutAutoNavTextAndTabColorUpdates": { + "description": "Boolean that allows envelope senders to opt out of the recipient signing auto-navigation feature and opt out of updating tab font color.", + "type": "string" + }, + "optOutAutoNavTextAndTabColorUpdatesMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `optOutAutoNavTextAndTabColorUpdates` property is editable.\n" + }, + "optOutNewPlatformSeal": { + "description": "Boolean that specifies whether to allow envelope senders to opt out of using the new platform seal.", + "type": "string" + }, + "optOutNewPlatformSealPlatformMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `optOutNewPlatformSealPlatform` property is editable.\n" + }, + "phoneAuthRecipientMayProvidePhoneNumber": { + "description": "When set to **true**, senders can allow recipients to provide a phone number for the Phone Authentication process.\n\n**Note**: Only Admin users can change this setting.", + "type": "string" + }, + "phoneAuthRecipientMayProvidePhoneNumberMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `phoneAuthRecipientMayProvidePhoneNumber` property is editable.\n" + }, + "pkiSignDownloadedPDFDocs": { + "description": "The policy for adding a digital certificate to downloaded, printed, and emailed documents. \n\nPossible values are: \n\n- `no_sign`\n- `no_sign_allow_user_override`\n- `yes_sign` (Specifies that PDF files downloaded from the platform are signed.)\n\n**Note**: Only Admin users can change this setting.\n", + "type": "string" + }, + "pkiSignDownloadedPDFDocsMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `pkiSignDownloadedPDFDocs` property is editable.\n" + }, + "recipientsCanSignOffline": { + "description": "When set to **true**,\nrecipients receiving envelopes from this account\ncan sign offline.\n\n**Note**: Only Admin users can change this setting.\n", + "type": "string" + }, + "recipientsCanSignOfflineMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `recipientsCanSignOffline` property is editable.\n" + }, + "recipientSigningAutoNavigationControl": { + "description": "When set to **true**, recipients receiving envelopes from this account can override auto-navigation functionality.\n\n**Note**: Only Admin users can change this setting.\n", + "type": "string" + }, + "recipientSigningAutoNavigationControlMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `recipientSigningAutoNavigationControl` property is editable.\n" + }, + "require21CFRpt11Compliance": { + "description": "When set to **true**,\nrecipients are required\nto use a 21 CFR part 11-compliant signing experience.\n\n**Note**: Only Admin users can change this setting.\n", + "type": "string" + }, + "require21CFRpt11ComplianceMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `require21CFRpt11Compliance` property is editable.\n" + }, + "requireDeclineReason": { + "description": "When set to **true**, signers who decline to sign an envelope sent from this account\nare required to provide a reason for declining.\n\n**Note**: Only Admin users can change this setting.\n", + "type": "string" + }, + "requireDeclineReasonMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `requireDeclineReason` property is editable.\n" + }, + "requireExternalUserManagement": { + "description": "When set to **true**, the account requires external management of users.\n\n**Note**: Only Admin users can change this setting.\n", + "type": "string" + }, + "requireExternalUserManagementMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `requireExternalUserManagement` property is editable.\n" + }, + "requireSignerCertificateType": { + "description": "Sets the Digital Signature certificate requirements for sending envelopes.\nValid values are:\n\n- `none`: A Digital Signature certificate is not required.\n- `docusign_express`: Signers must use a DocuSign Express certificate.\n- `docusign_personal`: Signers must use a DocuSign personal certificate.\n- `safe`\n- `open_trust`: Signers must use an OpenTrust certificate.\n", + "type": "string" + }, + "requireSignerCertificateTypeMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `requireSignerCertificateType` property is editable.\n" + }, + "rsaVeridAccountName": { + "description": "The RSA account name.\n\n**Note**:\nOnly Admin users can change this setting. Modifying this value may disrupt\nyour ID Check capability.\nEnsure you have the correct value before changing it.\n", + "type": "string" + }, + "rsaVeridPassword": { + "description": "The password for the RSA account.\n\n\n**Note**:\nOnly Admin users can change this setting. Modifying this value may disrupt\nyour ID Check capability.\nEnsure you have the correct value before changing it.\n", + "type": "string" + }, + "rsaVeridRuleset": { + "description": "The RSA rule set used with the account.\n\n**Note**:\nOnly Admin users can change this setting. Modifying this value may disrupt\nyour ID Check capability.\nEnsure you have the correct value before changing it.\n", + "type": "string" + }, + "rsaVeridUserId": { + "description": "The user ID for the RSA account.\n\n**Note**:\nOnly Admin users can change this setting. Modifying this value may disrupt\nyour ID Check capability.\nEnsure you have the correct value before changing it.\n", + "type": "string" + }, + "selfSignedRecipientEmailDocument": { + "description": "Sets how self-signed documents are presented to the email recipients.\nValid values are:\n\n- `include_pdf`: A PDF of the completed document is attached to the email.\n- `include_link`: A secure link to the self-signed documents is included\n in the email.\n\n**Note**: Only Admin users can change this setting.\n", + "type": "string" + }, + "selfSignedRecipientEmailDocumentMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `selfSignedRecipientEmailDocument` property is editable.\n" + }, + "selfSignedRecipientEmailDocumentUserOverride": { + "description": "When set to **true**, the `selfSignedRecipientEmailDocument` user setting\ncan be set for an individual user.\nThe user setting overrides the account setting.\n\n**Note**: Only Admin users can change this account setting.\n", + "type": "string" + }, + "selfSignedRecipientEmailDocumentUserOverrideMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `selfSignedRecipientEmailDocumentUserOverride` property is editable.\n" + }, + "senderCanSignInEachLocation": { + "description": "When set to **true**, a signer can draw their signature in each\nlocation where a sign or initial tab exists. This functionality\nis typically used for mobile signing.\n\n**Note**: Only Admin users can change this setting.\n", + "type": "string" + }, + "senderCanSignInEachLocationMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `senderCanSignInEachLocation` property is editable.\n" + }, + "senderMustAuthenticateSigning": { + "description": "When set to **true**, a sender who is also a recipient of an envelope\nmust follow the authentication requirements for the envelope.\n\n**Note**: Only Admin users can change this setting.\n", + "type": "string" + }, + "senderMustAuthenticateSigningMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `senderMustAuthenticateSigning` property is editable.\n" + }, + "sendingTagsFontColor": { + "description": "The account-wide default font color to use for the content of the tab.\n\nValid values are:\n\n- `Black`\n- `BrightBlue`\n- `BrightRed`\n- `DarkGreen`\n- `DarkRed`\n- `Gold`\n- `Green`\n- `NavyBlue`\n- `Purple`\n- `White`\n", + "type": "string" + }, + "sendingTagsFontColorMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `sendingTagsFontColor` property is editable.\n" + }, + "sendingTagsFontName": { + "description": "The account-wide default font to be used for the tab value. Supported fonts include:\n\n- `Default`\n- `Arial`\n- `ArialNarrow`\n- `Calibri`\n- `CourierNew`\n- `Garamond`\n- `Georgia`\n- `Helvetica`\n- `LucidaConsole`\n- `MSGothic`\n- `MSMincho`\n- `OCR-A`\n- `Tahoma`\n- `TimesNewRoman`\n- `Trebuchet`\n- `Verdana`", + "type": "string" + }, + "sendingTagsFontNameMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `sendingTagsFontName` property is editable.\n" + }, + "sendingTagsFontSize": { + "description": "The account-wide default font size used for the information in the tab:\n\n- `Size7`\n- `Size8`\n- `Size9`\n- `Size10`\n- `Size11`\n- `Size12`\n- `Size14`\n- `Size16`\n- `Size18`\n- `Size20`\n- `Size22`\n- `Size24`\n- `Size26`\n- `Size28`\n- `Size36`\n- `Size48`\n- `Size72`", + "type": "string" + }, + "sendingTagsFontSizeMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `sendingTagsFontSize` property is editable.\n" + }, + "sendToCertifiedDeliveryEnabled": { + "description": "When true,\nthe account can use the\ncertified deliveries recipient type.\n", + "type": "string" + }, + "sendToCertifiedDeliveryEnabledMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `sendToCertifiedDeliveryEnabled` property is editable.\n" + }, + "sessionTimeout": { + "description": "The amount of idle activity time, in minutes, before a user is automatically logged out of the system. The minimum setting is 20 minutes and the maximum setting is 120 minutes.\n", + "type": "string" + }, + "sessionTimeoutMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `sessionTimeout` property is editable.\n" + }, + "setRecipEmailLang": { + "description": "When set to **true**, senders can set the email language to use for\neach recipient.\n\n**Note**: Only Admin users can change this setting.\n", + "type": "string" + }, + "setRecipEmailLangMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `setRecipEmailLang` property is editable.\n" + }, + "setRecipSignLang": { + "description": "If **true**,\nsetting a unique language for a recipient\nnot only affects the email language, but also the signing\nlanguage they are presented with. If **false**, only the email will\nbe affected when the sender specifies a unique language for a\nrecipient.\n\n**Note**: Only Admin users can change this setting.\n", + "type": "string" + }, + "setRecipSignLangMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `setRecipSignLang` property is editable.\n" + }, + "sharedTemplateFolders": { + "description": "Boolean that specifies whether an account can use Shared Template Folders.", + "type": "string" + }, + "sharedTemplateFoldersMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `sharedTemplateFolders` property is editable.\n" + }, + "showCompleteDialogInEmbeddedSession": { + "description": "Boolean that specifies whether complete dialogs are displayed directly within an application in embedded signing sessions.", + "type": "string" + }, + "showCompleteDialogInEmbeddedSessionMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `showCompleteDialogInEmbeddedSession` property is editable.\n" + }, + "showConditionalRoutingOnSend": { + "description": "When set to **true**, Conditional Routing options display to senders during the sending experience.", + "type": "string" + }, + "showConditionalRoutingOnSendMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "" + }, + "showInitialConditionalFields": { + "description": "Boolean that specifies whether conditional field options are initially displayed (before a user makes entries).", + "type": "string" + }, + "showInitialConditionalFieldsMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `showInitialConditionalFields` property is editable.\n" + }, + "showLocalizedWatermarks": { + "description": "Boolean that specifies whether localized watermarks are displayed.", + "type": "string" + }, + "showLocalizedWatermarksMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `showLocalizedWatermarks` property is editable.\n" + }, + "showTutorials": { + "description": "If **true**,\nshow tutorials.\n", + "type": "string" + }, + "showTutorialsMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `showTutorials` property is editable.\n" + }, + "signatureProviders": { + "description": "Names of electronic or digital signature providers that can be used.", + "type": "array", + "items": { + "type": "string" + } + }, + "signatureProvidersMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `signatureProviders` property is editable.\n" + }, + "signDateFormat": { + "description": "The format for the signature date. Valid values are:\n\n- `d/M/yyyy`\n- `dd-MM-yy`\n- `dd-MMM-yy`\n- `dd-MM-yyyy`\n- `dd.MM.yyyy`\n- `dd-MMM-yyyy`\n- `dd MMMM yyyy`\n- `M/d/yyyy`\n- `MM-dd-yyyy`\n- `MM/dd/yyyy`\n- `MM/dd/yy`\n- `MMM-dd-yyyy`\n- `MMM d, yyyy`\n- `MMMM d, yyyy`\n- `yyyy-MM-dd`\n- `yyyy-MMM-dd`\n- `yyyy/MM/dd`\n- `yyyy MMMM d`\n\n**Note**: Only Admin users can change this setting.\n", + "type": "string" + }, + "signDateFormatMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `signDateFormat` property is editable.\n" + }, + "signerAttachCertificateToEnvelopePDF": { + "description": "When set to **true**,\nthe Certificate of Completion is included in the PDF of the envelope documents\nwhen it is downloaded.\n\n**Note**: Only Admin users can change this setting.\n", + "type": "string" + }, + "signerAttachCertificateToEnvelopePDFMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `signerAttachCertificateToEnvelopePDF` property is editable.\n" + }, + "signerAttachConcat": { + "description": "When set to **true**, signer attachments are added to the parent document\nthat contains the attachment.\nThe default behavior creates\na new document in the envelope for every signer attachment.\n\n**Note**: Only Admin users can change this setting.\n", + "type": "string" + }, + "signerAttachConcatMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `signerAttachConcat` property is editable.\n" + }, + "signerCanCreateAccount": { + "description": "When set to **true**,\na signer can create a DocuSign account\nafter signing.\n\n**Note**: Only Admin users can change this setting.\n", + "type": "string" + }, + "signerCanCreateAccountMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `signerCanCreateAccount` property is editable.\n" + }, + "signerCanSignOnMobile": { + "description": "When set to **true**, recipients can sign on a mobile device.\n\n**Note**: Only Admin users can change this setting.\n", + "type": "string" + }, + "signerCanSignOnMobileMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `signerCanSignOnMobile` property is editable.\n" + }, + "signerInSessionUseEnvelopeCompleteEmail": { + "description": "When set to **true**, an \"envelope complete\" email is sent to an in-session\n(embedded) or offline signer after DocuSign processes the envelope\nif in-session emails are not suppressed.\n\n**Note**: Only Admin users can change this setting.\n", + "type": "string" + }, + "signerInSessionUseEnvelopeCompleteEmailMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `signerInSessionUseEnvelopeCompleteEmail` property is editable.\n" + }, + "signerLoginRequirements": { + "description": "Sets the login requirements for signers. Valid values are:\n\n- `login_not_required`: Signers are not required to log in.\n- `login_required_if_account_holder`: If the signer has a DocuSign account,\n they must log in to sign the document.\n- `login_required_per_session`: The sender cannot send an envelope to anyone\n who does not have a DocuSign account.\n- `login_required_per_envelope`: The sender cannot send an envelope to anyone\n who does not have a DocuSign account, and the signer must also log in for\n each envelope they will sign.\n\n\n**Note**: Only Admin users can change this setting. If you use Direct PowerForms\nor captive (embedded signers), the \"Account required\" settings are bypassed for\nthose signers. If your workflow requires that the signer have an account,\nyou should not use those methods.\n", + "type": "string" + }, + "signerLoginRequirementsMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `signerLoginRequirements` property is editable.\n" + }, + "signerMustHaveAccount": { + "description": "When set to **true**, senders can only send an envelope to a recipient\nthat has a DocuSign account.\n\n**Note**: Only Account Administrators can change this setting.\n", + "type": "string" + }, + "signerMustHaveAccountMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `signerMustHaveAccount` property is editable.\n" + }, + "signerMustLoginToSign": { + "description": "When set to **true**,\nsigners must log in to the DocuSign platform to sign an envelope.\n\n**Note**: Only Admin users can change this setting.\n", + "type": "string" + }, + "signerMustLoginToSignMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `signerMustLoginToSign` property is editable.\n" + }, + "signerShowSecureFieldInitialValues": { + "description": "When set to **true**, the initial values of all SecureFields are written\nto the document when it is sent.\n\n**Note**: Only Admin users can change this setting.\n", + "type": "string" + }, + "signerShowSecureFieldInitialValuesMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `signerShowSecureFieldInitialValues` property is editable.\n" + }, + "signingSessionTimeout": { + "description": "The number of minutes\nthat a signing session stays\nalive without any activity.\n", + "type": "string" + }, + "signingSessionTimeoutMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `signingSessionTimeout` property is editable.\n" + }, + "signingUiVersion": { + "description": "Reserved for DocuSign.\n", + "type": "string" + }, + "signingUiVersionMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Reserved for DocuSign." + }, + "signTimeFormat": { + "description": "The format for the signature time. Valid values are:\n\n- `none`\n- `HH:mm`\n- `h:mm`\n- `HH:mm:ss`\n- `h:mm:ss`\n", + "type": "string" + }, + "signTimeFormatMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `signTimeFormat` property is editable.\n" + }, + "signTimeShowAmPm": { + "description": "If **true**,\nthe time shows the AM or PM indicator.\n", + "type": "string" + }, + "signTimeShowAmPmMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `signTimeShowAmPm` property is editable.\n" + }, + "simplifiedSendingEnabled": { + "description": "When set to **true**, simplified sending is enabled for the account. The default value is **false**.", + "type": "string" + }, + "simplifiedSendingEnabledMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `simplifiedSendingEnabled` property is editable.\n" + }, + "singleSignOnEnabled": { + "description": "If **true**,\nsingle sign-on (SSO) is enabled.\n", + "type": "string" + }, + "singleSignOnEnabledMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `singleSignOnEnabled` property is editable.\n" + }, + "skipAuthCompletedEnvelopes": { + "description": "If **true**,\ndo not require authentication prompt for viewing completed envelopes\n", + "type": "string" + }, + "skipAuthCompletedEnvelopesMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `skipAuthCompletedEnvelopes` property is editable.\n" + }, + "socialIdRecipAuth": { + "description": "If **true**,\nrecipients can use\n[social ids](https://support.docusign.com/guides/signer-authentication)\nwhen signing\n", + "type": "string" + }, + "socialIdRecipAuthMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `socialIdRecipAuth` property is editable.\n" + }, + "specifyDocumentVisibility": { + "description": "When **true**, senders can specify the visibility of the documents in an envelope at the recipient level.\n", + "type": "string" + }, + "specifyDocumentVisibilityMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `specifyDocumentVisibility` property is editable.\n" + }, + "startInAdvancedCorrect": { + "description": "If **true**,\nwhen initiating correction of an in-flight envelope\nthe sender starts in advanced correct mode.\n", + "type": "string" + }, + "startInAdvancedCorrectMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `startInAdvancedCorrect` property is editable.\n" + }, + "supplementalDocumentsMustAccept": { + "description": "When set to **true**, account users must accept supplemental documents when signing.", + "type": "string" + }, + "supplementalDocumentsMustAcceptMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `supplementalDocumentsMustAccept` property is editable.\n" + }, + "supplementalDocumentsMustRead": { + "description": "When set to **true**, account users must both view and accept supplemental documents when signing.", + "type": "string" + }, + "supplementalDocumentsMustReadMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `supplementalDocumentsMustRead` property is editable.\n" + }, + "supplementalDocumentsMustView": { + "description": "When set to **true**, account users must view supplemental documents when signing.", + "type": "string" + }, + "supplementalDocumentsMustViewMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `supplementalDocumentsMustView` property is editable.\n" + }, + "suppressCertificateEnforcement": { + "description": "Boolean that specifies whether or not API calls require a x509 cert in the header of the call.", + "type": "string" + }, + "suppressCertificateEnforcementMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `suppressCertificateEnforcement` property is editable.\n" + }, + "tabAccountSettings": { + "$ref": "#/definitions/tabAccountSettings", + "description": "Account-wide tab settings." + }, + "timezoneOffsetAPI": { + "description": "Specifies the time zone\nto use with the API.\n\nValid values are:\n\n- `TZ_01_AfghanistanStandardTime`\n- `TZ_02_AlaskanStandardTime`\n- `TZ_03_ArabStandardTime`\n- `TZ_04_ArabianStandardTime`\n- `TZ_05_ArabicStandardTime`\n- `TZ_06_ArgentinaStandardTime`\n- `TZ_07_AtlanticStandardTime`\n- `TZ_08_AUS_CentralStandardTime`\n- `TZ_09_AUS_EasternStandardTime`\n- `TZ_10_AzerbaijanStandardTime`\n- `TZ_11_AzoresStandardTime`\n- `TZ_12_BangladeshStandardTime`\n- `TZ_13_CanadaCentralStandardTime`\n- `TZ_14_CapeVerdeStandardTime`\n- `TZ_15_CaucasusStandardTime`\n- `TZ_16_CentralAustraliaStandardTime`\n- `TZ_17_CentralAmericaStandardTime`\n- `TZ_18_CentralAsiaStandardTime`\n- `TZ_19_CentralBrazilianStandardTime`\n- `TZ_20_CentralEuropeStandardTime`\n- `TZ_21_CentralEuropeanStandardTime`\n- `TZ_22_CentralPacificStandardTime`\n- `TZ_23_CentralStandardTime`\n- `TZ_24_CentralStandardTimeMexico`\n- `TZ_25_ChinaStandardTime`\n- `TZ_26_DatelineStandardTime`\n- `TZ_27_E_AfricaStandardTime`\n- `TZ_28_E_AustraliaStandardTime`\n- `TZ_29_E_EuropeStandardTime`\n- `TZ_30_E_SouthAmericaStandardTime`\n- `TZ_31_EasternStandardTime`\n- `TZ_32_EgyptStandardTime`\n- `TZ_33_EkaterinburgStandardTime`\n- `TZ_34_FijiStandardTime`\n- `TZ_35_FLE_StandardTime`\n- `TZ_36_GeorgianStandardTime`\n- `TZ_37_GMT_StandardTime`\n- `TZ_38_GreenlandStandardTime`\n- `TZ_39_GreenwichStandardTime`\n- `TZ_40_GTB_StandardTime`\n- `TZ_41_HawaiianStandardTime`\n- `TZ_42_IndiaStandardTime`\n- `TZ_43_IranStandardTime`\n- `TZ_44_IsraelStandardTime`\n- `TZ_45_JordanStandardTime`\n- `TZ_46_KaliningradStandardTime`\n- `TZ_47_KamchatkaStandardTime`\n- `TZ_48_KoreaStandardTime`\n- `TZ_49_MagadanStandardTime`\n- `TZ_50_MauritiusStandardTime`\n- `TZ_51_MidAtlanticStandardTime`\n- `TZ_52_MiddleEastStandardTime`\n- `TZ_53_MontevideoStandardTime`\n- `TZ_54_MoroccoStandardTime`\n- `TZ_55_MountainStandardTime`\n- `TZ_56_MountainStandardTimeMMexico`\n- `TZ_57_MyanmarStandardTime`\n- `TZ_58_N_CentralAsiaStandardTime`\n- `TZ_59_NamibiaStandardTime`\n- `TZ_60_NepalStandardTime`\n- `TZ_61_NewZealandStandardTime`\n- `TZ_62_NewfoundlandStandardTime`\n- `TZ_63_NorthAsiaEastStandardTime`\n- `TZ_64_NorthAsiaStandardTime`\n- `TZ_65_PacificSAStandardTime`\n- `TZ_66_PacificStandardTime`\n- `TZ_67_PacificStandardTimeMexico`\n- `TZ_68_PakistanStandardTime`\n- `TZ_69_ParaguayStandardTime`\n- `TZ_70_RomanceStandardTime`\n- `TZ_71_RussianStandardTime`\n- `TZ_72_SAEasternStandardTime`\n- `TZ_73_SAPacificStandardTime`\n- `TZ_74_SAWesternStandardTime`\n- `TZ_75_SamoaStandardTime`\n- `TZ_76_SE_AsiaStandardTime`\n- `TZ_77_SingaporeStandardTime`\n- `TZ_78_SouthAfricaStandardTime`\n- `TZ_79_SriLankaStandardTime`\n- `TZ_80_SyriaStandardTime`\n- `TZ_81_TaipeiStandardTime`\n- `TZ_82_TasmaniaStandardTime`\n- `TZ_83_TokyoStandardTime`\n- `TZ_84_TongaStandardTime`\n- `TZ_85_TurkeyStandardTime`\n- `TZ_86_UlaanbaatarStandardTime`\n- `TZ_87_US_EasternStandardTime`\n- `TZ_88_USMountainStandardTime`\n- `TZ_89_VenezuelaStandardTime`\n- `TZ_90_VladivostokStandardTime`\n- `TZ_91_W_AustraliaStandardTime`\n- `TZ_92_W_CentralAfricaStandardTime`\n- `TZ_93_W_EuropeStandardTime`\n- `TZ_94_WestAsiaStandardTime`\n- `TZ_95_WestPacificStandardTime`\n- `TZ_96_YakutskStandardTime`\n", + "type": "string" + }, + "timezoneOffsetAPIMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `timezoneOffsetAPI` property is editable.\n" + }, + "timezoneOffsetUI": { + "description": "Specifies the time zone\nto use in the UI.\n\nValid values are:\n\n- `TZ_01_AfghanistanStandardTime`\n- `TZ_02_AlaskanStandardTime`\n- `TZ_03_ArabStandardTime`\n- `TZ_04_ArabianStandardTime`\n- `TZ_05_ArabicStandardTime`\n- `TZ_06_ArgentinaStandardTime`\n- `TZ_07_AtlanticStandardTime`\n- `TZ_08_AUS_CentralStandardTime`\n- `TZ_09_AUS_EasternStandardTime`\n- `TZ_10_AzerbaijanStandardTime`\n- `TZ_11_AzoresStandardTime`\n- `TZ_12_BangladeshStandardTime`\n- `TZ_13_CanadaCentralStandardTime`\n- `TZ_14_CapeVerdeStandardTime`\n- `TZ_15_CaucasusStandardTime`\n- `TZ_16_CentralAustraliaStandardTime`\n- `TZ_17_CentralAmericaStandardTime`\n- `TZ_18_CentralAsiaStandardTime`\n- `TZ_19_CentralBrazilianStandardTime`\n- `TZ_20_CentralEuropeStandardTime`\n- `TZ_21_CentralEuropeanStandardTime`\n- `TZ_22_CentralPacificStandardTime`\n- `TZ_23_CentralStandardTime`\n- `TZ_24_CentralStandardTimeMexico`\n- `TZ_25_ChinaStandardTime`\n- `TZ_26_DatelineStandardTime`\n- `TZ_27_E_AfricaStandardTime`\n- `TZ_28_E_AustraliaStandardTime`\n- `TZ_29_E_EuropeStandardTime`\n- `TZ_30_E_SouthAmericaStandardTime`\n- `TZ_31_EasternStandardTime`\n- `TZ_32_EgyptStandardTime`\n- `TZ_33_EkaterinburgStandardTime`\n- `TZ_34_FijiStandardTime`\n- `TZ_35_FLE_StandardTime`\n- `TZ_36_GeorgianStandardTime`\n- `TZ_37_GMT_StandardTime`\n- `TZ_38_GreenlandStandardTime`\n- `TZ_39_GreenwichStandardTime`\n- `TZ_40_GTB_StandardTime`\n- `TZ_41_HawaiianStandardTime`\n- `TZ_42_IndiaStandardTime`\n- `TZ_43_IranStandardTime`\n- `TZ_44_IsraelStandardTime`\n- `TZ_45_JordanStandardTime`\n- `TZ_46_KaliningradStandardTime`\n- `TZ_47_KamchatkaStandardTime`\n- `TZ_48_KoreaStandardTime`\n- `TZ_49_MagadanStandardTime`\n- `TZ_50_MauritiusStandardTime`\n- `TZ_51_MidAtlanticStandardTime`\n- `TZ_52_MiddleEastStandardTime`\n- `TZ_53_MontevideoStandardTime`\n- `TZ_54_MoroccoStandardTime`\n- `TZ_55_MountainStandardTime`\n- `TZ_56_MountainStandardTimeMMexico`\n- `TZ_57_MyanmarStandardTime`\n- `TZ_58_N_CentralAsiaStandardTime`\n- `TZ_59_NamibiaStandardTime`\n- `TZ_60_NepalStandardTime`\n- `TZ_61_NewZealandStandardTime`\n- `TZ_62_NewfoundlandStandardTime`\n- `TZ_63_NorthAsiaEastStandardTime`\n- `TZ_64_NorthAsiaStandardTime`\n- `TZ_65_PacificSAStandardTime`\n- `TZ_66_PacificStandardTime`\n- `TZ_67_PacificStandardTimeMexico`\n- `TZ_68_PakistanStandardTime`\n- `TZ_69_ParaguayStandardTime`\n- `TZ_70_RomanceStandardTime`\n- `TZ_71_RussianStandardTime`\n- `TZ_72_SAEasternStandardTime`\n- `TZ_73_SAPacificStandardTime`\n- `TZ_74_SAWesternStandardTime`\n- `TZ_75_SamoaStandardTime`\n- `TZ_76_SE_AsiaStandardTime`\n- `TZ_77_SingaporeStandardTime`\n- `TZ_78_SouthAfricaStandardTime`\n- `TZ_79_SriLankaStandardTime`\n- `TZ_80_SyriaStandardTime`\n- `TZ_81_TaipeiStandardTime`\n- `TZ_82_TasmaniaStandardTime`\n- `TZ_83_TokyoStandardTime`\n- `TZ_84_TongaStandardTime`\n- `TZ_85_TurkeyStandardTime`\n- `TZ_86_UlaanbaatarStandardTime`\n- `TZ_87_US_EasternStandardTime`\n- `TZ_88_USMountainStandardTime`\n- `TZ_89_VenezuelaStandardTime`\n- `TZ_90_VladivostokStandardTime`\n- `TZ_91_W_AustraliaStandardTime`\n- `TZ_92_W_CentralAfricaStandardTime`\n- `TZ_93_W_EuropeStandardTime`\n- `TZ_94_WestAsiaStandardTime`\n- `TZ_95_WestPacificStandardTime`\n- `TZ_96_YakutskStandardTime`\n", + "type": "string" + }, + "timezoneOffsetUIMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `timezoneOffsetUI` property is editable.\n" + }, + "universalSignatureOptIn": { + "description": "Reserved for DocuSign.\n", + "type": "string" + }, + "useAccountLevelEmail": { + "description": "Reserved for DocuSign.\n", + "type": "string" + }, + "useAccountLevelEmailMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `useAccountLevelEmail` property is editable.\n" + }, + "useConsumerDisclosure": { + "description": "When set to **true**, the account uses an Electronic Record and\nSignature Disclosure Statement.\n\n**Note**: Only Admin users can change this setting.\n", + "type": "string" + }, + "useConsumerDisclosureMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `useConsumerDisclosure` property is editable.\n" + }, + "useConsumerDisclosureWithinAccount": { + "description": "When set to **true**, specifies that recipients in the same account as the sender must agree to eSign an Electronic Record and Signature Disclosure Statement.", + "type": "string" + }, + "useConsumerDisclosureWithinAccountMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `useConsumerDisclosureWithinAccount` property is editable.\n" + }, + "useDerivedKeys": { + "description": "Reserved for DocuSign.\n", + "type": "string" + }, + "useDerivedKeysMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `useDerivedKeys` property is editable.\n" + }, + "useDocuSignExpressSignerCertificate": { + "description": "If **true**,\nsigners\nare required to use Express Digital Signatures.\n", + "type": "string" + }, + "useDocuSignExpressSignerCertificateMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `useDocuSignExpressSignerCertificate` property is editable.\n" + }, + "useMultiAppGroupsData": { + "description": "", + "type": "string" + }, + "useMultiAppGroupsDataMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "" + }, + "useNewBlobForPdf": { + "description": "Reserved for DocuSign.\n", + "type": "string" + }, + "useNewBlobForPdfMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `useNewBlobForPdf` property is editable.\n" + }, + "useSAFESignerCertificates": { + "description": "If **true**,\nsigners are\nrequired to use SAFE digital signatures.\n", + "type": "string" + }, + "useSAFESignerCertificatesMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `useSAFESignerCertificates` property is editable.\n" + }, + "usesAPI": { + "description": "When set to **true**,\nthe account can use the API.\n\n**Note**: Only SysAdmin users can change this setting.\n", + "type": "string" + }, + "usesAPIMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `usesAPI` property is editable.\n" + }, + "useSignatureProviderPlatform": { + "description": "Boolean that specifies whether the account uses the digital signature provider platform to eSign.", + "type": "string" + }, + "useSignatureProviderPlatformMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `useSignatureProviderPlatform` property is editable.\n" + }, + "validationsAllowed": { + "description": "Boolean that specifies whether validations on recipient email domains are allowed.", + "type": "string" + }, + "validationsAllowedMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `validationsAllowed` property is editable.\n" + }, + "validationsBrand": { + "description": "Valid values are:\n\n- `docusign`\n- `account`\n", + "type": "string" + }, + "validationsBrandMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `validationsBrand` property is editable.\n" + }, + "validationsCadence": { + "description": "Valid values are:\n\n- `none`\n- `monthly`\n", + "type": "string" + }, + "validationsCadenceMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `validationsCadence` property is editable.\n" + }, + "validationsEnabled": { + "description": "If **true**,\nenables validations.\n", + "type": "string" + }, + "validationsEnabledMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `validationsEnabled` property is editable.\n" + }, + "validationsReport": { + "description": "Valid values are:\n\n- `none`\n- `life_sciences_part11`\n", + "type": "string" + }, + "validationsReportMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `validationsReport` property is editable.\n" + }, + "waterMarkEnabled": { + "description": "If **true**,\nthe\n[watermark feature](https://support.docusign.com/en/articles/How-do-I-manage-the-watermark-for-In-Process-envelopes-sent-from-my-account)\nis enabled for the account.\n", + "type": "string" + }, + "waterMarkEnabledMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `waterMarkEnabled` property is editable.\n" + }, + "writeReminderToEnvelopeHistory": { + "description": "If **true**,\nsent reminders are included in the envelope history.", + "type": "string" + }, + "writeReminderToEnvelopeHistoryMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `writeReminderToEnvelopeHistory` property is editable.\n" + }, + "wurflMinAllowableScreenSize": { + "description": "The smallest screen allowed.", + "type": "string" + }, + "wurflMinAllowableScreenSizeMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `wurflMinAllowableScreenSize` property is editable.\n" + } + }, + "x-ds-definition-name": "accountSettingsInformation", + "x-ms-summary": "Contains account settings information. Used in requests to set property values. Used in responses to report property values." + }, + "accountSharedAccess": { + "description": "Contains shared access information.", + "type": "object", + "properties": { + "accountId": { + "description": "The account ID associated with the envelope.", + "type": "string" + }, + "endPosition": { + "description": "The last index position in the result set. ", + "type": "string" + }, + "errorDetails": { + "$ref": "#/definitions/errorDetails", + "description": "A complex type containing an errorCode and message identifying the error that occurred." + }, + "nextUri": { + "description": "The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. ", + "type": "string" + }, + "previousUri": { + "description": "The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. ", + "type": "string" + }, + "resultSetSize": { + "description": "The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`.", + "type": "string" + }, + "sharedAccess": { + "description": "A list of shared access information of envelope and templates for the users specified in the request.", + "type": "array", + "items": { + "$ref": "#/definitions/memberSharedItems" + } + }, + "startPosition": { + "description": "The starting index position of the current result set.", + "type": "string" + }, + "totalSetSize": { + "description": "The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`.", + "type": "string" + } + }, + "x-ds-definition-name": "accountSharedAccess", + "x-ms-summary": "Contains shared access information." + }, + "accountSignature": { + "type": "object", + "properties": { + "adoptedDateTime": { + "description": "The UTC date and time when the user adopted the signature.", + "type": "string" + }, + "createdDateTime": { + "description": "The UTC DateTime when the item was created.", + "type": "string" + }, + "customField": { + "description": "", + "type": "string" + }, + "dateStampProperties": { + "$ref": "#/definitions/dateStampProperties", + "description": "Specifies the area in which a date stamp is placed. This parameter uses pixel positioning to draw a rectangle at the center of the stamp area. The stamp is superimposed on top of this central area.\n\nThis property contains the following information about the central rectangle:\n\n- `DateAreaX`: The X axis position of the top-left corner.\n- `DateAreaY`: The Y axis position of the top-left corner.\n- `DateAreaWidth`: The width of the rectangle.\n- `DateAreaHeight`: The height of the rectangle." + }, + "disallowUserResizeStamp": { + "description": "When set to **true**, users may not resize the stamp.", + "type": "string" + }, + "errorDetails": { + "$ref": "#/definitions/errorDetails", + "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." + }, + "externalID": { + "description": "Optionally specify an external identifier for the user's signature.", + "type": "string" + }, + "imageBase64": { + "description": "", + "type": "string" + }, + "imageType": { + "description": "Specificies the type of image. Valid values are:\n\n- `signature_image`\n- `initials_image`", + "type": "string" + }, + "initials150ImageId": { + "description": "The ID of the user's initials image.", + "type": "string" + }, + "initialsImageUri": { + "description": "The URI for retrieving the image of the user's initials.", + "type": "string" + }, + "isDefault": { + "description": "Boolean that specifies whether the signature is the default signature for the user.", + "type": "string" + }, + "lastModifiedDateTime": { + "description": "The date and time that the item was last modified.", + "type": "string" + }, + "nrdsId": { + "description": "The National Association of Realtors (NAR) membership ID for a user who is a realtor.", + "type": "string" + }, + "nrdsLastName": { + "description": "The realtor's last name.", + "type": "string" + }, + "nrdsStatus": { + "description": "The realtor's NAR membership status. The value `active` verifies that the user is a current NAR member. Valid values are:\n\n- `Active`\n- `Inactive`\n- `Terminate`\n- `Provisional`\n- `Deceased`\n- `Suspend`\n- `Unknown`", + "type": "string" + }, + "phoneticName": { + "description": "The phonetic spelling of the `signatureName`.", + "type": "string" + }, + "signature150ImageId": { + "description": "The ID of the user's signature image.", + "type": "string" + }, + "signatureFont": { + "description": "The font type to use for the signature if the signature is not drawn. The following font styles are supported. The quotes are to indicate that these values are strings, not `enums`.\n\n- `\"1_DocuSign\"`\n- `\"2_DocuSign\"`\n- `\"3_DocuSign\"`\n- `\"4_DocuSign\"`\n- `\"5_DocuSign\"`\n- `\"6_DocuSign\"`\n- `\"7_DocuSign\"`\n- `\"8_DocuSign\"`\n- `\"Mistral\"`\n- `\"Rage Italic\"`\n", + "type": "string" + }, + "signatureGroups": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/signatureGroup" + } + }, + "signatureId": { + "description": "Specifies the signature ID associated with the signature name. You can use the signature ID in the URI in place of the signature name, and the value stored in the `signatureName` property in the body is used. This allows the use of special characters (such as \"&\", \"<\", \">\") in a the signature name. Note that with each update to signatures, the returned signature ID might change, so the caller will need to trigger off the signature name to get the new signature ID.", + "type": "string" + }, + "signatureImageUri": { + "description": "An endpoint URI that you can use to retrieve the user's signature image.", + "type": "string" + }, + "signatureInitials": { + "description": "Specifies the user's signature in initials format.", + "type": "string" + }, + "signatureName": { + "description": "Specifies the user's signature name.", + "type": "string" + }, + "signatureRights": { + "description": "The rights that the user has to the signature. Valid values are:\n\n- `none`\n- `read`\n- `admin`", + "type": "string" + }, + "signatureType": { + "description": "Specifies the type of signature.", + "type": "string" + }, + "signatureUsers": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/signatureUser" + } + }, + "stampFormat": { + "description": "The format of a stamp. Valid values are:\n\n- `NameHanko`: The stamp represents only the signer's name.\n- `NameDateHanko`: The stamp represents the signer's name and the date. ", + "type": "string" + }, + "stampImageUri": { + "description": "The URI for retrieving the image of the user's stamp.", + "type": "string" + }, + "stampSizeMM": { + "description": "The physical height of the stamp image (in millimeters) that the stamp vendor recommends for displaying the image in PDF documents.", + "type": "string" + }, + "stampType": { + "description": "The type of stamp. Valid values are:\n\n- `signature`: A signature image. This is the default value.\n- `stamp`: A stamp image.\n- null", + "type": "string" + }, + "status": { + "description": "Indicates the envelope status. Valid values are:\n\n* sent - The envelope is sent to the recipients. \n* created - The envelope is saved as a draft and can be modified and sent later.", + "type": "string" + } + }, + "x-ds-definition-name": "accountSignature", + "description": "", + "x-ms-summary": "" + }, + "accountSignatureDefinition": { + "type": "object", + "properties": { + "dateStampProperties": { + "$ref": "#/definitions/dateStampProperties", + "description": "Specifies the area in which a date stamp is placed. This parameter uses pixel positioning to draw a rectangle at the center of the stamp area. The stamp is superimposed on top of this central area.\n\nThis property contains the following information about the central rectangle:\n\n- `DateAreaX`: The X axis position of the top-left corner.\n- `DateAreaY`: The Y axis position of the top-left corner.\n- `DateAreaWidth`: The width of the rectangle.\n- `DateAreaHeight`: The height of the rectangle." + }, + "disallowUserResizeStamp": { + "description": "When set to **true**, users may not resize the stamp.", + "type": "string" + }, + "externalID": { + "description": "Optionally specify an external identifier for the user's signature.", + "type": "string" + }, + "imageType": { + "description": "Specificies the type of image. Valid values are:\n\n- `signature_image`\n- `initials_image`", + "type": "string" + }, + "isDefault": { + "description": "Boolean that specifies whether the signature is the default signature for the user.", + "type": "string" + }, + "nrdsId": { + "description": "The National Association of Realtors (NAR) membership ID for a user who is a realtor.", + "type": "string" + }, + "nrdsLastName": { + "description": "The realtor's last name.", + "type": "string" + }, + "phoneticName": { + "description": "The phonetic spelling of the `signatureName`.", + "type": "string" + }, + "signatureFont": { + "description": "The font type to use for the signature if the signature is not drawn. The following font styles are supported. The quotes are to indicate that these values are strings, not `enums`.\n\n- `\"1_DocuSign\"`\n- `\"2_DocuSign\"`\n- `\"3_DocuSign\"`\n- `\"4_DocuSign\"`\n- `\"5_DocuSign\"`\n- `\"6_DocuSign\"`\n- `\"7_DocuSign\"`\n- `\"8_DocuSign\"`\n- `\"Mistral\"`\n- `\"Rage Italic\"`\n", + "type": "string" + }, + "signatureGroups": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/signatureGroupDef" + } + }, + "signatureId": { + "description": "Specifies the signature ID associated with the signature name. You can use the signature ID in the URI in place of the signature name, and the value stored in the `signatureName` property in the body is used. This allows the use of special characters (such as \"&\", \"<\", \">\") in a the signature name. Note that with each update to signatures, the returned signature ID might change, so the caller will need to trigger off the signature name to get the new signature ID.", + "type": "string" + }, + "signatureInitials": { + "description": "Specifies the user's signature in initials format.", + "type": "string" + }, + "signatureName": { + "description": "Specifies the user's signature name.", + "type": "string" + }, + "signatureUsers": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/signatureUserDef" + } + }, + "stampFormat": { + "description": "The format of a stamp. Valid values are:\n\n- `NameHanko`: The stamp represents only the signer's name.\n- `NameDateHanko`: The stamp represents the signer's name and the date. ", + "type": "string" + }, + "stampSizeMM": { + "description": "The physical height of the stamp image (in millimeters) that the stamp vendor recommends for displaying the image in PDF documents.", + "type": "string" + } + }, + "x-ds-definition-name": "accountSignatureDefinition", + "description": "", + "x-ms-summary": "" + }, + "accountSignatureProvider": { + "type": "object", + "properties": { + "isRequired": { + "description": "Reserved for DocuSign.", + "type": "string" + }, + "priority": { + "description": "Reserved for DocuSign.", + "type": "string" + }, + "signatureProviderDisplayName": { + "description": "Reserved for DocuSign.", + "type": "string" + }, + "signatureProviderId": { + "description": "Reserved for DocuSign.", + "type": "string" + }, + "signatureProviderName": { + "description": "The name of an Electronic or Standards Based Signature (digital signature) provider for the signer to use. For details, see [the current provider list](https://developers.docusign.com/esign-rest-api/guides/standards-based-signatures). You can also retrieve the list by using the [AccountSignatureProviders::List](https://developers.docusign.com/esign-rest-api/reference/Accounts/AccountSignatureProviders/list/) method.\n\nExample: `universalsignaturepen_default`\n\n", + "type": "string" + }, + "signatureProviderOptionsMetadata": { + "description": "Reserved for DocuSign.", + "type": "array", + "items": { + "$ref": "#/definitions/accountSignatureProviderOption" + } + }, + "signatureProviderRequiredOptions": { + "description": "Reserved for DocuSign.", + "type": "array", + "items": { + "$ref": "#/definitions/signatureProviderRequiredOption" + } + } + }, + "x-ds-definition-name": "accountSignatureProvider", + "description": "Contains information abotu the signature provider associated with the Identity Verification workflow. \nIf empty, then this specific workflow is not intended for signers.\n", + "x-ms-summary": "Contains information abotu the signature provider associated with the Identity Verification workflow. \nIf empty, then this specific workflow is not intended for signers.\n" + }, + "accountSignatureProviderOption": { + "type": "object", + "properties": { + "signatureProviderOptionDisplayName": { + "description": "Reserved for DocuSign.", + "type": "string" + }, + "signatureProviderOptionId": { + "description": "Reserved for DocuSign.", + "type": "string" + }, + "signatureProviderOptionName": { + "description": "Reserved for DocuSign.", + "type": "string" + } + }, + "x-ds-definition-name": "accountSignatureProviderOption", + "description": "Reserved for DocuSign.", + "x-ms-summary": "Reserved for DocuSign." + }, + "accountSignatureProviders": { + "type": "object", + "properties": { + "signatureProviders": { + "description": "Names of electronic or digital signature providers that can be used.", + "type": "array", + "items": { + "$ref": "#/definitions/accountSignatureProvider" + } + } + }, + "x-ds-definition-name": "accountSignatureProviders", + "description": "", + "x-ms-summary": "" + }, + "accountSignaturesInformation": { + "type": "object", + "properties": { + "accountSignatures": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/accountSignature" + } + } + }, + "x-ds-definition-name": "accountSignaturesInformation", + "description": "", + "x-ms-summary": "" + }, + "accountUISettings": { + "type": "object", + "properties": { + "adminMessage": { + "$ref": "#/definitions/adminMessage", + "description": "" + }, + "askAnAdmin": { + "$ref": "#/definitions/askAnAdmin", + "description": "" + }, + "enableAdminMessage": { + "description": "", + "type": "string" + }, + "enableAdminMessageMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "" + }, + "enableAdvancedPaymentsReactEdit": { + "description": "", + "type": "string" + }, + "enableEasySignCanUseMultiTemplateApply": { + "description": "", + "type": "string" + }, + "enableEasySignCanUseMultiTemplateApplyMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "" + }, + "enableEasySignTemplateUpload": { + "description": "", + "type": "string" + }, + "enableEasySignTemplateUploadMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "" + }, + "enableEnvelopeCopyWithData": { + "description": "", + "type": "string" + }, + "enableEnvelopeCopyWithDataMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "" + }, + "enableLegacyHomepageLink": { + "description": "", + "type": "string" + }, + "enableLegacyHomepageLinkMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "" + }, + "hideSendAnEnvelope": { + "description": "", + "type": "string" + }, + "hideSendAnEnvelopeMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "" + }, + "hideUseATemplate": { + "description": "When set to **true**, the **Templates** menu is hidden from account users who are not Admins. The default value is **false**.", + "type": "string" + }, + "hideUseATemplateInPrepare": { + "description": "", + "type": "string" + }, + "hideUseATemplateInPrepareMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "" + }, + "hideUseATemplateMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "" + }, + "orderBasedRecipientIdGeneration": { + "description": "", + "type": "string" + }, + "orderBasedRecipientIdGenerationMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "" + }, + "removeEnvelopeForwarding": { + "description": "", + "type": "string" + }, + "removeEnvelopeForwardingMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "" + }, + "shouldRedactAccessCode": { + "description": "", + "type": "string" + }, + "shouldRedactAccessCodeMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "" + }, + "uploadNewImageToSignOrInitial": { + "description": "", + "type": "string" + }, + "uploadNewImageToSignOrInitialMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "" + } + }, + "x-ds-definition-name": "accountUISettings", + "description": "An object that defines the options that are available to non-administrators in the UI.", + "x-ms-summary": "An object that defines the options that are available to non-administrators in the UI." + }, + "addOn": { + "description": "Contains information about add ons.", + "type": "object", + "properties": { + "active": { + "description": "Reserved for DocuSign.", + "type": "string" + }, + "addOnId": { + "description": "Reserved for DocuSign.", + "type": "string" + }, + "id": { + "description": "A unique ID for the Salesforce object.", + "type": "string" + }, + "name": { + "description": "Reserved for DocuSign.", + "type": "string" + } + }, + "x-ds-definition-name": "addOn", + "x-ms-summary": "Contains information about add ons." + }, + "addressInformation": { + "description": "Contains address information.", + "type": "object", + "properties": { + "address1": { + "description": "The first line of the user's address.\nMaximum length: 100 characters.", + "type": "string" + }, + "address2": { + "description": "The second line of the user's address.\nMaximum length: 100 characters.", + "type": "string" + }, + "city": { + "description": "The user's city. Maximum length: 40 characters.", + "type": "string" + }, + "country": { + "description": "The user's country. Maximum length: 50 characters.", + "type": "string" + }, + "fax": { + "description": "A fax number associated with the address, if one is available.", + "type": "string" + }, + "phone": { + "description": "A phone number associated with the address.", + "type": "string" + }, + "postalCode": { + "description": "The user's postal code. Maximum length: 20 characters.", + "type": "string" + }, + "stateOrProvince": { + "description": "The user's state or province. Maximum length: 40 characters.", + "type": "string" + }, + "zipPlus4": { + "description": "", + "type": "string" + } + }, + "x-ds-definition-name": "addressInformation", + "x-ms-summary": "Contains address information." + }, + "addressInformationInput": { + "description": "Contains address input information.", + "type": "object", + "properties": { + "addressInformation": { + "$ref": "#/definitions/addressInformation", + "description": "A complex type that contains the following information for the new account: `address1`, `address2`, `city`, `country`, `fax`, `phone`, `postalCode` and `stateOrProvince`.\n\nThe maximum characters for the strings are:\n* `address1`, `address2`, `city`, `country` and `stateOrProvince`: 100 characters\n* `postalCode`, `phone`, and `fax`: 20 characters\n\n**Note**: If country is US (United States), `stateOrProvince` codes are validated. Otherwise, `stateOrProvince` is treated as a non-validated string used to specify a state, province, or region." + }, + "displayLevelCode": { + "description": "Specifies the display level for the recipient. Valid values are:\n* `ReadOnly`\n* `Editable`\n* `DoNotDisplay`", + "type": "string" + }, + "receiveInResponse": { + "description": "A Boolean value that specifies whether the information must be returned in the response.", + "type": "string" + } + }, + "x-ds-definition-name": "addressInformationInput", + "x-ms-summary": "Contains address input information." + }, + "adminMessage": { + "type": "object", + "properties": { + "baseMessage": { + "description": "", + "type": "string" + }, + "moreInformation": { + "description": "", + "type": "string" + } + }, + "x-ds-definition-name": "adminMessage", + "description": "", + "x-ms-summary": "" + }, + "agent": { + "description": "Contains information about an agent recipient. An agent is a recipient who can add name and email information for recipients that appear after the agent in routing order.", + "type": "object", + "properties": { + "accessCode": { + "description": "If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. \n\nMaximum Length: 50 characters and it must conform to the account's access code format setting.\n\nIf blank, but the signer `accessCode` property is set in the envelope, then that value is used.\n\nIf blank and the signer `accessCode` property is not set, then the access code is not required.", + "type": "string" + }, + "accessCodeMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `accessCode` property is editable. Read only." + }, + "addAccessCodeToEmail": { + "description": "Optional. When set to **true**, the access code will be added to the email sent to the recipient. This nullifies the security measure of `accessCode` on the recipient.", + "type": "string" + }, + "additionalNotifications": { + "description": "An array of additional notification objects.", + "type": "array", + "items": { + "$ref": "#/definitions/recipientAdditionalNotification" + } + }, + "allowSystemOverrideForLockedRecipient": { + "description": "", + "type": "string" + }, + "clientUserId": { + "description": "Specifies whether the recipient is embedded or remote. \n\nIf the `clientUserId` property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing.\n\nNote: if the `clientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true**, an error is generated on sending. \n\nMaximum length: 100 characters. ", + "type": "string" + }, + "completedCount": { + "description": "Indicates the number of times that the recipient has been through a signing completion for the envelope. If this number is greater than 0 for a signing group, only the user who previously completed may sign again. Read only.", + "type": "string" + }, + "customFields": { + "description": "An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters.", + "type": "array", + "items": { + "type": "string" + } + }, + "declinedDateTime": { + "description": "The date and time the recipient declined the document. Read only.", + "type": "string" + }, + "declinedReason": { + "description": "The reason the recipient declined the document. Read only.", + "type": "string" + }, + "deliveredDateTime": { + "description": "The date and time that the envelope was delivered to the recipient. Read only.", + "type": "string" + }, + "deliveryMethod": { + "description": "Reserved for DocuSign.", + "type": "string" + }, + "deliveryMethodMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Reserved for DocuSign." + }, + "designatorId": { + "description": "", + "type": "string" + }, + "designatorIdGuid": { + "description": "", + "type": "string" + }, + "documentVisibility": { + "description": "A list of `documentVisibility` objects. Each object in the list specifies whether a document in the envelope is visible to this recipient. For the envelope to use this functionality, Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true**.", + "type": "array", + "items": { + "$ref": "#/definitions/documentVisibility" + } + }, + "email": { + "description": "The email id of the agent. Notification of the document to sign is sent to this email id. \n\nMaximum length: 100 characters. ", + "type": "string" + }, + "emailMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `email` property is editable. Read only." + }, + "emailNotification": { + "$ref": "#/definitions/recipientEmailNotification", + "description": "An optional complex type that sets a specific email subject and body for this recipient's notification email. \n\n**Note**: You can set the `emailNotification` property separately for each recipient. If you set the value only for certain recipients, the other recipients will inherit the this value from the top-level `emailSubject` and `emailBlurb`. " + }, + "embeddedRecipientStartURL": { + "description": "Specifies a sender-provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. \n\nIf set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation launched by a partner.\n\nIt is important to understand that in a typical embedded workflow, the authentication of an embedded recipient is the responsibility of the sending application. DocuSign expects that senders will follow their own processes for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process is initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process, bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient.\n\nIf the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: `envelopeId`, `recipientId`, `recipientName`, `recipientEmail`, and `customFields`. The `customFields` property must be set for the recipient or envelope. The merge fields are enclosed in double brackets. \n\n*Example*: \n\n`http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` ", + "type": "string" + }, + "errorDetails": { + "$ref": "#/definitions/errorDetails", + "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." + }, + "excludedDocuments": { + "description": "Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true** for the envelope to use this.\n\nWhen enforce signer visibility is enabled, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent.", + "type": "array", + "items": { + "type": "string" + } + }, + "faxNumber": { + "description": "Reserved for DocuSign.", + "type": "string" + }, + "faxNumberMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Reserved for DocuSign." + }, + "firstName": { + "description": "The recipient's first name. Maximum Length: 50 characters.", + "type": "string" + }, + "firstNameMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `firstame` property is editable. Read only." + }, + "fullName": { + "description": "Reserved for DocuSign.", + "type": "string" + }, + "fullNameMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Reserved for DocuSign." + }, + "idCheckConfigurationName": { + "description": "The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are:\n\n- `Phone Auth $`: The recipient must authenticate by using two-factor authentication (2FA). You provide the phone number to use for 2FA in the `phoneAuthentication` object.\n- `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object.\n- `ID Check $`: The recipient must answer detailed security questions. \n\n**Example**: Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node.", + "type": "string" + }, + "idCheckConfigurationNameMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `idCheckConfigurationName` property is editable. Read only." + }, + "idCheckInformationInput": { + "$ref": "#/definitions/idCheckInformationInput", + "description": "An object that contains input information related to a recipient ID check." + }, + "identityVerification": { + "$ref": "#/definitions/recipientIdentityVerification", + "description": "Specifies the ID Verification workflow applied on an envelope by workflow ID.
See the [list](https://developers.docusign.com/docs/esign-rest-api/reference/Accounts/IdentityVerifications/list) method in the [IdentityVerifications](https://developers.docusign.com/docs/esign-rest-api/reference/Accounts/IdentityVerifications) resource for more information on how to retrieve workflow IDs available for an account.
This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods.
Note that ID Verification and ID Check are two distinct methods. ID Verification checks recipients' identity by verifying their ID while ID Check relies on data available on public records (such as current and former address)." + }, + "inheritEmailNotificationConfiguration": { + "description": "When set to **true** and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account. ", + "type": "string" + }, + "lastName": { + "description": "The recipient's last name.", + "type": "string" + }, + "lastNameMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `lastName` property is editable. Read only." + }, + "lockedRecipientPhoneAuthEditable": { + "description": "Reserved for DocuSign.", + "type": "string" + }, + "lockedRecipientSmsEditable": { + "description": "Reserved for DocuSign.", + "type": "string" + }, + "name": { + "description": "The full legal name of the recipient. Maximum Length: 100 characters.\n\n**Note**: You must always set a value for this property in requests, even if `firstName` and `lastName` are set.", + "type": "string" + }, + "nameMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `name` property is editable. Read only." + }, + "note": { + "description": "A note sent to the recipient in the signing email.\nThis note is unique to this recipient.\nIn the user interface,\nit appears near the upper left corner\nof the document\non the signing screen.\n\nMaximum Length: 1000 characters.\n", + "type": "string" + }, + "noteMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `note` property is editable. Read only." + }, + "phoneAuthentication": { + "$ref": "#/definitions/recipientPhoneAuthentication", + "description": "When `idCheckConfigurationName` is set to `Phone Auth $`, you use this complex type to provide the recipient authentication method details. It contains the following elements:\n\n* `recipMayProvideNumber`: Boolean. When set to **true**, the recipient can use whatever phone number they choose.\n* `senderProvidedNumbers`: ArrayOfStrings. A list of phone numbers the recipient can use.\n* `recordVoicePrint`: Reserved for DocuSign.\n* `validateRecipProvidedNumber`: Reserved for DocuSign.\n\n" + }, + "recipientAttachments": { + "description": "Reserved for DocuSign.", + "type": "array", + "items": { + "$ref": "#/definitions/recipientAttachment" + } + }, + "recipientAuthenticationStatus": { + "$ref": "#/definitions/authenticationStatus", + "description": "Information about the recipient's authentication status. Read only." + }, + "recipientFeatureMetadata": { + "description": "Metadata about the features that are supported for the recipient type. Read only.", + "type": "array", + "items": { + "$ref": "#/definitions/featureAvailableMetadata" + } + }, + "recipientId": { + "description": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.", + "type": "string" + }, + "recipientIdGuid": { + "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only.", + "type": "string" + }, + "recipientType": { + "description": "The recipient type, as specified by the following values:\n- `agent`: Agent recipients can add name and email information for recipients that appear after the agent in routing order.\n- `carbonCopy`: Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date, or add information to any of the documents. This type of recipient can be used in any routing order.\n- `certifiedDelivery`: Certified delivery recipients must receive the completed documents for the envelope to be completed. They don't need to sign, initial, date, or add information to any of the documents.\n- `editor`: Editors have the same management and access rights for the envelope as the sender. Editors can add name and email information, add or change the routing order, set authentication options, and can edit signature/initial tabs and data fields for the remaining recipients.\n- `inPersonSigner`: In-person recipients are DocuSign users who act as signing hosts in the same physical location as the signer.\n- `intermediaries`: Intermediary recipients can optionally add name and email information for recipients at the same or subsequent level in the routing order.\n- `seal`: Electronic seal recipients represent legal entities.\n- `signer`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope.\n- `witness`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope.", + "type": "string" + }, + "recipientTypeMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `recipientType` property is editable. Read only." + }, + "requireIdLookup": { + "description": "When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. ", + "type": "string" + }, + "requireIdLookupMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `requireIdLookup` property is editable. Read only." + }, + "roleName": { + "description": "Optional element. Specifies the role name associated with the recipient.

This property is required when you are working with template recipients.", + "type": "string" + }, + "routingOrder": { + "description": "Specifies the routing order of the recipient in the envelope. ", + "type": "string" + }, + "routingOrderMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `routingOrder` property is editable. Read only." + }, + "sentDateTime": { + "description": "The UTC DateTime when the envelope was sent. Read only.", + "type": "string" + }, + "signedDateTime": { + "description": "Reserved for DocuSign.", + "type": "string" + }, + "signingGroupId": { + "description": "When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once).", + "type": "string" + }, + "signingGroupIdMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `signingGroupId` property is editable. Read only." + }, + "signingGroupName": { + "description": "Optional. The name of the signing group. \n\nMaximum Length: 100 characters. ", + "type": "string" + }, + "signingGroupUsers": { + "description": "A complex type that contains information about users in the signing group.", + "type": "array", + "items": { + "$ref": "#/definitions/userInfo" + } + }, + "smsAuthentication": { + "$ref": "#/definitions/recipientSMSAuthentication", + "description": "When `idCheckConfigurationName` is set to `SMS Auth $`, you use this complex type to provide the recipient authentication method details. It contains the element `senderProvidedNumbers`, which is an array of phone numbers that the recipient can use for SMS text authentication. \n\n" + }, + "socialAuthentications": { + "description": "Deprecated.", + "type": "array", + "items": { + "$ref": "#/definitions/socialAuthentication" + } + }, + "status": { + "description": "The recipient's status. Read only. \n\nPossible values:\n\n- `autoresponded`: The recipient's email system auto-responded to the email from DocuSign. This status is used in the web console to inform senders about the bounced-back email. This recipient status is only used if **Send-on-behalf-of** is turned off for the account.\n- `completed`: The recipient has completed their actions (signing or other required actions if not a signer) for an envelope.\n- `created`: The recipient is in a draft state. This value is only associated with draft envelopes (envelopes that have a status of `created`).\n- `declined`: The recipient declined to sign the document(s) in the envelope.\n- `delivered`: The recipient has viewed the document(s) in an envelope through the DocuSign signing website. This is not an email delivery of the documents in an envelope.\n- `faxPending`: The recipient has finished signing and the system is waiting for a fax attachment from the recipient before completing their signing step.\n- `sent`: The recipient has been sent an email notification that it is their turn to sign an envelope.\n- `signed`: The recipient has completed (signed) all required tags in an envelope. This is a temporary state during processing, after which the recipient's status automatically switches to `completed`.", + "type": "string" + }, + "statusCode": { + "description": "The code associated with the recipient's status. Read only.", + "type": "string" + }, + "suppressEmails": { + "description": "When set to **true**, email notifications are suppressed for the recipient, and they must access envelopes and documents from their DocuSign inbox.", + "type": "string" + }, + "templateLocked": { + "description": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ", + "type": "string" + }, + "templateRequired": { + "description": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.", + "type": "string" + }, + "totalTabCount": { + "description": "The total number of tabs in the documents. Read only.", + "type": "string" + }, + "userId": { + "description": "The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.\n", + "type": "string" + } + }, + "x-ds-definition-name": "agent", + "x-ms-summary": "Contains information about an agent recipient. An agent is a recipient who can add name and email information for recipients that appear after the agent in routing order." + }, + "apiRequestLog": { + "description": "Contains API request log information.", + "type": "object", + "properties": { + "createdDateTime": { + "description": "The UTC DateTime when the item was created.", + "type": "string" + }, + "description": { + "description": "A sender-defined description of the line item.\n", + "type": "string" + }, + "requestLogId": { + "description": "", + "type": "string" + }, + "status": { + "description": "Indicates the envelope status. Valid values are:\n\n* sent - The envelope is sent to the recipients. \n* created - The envelope is saved as a draft and can be modified and sent later.", + "type": "string" + } + }, + "x-ds-definition-name": "apiRequestLog", + "x-ms-summary": "Contains API request log information." + }, + "apiRequestLogsResult": { + "description": "Contains information about mutiple API request logs.", + "type": "object", + "properties": { + "apiRequestLogs": { + "description": "Reserved: TBD", + "type": "array", + "items": { + "$ref": "#/definitions/apiRequestLog" + } + } + }, + "x-ds-definition-name": "apiRequestLogsResult", + "x-ms-summary": "Contains information about mutiple API request logs." + }, + "approve": { + "type": "object", + "properties": { + "anchorAllowWhiteSpaceInCharacters": { + "description": "", + "type": "string" + }, + "anchorAllowWhiteSpaceInCharactersMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "" + }, + "anchorCaseSensitive": { + "description": "This property controls how [anchor tabs][AnchorTabs] are placed. When **true**, the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false**.\n\nFor example, when set to **true**, if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When set to **false**, `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**.\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place", + "type": "string" + }, + "anchorCaseSensitiveMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorCaseSensitive` property is editable." + }, + "anchorHorizontalAlignment": { + "description": "This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are :\n\n- `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value.\n- `right`: Aligns the tab’s left side with the last character of the matching anchor word.\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place\n", + "type": "string" + }, + "anchorHorizontalAlignmentMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorHorizontalAlignment` property is editable." + }, + "anchorIgnoreIfNotPresent": { + "description": "When set to **true**, this tab is ignored if the `anchorString` is not found in the document.", + "type": "string" + }, + "anchorIgnoreIfNotPresentMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable." + }, + "anchorMatchWholeWord": { + "description": "When set to **true**, the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false**.\n\nFor example, when set to **true**, if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When set to **false**, if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**.\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTab]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place\n", + "type": "string" + }, + "anchorMatchWholeWordMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorMatchWholeWord` property is editable." + }, + "anchorString": { + "description": "Specifies the string to find in the document and use as the basis for tab placement.", + "type": "string" + }, + "anchorStringMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorString` property is editable." + }, + "anchorTabProcessorVersion": { + "description": "Reserved for DocuSign.", + "type": "string" + }, + "anchorTabProcessorVersionMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Reserved for DocuSign." + }, + "anchorUnits": { + "description": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n", + "type": "string" + }, + "anchorUnitsMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorUnits` property is editable." + }, + "anchorXOffset": { + "description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n", + "type": "string" + }, + "anchorXOffsetMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorXOffset` property is editable." + }, + "anchorYOffset": { + "description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n", + "type": "string" + }, + "anchorYOffsetMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorYOffset` property is editable." + }, + "bold": { + "description": "When set to **true**, the information in the tab is bold.", + "type": "string" + }, + "boldMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `bold` property is editable." + }, + "buttonText": { + "description": " Specifies the approval text that displays in the tab. ", + "type": "string" + }, + "buttonTextMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `buttonText` property is editable." + }, + "conditionalParentLabel": { + "description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility.", + "type": "string" + }, + "conditionalParentLabelMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `conditionalParentLabel` property is editable." + }, + "conditionalParentValue": { + "description": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use \"on\" as the value to show that the parent tab is active.\n", + "type": "string" + }, + "conditionalParentValueMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `conditionalParentValue` property is editable." + }, + "customTabId": { + "description": "The DocuSign-generated custom tab ID for the custom tab to be applied. You can only use this when adding new tabs for a recipient. When used, the new tab inherits all of the properties of the custom tab.", + "type": "string" + }, + "customTabIdMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `customTabId` property is editable." + }, + "documentId": { + "description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.", + "type": "string" + }, + "documentIdMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `documentId` property is editable." + }, + "errorDetails": { + "$ref": "#/definitions/errorDetails", + "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." + }, + "font": { + "description": "The font to be used for the tab value. Supported fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n", + "type": "string" + }, + "fontColor": { + "description": "The font color to use for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n", + "type": "string" + }, + "fontColorMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `fontColor` property is editable." + }, + "fontMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `font` property is editable." + }, + "fontSize": { + "description": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72", + "type": "string" + }, + "fontSizeMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `fontSize` property is editable." + }, + "formOrder": { + "description": "An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block.", + "type": "string" + }, + "formOrderMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `formOrder` property is editable." + }, + "formPageLabel": { + "description": "A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience.", + "type": "string" + }, + "formPageLabelMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `formPageLabel` property is editable." + }, + "formPageNumber": { + "description": "An integer specifying the order in which to present the guided form pages.", + "type": "string" + }, + "formPageNumberMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `fromPageNumber` property is editable." + }, + "height": { + "description": "The height of the tab in pixels.", + "type": "string" + }, + "heightMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `height` property is editable." + }, + "italic": { + "description": "When set to **true**, the information in the tab is italic.", + "type": "string" + }, + "italicMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `italic` property is editable." + }, + "localePolicy": { + "$ref": "#/definitions/localePolicyTab", + "description": "Reserved for DocuSign." + }, + "mergeField": { + "$ref": "#/definitions/mergeField", + "description": "Contains the information necessary to map the tab to a field in SalesForce." + }, + "mergeFieldXml": { + "description": "", + "type": "string" + }, + "pageNumber": { + "description": "Specifies the page number on which the tab is located. For supplemental documents, this value must be `1`.\n", + "type": "string" + }, + "pageNumberMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `pageNumber` property is editable." + }, + "recipientId": { + "description": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.", + "type": "string" + }, + "recipientIdGuid": { + "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only.", + "type": "string" + }, + "recipientIdGuidMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `recipientIdGuid` property is editable." + }, + "recipientIdMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `recipientId` property is editable." + }, + "smartContractInformation": { + "$ref": "#/definitions/smartContractInformation", + "description": "" + }, + "status": { + "description": "The status of the tab. Possible values are:\n\n- `active`: The tab is active, but the recipient has not yet interacted with it.\n- `signed`: The recipient signed the tab.\n- `declined`: The recipient declined the envelope.\n- `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`).", + "type": "string" + }, + "statusMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `status` property is editable." + }, + "tabGroupLabels": { + "description": "An array of tab group labels that uniquely identify tab groups. To assign a tab to a `tabGroup`, you assign the `TabGroupLabel` to the `Tab.TabGroupLabels` array.", + "type": "array", + "items": { + "type": "string" + } + }, + "tabGroupLabelsMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `tabGroupLabels` property is editable." + }, + "tabId": { + "description": "The unique identifier for the tab.", + "type": "string" + }, + "tabIdMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `tabId` property is editable." + }, + "tabLabel": { + "description": "The label associated with the tab. This value may be an empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum Length: 500 characters.\n", + "type": "string" + }, + "tabLabelMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `tabLabel` property is editable." + }, + "tabOrder": { + "description": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.", + "type": "string" + }, + "tabOrderMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `tabOrder` property is editable." + }, + "tabType": { + "description": "Indicates the type of tab (for example, `signHere` or `initialHere`).", + "type": "string" + }, + "tabTypeMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `tabType` property is editable." + }, + "templateLocked": { + "description": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ", + "type": "string" + }, + "templateLockedMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `templateLocked` property is editable." + }, + "templateRequired": { + "description": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.", + "type": "string" + }, + "templateRequiredMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `templateRequired` property is editable." + }, + "tooltip": { + "description": "The text of a tooltip that appears when a user hovers over a form field or tab.", + "type": "string" + }, + "toolTipMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `toolTip` property is editable." + }, + "underline": { + "description": "When set to **true**, the information in the tab is underlined.", + "type": "string" + }, + "underlineMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `underline` property is editable." + }, + "width": { + "description": "The width of the tab in pixels.", + "type": "string" + }, + "widthMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `width` property is editable." + }, + "xPosition": { + "description": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n", + "type": "string" + }, + "xPositionMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `xPosition` property is editable." + }, + "yPosition": { + "description": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n", + "type": "string" + }, + "yPositionMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `yPosition` property is editable." + } + }, + "x-ds-definition-name": "approve", + "description": "A tab that allows the recipient to approve documents\nwithout placing a signature or initials on the\ndocument.\n", + "x-ms-summary": "A tab that allows the recipient to approve documents\nwithout placing a signature or initials on the\ndocument.\n" + }, + "appStoreProduct": { + "description": "Contains information about an APP store product.", + "type": "object", + "properties": { + "marketPlace": { + "description": "", + "type": "string" + }, + "productId": { + "description": "The Product ID from the AppStore.", + "type": "string" + } + }, + "x-ds-definition-name": "appStoreProduct", + "x-ms-summary": "Contains information about an APP store product." + }, + "appStoreReceipt": { + "description": "Contains information about an APP store receipt.", + "type": "object", + "properties": { + "productId": { + "description": "The Product ID from the AppStore.", + "type": "string" + }, + "receiptData": { + "description": "Reserved: TBD", + "type": "string" + } + }, + "x-ds-definition-name": "appStoreReceipt", + "x-ms-summary": "Contains information about an APP store receipt." + }, + "askAnAdmin": { + "type": "object", + "properties": { + "email": { + "description": "", + "type": "string" + }, + "message": { + "description": "", + "type": "string" + }, + "name": { + "description": "", + "type": "string" + }, + "phone": { + "description": "", + "type": "string" + } + }, + "x-ds-definition-name": "askAnAdmin", + "description": "", + "x-ms-summary": "" + }, + "attachment": { + "description": "Contains information about an attachment.", + "type": "object", + "properties": { + "accessControl": { + "description": "Valid values are `sender` and `senderAndAllRecipients`.", + "type": "string" + }, + "attachmentId": { + "description": "The unique identifier for the attachment.", + "type": "string" + }, + "attachmentType": { + "description": "Specifies the type of the attachment for the recipient.", + "type": "string" + }, + "data": { + "description": "A Base64-encoded representation of the attachment that is used to upload and download the file. File attachments may be up to 50 MB in size.", + "type": "string" + }, + "label": { + "description": "A label for the attachment. Potential values include: \n\n- `guidedForm`: [Guided forms](https://www.docusign.com/products/guided-forms) provide a step-by-step, mobile-ready experience to help signers easily complete long or complex forms.\n- `eventNotifications`: A list of envelope-level event statuses that trigger Connect to send updates to the endpoint specified in the `url` property. \n", + "type": "string" + }, + "name": { + "description": "The name of the attachment.", + "type": "string" + }, + "remoteUrl": { + "description": "The URL of a previously staged chunked upload. Using a chunked upload enables you to stage a large, chunkable temp file. You then use the `remoteUrl` property to reference the chunked upload as the content in attachment and document-related requests. The `remoteUrl` property cannot be used for downloads.", + "type": "string" + } + }, + "x-ds-definition-name": "attachment", + "x-ms-summary": "Contains information about an attachment." + }, + "authenticationMethod": { + "description": "Contains information about the method used for authentication.", + "type": "object", + "properties": { + "authenticationType": { + "description": "Indicates the type of authentication. Valid values are: PhoneAuth, STAN, ISCheck, OFAC, AccessCode, AgeVerify, or SSOAuth. ", + "type": "string" + }, + "lastProvider": { + "description": "The last provider that authenticated the user. ", + "type": "string" + }, + "lastTimestamp": { + "description": " The data and time the user last used the authentication method. ", + "type": "string" + }, + "totalCount": { + "description": "The number of times the authentication method was used. ", + "type": "string" + } + }, + "x-ds-definition-name": "authenticationMethod", + "x-ms-summary": "Contains information about the method used for authentication." + }, + "authenticationStatus": { + "description": "A complex element that contains information about a user's authentication status.", + "type": "object", + "properties": { + "accessCodeResult": { + "$ref": "#/definitions/eventResult", + "description": "The result of a user's attempt to authenticate by using an access code. It returns:\n\n- `Status`: `Pass` or `Fail`.\n- `dateTime`: The date and time that the event occurred.\n- `FailureDescription`: A string containing the details about a failed authentication.\n- `VendorFailureStatusCode`: A string containing the vendor's status code for a failed authentication. " + }, + "ageVerifyResult": { + "$ref": "#/definitions/eventResult", + "description": "The result of an age verification check. It returns:\n\n- `Status`: `Pass` or `Fail`.\n- `dateTime`: The date and time that the event occurred.\n- `FailureDescription`: A string containing the details about a failed authentication.\n- `VendorFailureStatusCode`: A string containing the vendor's status code for a failed authentication. " + }, + "anySocialIDResult": { + "$ref": "#/definitions/eventResult", + "description": "Deprecated." + }, + "facebookResult": { + "$ref": "#/definitions/eventResult", + "description": "Deprecated." + }, + "googleResult": { + "$ref": "#/definitions/eventResult", + "description": "Deprecated." + }, + "identityVerificationResult": { + "$ref": "#/definitions/eventResult", + "description": "The result of an [Identity Verification][IDV] workflow.\n\n[IDV]: https://developers.docusign.com/docs/esign-rest-api/reference/Accounts/IdentityVerifications/" + }, + "idLookupResult": { + "$ref": "#/definitions/eventResult", + "description": "The result of an ID lookup authentication check. It returns:\n\n- `Status`: `Pass` or `Fail`.\n- `dateTime`: The date and time that the event occurred.\n- `FailureDescription`: A string containing the details about a failed authentication.\n- `VendorFailureStatusCode`: A string containing the vendor's status code for a failed authentication. " + }, + "idQuestionsResult": { + "$ref": "#/definitions/eventResult", + "description": "The result of the user's answers to ID challenge questions. It returns:\n\n- `Status`: `Pass` or `Fail`.\n- `dateTime`: The date and time that the event occurred.\n- `FailureDescription`: A string containing the details about a failed authentication.\n- `VendorFailureStatusCode`: A string containing the vendor's status code for a failed authentication. " + }, + "linkedinResult": { + "$ref": "#/definitions/eventResult", + "description": "Deprecated." + }, + "liveIDResult": { + "$ref": "#/definitions/eventResult", + "description": "Deprecated." + }, + "ofacResult": { + "$ref": "#/definitions/eventResult", + "description": "The result of an Office of Foreign Asset Control (OFAC) check. It returns:\n\n- `Status`: `Pass` or `Fail`.\n- `dateTime`: The date and time that the event occurred.\n- `FailureDescription`: A string containing the details about a failed authentication.\n- `VendorFailureStatusCode`: A string containing the vendor's status code for a failed authentication. " + }, + "openIDResult": { + "$ref": "#/definitions/eventResult", + "description": "Deprecated." + }, + "phoneAuthResult": { + "$ref": "#/definitions/eventResult", + "description": "The result of the user's attempt to authenticate by using two-factor authentication (2FA) through phone messaging. It returns:\n\n- `Status`: `Pass` or `Fail`.\n- `dateTime`: The date and time that the event occurred.\n- `FailureDescription`: A string containing the details about a failed authentication.\n- `VendorFailureStatusCode`: A string containing the vendor's status code for a failed authentication. " + }, + "salesforceResult": { + "$ref": "#/definitions/eventResult", + "description": "Success/failure result of authentication using sign-in with a Salesforce account. It returns:\n\n- `Status`: `Pass` or `Fail`.\n- `dateTime`: The date and time that the event occurred.\n- `FailureDescription`: A string containing the details about a failed authentication.\n- `VendorFailureStatusCode`: A string containing the vendor's status code for a failed authentication. " + }, + "signatureProviderResult": { + "$ref": "#/definitions/eventResult", + "description": "The result of the user's attempt to authenticate by using a signature provider." + }, + "smsAuthResult": { + "$ref": "#/definitions/eventResult", + "description": "The result of the user's attempt to authenticate by using two-factor authentication (2FA) through SMS messaging on a mobile phone." + }, + "sTANPinResult": { + "$ref": "#/definitions/eventResult", + "description": "The result of a Student Authentication Network (STAN) authentication check. It returns:\n\n- `Status`: `Pass` or `Fail`.\n- `dateTime`: The date and time that the event occurred.\n- `FailureDescription`: A string containing the details about a failed authentication.\n- `VendorFailureStatusCode`: A string containing the vendor's status code for a failed authentication. " + }, + "twitterResult": { + "$ref": "#/definitions/eventResult", + "description": "Deprecated." + }, + "yahooResult": { + "$ref": "#/definitions/eventResult", + "description": "Deprecated." + } + }, + "x-ds-definition-name": "authenticationStatus", + "x-ms-summary": "A complex element that contains information about a user's authentication status." + }, + "bccEmailAddress": { + "description": "Contains information about the BCC email address.", + "type": "object", + "properties": { + "bccEmailAddressId": { + "description": "Only users with canManageAccount setting can use this option. An array of up to 5 email addresses the envelope is sent to as a BCC email. \n \nExample: If your account has BCC for Email Archive set up for the email address 'archive@mycompany.com' and you send an envelope using the BCC Email Override to send a BCC email to 'salesarchive@mycompany.com', then a copy of the envelope is only sent to the 'salesarchive@mycompany.com' email address.", + "type": "string" + }, + "email": { + "description": "Specifies the BCC email address. DocuSign verifies that the email format is correct, but does not verify that the email is active.Using this overrides the BCC for Email Archive information setting for this envelope.\n\nMaximum of length: 100 characters. ", + "type": "string" + } + }, + "x-ds-definition-name": "bccEmailAddress", + "x-ms-summary": "Contains information about the BCC email address." + }, + "bccEmailArchive": { + "type": "object", + "properties": { + "accountId": { + "description": "The id of the account that owns the BCC email archive configuration.", + "type": "string" + }, + "bccEmailArchiveId": { + "description": "The id of the BCC email archive configuration.", + "type": "string" + }, + "created": { + "description": "The UTC DateTime when the BCC email archive configuration was created.", + "type": "string" + }, + "createdBy": { + "$ref": "#/definitions/userInfo", + "description": "Details about the user who created the BCC email archive configuration." + }, + "email": { + "description": "The BCC email address to use for archiving DocuSign messages.\n\nExample: customer_bcc@example.com", + "type": "string" + }, + "emailNotificationId": { + "description": "The GUID of the activation email message sent to the BCC email address.", + "type": "string" + }, + "modified": { + "description": "The UTC DateTime when the BCC email archive configuration was last modified.", + "type": "string" + }, + "modifiedBy": { + "$ref": "#/definitions/userInfo", + "description": "Details about the user who last modified the BCC email archive configuration." + }, + "status": { + "description": "The status of the BCC email address. Possible values are:\n\n- `activation_sent`: An activation link has been sent to the BCC email address.\n- `active`: The BCC email address is actively used for archiving.\n- `closed`: The BCC email address is no longer used for archiving.", + "type": "string" + }, + "uri": { + "description": "The helper URI for retrieving the BCC email archive.", + "type": "string" + } + }, + "x-ds-definition-name": "bccEmailArchive", + "description": "This object contains information abut a BCC email archive configuration (a BCC email address used to archive DocuSign-generated emails).", + "x-ms-summary": "This object contains information abut a BCC email archive configuration (a BCC email address used to archive DocuSign-generated emails)." + }, + "bccEmailArchiveHistory": { + "type": "object", + "properties": { + "accountId": { + "description": "The id of the account that owns the BCC email archive configuration.", + "type": "string" + }, + "action": { + "description": "The action taken on the BCC email archive configuration.\n\nExamples: \n\n- `CREATED`: The BCC email archive configuration has been created.\n- `UPDATED`: The BCC email address has been activated by clicking on the activation link in the activation email message.\n- `CLOSED`: The BCC email address has been marked as closed is no longer used for archiving.", + "type": "string" + }, + "email": { + "description": "The BCC email address used to archive the emails that DocuSign generates. \n\nExample: customer_bcc@example.com", + "type": "string" + }, + "modified": { + "description": "The UTC DateTime when the BCC email address was last modified.", + "type": "string" + }, + "modifiedBy": { + "$ref": "#/definitions/userInfo", + "description": "Details about the user who last modified the BCC email archive configuration." + }, + "status": { + "description": "The status of the BCC email address. Possible values are:\n\n- `activation_sent`: An activation link has been sent to the BCC email address.\n- `active`: The BCC email address is actively used for archiving.\n- `closed`: The BCC email address is no longer used for archiving.", + "type": "string" + } + }, + "x-ds-definition-name": "bccEmailArchiveHistory", + "description": "Contains details about the history of the BCC email archive configuration.", + "x-ms-summary": "Contains details about the history of the BCC email archive configuration." + }, + "bccEmailArchiveHistoryList": { + "type": "object", + "properties": { + "bccEmailArchiveHistory": { + "description": "A list of changes to the BCC email archive configuration.", + "type": "array", + "items": { + "$ref": "#/definitions/bccEmailArchiveHistory" + } + }, + "endPosition": { + "description": "The last index position in the result set. ", + "type": "string" + }, + "nextUri": { + "description": "The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. ", + "type": "string" + }, + "previousUri": { + "description": "The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. ", + "type": "string" + }, + "resultSetSize": { + "description": "The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`.", + "type": "string" + }, + "startPosition": { + "description": "The starting index position of the current result set.", + "type": "string" + }, + "totalSetSize": { + "description": "The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`.", + "type": "string" + } + }, + "x-ds-definition-name": "bccEmailArchiveHistoryList", + "description": "", + "x-ms-summary": "" + }, + "bccEmailArchiveList": { + "type": "object", + "properties": { + "bccEmailArchives": { + "description": "A list of BCC email archive configurations.", + "type": "array", + "items": { + "$ref": "#/definitions/bccEmailArchive" + } + }, + "endPosition": { + "description": "The last index position in the result set. ", + "type": "string" + }, + "nextUri": { + "description": "The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. ", + "type": "string" + }, + "previousUri": { + "description": "The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. ", + "type": "string" + }, + "resultSetSize": { + "description": "The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`.", + "type": "string" + }, + "startPosition": { + "description": "The starting index position of the current result set.", + "type": "string" + }, + "totalSetSize": { + "description": "The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`.", + "type": "string" + } + }, + "x-ds-definition-name": "bccEmailArchiveList", + "description": "Contains a list of BCC email archive configurations.", + "x-ms-summary": "Contains a list of BCC email archive configurations." + }, + "billingCharge": { + "description": "Contains information about a billing charge.", + "type": "object", + "properties": { + "allowedQuantity": { + "description": "Reserved: TBD", + "type": "string" + }, + "blocked": { + "description": "Reserved: TBD", + "type": "string" + }, + "chargeName": { + "description": "Provides information on what services the charge item is for.\n\nThe following table provides a description of the different chargeName values available at this time.\n\n| chargeName | Description |\n| --- | --- |\n| id_check | ID Check Charge |\n| in_person_signing | In Person Signing charge |\n| envelopes Included | Sent Envelopes for the account |\n| age_verify | Age verification check |\n| ofac | OFAC Check |\n| id_confirm | ID confirmation check |\n| student_authentication | STAN PIN authentication check |\n| wet_sign_fax | Pages for returning signed documents by fax |\n| attachment_fax | Pages for returning attachments by fax |\n| phone_authentication | Phone authentication charge |\n| powerforms | PowerForm envelopes sent |\n| signer_payments | Payment processing charge |\n| outbound_fax | Send by fax charge |\n| bulk_recipient_envelopes | Bulk Recipient Envelopes sent |\n| sms_authentications | SMS authentication charge |\n| saml_authentications | SAML authentication charge |\n| express_signer_certificate | DocuSign Express Certificate charge |\n| personal_signer_certificate | Personal Signer Certificate charge |\n| safe_certificate | SAFE BioPharma Signer Certificate charge |\n| seats | Included active seats charge |\n| open_trust_certificate | OpenTrust Signer Certificate charge |", + "type": "string" + }, + "chargeType": { + "description": "Reserved: TBD", + "type": "string" + }, + "chargeUnitOfMeasure": { + "description": "Reserved: TBD", + "type": "string" + }, + "discounts": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/billingDiscount" + } + }, + "firstEffectiveDate": { + "description": "", + "type": "string" + }, + "includedQuantity": { + "description": "", + "type": "string" + }, + "incrementalQuantity": { + "description": "Reserved: TBD", + "type": "string" + }, + "lastEffectiveDate": { + "description": "", + "type": "string" + }, + "prices": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/billingPrice" + } + }, + "unitPrice": { + "description": "Reserved: TBD", + "type": "string" + }, + "usedQuantity": { + "description": "", + "type": "string" + } + }, + "x-ds-definition-name": "billingCharge", + "x-ms-summary": "Contains information about a billing charge." + }, + "billingChargeResponse": { + "description": "Defines a billing charge response object.", + "type": "object", + "properties": { + "billingChargeItems": { + "description": "Reserved: TBD", + "type": "array", + "items": { + "$ref": "#/definitions/billingCharge" + } + } + }, + "x-ds-definition-name": "billingChargeResponse", + "x-ms-summary": "Defines a billing charge response object." + }, + "billingDiscount": { + "type": "object", + "properties": { + "beginQuantity": { + "description": "Reserved: TBD", + "type": "string" + }, + "discount": { + "description": "", + "type": "string" + }, + "endQuantity": { + "description": "", + "type": "string" + } + }, + "x-ds-definition-name": "billingDiscount", + "description": "", + "x-ms-summary": "" + }, + "billingInvoice": { + "description": "Contains information about a billing invoice.", + "type": "object", + "properties": { + "amount": { + "description": "The total amount of the purchase.", + "type": "string" + }, + "balance": { + "description": "Reserved: TBD", + "type": "string" + }, + "dueDate": { + "description": "Reserved: TBD", + "type": "string" + }, + "invoiceId": { + "description": "Reserved: TBD", + "type": "string" + }, + "invoiceItems": { + "description": "Reserved: TBD", + "type": "array", + "items": { + "$ref": "#/definitions/billingInvoiceItem" + } + }, + "invoiceNumber": { + "description": "Reserved: TBD", + "type": "string" + }, + "invoiceUri": { + "description": "Contains a URI for an endpoint that you can use to retrieve invoice information.", + "type": "string" + }, + "nonTaxableAmount": { + "description": "", + "type": "string" + }, + "pdfAvailable": { + "description": "", + "type": "string" + }, + "taxableAmount": { + "description": "", + "type": "string" + } + }, + "x-ds-definition-name": "billingInvoice", + "x-ms-summary": "Contains information about a billing invoice." + }, + "billingInvoiceItem": { + "description": "Contains information about an item on a billing invoice.", + "type": "object", + "properties": { + "chargeAmount": { + "description": "Reserved: TBD", + "type": "string" + }, + "chargeName": { + "description": "Reserved: TBD", + "type": "string" + }, + "invoiceItemId": { + "description": "Reserved: TBD", + "type": "string" + }, + "quantity": { + "description": "The quantity of envelopes to add to the account.", + "type": "string" + }, + "unitPrice": { + "description": "Reserved: TBD", + "type": "string" + } + }, + "x-ds-definition-name": "billingInvoiceItem", + "x-ms-summary": "Contains information about an item on a billing invoice." + }, + "billingInvoicesResponse": { + "description": "Defines a billing invoice response object.", + "type": "object", + "properties": { + "billingInvoices": { + "description": "Reserved: TBD", + "type": "array", + "items": { + "$ref": "#/definitions/billingInvoice" + } + }, + "nextUri": { + "description": "The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. ", + "type": "string" + }, + "previousUri": { + "description": "The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. ", + "type": "string" + } + }, + "x-ds-definition-name": "billingInvoicesResponse", + "x-ms-summary": "Defines a billing invoice response object." + }, + "billingInvoicesSummary": { + "type": "object", + "properties": { + "billingInvoices": { + "description": "Reserved: TBD", + "type": "array", + "items": { + "$ref": "#/definitions/billingInvoice" + } + }, + "pastDueBalance": { + "description": "", + "type": "string" + }, + "paymentAllowed": { + "description": "", + "type": "string" + } + }, + "x-ds-definition-name": "billingInvoicesSummary", + "description": "", + "x-ms-summary": "" + }, + "billingPayment": { + "description": "Contains information on a billing plan.", + "type": "object", + "properties": { + "amount": { + "description": "Reserved: TBD", + "type": "string" + }, + "invoiceId": { + "description": "Reserved: TBD", + "type": "string" + }, + "paymentId": { + "description": "", + "type": "string" + } + }, + "x-ds-definition-name": "billingPayment", + "x-ms-summary": "Contains information on a billing plan." + }, + "billingPaymentItem": { + "description": "Defines a billing payment request object.", + "type": "object", + "properties": { + "amount": { + "description": "The total amount of the purchase.", + "type": "string" + }, + "description": { + "description": "A sender-defined description of the line item.\n", + "type": "string" + }, + "paymentDate": { + "description": "", + "type": "string" + }, + "paymentId": { + "description": "", + "type": "string" + }, + "paymentNumber": { + "description": "When set to **true**, a PDF version of the invoice is available. \n\nTo get the PDF, make the call again and change \"Accept:\" in the header to \"Accept: application/pdf\".", + "type": "string" + } + }, + "x-ds-definition-name": "billingPaymentItem", + "x-ms-summary": "Defines a billing payment request object." + }, + "billingPaymentRequest": { + "type": "object", + "properties": { + "paymentAmount": { + "description": "The payment amount for the past due invoices. This value must match the pastDueBalance value retrieved using Get Past Due Invoices.", + "type": "string" + } + }, + "x-ds-definition-name": "billingPaymentRequest", + "description": "", + "x-ms-summary": "" + }, + "billingPaymentResponse": { + "description": "Defines an billing payment response object.", + "type": "object", + "properties": { + "billingPayments": { + "description": "Reserved: TBD", + "type": "array", + "items": { + "$ref": "#/definitions/billingPayment" + } + } + }, + "x-ds-definition-name": "billingPaymentResponse", + "x-ms-summary": "Defines an billing payment response object." + }, + "billingPaymentsResponse": { + "description": "Defines a billing payments response object.", + "type": "object", + "properties": { + "billingPayments": { + "description": "Reserved: TBD", + "type": "array", + "items": { + "$ref": "#/definitions/billingPaymentItem" + } + }, + "nextUri": { + "description": "The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. ", + "type": "string" + }, + "previousUri": { + "description": "The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. ", + "type": "string" + } + }, + "x-ds-definition-name": "billingPaymentsResponse", + "x-ms-summary": "Defines a billing payments response object." + }, + "billingPlan": { + "description": "Contains information about a billing plan.", + "type": "object", + "properties": { + "appStoreProducts": { + "description": "Reserved for DocuSign.", + "type": "array", + "items": { + "$ref": "#/definitions/appStoreProduct" + } + }, + "currencyPlanPrices": { + "description": "Contains the `currencyCode` and `currencySymbol` for the alternate currency values for `envelopeFee`, `fixedFee`, and `seatFee` that are configured for this plan feature set.", + "type": "array", + "items": { + "$ref": "#/definitions/currencyPlanPrice" + } + }, + "enableSupport": { + "description": "When set to **true**, customer support is provided as part of the account plan.", + "type": "string" + }, + "includedSeats": { + "description": "The number of seats (users) included in the plan.", + "type": "string" + }, + "otherDiscountPercent": { + "description": "Any other percentage discount for the plan.\n\nExample: `\"0.00\"`", + "type": "string" + }, + "paymentCycle": { + "description": " The payment cycle associated with the plan. The possible values are: Monthly or Annually. ", + "type": "string" + }, + "paymentMethod": { + "description": "The payment method used for the billing plan. Valid values are:\n\n- `NotSupported`\n- `CreditCard`\n- `PurchaseOrder`\n- `Premium`\n- `Freemium`\n- `FreeTrial`\n- `AppStore`\n- `DigitalExternal`\n- `DirectDebit`", + "type": "string" + }, + "perSeatPrice": { + "description": "The per seat price for the plan.", + "type": "string" + }, + "planClassification": { + "description": "Identifies the type of plan. Examples include:\n\n- `business`\n- `corporate`\n- `enterprise` \n- `free`", + "type": "string" + }, + "planFeatureSets": { + "description": "Reserved for DocuSign.", + "type": "array", + "items": { + "$ref": "#/definitions/featureSet" + } + }, + "planId": { + "description": "DocuSign's id for the account plan.", + "type": "string" + }, + "planName": { + "description": "\n", + "type": "string" + }, + "seatDiscounts": { + "description": "A complex type that returns information about any seat discounts. It contains the information `BeginSeatCount`, `EndSeatCount` and `SeatDiscountPercent`.", + "type": "array", + "items": { + "$ref": "#/definitions/seatDiscount" + } + }, + "supportIncidentFee": { + "description": "The support incident fee charged for each support incident.\n\nExample: `\"$0.00\"`", + "type": "string" + }, + "supportPlanFee": { + "description": "The support plan fee charged for this plan.\n\nExample: `\"$0.00\"`", + "type": "string" + } + }, + "x-ds-definition-name": "billingPlan", + "x-ms-summary": "Contains information about a billing plan." + }, + "billingPlanInformation": { + "type": "object", + "properties": { + "appStoreReceipt": { + "$ref": "#/definitions/appStoreReceipt", + "description": "" + }, + "billingAddress": { + "$ref": "#/definitions/accountAddress", + "description": "The billing address for the account." + }, + "creditCardInformation": { + "$ref": "#/definitions/creditCardInformation", + "description": "A complex type that has information about the credit card used to pay for this account." + }, + "directDebitProcessorInformation": { + "$ref": "#/definitions/directDebitProcessorInformation", + "description": "Information about the bank that processes direct debits for the payment plan." + }, + "downgradeReason": { + "description": "(Optional) The user's reason for downgrading their billing plan.", + "type": "string" + }, + "enableSupport": { + "description": "When set to **true**, customer support is provided as part of the account plan.", + "type": "string" + }, + "includedSeats": { + "description": "The number of seats (users) included in the plan.", + "type": "string" + }, + "incrementalSeats": { + "description": "Reserved for DocuSign.", + "type": "string" + }, + "paymentMethod": { + "description": "The payment method used for the billing plan. Valid values are:\n\n- `NotSupported`\n- `CreditCard`\n- `PurchaseOrder`\n- `Premium`\n- `Freemium`\n- `FreeTrial`\n- `AppStore`\n- `DigitalExternal`\n- `DirectDebit`", + "type": "string" + }, + "paymentProcessorInformation": { + "$ref": "#/definitions/paymentProcessorInformation", + "description": "Information about the entity that processes payments for the billing plan." + }, + "planInformation": { + "$ref": "#/definitions/planInformation", + "description": "An object used to identify the features and attributes of the account being created." + }, + "referralInformation": { + "$ref": "#/definitions/referralInformation", + "description": "A complex type that contains properties for entering referral and discount information." + }, + "renewalStatus": { + "description": "The renewal status of the account. Possible values are:\n\n- `auto`: The account automatically renews. \n- `queued_for_close`: The account will be closed at the billingPeriodEndDate. \n- queued_for_downgrade`: The account will be downgraded at the `billingPeriodEndDate`.", + "type": "string" + }, + "saleDiscountAmount": { + "description": "Reserved for DocuSign.", + "type": "string" + }, + "saleDiscountFixedAmount": { + "description": "Reserved for DocuSign.", + "type": "string" + }, + "saleDiscountPercent": { + "description": "Reserved for DocuSign.", + "type": "string" + }, + "saleDiscountPeriods": { + "description": "Reserved for DocuSign.", + "type": "string" + }, + "saleDiscountSeatPriceOverride": { + "description": "Reserved for DocuSign.", + "type": "string" + } + }, + "x-ds-definition-name": "billingPlanInformation", + "description": "This object contains details about a billing plan.", + "x-ms-summary": "This object contains details about a billing plan." + }, + "billingPlanPreview": { + "description": "Information used to provide a preview of a billing plan.", + "type": "object", + "properties": { + "currencyCode": { + "description": "Specifies the ISO currency code for the account.", + "type": "string" + }, + "invoice": { + "$ref": "#/definitions/billingInvoice", + "description": "" + }, + "isProrated": { + "description": "When set to **true**, the billing plan is prorated.", + "type": "string" + }, + "subtotalAmount": { + "description": "", + "type": "string" + }, + "taxAmount": { + "description": "", + "type": "string" + }, + "totalAmount": { + "description": "", + "type": "string" + } + }, + "x-ds-definition-name": "billingPlanPreview", + "x-ms-summary": "Information used to provide a preview of a billing plan." + }, + "billingPlanResponse": { + "description": "Defines a billing plan response object.", + "type": "object", + "properties": { + "billingPlan": { + "$ref": "#/definitions/billingPlan", + "description": "An object that contains details about the billing plan." + }, + "successorPlans": { + "description": "A list of billing plans that the current billing plan can be rolled into.", + "type": "array", + "items": { + "$ref": "#/definitions/billingPlan" + } + } + }, + "x-ds-definition-name": "billingPlanResponse", + "x-ms-summary": "Defines a billing plan response object." + }, + "billingPlansResponse": { + "description": "Defines a billing plans response object.", + "type": "object", + "properties": { + "billingPlans": { + "description": "Reserved: TBD", + "type": "array", + "items": { + "$ref": "#/definitions/billingPlan" + } + } + }, + "x-ds-definition-name": "billingPlansResponse", + "x-ms-summary": "Defines a billing plans response object." + }, + "billingPlanUpdateResponse": { + "description": "Defines a billing plan update response object.", + "type": "object", + "properties": { + "accountPaymentMethod": { + "description": "The type of payment method used for the account. Valid values are:\n\n- `credit_card`\n- ", + "type": "string" + }, + "billingPlanPreview": { + "$ref": "#/definitions/billingPlanPreview", + "description": "" + }, + "currencyCode": { + "description": "Specifies the ISO currency code for the account.", + "type": "string" + }, + "includedSeats": { + "description": "The number of seats (users) included in the plan.", + "type": "string" + }, + "paymentCycle": { + "description": "The payment cycle associated with the plan. The possible values are: \n\n- `Monthly`\n- `Annually` ", + "type": "string" + }, + "paymentMethod": { + "description": "The payment method used for the billing plan. Valid values are:\n\n- `NotSupported`\n- `CreditCard`\n- `PurchaseOrder`\n- `Premium`\n- `Freemium`\n- `FreeTrial`\n- `AppStore`\n- `DigitalExternal`\n- `DirectDebit`", + "type": "string" + }, + "planId": { + "description": "DocuSign's id for the account plan.", + "type": "string" + }, + "planName": { + "description": "The name of the billing plan used for the account.\n\nExamples: \n\n- `Personal - Annual`\n- `Unlimited Envelope Subscription - Annual Billing`", + "type": "string" + } + }, + "x-ds-definition-name": "billingPlanUpdateResponse", + "x-ms-summary": "Defines a billing plan update response object." + }, + "billingPrice": { + "type": "object", + "properties": { + "beginQuantity": { + "description": "Reserved: TBD", + "type": "string" + }, + "endQuantity": { + "description": "", + "type": "string" + }, + "unitPrice": { + "description": "Reserved: TBD", + "type": "string" + } + }, + "x-ds-definition-name": "billingPrice", + "description": "", + "x-ms-summary": "" + }, + "brand": { + "type": "object", + "properties": { + "brandCompany": { + "description": "The name of the company associated with the brand.", + "type": "string" + }, + "brandId": { + "description": "The ID used to identify a specific brand in API calls.", + "type": "string" + }, + "brandLanguages": { + "description": "An array of two-letter codes for the languages that you want to use with the brand. The supported languages are:\n\n- Arabic (`ar`)\n- Armenian (`hy`)\n- Bahasa Indonesia (`id`)\n- Bahasa Malay (`ms`)\n- Bulgarian (`bg`)\n- Chinese Simplified (`zh_CN`)\n- Chinese Traditional (`zh_TW`)\n- Croatian (`hr`)\n- Czech (`cs`)\n- Danish (`da`)\n- Dutch (`nl`)\n- English UK (`en_GB`)\n- English US (`en`)\n- Estonian (`et`)\n- Farsi (`fa`)\n- Finnish (`fi`)\n- French (`fr`)\n- French Canada (`fr_CA`)\n- German (`de`)\n- Greek (`el`)\n- Hebrew (`he`)\n- Hindi (`hi`)\n- Hungarian (`hu`)\n- Italian (`it`)\n- Japanese (`ja`)\n- Korean (`ko`)\n- Latvian (`lv`)\n- Lithuanian (`lt`)\n- Norwegian (`no`)\n- Polish (`pl`)\n- Portuguese (`pt`)\n- Portuguese Brasil (`pt_BR`)\n- Romanian (`ro`)\n- Russian (`ru`)\n- Serbian (`sr`)\n- Slovak (`sk`)\n- Slovenian (`sl`)\n- Spanish (`es`)\n- Spanish Latin America (`es_MX`)\n- Swedish (`sv`)\n- Thai (`th`)\n- Turkish (`tr`)\n- Ukranian (`uk`)\n- Vietnamese (`vi`)", + "type": "array", + "items": { + "type": "string" + } + }, + "brandName": { + "description": "The name of the brand.", + "type": "string" + }, + "colors": { + "description": "An array of name-value pairs specifying the colors that the brand uses for the following elements:\n\n- Button background\n- Button text\n- Header background\n- Header text", + "type": "array", + "items": { + "$ref": "#/definitions/nameValue" + } + }, + "defaultBrandLanguage": { + "description": "The two-letter code for the language that you want to use as the brand default. The supported languages are:\n\n- Arabic (`ar`)\n- Armenian (`hy`)\n- Bahasa Indonesia (`id`)\n- Bahasa Malay (`ms`)\n- Bulgarian (`bg`)\n- Chinese Simplified (`zh_CN`)\n- Chinese Traditional (`zh_TW`)\n- Croatian (`hr`)\n- Czech (`cs`)\n- Danish (`da`)\n- Dutch (`nl`)\n- English UK (`en_GB`)\n- English US (`en`)\n- Estonian (`et`)\n- Farsi (`fa`)\n- Finnish (`fi`)\n- French (`fr`)\n- French Canada (`fr_CA`)\n- German (`de`)\n- Greek (`el`)\n- Hebrew (`he`)\n- Hindi (`hi`)\n- Hungarian (`hu`)\n- Italian (`it`)\n- Japanese (`ja`)\n- Korean (`ko`)\n- Latvian (`lv`)\n- Lithuanian (`lt`)\n- Norwegian (`no`)\n- Polish (`pl`)\n- Portuguese (`pt`)\n- Portuguese Brasil (`pt_BR`)\n- Romanian (`ro`)\n- Russian (`ru`)\n- Serbian (`sr`)\n- Slovak (`sk`)\n- Slovenian (`sl`)\n- Spanish (`es`)\n- Spanish Latin America (`es_MX`)\n- Swedish (`sv`)\n- Thai (`th`)\n- Turkish (`tr`)\n- Ukranian (`uk`)\n- Vietnamese (`vi`)", + "type": "string" + }, + "emailContent": { + "description": "Deprecated.", + "type": "array", + "items": { + "$ref": "#/definitions/brandEmailContent" + } + }, + "errorDetails": { + "$ref": "#/definitions/errorDetails", + "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." + }, + "isOverridingCompanyName": { + "description": "When **true**, the `brandCompany` property is overriding the name of the company in the account settings.", + "type": "boolean" + }, + "isSendingDefault": { + "description": "When **true**, the sending brand is the default brand for sending new envelopes.", + "type": "boolean" + }, + "isSigningDefault": { + "description": "When **true**, the siging brand is the default brand for the signing experience.", + "type": "boolean" + }, + "landingPages": { + "description": "An array of name/value pairs specifying the pages to which the user is redirected after the following events occur:\n\n- Signing Completed\n- Viewed Exit\n- Finish Later\n- Decline\n- Session Timeout\n- Authentication Failure\n\nIf you do not specify landing pages, the DocuSign default pages are used.", + "type": "array", + "items": { + "$ref": "#/definitions/nameValue" + } + }, + "links": { + "description": "An array of `brandLink` objects that contain information about the links that the brand uses.", + "type": "array", + "items": { + "$ref": "#/definitions/brandLink" + } + }, + "logos": { + "$ref": "#/definitions/brandLogos", + "description": "The URIs for retrieving the logos that are associated with the brand." + }, + "resources": { + "$ref": "#/definitions/brandResourceUrls", + "description": "An object containing the URLs for the four DocuSign master resource files that the brand uses for sending, signing, email messages, and captive (embedded) signing. You can modify the default email messages and formats in these file to customize the user experience.\n\n**Note**: This object is returned only when the `resourceContentType` is `sending`, `signing`, `email`, or `signing_captive`." + } + }, + "x-ds-definition-name": "brand", + "description": "Information about a brand that is associated with an account. A brand applies custom styles and text to an envelope.", + "x-ms-summary": "Information about a brand that is associated with an account. A brand applies custom styles and text to an envelope." + }, + "brandEmailContent": { + "type": "object", + "properties": { + "content": { + "description": "Deprecated.", + "type": "string" + }, + "emailContentType": { + "description": "Deprecated.", + "type": "string" + }, + "emailToLink": { + "description": "Deprecated.", + "type": "string" + }, + "linkText": { + "description": "Deprecated.", + "type": "string" + } + }, + "x-ds-definition-name": "brandEmailContent", + "description": "Deprecated.", + "x-ms-summary": "Deprecated." + }, + "brandLink": { + "type": "object", + "properties": { + "linkText": { + "description": "The text used for the link.", + "type": "string" + }, + "linkType": { + "description": "The type of link. Valid values include:\n\n- `aboutDocusign`\n- `closeButton`", + "type": "string" + }, + "showLink": { + "description": "When **true**, the link displays to the recipient.", + "type": "string" + }, + "urlOrMailTo": { + "description": "The URL or mailto address of the link.", + "type": "string" + } + }, + "x-ds-definition-name": "brandLink", + "description": "Information about a link that a brand uses.", + "x-ms-summary": "Information about a link that a brand uses." + }, + "brandLogos": { + "type": "object", + "properties": { + "email": { + "description": "The URI for the logo that the brand uses in the header of email messages.", + "type": "string" + }, + "primary": { + "description": "The URI for the brand's primary logo.", + "type": "string" + }, + "secondary": { + "description": "The URI for the brand's secondary logo.", + "type": "string" + } + }, + "x-ds-definition-name": "brandLogos", + "description": "Information about the logos associated with the brand.", + "x-ms-summary": "Information about the logos associated with the brand." + }, + "brandRequest": { + "type": "object", + "properties": { + "brandId": { + "description": "The ID of the brand used in API calls", + "type": "string" + } + }, + "x-ds-definition-name": "brandRequest", + "description": "This request object contains information about a specific brand.", + "x-ms-summary": "This request object contains information about a specific brand." + }, + "brandResources": { + "type": "object", + "properties": { + "createdByUserInfo": { + "$ref": "#/definitions/userInfo", + "description": "The user id of the user who created the brand resource." + }, + "createdDate": { + "description": "The date and time that the brand resource was created.", + "type": "string" + }, + "dataNotSavedNotInMaster": { + "description": "Deprecated.", + "type": "array", + "items": { + "type": "string" + } + }, + "modifiedByUserInfo": { + "$ref": "#/definitions/userInfo", + "description": "Information about the user who last modified the brand resource." + }, + "modifiedDate": { + "description": "The date on which this user record was last modified.", + "type": "string" + }, + "modifiedTemplates": { + "description": "This property is returned in the response to the [AccountBrands::listResources][listResources] request. It contains a list of any email templates that have been modified to differ from the master resource files.\n\n[listResources]: https://developers.docusign.com/docs/esign-rest-api/reference/Accounts/AccountBrands/listResources", + "type": "array", + "items": { + "type": "string" + } + }, + "resourcesContentType": { + "description": "The type of brand resource file. A brand uses a different resource file to control each of the following experiences:\n\n- Sending (`sending`)\n- Signing (`signing`)\n- Email messages (`email`)\n- Captive (embedded) signing (`signing_captive`)\n\nYou can modify the default email messages and formats in these files and upload them to your brand to customize the user experience.", + "type": "string" + }, + "resourcesContentUri": { + "description": "The URI for the brand resource file.", + "type": "string" + } + }, + "x-ds-definition-name": "brandResources", + "description": "Information about the resource files that the brand uses for the email, signing, sending, and captive (embedded) signing experiences.", + "x-ms-summary": "Information about the resource files that the brand uses for the email, signing, sending, and captive (embedded) signing experiences." + }, + "brandResourcesList": { + "type": "object", + "properties": { + "resourcesContentTypes": { + "description": "A list of resources that the brand uses.", + "type": "array", + "items": { + "$ref": "#/definitions/brandResources" + } + } + }, + "x-ds-definition-name": "brandResourcesList", + "description": "", + "x-ms-summary": "" + }, + "brandResourceUrls": { + "type": "object", + "properties": { + "email": { + "description": "The URI for the email resource file that the brand uses.", + "type": "string" + }, + "sending": { + "description": "The URI for the sending resource file that the brand uses.", + "type": "string" + }, + "signing": { + "description": "The URI for the signing resource file that the brand uses.", + "type": "string" + }, + "signingCaptive": { + "description": "The URI for the captive (embedded) signing resource file that the brand uses.", + "type": "string" + } + }, + "x-ds-definition-name": "brandResourceUrls", + "description": "Brands use resource files to style the following experiences: \n\n- Email\n- Sending\n- Signing\n- Captive (embedded) signing \n\nYou can modify these resource files to customize these experiences.", + "x-ms-summary": "Brands use resource files to style the following experiences: \n\n- Email\n- Sending\n- Signing\n- Captive (embedded) signing \n\nYou can modify these resource files to customize these experiences." + }, + "brandsRequest": { + "type": "object", + "properties": { + "brands": { + "description": "A list of brands.", + "type": "array", + "items": { + "$ref": "#/definitions/brandRequest" + } + } + }, + "x-ds-definition-name": "brandsRequest", + "description": "Details about one or more brands.", + "x-ms-summary": "Details about one or more brands." + }, + "brandsResponse": { + "type": "object", + "properties": { + "brands": { + "description": "A list of brands.", + "type": "array", + "items": { + "$ref": "#/definitions/brand" + } + }, + "recipientBrandIdDefault": { + "description": "The brand that envelope recipients see when a brand is not explicitly set.", + "type": "string" + }, + "senderBrandIdDefault": { + "description": "The brand that envelope senders see when a brand is not explicitly set.", + "type": "string" + } + }, + "x-ds-definition-name": "brandsResponse", + "description": "", + "x-ms-summary": "" + }, + "bulkEnvelope": { + "type": "object", + "properties": { + "bulkRecipientRow": { + "description": "The row of the recipient in the CSV file used to create the bulk recipient list.", + "type": "string" + }, + "bulkStatus": { + "description": "Indicates the status of the bulk send operation. Returned values can be:\n- `queued`\n- `processing`\n- `sent`\n- `failed`", + "type": "string" + }, + "email": { + "description": "The email address of the recipient assigned to this envelope transaction.", + "type": "string" + }, + "envelopeId": { + "description": "GUID of the bulk envelope.", + "type": "string" + }, + "envelopeUri": { + "description": "The URI for retrieving the envelope or envelopes.", + "type": "string" + }, + "errorDetails": { + "$ref": "#/definitions/errorDetails", + "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." + }, + "name": { + "description": "The name of the recipient assigned to this envelope transaction.", + "type": "string" + }, + "submittedDateTime": { + "description": "The date and time on which the bulk envelope was created.", + "type": "string" + }, + "transactionId": { + "description": "Identifier for the envelope transaction. The ID is a sender-generated value and is valid in the DocuSign system for 7 days. We recommend that you use a transaction ID for offline signing to ensure that an envelope is not sent multiple times. You can use the transaction ID to determine an envelope's status (queued, processing, sent, or failed) in cases where the Internet connection is lost before envelope status is returned.", + "type": "string" + } + }, + "x-ds-definition-name": "bulkEnvelope", + "description": "", + "x-ms-summary": "" + }, + "bulkEnvelopeStatus": { + "type": "object", + "properties": { + "batchId": { + "description": "Specifies an identifier which can be used to retrieve a more detailed status of individual bulk recipient batches.", + "type": "string" + }, + "batchSize": { + "description": "The number of items returned in this response.", + "type": "string" + }, + "bulkEnvelopes": { + "description": "A list of bulk envelope objects.", + "type": "array", + "items": { + "$ref": "#/definitions/bulkEnvelope" + } + }, + "bulkEnvelopesBatchUri": { + "description": "URI at which you can retrieve the batch envelopes.", + "type": "string" + }, + "endPosition": { + "description": "The last index position in the result set. ", + "type": "string" + }, + "failed": { + "description": "The number of entries with a status of failed. ", + "type": "string" + }, + "nextUri": { + "description": "The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. ", + "type": "string" + }, + "previousUri": { + "description": "The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. ", + "type": "string" + }, + "queued": { + "description": "The number of entries with a status of queued. ", + "type": "string" + }, + "resultSetSize": { + "description": "The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`.", + "type": "string" + }, + "sent": { + "description": "The number of entries with a status of sent.", + "type": "string" + }, + "startPosition": { + "description": "The starting index position of the current result set.", + "type": "string" + }, + "submittedDate": { + "description": "The date on which the bulk envelope was created.", + "type": "string" + }, + "totalSetSize": { + "description": "The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`.", + "type": "string" + } + }, + "x-ds-definition-name": "bulkEnvelopeStatus", + "description": "", + "x-ms-summary": "" + }, + "bulkRecipient": { + "type": "object", + "properties": { + "accessCode": { + "description": "If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. \n\nMaximum Length: 50 characters and it must conform to the account's access code format setting.\n\nIf blank, but the signer `accessCode` property is set in the envelope, then that value is used.\n\nIf blank and the signer `accessCode` property is not set, then the access code is not required.", + "type": "string" + }, + "email": { + "description": "Specifies the recipient's email address. \n\nMaximum length: 100 characters.", + "type": "string" + }, + "errorDetails": { + "description": "Array or errors.", + "type": "array", + "items": { + "$ref": "#/definitions/errorDetails" + } + }, + "identification": { + "description": "Specifies the authentication check used for the signer. If blank then no authentication check is required for the signer. Only one value can be used in this field.\n\nThe acceptable values are:\n\n* KBA: Enables the normal ID check authentication set up for your account.\n* Phone: Enables phone authentication.\n* SMS: Enables SMS authentication.", + "type": "string" + }, + "name": { + "description": "Specifies the recipient's name. \n\nMaximum length: 50 characters.", + "type": "string" + }, + "note": { + "description": "A note sent to the recipient in the signing email.\nThis note is unique to this recipient.\nIn the user interface,\nit appears near the upper left corner\nof the document\non the signing screen.\n\nMaximum Length: 1000 characters.\n", + "type": "string" + }, + "phoneNumber": { + "description": "This is only used if the Identification field value is Phone or SMS. The value for this field can be a valid telephone number or, if Phone, usersupplied (SMS authentication cannot use a user supplied number). Parenthesis and dashes can be used in the telephone number.\n\nIf `usersupplied` is used, the signer supplies his or her own telephone number.", + "type": "string" + }, + "recipientSignatureProviderInfo": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/bulkRecipientSignatureProvider" + } + }, + "rowNumber": { + "description": "", + "type": "string" + }, + "tabLabels": { + "description": "Specifies values used to populate recipient tabs with information. This allows each bulk recipient signer to have different values for their associated tabs. Any number of `tabLabel` columns can be added to the bulk recipient file.\n\nThe information used in the bulk recipient file header must be the same as the `tabLabel` for the tab.\n\nThe values entered in this column are automatically inserted into the corresponding tab for the recipient in the same row.\n\nNote that this option cannot be used for tabs that do not have data or that are automatically populated data such as Signature, Full Name, Email Address, Company, Title, and Date Signed tabs.", + "type": "array", + "items": { + "$ref": "#/definitions/bulkRecipientTabLabel" + } + } + }, + "x-ds-definition-name": "bulkRecipient", + "description": "", + "x-ms-summary": "" + }, + "bulkRecipientSignatureProvider": { + "type": "object", + "properties": { + "name": { + "description": "", + "type": "string" + }, + "value": { + "description": "Specifies the value of the tab. ", + "type": "string" + } + }, + "x-ds-definition-name": "bulkRecipientSignatureProvider", + "description": "", + "x-ms-summary": "" + }, + "bulkRecipientsRequest": { + "type": "object", + "properties": { + "bulkRecipients": { + "description": "A complex type containing information about the bulk recipients in the request.", + "type": "array", + "items": { + "$ref": "#/definitions/bulkRecipient" + } + } + }, + "x-ds-definition-name": "bulkRecipientsRequest", + "description": "", + "x-ms-summary": "" + }, + "bulkRecipientsResponse": { + "type": "object", + "properties": { + "bulkRecipients": { + "description": "A complex type containing information about the bulk recipients in the response.", + "type": "array", + "items": { + "$ref": "#/definitions/bulkRecipient" + } + }, + "endPosition": { + "description": "The last index position in the result set. ", + "type": "string" + }, + "nextUri": { + "description": "The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. ", + "type": "string" + }, + "previousUri": { + "description": "The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. ", + "type": "string" + }, + "resultSetSize": { + "description": "The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`.", + "type": "string" + }, + "startPosition": { + "description": "The starting index position of the current result set.", + "type": "string" + }, + "totalSetSize": { + "description": "The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`.", + "type": "string" + } + }, + "x-ds-definition-name": "bulkRecipientsResponse", + "description": "", + "x-ms-summary": "" + }, + "bulkRecipientsSummaryResponse": { + "type": "object", + "properties": { + "bulkRecipients": { + "description": "A complex type containing information about the bulk recipients in the response.", + "type": "array", + "items": { + "$ref": "#/definitions/bulkRecipient" + } + }, + "bulkRecipientsCount": { + "description": "The number of items returned in this response.", + "type": "string" + }, + "bulkRecipientsUri": { + "description": "Reserved for DocuSign.", + "type": "string" + }, + "errorDetails": { + "description": "Array or errors.", + "type": "array", + "items": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "x-ds-definition-name": "bulkRecipientsSummaryResponse", + "description": "", + "x-ms-summary": "" + }, + "bulkRecipientsUpdateResponse": { + "type": "object", + "properties": { + "signer": { + "$ref": "#/definitions/signer", + "description": "" + } + }, + "x-ds-definition-name": "bulkRecipientsUpdateResponse", + "description": "", + "x-ms-summary": "" + }, + "bulkRecipientTabLabel": { + "type": "object", + "properties": { + "name": { + "description": "", + "type": "string" + }, + "value": { + "description": "Specifies the value of the tab. ", + "type": "string" + } + }, + "x-ds-definition-name": "bulkRecipientTabLabel", + "description": "", + "x-ms-summary": "" + }, + "bulkSendBatchRequest": { + "type": "object", + "properties": { + "batchName": { + "description": "", + "type": "string" + } + }, + "x-ds-definition-name": "bulkSendBatchRequest", + "description": "", + "x-ms-summary": "" + }, + "bulkSendBatchStatus": { + "type": "object", + "properties": { + "batchId": { + "description": "The batch ID.", + "type": "string" + }, + "batchName": { + "description": "The batch name.", + "type": "string" + }, + "batchSize": { + "description": "The number of of bulk envelopes submitted in the current batch\n", + "type": "string" + }, + "bulkErrors": { + "description": "An array of error statuses.", + "type": "array", + "items": { + "$ref": "#/definitions/bulkSendErrorStatus" + } + }, + "envelopeIdOrTemplateId": { + "description": "The ID of the draft envelope or template that was used to create the batch.\n", + "type": "string" + }, + "envelopesUri": { + "description": "The URI to get all envelopes sent in the batch.\n", + "type": "string" + }, + "failed": { + "description": "The number of envelopes that failed to process or send.\n", + "type": "string" + }, + "mailingListId": { + "description": "The id of the mailing list used to create the batch.", + "type": "string" + }, + "ownerUserId": { + "description": "", + "type": "string" + }, + "queued": { + "description": "The number of envelopes waiting in pending queue\n", + "type": "string" + }, + "senderUserId": { + "description": "The id of the sender.", + "type": "string" + }, + "sent": { + "description": "The number of envelopes sent successfully.", + "type": "string" + }, + "submittedDate": { + "description": "The timestamp of when the batch was submitted in ISO-8601 format.\n\n", + "type": "string" + } + }, + "x-ds-definition-name": "bulkSendBatchStatus", + "description": "Result of `getBulkSendBatchStatus`", + "x-ms-summary": "Result of `getBulkSendBatchStatus`" + }, + "bulkSendBatchSummaries": { + "type": "object", + "properties": { + "batchSizeLimit": { + "description": "The maximum number of envelopes the account is permitted to submit in a given batch.", + "type": "string" + }, + "bulkBatchSummaries": { + "description": "An array of batch summaries.", + "type": "array", + "items": { + "$ref": "#/definitions/bulkSendBatchSummary" + } + }, + "endPosition": { + "description": "The last index position in the result set. ", + "type": "string" + }, + "nextUri": { + "description": "The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. ", + "type": "string" + }, + "previousUri": { + "description": "The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. ", + "type": "string" + }, + "queueLimit": { + "description": "Maximum number of envelopes an account is permitted to have in the queue at any one time.", + "type": "string" + }, + "resultSetSize": { + "description": "The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`.", + "type": "string" + }, + "startPosition": { + "description": "The starting index position of the current result set.", + "type": "string" + }, + "totalQueued": { + "description": "The number of envelopes currently pending processing for the entire account.", + "type": "string" + }, + "totalSetSize": { + "description": "The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`.", + "type": "string" + } + }, + "x-ds-definition-name": "bulkSendBatchSummaries", + "description": "A list of bulk send batch summaries. ", + "x-ms-summary": "A list of bulk send batch summaries. " + }, + "bulkSendBatchSummary": { + "type": "object", + "properties": { + "batchId": { + "description": "The batch ID.", + "type": "string" + }, + "batchName": { + "description": "The name of the batch.", + "type": "string" + }, + "batchSize": { + "description": "The number of envelopes in the batch.", + "type": "string" + }, + "batchUri": { + "description": "The batch details URI.", + "type": "string" + }, + "failed": { + "description": "Number of envelopes that failed to send.", + "type": "string" + }, + "queued": { + "description": "Number of envelopes peding processing.\n", + "type": "string" + }, + "sent": { + "description": "Number of envelopes that have been sent.", + "type": "string" + }, + "submittedDate": { + "description": "The time stamp of when the batch was created in ISO-8601 format.", + "type": "string" + } + }, + "x-ds-definition-name": "bulkSendBatchSummary", + "description": "Summary status of a single batch.", + "x-ms-summary": "Summary status of a single batch." + }, + "bulkSendErrorStatus": { + "type": "object", + "properties": { + "created": { + "description": "The timestamp of when the error occurred in ISO-8601 format.", + "type": "string" + }, + "errorMessage": { + "description": "The error message generated during processing, if any.\n", + "type": "string" + }, + "recipientEmails": { + "description": "An array of email addresses for the failed bulk envelope.\n\nRecipient email/info of the failed bulk envelope.\n", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ds-definition-name": "bulkSendErrorStatus", + "description": "A single bulk send error report.", + "x-ms-summary": "A single bulk send error report." + }, + "bulkSendingCopy": { + "type": "object", + "properties": { + "customFields": { + "description": "The custom fields for this copy of the envelope.\n\n**Note**: These custom fields must also be included in the original envelope or template that you want to send.", + "type": "array", + "items": { + "$ref": "#/definitions/bulkSendingCopyCustomField" + } + }, + "emailBlurb": { + "description": "The email body for this copy of the envelope.", + "type": "string" + }, + "emailSubject": { + "description": "The email subject line for this copy of the envelope.\nFor information about adding merge field information to the email subject,\nsee [Template Email Subject Merge Fields](https://developers.docusign.com/docs/esign-rest-api/reference/templates/templates/create/).", + "type": "string" + }, + "recipients": { + "description": "Information about the recipients associated with this copy of the envelope.", + "type": "array", + "items": { + "$ref": "#/definitions/bulkSendingCopyRecipient" + } + } + }, + "x-ds-definition-name": "bulkSendingCopy", + "description": "This object contains the details to use for a specific copy, or instance, of the envelope. When you send an envelope by using a bulk send list, you can customize these properties for each instance.", + "x-ms-summary": "This object contains the details to use for a specific copy, or instance, of the envelope. When you send an envelope by using a bulk send list, you can customize these properties for each instance." + }, + "bulkSendingCopyCustomField": { + "type": "object", + "properties": { + "name": { + "description": "The name of the custom field.", + "type": "string" + }, + "value": { + "description": "The value of the custom field.", + "type": "string" + } + }, + "x-ds-definition-name": "bulkSendingCopyCustomField", + "description": "This object contains details about a custom field for a bulk send copy. In a bulk send request, each custom field in the bulk send list must match a custom field in the envelope or template that you want to send.", + "x-ms-summary": "This object contains details about a custom field for a bulk send copy. In a bulk send request, each custom field in the bulk send list must match a custom field in the envelope or template that you want to send." + }, + "bulkSendingCopyRecipient": { + "type": "object", + "properties": { + "accessCode": { + "description": "If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. \n\nMaximum Length: 50 characters and it must conform to the account's access code format setting.\n\nIf blank, but the signer `accessCode` property is set in the envelope, then that value is used.\n\nIf blank and the signer `accessCode` property is not set, then the access code is not required.", + "type": "string" + }, + "clientUserId": { + "description": "Specifies whether the recipient is embedded or remote. \n\nIf the `clientUserId` property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing.\n\nNote: if the `clientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true**, an error is generated on sending. \n\nMaximum length: 100 characters. ", + "type": "string" + }, + "customFields": { + "description": "An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters.", + "type": "array", + "items": { + "type": "string" + } + }, + "deliveryMethod": { + "description": "Reserved for DocuSign.", + "type": "string" + }, + "email": { + "description": "The recipient's email address.", + "type": "string" + }, + "emailNotification": { + "$ref": "#/definitions/recipientEmailNotification", + "description": "An optional complex type that sets a specific email subject and body for this recipient's notification email. \n\n**Note**: You can set the `emailNotification` property separately for each recipient. If you set the value only for certain recipients, the other recipients will inherit the this value from the top-level `emailSubject` and `emailBlurb`. " + }, + "embeddedRecipientStartURL": { + "description": "Specifies a sender-provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. \n\nIf set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation launched by a partner.\n\nIt is important to understand that in a typical embedded workflow, the authentication of an embedded recipient is the responsibility of the sending application. DocuSign expects that senders will follow their own processes for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process is initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process, bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient.\n\nIf the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: `envelopeId`, `recipientId`, `recipientName`, `recipientEmail`, and `customFields`. The `customFields` property must be set for the recipient or envelope. The merge fields are enclosed in double brackets. \n\n*Example*: \n\n`http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` ", + "type": "string" + }, + "faxNumber": { + "description": "Reserved for DocuSign.", + "type": "string" + }, + "hostEmail": { + "description": "The email address of the signing host.\nThis is the DocuSign user that is hosting the in-person signing session.\n\nRequired when `inPersonSigningType` is `inPersonSigner`.\nFor eNotary flow, use `email` instead.\n\nMaximum Length: 100 characters.\n", + "type": "string" + }, + "hostName": { + "description": "The name of the signing host.\nThis is the DocuSign user that is hosting the in-person signing session.\n\nRequired when `inPersonSigningType` is `inPersonSigner`.\nFor eNotary flow, use `name` instead.\n\nMaximum Length: 100 characters.\n", + "type": "string" + }, + "idCheckConfigurationName": { + "description": "The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are:\n\n- `Phone Auth $`: The recipient must authenticate by using two-factor authentication (2FA). You provide the phone number to use for 2FA in the `phoneAuthentication` object.\n- `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object.\n- `ID Check $`: The recipient must answer detailed security questions. \n\n**Example**: Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node.", + "type": "string" + }, + "idCheckInformationInput": { + "$ref": "#/definitions/idCheckInformationInput", + "description": "An object that contains input information related to a recipient ID check." + }, + "identificationMethod": { + "description": "", + "type": "string" + }, + "name": { + "description": "", + "type": "string" + }, + "note": { + "description": "A note sent to the recipient in the signing email.\nThis note is unique to this recipient.\nIn the user interface,\nit appears near the upper left corner\nof the document\non the signing screen.\n\nMaximum Length: 1000 characters.\n", + "type": "string" + }, + "phoneAuthentication": { + "$ref": "#/definitions/recipientPhoneAuthentication", + "description": "When `idCheckConfigurationName` is set to `Phone Auth $`, you use this complex type to provide the recipient authentication method details. It contains the following elements:\n\n* `recipMayProvideNumber`: Boolean. When set to **true**, the recipient can use whatever phone number they choose.\n* `senderProvidedNumbers`: ArrayOfStrings. A list of phone numbers the recipient can use.\n* `recordVoicePrint`: Reserved for DocuSign.\n* `validateRecipProvidedNumber`: Reserved for DocuSign.\n\n" + }, + "recipientId": { + "description": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.", + "type": "string" + }, + "recipientSignatureProviders": { + "description": "The default signature provider is the DocuSign Electronic signature system. This parameter is used to specify one or more Standards Based Signature (digital signature) providers for the signer to use. [More information.](https://developers.docusign.com/esign-rest-api/guides/standards-based-signatures)", + "type": "array", + "items": { + "$ref": "#/definitions/recipientSignatureProvider" + } + }, + "roleName": { + "description": "The name of the role associated with the recipient. This property is optional and is only used in place of a `recipientId`.", + "type": "string" + }, + "signerName": { + "description": "The in-person signer's full legal name.\n\nRequired when `inPersonSigningType` is `inPersonSigner`.\nFor eNotary flow, use `name` instead.\n\nMaximum Length: 100 characters.\n", + "type": "string" + }, + "signingGroupId": { + "description": "Optional. The ID of the [signing group](https://support.docusign.com/en/guides/ndse-user-guide-signing-groups).\n\n**Note**: When you send an envelope to a signing group, anyone in the group can open it and sign it with their own signature. For this reason, we recommend that you do not include non-signer recipients (such as carbon copy recipients) in the same signing group as signer recipients. However, you could create a second signing group for the non-signer recipients and change the default action of Needs to Sign to a different value, such as Receives a Copy. ", + "type": "string" + }, + "smsAuthentication": { + "$ref": "#/definitions/recipientSMSAuthentication", + "description": "When `idCheckConfigurationName` is set to `SMS Auth $`, you use this complex type to provide the recipient authentication method details. It contains the element `senderProvidedNumbers`, which is an array of phone numbers that the recipient can use for SMS text authentication. \n\n" + }, + "socialAuthentications": { + "description": "Deprecated.", + "type": "array", + "items": { + "$ref": "#/definitions/socialAuthentication" + } + }, + "tabs": { + "description": "A list of tabs associated with the recipient. In a bulk send request, each of these recipient tabs must match a recipient tab on the envelope or template that you want to send. To match up, the `tabLabel` for this tab and the `tabLabel` for the corresponding tab on the envelope or template must be the same.\n\nFor example, if the envelope has a placeholder text tab with the `tabLabel` `childName`, you must assign the same `tabLabel` `childName` to the tab here that you are populating with that information.\n\n You can use the following types of tabs to match bulk send recipients to an envelope:\n\n- Text tabs\n- Radio group tabs (where the name of the `radioGroup` on the envelope is used as the `tabLabel` in the bulk send list)\n- List tabs", + "type": "array", + "items": { + "$ref": "#/definitions/bulkSendingCopyTab" + } + } + }, + "x-ds-definition-name": "bulkSendingCopyRecipient", + "description": "This object contains details about a bulk send recipient.", + "x-ms-summary": "This object contains details about a bulk send recipient." + }, + "bulkSendingCopyTab": { + "type": "object", + "properties": { + "initialValue": { + "description": "The initial value that you want to assign to the tab.", + "type": "string" + }, + "tabLabel": { + "description": "The label associated with the recipient tab. In a bulk send request, the `tabLabel` for this tab and the `tabLabel` for the corresponding tab on the envelope or template must be the same.\n\nMaximum Length: 500 characters.", + "type": "string" + } + }, + "x-ds-definition-name": "bulkSendingCopyTab", + "description": "A tab associated with the bulk send recipient. In a bulk send request, each recipient tab must match a recipient tab on the envelope or template that you want to send. To match up, the `tabLabel` for this tab and the `tabLabel` for the corresponding tab on the envelope or template must be the same.\n\nFor example, if the envelope has a placeholder text tab with the `tabLabel` `childName`, you must assign the same `tabLabel` `childName` to the tab here that you are populating with that information.", + "x-ms-summary": "A tab associated with the bulk send recipient. In a bulk send request, each recipient tab must match a recipient tab on the envelope or template that you want to send. To match up, the `tabLabel` for this tab and the `tabLabel` for the corresponding tab on the envelope or template must be the same.\n\nFor example, if the envelope has a placeholder text tab with the `tabLabel` `childName`, you must assign the same `tabLabel` `childName` to the tab here that you are populating with that information." + }, + "bulkSendingList": { + "type": "object", + "properties": { + "bulkCopies": { + "description": "An array of `bulkCopy` objects. Each object represents an instance or copy of an envelope and contains details such as the recipient, custom fields, tabs, and other information.", + "type": "array", + "items": { + "$ref": "#/definitions/bulkSendingCopy" + } + }, + "listId": { + "description": "The GUID of the bulk send list.", + "type": "string" + }, + "name": { + "description": "The name of the bulk send list.", + "type": "string" + } + }, + "x-ds-definition-name": "bulkSendingList", + "description": "This object contains the details for the bulk send list.", + "x-ms-summary": "This object contains the details for the bulk send list." + }, + "bulkSendingListSummaries": { + "type": "object", + "properties": { + "bulkListSummaries": { + "description": "An array of `bulkSendingListSummary` objects where each summary provides basic information about a bulk send list that belongs to the current user.", + "type": "array", + "items": { + "$ref": "#/definitions/bulkSendingListSummary" + } + } + }, + "x-ds-definition-name": "bulkSendingListSummaries", + "description": "This complex type contains summaries that provide basic information about the bulk send lists that belong to the current user.", + "x-ms-summary": "This complex type contains summaries that provide basic information about the bulk send lists that belong to the current user." + }, + "bulkSendingListSummary": { + "type": "object", + "properties": { + "bulkSendListId": { + "description": "The GUID of the bulk send list. This property is created after you post a new bulk send list.", + "type": "string" + }, + "createdByUser": { + "description": "The GUID of the user who created the bulk send list.", + "type": "string" + }, + "createdDate": { + "description": "The UTC DateTime that the bulk send list was created.", + "type": "string" + }, + "name": { + "description": "The name of the bulk send list.", + "type": "string" + } + }, + "x-ds-definition-name": "bulkSendingListSummary", + "description": "This object contains basic information about a bulk send list.", + "x-ms-summary": "This object contains basic information about a bulk send list." + }, + "bulkSendRequest": { + "type": "object", + "properties": { + "batchName": { + "description": "", + "type": "string" + }, + "envelopeOrTemplateId": { + "description": "The GUID of the envelope or template that you want to send in bulk.", + "type": "string" + } + }, + "x-ds-definition-name": "bulkSendRequest", + "description": "This object contains information about the envelope or template that you want to send in bulk.", + "x-ms-summary": "This object contains information about the envelope or template that you want to send in bulk." + }, + "bulkSendResponse": { + "type": "object", + "properties": { + "batchId": { + "description": "A batch identifier that you can use to get the status of the batch.", + "type": "string" + }, + "batchName": { + "description": "", + "type": "string" + }, + "batchSize": { + "description": "The total number of items in the batch being queried.", + "type": "string" + }, + "envelopeOrTemplateId": { + "description": "The GUID of the envelope or template that was sent.", + "type": "string" + }, + "errorDetails": { + "description": "A human-readable object that describes errors that occur. It is only valid for responses and ignored in requests.", + "type": "array", + "items": { + "type": "string" + } + }, + "errors": { + "description": "A list of errors that occurred. This information is intended to be parsed by machine.", + "type": "array", + "items": { + "type": "string" + } + }, + "queueLimit": { + "description": "", + "type": "string" + }, + "totalQueued": { + "description": "", + "type": "string" + } + }, + "x-ds-definition-name": "bulkSendResponse", + "description": "The object contains the response to a bulk send request.", + "x-ms-summary": "The object contains the response to a bulk send request." + }, + "bulkSendTestResponse": { + "type": "object", + "properties": { + "canBeSent": { + "description": "When **true**, the envelope or template is compatible with the bulk send list and can be sent by using the [BulkSend::createBulkSendRequest][BulkSendRequest] method.\n\n**Note**: This property is only returned in responses and ignored in requests.\n\n[BulkSendRequest]: https://developers.docusign.com/docs/esign-rest-api/reference/BulkEnvelopes/BulkSend/createBulkSendRequest", + "type": "boolean" + }, + "validationErrorDetails": { + "description": "Human-readable details about any validation errors that occurred.", + "type": "array", + "items": { + "type": "string" + } + }, + "validationErrors": { + "description": "A list of validation errors that were encountered during the bulk send test.\n\n**Note**: This information is intended to be parsed by machine.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ds-definition-name": "bulkSendTestResponse", + "description": "This object contains the results of a bulk send test.", + "x-ms-summary": "This object contains the results of a bulk send test." + }, + "captiveRecipient": { + "type": "object", + "properties": { + "clientUserId": { + "description": "Specifies whether the recipient is embedded or remote. \n\nIf the `clientUserId` property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing.\n\nNote: if the `clientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true**, an error is generated on sending. \n\nMaximum length: 100 characters. ", + "type": "string" + }, + "email": { + "description": "The email address associated with the captive recipient.", + "type": "string" + }, + "errorDetails": { + "$ref": "#/definitions/errorDetails", + "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." + }, + "userName": { + "description": "The username associated with the captive recipient.", + "type": "string" + } + }, + "x-ds-definition-name": "captiveRecipient", + "description": "This object contains details about a captive (embedded) recipient.", + "x-ms-summary": "This object contains details about a captive (embedded) recipient." + }, + "captiveRecipientInformation": { + "type": "object", + "properties": { + "captiveRecipients": { + "description": "A complex type containing information about one or more captive recipients.", + "type": "array", + "items": { + "$ref": "#/definitions/captiveRecipient" + } + } + }, + "x-ds-definition-name": "captiveRecipientInformation", + "description": "Contains information about captive (embedded) recipients.", + "x-ms-summary": "Contains information about captive (embedded) recipients." + }, + "carbonCopy": { + "type": "object", + "properties": { + "accessCode": { + "description": "If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. \n\nMaximum Length: 50 characters and it must conform to the account's access code format setting.\n\nIf blank, but the signer `accessCode` property is set in the envelope, then that value is used.\n\nIf blank and the signer `accessCode` property is not set, then the access code is not required.", + "type": "string" + }, + "accessCodeMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `accessCode` property is editable. Read only." + }, + "addAccessCodeToEmail": { + "description": "Optional. When set to **true**, the access code will be added to the email sent to the recipient. This nullifies the security measure of `accessCode` on the recipient.", + "type": "string" + }, + "additionalNotifications": { + "description": "An array of additional notification objects.", + "type": "array", + "items": { + "$ref": "#/definitions/recipientAdditionalNotification" + } + }, + "agentCanEditEmail": { + "description": "Optional element. When set to **true**, the agents recipient associated with this recipient can change the recipient's pre-populated email address. This element is only active if enabled for the account.", + "type": "string" + }, + "agentCanEditName": { + "description": "Optional element. When set to **true**, the agents recipient associated with this recipient can change the recipient's pre-populated name. This element is only active if enabled for the account.", + "type": "string" + }, + "allowSystemOverrideForLockedRecipient": { + "description": "", + "type": "string" + }, + "clientUserId": { + "description": "Not applicable for Carbon Copy recipients.", + "type": "string" + }, + "completedCount": { + "description": "Indicates the number of times that the recipient has been through a signing completion for the envelope. If this number is greater than 0 for a signing group, only the user who previously completed may sign again. Read only.", + "type": "string" + }, + "customFields": { + "description": "An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters.", + "type": "array", + "items": { + "type": "string" + } + }, + "declinedDateTime": { + "description": "The date and time the recipient declined the document. Read only.", + "type": "string" + }, + "declinedReason": { + "description": "The reason the recipient declined the document. Read only.", + "type": "string" + }, + "deliveredDateTime": { + "description": "The date and time that the envelope was delivered to the recipient. Read only.", + "type": "string" + }, + "deliveryMethod": { + "description": "Reserved for DocuSign.", + "type": "string" + }, + "deliveryMethodMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Reserved for DocuSign." + }, + "designatorId": { + "description": "", + "type": "string" + }, + "designatorIdGuid": { + "description": "", + "type": "string" + }, + "documentVisibility": { + "description": "A list of `documentVisibility` objects. Each object in the list specifies whether a document in the envelope is visible to this recipient. For the envelope to use this functionality, Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true**.", + "type": "array", + "items": { + "$ref": "#/definitions/documentVisibility" + } + }, + "email": { + "description": "The recipient's email address. Notification of the document to sign is sent to this email address. \n\nMaximum length: 100 characters. ", "type": "string" }, - "formatRequiredMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata indicating whether the `formatRequired` property is editable." + "emailMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `email` property is editable. Read only." }, - "letterRequired": { - "description": "Boolean specifying whether alphabetical characters are required in the access code string.", + "emailNotification": { + "$ref": "#/definitions/recipientEmailNotification", + "description": "An optional complex type that sets a specific email subject and body for this recipient's notification email. \n\n**Note**: You can set the `emailNotification` property separately for each recipient. If you set the value only for certain recipients, the other recipients will inherit the this value from the top-level `emailSubject` and `emailBlurb`. " + }, + "embeddedRecipientStartURL": { + "description": "Specifies a sender-provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. \n\nIf set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation launched by a partner.\n\nIt is important to understand that in a typical embedded workflow, the authentication of an embedded recipient is the responsibility of the sending application. DocuSign expects that senders will follow their own processes for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process is initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process, bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient.\n\nIf the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: `envelopeId`, `recipientId`, `recipientName`, `recipientEmail`, and `customFields`. The `customFields` property must be set for the recipient or envelope. The merge fields are enclosed in double brackets. \n\n*Example*: \n\n`http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` ", "type": "string" }, - "letterRequiredMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata indicating whether the `letterRequired` property is editable." + "errorDetails": { + "$ref": "#/definitions/errorDetails", + "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." }, - "minimumLength": { - "description": "Minimum length of the access code string.", + "excludedDocuments": { + "description": "Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true** for the envelope to use this.\n\nWhen enforce signer visibility is enabled, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent.", + "type": "array", + "items": { + "type": "string" + } + }, + "faxNumber": { + "description": "Reserved for DocuSign.", "type": "string" }, - "minimumLengthMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata indicating whether the `minimumLength` property is editable." + "faxNumberMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Reserved for DocuSign." }, - "numberRequired": { - "description": "Boolean specifying whether numerical characters (0-9) are required in the access code string.", + "firstName": { + "description": "The recipient's first name. Maximum Length: 50 characters.", "type": "string" }, - "numberRequiredMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata indicating whether the `numberRequired` property is editable." + "firstNameMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `firstame` property is editable. Read only." }, - "specialCharacterRequired": { - "description": "Boolean specifying whether special characters are required in the access code string. The string cannot contain the special characters '<', '>', '&', or '#'.", + "fullName": { + "description": "Reserved for DocuSign.", "type": "string" }, - "specialCharacterRequiredMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata indicating whether the `specialCharacterRequired` property is editable." - } - }, - "x-ds-definition-name": "accessCodeFormat", - "description": "Object specifying the format of the string provided to a recipient in order to access an envelope.", - "x-ms-summary": "Object specifying the format of the string provided to a recipient in order to access an envelope." - }, - "accountAddress": { - "description": "Contains information about an account address.", - "type": "object", - "properties": { - "address1": { - "description": "The first line of the user's address.\nMaximum length: 100 characters.", + "fullNameMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Reserved for DocuSign." + }, + "idCheckConfigurationName": { + "description": "The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are:\n\n- `Phone Auth $`: The recipient must authenticate by using two-factor authentication (2FA). You provide the phone number to use for 2FA in the `phoneAuthentication` object.\n- `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object.\n- `ID Check $`: The recipient must answer detailed security questions. \n\n**Example**: Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node.", "type": "string" }, - "address2": { - "description": "The second line of the user's address.\nMaximum length: 100 characters.", + "idCheckConfigurationNameMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `idCheckConfigurationName` property is editable. Read only." + }, + "idCheckInformationInput": { + "$ref": "#/definitions/idCheckInformationInput", + "description": "An object that contains input information related to a recipient ID check." + }, + "identityVerification": { + "$ref": "#/definitions/recipientIdentityVerification", + "description": "Specifies the ID Verification workflow applied on an envelope by workflow ID.
See the [list](https://developers.docusign.com/docs/esign-rest-api/reference/Accounts/IdentityVerifications/list) method in the [IdentityVerifications](https://developers.docusign.com/docs/esign-rest-api/reference/Accounts/IdentityVerifications) resource for more information on how to retrieve workflow IDs available for an account.
This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods.
Note that ID Verification and ID Check are two distinct methods. ID Verification checks recipients' identity by verifying their ID while ID Check relies on data available on public records (such as current and former address)." + }, + "inheritEmailNotificationConfiguration": { + "description": "When set to **true** and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account. ", "type": "string" }, - "city": { - "description": "The city value of the address.", + "lastName": { + "description": "The recipient's last name.", "type": "string" }, - "country": { - "description": "Specifies the country associated with the address.", + "lastNameMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `lastName` property is editable. Read only." + }, + "lockedRecipientPhoneAuthEditable": { + "description": "Reserved for DocuSign.", "type": "string" }, - "email": { - "description": "Filters returned user records by the specified email address.", + "lockedRecipientSmsEditable": { + "description": "Reserved for DocuSign.", "type": "string" }, - "fax": { - "description": "", + "name": { + "description": "The full legal name of the recipient. Maximum Length: 100 characters.\n\n**Note**: You must always set a value for this property in requests, even if `firstName` and `lastName` are set.", "type": "string" }, - "firstName": { - "description": "The user's first name. \nMaximum Length: 50 characters.", + "nameMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `name` property is editable. Read only." + }, + "note": { + "description": "A note sent to the recipient in the signing email.\nThis note is unique to this recipient.\nIn the user interface,\nit appears near the upper left corner\nof the document\non the signing screen.\n\nMaximum Length: 1000 characters.\n", "type": "string" }, - "lastName": { - "description": "", + "noteMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `note` property is editable. Read only." + }, + "phoneAuthentication": { + "$ref": "#/definitions/recipientPhoneAuthentication", + "description": "When `idCheckConfigurationName` is set to `Phone Auth $`, you use this complex type to provide the recipient authentication method details. It contains the following elements:\n\n* `recipMayProvideNumber`: Boolean. When set to **true**, the recipient can use whatever phone number they choose.\n* `senderProvidedNumbers`: ArrayOfStrings. A list of phone numbers the recipient can use.\n* `recordVoicePrint`: Reserved for DocuSign.\n* `validateRecipProvidedNumber`: Reserved for DocuSign.\n\n" + }, + "proofFile": { + "$ref": "#/definitions/recipientProofFile", + "description": "The proof file of the recipient." + }, + "recipientAttachments": { + "description": "Reserved for DocuSign.", + "type": "array", + "items": { + "$ref": "#/definitions/recipientAttachment" + } + }, + "recipientAuthenticationStatus": { + "$ref": "#/definitions/authenticationStatus", + "description": "Information about the recipient's authentication status. Read only." + }, + "recipientFeatureMetadata": { + "description": "Metadata about the features that are supported for the recipient type. Read only.", + "type": "array", + "items": { + "$ref": "#/definitions/featureAvailableMetadata" + } + }, + "recipientId": { + "description": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.", "type": "string" }, - "phone": { - "description": "", + "recipientIdGuid": { + "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only.", "type": "string" }, - "postalCode": { - "description": "The postal code associated with the address.", + "recipientType": { + "description": "The recipient type, as specified by the following values:\n- `agent`: Agent recipients can add name and email information for recipients that appear after the agent in routing order.\n- `carbonCopy`: Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date, or add information to any of the documents. This type of recipient can be used in any routing order.\n- `certifiedDelivery`: Certified delivery recipients must receive the completed documents for the envelope to be completed. They don't need to sign, initial, date, or add information to any of the documents.\n- `editor`: Editors have the same management and access rights for the envelope as the sender. Editors can add name and email information, add or change the routing order, set authentication options, and can edit signature/initial tabs and data fields for the remaining recipients.\n- `inPersonSigner`: In-person recipients are DocuSign users who act as signing hosts in the same physical location as the signer.\n- `intermediaries`: Intermediary recipients can optionally add name and email information for recipients at the same or subsequent level in the routing order.\n- `seal`: Electronic seal recipients represent legal entities.\n- `signer`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope.\n- `witness`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope.", "type": "string" }, - "state": { - "description": "The state or province associated with the address.", + "recipientTypeMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `recipientType` property is editable. Read only." + }, + "requireIdLookup": { + "description": "When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. ", "type": "string" }, - "supportedCountries": { - "description": "Contains an array of countries supported by the billing plan.", + "requireIdLookupMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `requireIdLookup` property is editable. Read only." + }, + "roleName": { + "description": "Optional element. Specifies the role name associated with the recipient.

This property is required when you are working with template recipients.", + "type": "string" + }, + "routingOrder": { + "description": "Specifies the routing order of the recipient in the envelope. ", + "type": "string" + }, + "routingOrderMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `routingOrder` property is editable. Read only." + }, + "sentDateTime": { + "description": "The UTC DateTime when the envelope was sent. Read only.", + "type": "string" + }, + "signedDateTime": { + "description": "Reserved for DocuSign.", + "type": "string" + }, + "signingGroupId": { + "description": "When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once).", + "type": "string" + }, + "signingGroupIdMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `signingGroupId` property is editable. Read only." + }, + "signingGroupName": { + "description": "Optional. The name of the signing group. \n\nMaximum Length: 100 characters. ", + "type": "string" + }, + "signingGroupUsers": { + "description": "A complex type that contains information about users in the signing group.", "type": "array", "items": { - "$ref": "#/definitions/country" + "$ref": "#/definitions/userInfo" + } + }, + "smsAuthentication": { + "$ref": "#/definitions/recipientSMSAuthentication", + "description": "When `idCheckConfigurationName` is set to `SMS Auth $`, you use this complex type to provide the recipient authentication method details. It contains the element `senderProvidedNumbers`, which is an array of phone numbers that the recipient can use for SMS text authentication. \n\n" + }, + "socialAuthentications": { + "description": "Deprecated.", + "type": "array", + "items": { + "$ref": "#/definitions/socialAuthentication" } + }, + "status": { + "description": "The recipient's status. Read only. \n\nPossible values:\n\n- `autoresponded`: The recipient's email system auto-responded to the email from DocuSign. This status is used in the web console to inform senders about the bounced-back email. This recipient status is only used if **Send-on-behalf-of** is turned off for the account.\n- `completed`: The recipient has completed their actions (signing or other required actions if not a signer) for an envelope.\n- `created`: The recipient is in a draft state. This value is only associated with draft envelopes (envelopes that have a status of `created`).\n- `declined`: The recipient declined to sign the document(s) in the envelope.\n- `delivered`: The recipient has viewed the document(s) in an envelope through the DocuSign signing website. This is not an email delivery of the documents in an envelope.\n- `faxPending`: The recipient has finished signing and the system is waiting for a fax attachment from the recipient before completing their signing step.\n- `sent`: The recipient has been sent an email notification that it is their turn to sign an envelope.\n- `signed`: The recipient has completed (signed) all required tags in an envelope. This is a temporary state during processing, after which the recipient's status automatically switches to `completed`.", + "type": "string" + }, + "statusCode": { + "description": "The code associated with the recipient's status. Read only.", + "type": "string" + }, + "suppressEmails": { + "description": "When set to **true**, email notifications are suppressed for the recipient, and they must access envelopes and documents from their DocuSign inbox.", + "type": "string" + }, + "tabs": { + "$ref": "#/definitions/EnvelopeRecipientTabs", + "description": "A list of `commentTabs` that contains the Carbon Copy recipient's comments." + }, + "templateLocked": { + "description": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ", + "type": "string" + }, + "templateRequired": { + "description": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.", + "type": "string" + }, + "totalTabCount": { + "description": "The total number of tabs in the documents. Read only.", + "type": "string" + }, + "userId": { + "description": "The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.\n", + "type": "string" } }, - "x-ds-definition-name": "accountAddress", - "x-ms-summary": "Contains information about an account address." + "x-ds-definition-name": "carbonCopy", + "description": "Contains information about a carbon copy recipient. Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date or add information to any of the documents. ", + "x-ms-summary": "Contains information about a carbon copy recipient. Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date or add information to any of the documents. " }, - "accountBillingPlan": { - "description": "Contains information about an account billing plan.", + "certifiedDelivery": { "type": "object", "properties": { - "addOns": { - "description": "Reserved for DocuSign.", + "accessCode": { + "description": "If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. \n\nMaximum Length: 50 characters and it must conform to the account's access code format setting.\n\nIf blank, but the signer `accessCode` property is set in the envelope, then that value is used.\n\nIf blank and the signer `accessCode` property is not set, then the access code is not required.", + "type": "string" + }, + "accessCodeMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `accessCode` property is editable. Read only." + }, + "addAccessCodeToEmail": { + "description": "Optional. When set to **true**, the access code will be added to the email sent to the recipient. This nullifies the security measure of `accessCode` on the recipient.", + "type": "string" + }, + "additionalNotifications": { + "description": "An array of additional notification objects.", "type": "array", "items": { - "$ref": "#/definitions/addOn" + "$ref": "#/definitions/recipientAdditionalNotification" } }, - "canCancelRenewal": { - "description": "Reserved for DocuSign.", + "agentCanEditEmail": { + "description": "Optional element. When set to **true**, the agents recipient associated with this recipient can change the recipient's pre-populated email address. This element is only active if enabled for the account.", "type": "string" }, - "canUpgrade": { - "description": "When set to **true**, specifies that you can upgrade the account through the API. For GET methods, you must set the `include_metadata` query parameter to **true** for this property to appear in the response.", + "agentCanEditName": { + "description": "Optional element. When set to **true**, the agents recipient associated with this recipient can change the recipient's pre-populated name. This element is only active if enabled for the account.", "type": "string" }, - "currencyCode": { - "description": "Specifies the ISO currency code for the account.", + "allowSystemOverrideForLockedRecipient": { + "description": "", "type": "string" }, - "enableSupport": { - "description": "When set to **true**, then customer support is provided as part of the account plan.", + "clientUserId": { + "description": "Specifies whether the recipient is embedded or remote. \n\nIf the `clientUserId` property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing.\n\nNote: if the `clientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true**, an error is generated on sending. \n\nMaximum length: 100 characters. ", "type": "string" }, - "includedSeats": { - "description": "The number of seats (users) included.", + "completedCount": { + "description": "Indicates the number of times that the recipient has been through a signing completion for the envelope. If this number is greater than 0 for a signing group, only the user who previously completed may sign again. Read only.", "type": "string" }, - "incrementalSeats": { - "description": "Reserved for DocuSign.", - "type": "string" + "customFields": { + "description": "An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters.", + "type": "array", + "items": { + "type": "string" + } }, - "isDowngrade": { - "description": "When **true**, the account has been downgraded from a premium account type. Otherwise **false**.", + "declinedDateTime": { + "description": "The date and time the recipient declined the document. Read only.", "type": "string" }, - "otherDiscountPercent": { - "description": " Any other percentage discount for the plan. ", + "declinedReason": { + "description": "The reason the recipient declined the document. Read only.", "type": "string" }, - "paymentCycle": { - "description": "", + "deliveredDateTime": { + "description": "The date and time that the envelope was delivered to the recipient. Read only.", "type": "string" }, - "paymentMethod": { - "description": " The payment method used with the plan. The possible values are: CreditCard, PurchaseOrder, Premium, or Freemium. ", + "deliveryMethod": { + "description": "Reserved for DocuSign.", "type": "string" }, - "perSeatPrice": { + "deliveryMethodMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Reserved for DocuSign." + }, + "designatorId": { "description": "", "type": "string" }, - "planClassification": { - "description": "Identifies the type of plan. Examples include:\n\n- `business`\n- `corporate`\n- `enterprise` \n- `free`", + "designatorIdGuid": { + "description": "", "type": "string" }, - "planFeatureSets": { - "description": "Reserved for DocuSign.", + "documentVisibility": { + "description": "A list of `documentVisibility` objects. Each object in the list specifies whether a document in the envelope is visible to this recipient. For the envelope to use this functionality, Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true**.", "type": "array", "items": { - "$ref": "#/definitions/featureSet" + "$ref": "#/definitions/documentVisibility" } }, - "planId": { - "description": "The DocuSign plan id for the account.", + "email": { + "description": "The recipient's email address.", "type": "string" }, - "planName": { - "description": "The name of the billing plan.", - "type": "string" + "emailMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `email` property is editable. Read only." }, - "renewalStatus": { - "description": "The renewal status for the account. Valid values are:\n\n* auto - The account automatically renews.\n* queued_for_close - The account will be closed at the `billingPeriodEndDate`.\n* queued_for_downgrade - The account will be downgraded at the `billingPeriodEndDate`.\n\n**Note**: For GET methods, you must set the `include_metadata` query parameter to **true** for this property to appear in the response.", + "emailNotification": { + "$ref": "#/definitions/recipientEmailNotification", + "description": "An optional complex type that sets a specific email subject and body for this recipient's notification email. \n\n**Note**: You can set the `emailNotification` property separately for each recipient. If you set the value only for certain recipients, the other recipients will inherit the this value from the top-level `emailSubject` and `emailBlurb`. " + }, + "embeddedRecipientStartURL": { + "description": "Specifies a sender-provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. \n\nIf set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation launched by a partner.\n\nIt is important to understand that in a typical embedded workflow, the authentication of an embedded recipient is the responsibility of the sending application. DocuSign expects that senders will follow their own processes for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process is initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process, bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient.\n\nIf the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: `envelopeId`, `recipientId`, `recipientName`, `recipientEmail`, and `customFields`. The `customFields` property must be set for the recipient or envelope. The merge fields are enclosed in double brackets. \n\n*Example*: \n\n`http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` ", "type": "string" }, - "seatDiscounts": { - "description": " A complex type that contains any seat discount information. Valid values are: \n\n- `BeginSeatCount`\n- `EndSeatCount`\n- `SeatDiscountPercent`\n ", + "errorDetails": { + "$ref": "#/definitions/errorDetails", + "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." + }, + "excludedDocuments": { + "description": "Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true** for the envelope to use this.\n\nWhen enforce signer visibility is enabled, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent.", "type": "array", "items": { - "$ref": "#/definitions/seatDiscount" + "type": "string" } }, - "supportIncidentFee": { - "description": "The support incident fee charged for each support incident.", + "faxNumber": { + "description": "Reserved for DocuSign.", "type": "string" }, - "supportPlanFee": { - "description": "The support plan fee charged for this plan.", + "faxNumberMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Reserved for DocuSign." + }, + "firstName": { + "description": "The recipient's first name. Maximum Length: 50 characters.", "type": "string" - } - }, - "x-ds-definition-name": "accountBillingPlan", - "x-ms-summary": "Contains information about an account billing plan." - }, - "accountBillingPlanResponse": { - "description": "", - "type": "object", - "properties": { - "billingAddress": { - "$ref": "#/definitions/accountAddress", - "description": "The billing address for the account." }, - "billingAddressIsCreditCardAddress": { - "description": "When set to **true**, the credit card address information is the same as that returned as the billing address. If false, then the billing address is considered a billing contact address, and the credit card address can be different.", + "firstNameMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `firstame` property is editable. Read only." + }, + "fullName": { + "description": "Reserved for DocuSign.", "type": "string" }, - "billingPlan": { - "$ref": "#/definitions/accountBillingPlan", - "description": "An object that contains details about the billing plan." + "fullNameMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Reserved for DocuSign." }, - "creditCardInformation": { - "$ref": "#/definitions/creditCardInformation", - "description": "A complex type that has information about the credit card used to pay for this account." + "idCheckConfigurationName": { + "description": "The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are:\n\n- `Phone Auth $`: The recipient must authenticate by using two-factor authentication (2FA). You provide the phone number to use for 2FA in the `phoneAuthentication` object.\n- `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object.\n- `ID Check $`: The recipient must answer detailed security questions. \n\n**Example**: Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node.", + "type": "string" }, - "directDebitProcessorInformation": { - "$ref": "#/definitions/directDebitProcessorInformation", - "description": "Information about the bank that processes direct debits for the payment plan." + "idCheckConfigurationNameMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `idCheckConfigurationName` property is editable. Read only." }, - "paymentMethod": { - "description": "The payment method used for the billing plan. Valid values are:\n\n- `NotSupported`\n- `CreditCard`\n- `PurchaseOrder`\n- `Premium`\n- `Freemium`\n- `FreeTrial`\n- `AppStore`\n- `DigitalExternal`\n- `DirectDebit`", + "idCheckInformationInput": { + "$ref": "#/definitions/idCheckInformationInput", + "description": "An object that contains input information related to a recipient ID check." + }, + "identityVerification": { + "$ref": "#/definitions/recipientIdentityVerification", + "description": "Specifies the ID Verification workflow applied on an envelope by workflow ID.
See the [list](https://developers.docusign.com/docs/esign-rest-api/reference/Accounts/IdentityVerifications/list) method in the [IdentityVerifications](https://developers.docusign.com/docs/esign-rest-api/reference/Accounts/IdentityVerifications) resource for more information on how to retrieve workflow IDs available for an account.
This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods.
Note that ID Verification and ID Check are two distinct methods. ID Verification checks recipients' identity by verifying their ID while ID Check relies on data available on public records (such as current and former address)." + }, + "inheritEmailNotificationConfiguration": { + "description": "When set to **true** and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account. ", "type": "string" }, - "paymentProcessorInformation": { - "$ref": "#/definitions/paymentProcessorInformation", - "description": "Information about the entity that processes payments for the billing plan." + "lastName": { + "description": "The recipient's last name.", + "type": "string" }, - "referralInformation": { - "$ref": "#/definitions/referralInformation", - "description": "A complex type that contains the following information for entering referral and discount information. The following items are included in the referral information (all string content): enableSupport, includedSeats, saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, saleDiscountSeatPriceOverride, planStartMonth, referralCode, referrerName, advertisementId, publisherId, shopperId, promoCode, groupMemberId, idType, and industry \n\n###### Note: saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, and saleDiscountSeatPriceOverride are reserved for DoucSign use only. \n" + "lastNameMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `lastName` property is editable. Read only." }, - "successorPlans": { - "description": "", + "lockedRecipientPhoneAuthEditable": { + "description": "Reserved for DocuSign.", + "type": "string" + }, + "lockedRecipientSmsEditable": { + "description": "Reserved for DocuSign.", + "type": "string" + }, + "name": { + "description": "The full legal name of the recipient. Maximum Length: 100 characters.\n\n**Note**: You must always set a value for this property in requests, even if `firstName` and `lastName` are set.", + "type": "string" + }, + "nameMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `name` property is editable. Read only." + }, + "note": { + "description": "A note sent to the recipient in the signing email.\nThis note is unique to this recipient.\nIn the user interface,\nit appears near the upper left corner\nof the document\non the signing screen.\n\nMaximum Length: 1000 characters.\n", + "type": "string" + }, + "noteMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `note` property is editable. Read only." + }, + "phoneAuthentication": { + "$ref": "#/definitions/recipientPhoneAuthentication", + "description": "When `idCheckConfigurationName` is set to `Phone Auth $`, you use this complex type to provide the recipient authentication method details. It contains the following elements:\n\n* `recipMayProvideNumber`: Boolean. When set to **true**, the recipient can use whatever phone number they choose.\n* `senderProvidedNumbers`: ArrayOfStrings. A list of phone numbers the recipient can use.\n* `recordVoicePrint`: Reserved for DocuSign.\n* `validateRecipProvidedNumber`: Reserved for DocuSign.\n\n" + }, + "proofFile": { + "$ref": "#/definitions/recipientProofFile", + "description": "The proof file of the recipient." + }, + "recipientAttachments": { + "description": "Reserved for DocuSign.", "type": "array", "items": { - "$ref": "#/definitions/billingPlan" + "$ref": "#/definitions/recipientAttachment" } - } - }, - "x-ds-definition-name": "accountBillingPlanResponse", - "x-ms-summary": "" - }, - "accountIdentityVerificationResponse": { - "type": "object", - "properties": { - "identityVerification": { - "description": " ", + }, + "recipientAuthenticationStatus": { + "$ref": "#/definitions/authenticationStatus", + "description": "Information about the recipient's authentication status. Read only." + }, + "recipientFeatureMetadata": { + "description": "Metadata about the features that are supported for the recipient type. Read only.", "type": "array", "items": { - "$ref": "#/definitions/accountIdentityVerificationWorkflow" + "$ref": "#/definitions/featureAvailableMetadata" } - } - }, - "x-ds-definition-name": "accountIdentityVerificationResponse", - "description": "", - "x-ms-summary": "" - }, - "accountIdentityVerificationStep": { - "type": "object", - "properties": { - "name": { - "description": "Name of the identity verification step", + }, + "recipientId": { + "description": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the document.", "type": "string" }, - "type": { - "description": "Type of user:\n- `type_owner`\n- `type_participant`", + "recipientIdGuid": { + "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only.", "type": "string" - } - }, - "x-ds-definition-name": "accountIdentityVerificationStep", - "description": "Identity verification step", - "x-ms-summary": "Identity verification step" - }, - "accountIdentityVerificationWorkflow": { - "type": "object", - "properties": { - "defaultDescription": { - "description": "Text describing the purpose of the ID Verification workflow", + }, + "recipientType": { + "description": "The recipient type, as specified by the following values:\n- `agent`: Agent recipients can add name and email information for recipients that appear after the agent in routing order.\n- `carbonCopy`: Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date, or add information to any of the documents. This type of recipient can be used in any routing order.\n- `certifiedDelivery`: Certified delivery recipients must receive the completed documents for the envelope to be completed. They don't need to sign, initial, date, or add information to any of the documents.\n- `editor`: Editors have the same management and access rights for the envelope as the sender. Editors can add name and email information, add or change the routing order, set authentication options, and can edit signature/initial tabs and data fields for the remaining recipients.\n- `inPersonSigner`: In-person recipients are DocuSign users who act as signing hosts in the same physical location as the signer.\n- `intermediaries`: Intermediary recipients can optionally add name and email information for recipients at the same or subsequent level in the routing order.\n- `seal`: Electronic seal recipients represent legal entities.\n- `signer`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope.\n- `witness`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope.", + "type": "string" + }, + "recipientTypeMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `recipientType` property is editable. Read only." + }, + "requireIdLookup": { + "description": "When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. ", + "type": "string" + }, + "requireIdLookupMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `requireIdLookup` property is editable. Read only." + }, + "roleName": { + "description": "Optional element. Specifies the role name associated with the recipient.

This property is required when you are working with template recipients.", + "type": "string" + }, + "routingOrder": { + "description": "Specifies the routing order of the recipient in the envelope. ", + "type": "string" + }, + "routingOrderMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `routingOrder` property is editable. Read only." + }, + "sentDateTime": { + "description": "The UTC DateTime when the envelope was sent. Read only.", + "type": "string" + }, + "signedDateTime": { + "description": "Reserved for DocuSign.", + "type": "string" + }, + "signingGroupId": { + "description": "When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once).", + "type": "string" + }, + "signingGroupIdMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `signingGroupId` property is editable. Read only." + }, + "signingGroupName": { + "description": "Optional. The name of the signing group. \n\nMaximum Length: 100 characters. ", + "type": "string" + }, + "signingGroupUsers": { + "description": "A complex type that contains information about users in the signing group.", + "type": "array", + "items": { + "$ref": "#/definitions/userInfo" + } + }, + "smsAuthentication": { + "$ref": "#/definitions/recipientSMSAuthentication", + "description": "When `idCheckConfigurationName` is set to `SMS Auth $`, you use this complex type to provide the recipient authentication method details. It contains the element `senderProvidedNumbers`, which is an array of phone numbers that the recipient can use for SMS text authentication. \n\n" + }, + "socialAuthentications": { + "description": "Deprecated.", + "type": "array", + "items": { + "$ref": "#/definitions/socialAuthentication" + } + }, + "status": { + "description": "The status of the recipient. Read only. \n\nPossible values:\n\n- `autoresponded`: The recipient's email system auto-responded to the email from DocuSign. This status is used in the web console to inform senders about the bounced-back email. This recipient status is only used if **Send-on-behalf-of** is turned off for the account.\n- `completed`: The recipient has completed their actions (signing or other required actions if not a signer) for an envelope.\n- `created`: The recipient is in a draft state. This value is only associated with draft envelopes (envelopes that have a status of `created`).\n- `declined`: The recipient declined to sign the document(s) in the envelope.\n- `delivered`: The recipient has viewed the document(s) in an envelope through the DocuSign signing website. This is not an email delivery of the documents in an envelope.\n- `faxPending`: The recipient has finished signing and the system is waiting for a fax attachment from the recipient before completing their signing step.\n- `sent`: The recipient has been sent an email notification that it is their turn to sign an envelope.\n- `signed`: The recipient has completed (signed) all required tags in an envelope. This is a temporary state during processing, after which the recipient's status automatically switches to `completed`.", "type": "string" }, - "defaultName": { - "description": "Name of the ID Verification workflow", + "statusCode": { + "description": "The code associated with the recipient's status. Read only.", "type": "string" }, - "signatureProvider": { - "$ref": "#/definitions/accountSignatureProvider", - "description": "Signature provider associated with the identity verification workflow" + "suppressEmails": { + "description": "When set to **true**, email notifications are suppressed for the recipient, and they must access envelopes and documents from their DocuSign inbox.", + "type": "string" }, - "workflowId": { - "description": "Workflow unique ID
This is the ID you must specify when [setting ID Verification in an envelope](https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipients)", + "templateLocked": { + "description": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ", "type": "string" }, - "workflowResourceKey": { - "description": "Key for translated resources", + "templateRequired": { + "description": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.", + "type": "string" + }, + "totalTabCount": { + "description": "The total number of tabs in the documents. Read only.", + "type": "string" + }, + "userId": { + "description": "The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.\n", "type": "string" } }, - "x-ds-definition-name": "accountIdentityVerificationWorkflow", - "description": "Specifies an identity verification workflow", - "x-ms-summary": "Specifies an identity verification workflow" + "x-ds-definition-name": "certifiedDelivery", + "description": "Contains information about a certified delivery recipient. Certified delivery recipients must receive the completed documents for the envelope to be completed. However, they don't need to sign, initial, date or add information to any of the documents.", + "x-ms-summary": "Contains information about a certified delivery recipient. Certified delivery recipients must receive the completed documents for the envelope to be completed. However, they don't need to sign, initial, date or add information to any of the documents." }, - "accountInformation": { - "description": "", + "checkbox": { "type": "object", "properties": { - "accountIdGuid": { - "description": "The GUID associated with the account ID.", + "anchorAllowWhiteSpaceInCharacters": { + "description": "", "type": "string" }, - "accountName": { - "description": "The name of the account associated with the current workspace user.", + "anchorAllowWhiteSpaceInCharactersMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "" + }, + "anchorCaseSensitive": { + "description": "This property controls how [anchor tabs][AnchorTabs] are placed. When **true**, the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false**.\n\nFor example, when set to **true**, if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When set to **false**, `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**.\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place", "type": "string" }, - "accountSettings": { - "$ref": "#/definitions/accountSettingsInformation", - "description": "The list of\n[account settings][accountsettings]\nthat determine\nthe features available for the account.\nNote that some features are determined\nby the plan used to create the account and cannot be overridden.\n\n[accountsettings]: https://developers.docusign.com/esign-rest-api/reference/Accounts/Accounts/create/#account-settings\n" + "anchorCaseSensitiveMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorCaseSensitive` property is editable." }, - "allowTransactionRooms": { - "description": "When set to **true**, the transaction rooms feature exposed through the Workspaces API is enabled.", + "anchorHorizontalAlignment": { + "description": "This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are :\n\n- `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value.\n- `right`: Aligns the tab’s left side with the last character of the matching anchor word.\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place\n", "type": "string" }, - "billingPeriodDaysRemaining": { - "description": "Number of days remaining in the current billing period.", - "type": "string" + "anchorHorizontalAlignmentMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorHorizontalAlignment` property is editable." }, - "billingPeriodEndDate": { - "description": "The billing period end date in UTC timedate format.", + "anchorIgnoreIfNotPresent": { + "description": "When set to **true**, this tab is ignored if the `anchorString` is not found in the document.", "type": "string" }, - "billingPeriodEnvelopesAllowed": { - "description": "The number of envelopes that can be sent in the current billing period (can be unlimited).", - "type": "string" + "anchorIgnoreIfNotPresentMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable." }, - "billingPeriodEnvelopesSent": { - "description": "The number of envelopes that have been sent in the current billing period.", + "anchorMatchWholeWord": { + "description": "When set to **true**, the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false**.\n\nFor example, when set to **true**, if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When set to **false**, if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**.\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTab]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place\n", "type": "string" }, - "billingPeriodStartDate": { - "description": "The billing period start date in UTC timedate format.", - "type": "string" + "anchorMatchWholeWordMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorMatchWholeWord` property is editable." }, - "billingProfile": { - "description": "The type of billing method on the account; for example `direct` or `web`.", + "anchorString": { + "description": "Specifies the string to find in the document and use as the basis for tab placement.", "type": "string" }, - "canUpgrade": { - "description": "When set to **true**, specifies that you can upgrade the account through the API. For GET methods, you must set the `include_metadata` query parameter to **true** for this property to appear in the response.", - "type": "string" + "anchorStringMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorString` property is editable." }, - "connectPermission": { - "description": "", + "anchorTabProcessorVersion": { + "description": "Reserved for DocuSign.", "type": "string" }, - "createdDate": { - "description": "The creation date of the account in UTC timedate format.", + "anchorTabProcessorVersionMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Reserved for DocuSign." + }, + "anchorUnits": { + "description": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n", "type": "string" }, - "currencyCode": { - "description": "The currency code for the account, based on the [ISO 4217 currency code](https://www.iso.org/iso-4217-currency-codes.html).", + "anchorUnitsMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorUnits` property is editable." + }, + "anchorXOffset": { + "description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n", "type": "string" }, - "currentPlanId": { - "description": "ID of the plan used to create this account.", + "anchorXOffsetMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorXOffset` property is editable." + }, + "anchorYOffset": { + "description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n", "type": "string" }, - "distributorCode": { - "description": "The code that identifies the billing plan groups and plans for the new account.", + "anchorYOffsetMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorYOffset` property is editable." + }, + "bold": { + "description": "When set to **true**, the information in the tab is bold.", "type": "string" }, - "docuSignLandingUrl": { - "description": "URL of the landing page used to create the account.", + "boldMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `bold` property is editable." + }, + "conditionalParentLabel": { + "description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility.", "type": "string" }, - "envelopeSendingBlocked": { - "description": "When **true**, the ability to send envelopes is blocked. When **false**, envelopes can be sent.", + "conditionalParentLabelMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `conditionalParentLabel` property is editable." + }, + "conditionalParentValue": { + "description": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use \"on\" as the value to show that the parent tab is active.\n", "type": "string" }, - "envelopeUnitPrice": { - "description": "The price of sending an envelope, represented in the account's local currency.", + "conditionalParentValueMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `conditionalParentValue` property is editable." + }, + "customTabId": { + "description": "The DocuSign-generated custom tab ID for the custom tab to apply. This property can only be used when adding new tabs for a recipient. When used, the new tab inherits all custom tab properties.", "type": "string" }, - "externalAccountId": { - "description": "The Account ID displayed on the user's Account page.", + "customTabIdMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `customTabId` property is editable." + }, + "documentId": { + "description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.", "type": "string" }, - "forgottenPasswordQuestionsCount": { - "description": " A complex element that contains up to four Question/Answer pairs for forgotten password information for a user.", + "documentIdMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `documentId` property is editable." + }, + "errorDetails": { + "$ref": "#/definitions/errorDetails", + "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." + }, + "font": { + "description": "The font to be used for the tab value. Supported fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n", "type": "string" }, - "isDowngrade": { - "description": "When **true**, the account has been downgraded from a premium account type. Otherwise **false**.", + "fontColor": { + "description": "The font color to use for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n", "type": "string" }, - "paymentMethod": { - "description": "The payment method used for the billing plan. Valid values are:\n\n- `NotSupported`\n- `CreditCard`\n- `PurchaseOrder`\n- `Premium`\n- `Freemium`\n- `FreeTrial`\n- `AppStore`\n- `DigitalExternal`\n- `DirectDebit`", + "fontColorMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `fontColor` property is editable." + }, + "fontMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `font` property is editable." + }, + "fontSize": { + "description": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72", "type": "string" }, - "planClassification": { - "description": "Identifies the type of plan. Examples include:\n\n- `business`\n- `corporate`\n- `enterprise` \n- `free`", + "fontSizeMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `fontSize` property is editable." + }, + "formOrder": { + "description": "An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block.", "type": "string" }, - "planEndDate": { - "description": "The date that the current plan will end.", + "formOrderMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `formOrder` property is editable." + }, + "formPageLabel": { + "description": "A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience.", "type": "string" }, - "planName": { - "description": "The name of the billing plan used for the account.", + "formPageLabelMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `formPageLabel` property is editable." + }, + "formPageNumber": { + "description": "An integer specifying the order in which to present the guided form pages.", "type": "string" }, - "planStartDate": { - "description": "The date that the Account started using the current plan.", + "formPageNumberMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `fromPageNumber` property is editable." + }, + "height": { + "description": "The height of the tab in pixels.", "type": "string" }, - "recipientDomains": { - "description": "", - "type": "array", - "items": { - "$ref": "#/definitions/recipientDomain" - } + "heightMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `height` property is editable." }, - "seatsAllowed": { - "description": "The number of active users the account can have at one time.", + "italic": { + "description": "When set to **true**, the information in the tab is italic.", "type": "string" }, - "seatsInUse": { - "description": "The number of users currently active on the account.", + "italicMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `italic` property is editable." + }, + "locked": { + "description": "When set to **true**, the signer cannot change the data of the custom tab.", "type": "string" }, - "status21CFRPart11": { - "description": "The status of the account content per (Title 21 CFR Part 11)[https://www.fda.gov/regulatory-information/search-fda-guidance-documents/part-11-electronic-records-electronic-signatures-scope-and-application]. This regulation defines the criteria under which electronic records and electronic signatures are considered trustworthy.", + "lockedMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `locked` property is editable." + }, + "mergeField": { + "$ref": "#/definitions/mergeField", + "description": "Contains the information necessary to map the tab to a field in SalesForce." + }, + "mergeFieldXml": { + "description": "", "type": "string" }, - "suspensionDate": { - "description": "The date on which the account was suspended.", + "name": { + "description": "The name of the tab. For example, `Sign Here` or `Initial Here`.", "type": "string" }, - "suspensionStatus": { - "description": "Indicates whether the account is currently suspended.", + "nameMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `name` property is editable. Read only." + }, + "pageNumber": { + "description": "The page number on which the tab is located.\nFor supplemental documents, this value must be `1`.", "type": "string" - } - }, - "x-ds-definition-name": "accountInformation", - "x-ms-summary": "" - }, - "accountMinimumPasswordLength": { - "type": "object", - "properties": { - "maximumLength": { - "description": "", + }, + "pageNumberMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `pageNumber` property is editable." + }, + "recipientId": { + "description": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.", "type": "string" }, - "minimumLength": { - "description": "Minimum length of the access code string.", + "recipientIdGuid": { + "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only.", "type": "string" - } - }, - "x-ds-definition-name": "accountMinimumPasswordLength", - "description": "", - "x-ms-summary": "" - }, - "accountNotification": { - "type": "object", - "properties": { - "expirations": { - "$ref": "#/definitions/expirations", - "description": "A complex element that specifies the expiration settings for the envelope." }, - "reminders": { - "$ref": "#/definitions/reminders", - "description": "A complex element that specifies reminder settings for the envelope" + "recipientIdGuidMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `recipientIdGuid` property is editable." }, - "userOverrideEnabled": { - "description": "When **true**, the user can override envelope expirations.", + "recipientIdMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `recipientId` property is editable." + }, + "required": { + "description": "This property does not apply to `checkbox` tabs. Check boxes are always optional.", "type": "string" - } - }, - "x-ds-definition-name": "accountNotification", - "description": "A complex element that specifies notifications (expirations and reminders) for the envelope.", - "x-ms-summary": "A complex element that specifies notifications (expirations and reminders) for the envelope." - }, - "accountPasswordExpirePasswordDays": { - "type": "object", - "properties": { - "maximumDays": { - "description": "", + }, + "requiredMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `required` property is editable." + }, + "requireInitialOnSharedChange": { + "description": "Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.", "type": "string" }, - "minimumDays": { - "description": "", + "requireInitialOnSharedChangeMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `requireInitialOnSharedChange` property is editable." + }, + "selected": { + "description": "When **true**, the checkbox is selected.", "type": "string" - } - }, - "x-ds-definition-name": "accountPasswordExpirePasswordDays", - "description": "", - "x-ms-summary": "" - }, - "accountPasswordLockoutDurationMinutes": { - "type": "object", - "properties": { - "maximumMinutes": { - "description": "", + }, + "selectedMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `selected` property is editable." + }, + "shared": { + "description": "When **true**, this tab is shared.", "type": "string" }, - "minimumMinutes": { - "description": "", + "sharedMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `shared` property is editable.\n" + }, + "smartContractInformation": { + "$ref": "#/definitions/smartContractInformation", + "description": "" + }, + "status": { + "description": "The status of the tab. Possible values are:\n\n- `active`: The tab is active, but the recipient has not yet interacted with it.\n- `signed`: The recipient signed the tab.\n- `declined`: The recipient declined the envelope.\n- `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`).", "type": "string" - } - }, - "x-ds-definition-name": "accountPasswordLockoutDurationMinutes", - "description": "", - "x-ms-summary": "" - }, - "accountPasswordLockoutDurationType": { - "type": "object", - "properties": { - "options": { - "description": "An array of option strings supported by this setting.", + }, + "statusMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `status` property is editable." + }, + "tabGroupLabels": { + "description": "An array of tab group labels that uniquely identify tab groups. To assign a tab to a `tabGroup`, you assign the `TabGroupLabel` to the `Tab.TabGroupLabels` array.", "type": "array", "items": { "type": "string" } - } - }, - "x-ds-definition-name": "accountPasswordLockoutDurationType", - "description": "", - "x-ms-summary": "" - }, - "accountPasswordMinimumPasswordAgeDays": { - "type": "object", - "properties": { - "maximumAge": { - "description": "", - "type": "string" }, - "minimumAge": { - "description": "", - "type": "string" - } - }, - "x-ds-definition-name": "accountPasswordMinimumPasswordAgeDays", - "description": "", - "x-ms-summary": "" - }, - "accountPasswordQuestionsRequired": { - "type": "object", - "properties": { - "maximumQuestions": { - "description": "", - "type": "string" + "tabGroupLabelsMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `tabGroupLabels` property is editable." }, - "minimumQuestions": { - "description": "", - "type": "string" - } - }, - "x-ds-definition-name": "accountPasswordQuestionsRequired", - "description": "", - "x-ms-summary": "" - }, - "accountPasswordRules": { - "type": "object", - "properties": { - "expirePassword": { - "description": "", + "tabId": { + "description": "The unique identifier for the tab.", "type": "string" }, - "expirePasswordDays": { - "description": "", + "tabIdMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `tabId` property is editable." + }, + "tabLabel": { + "description": "The label associated with the tab. This value may be an empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum Length: 500 characters.\n", "type": "string" }, - "expirePasswordDaysMetadata": { - "$ref": "#/definitions/accountPasswordExpirePasswordDays", - "description": "Metadata that indicates whether the `expirePasswordDays` property is editable.\n" + "tabLabelMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `tabLabel` property is editable." }, - "lockoutDurationMinutes": { - "description": "", + "tabOrder": { + "description": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.", "type": "string" }, - "lockoutDurationMinutesMetadata": { - "$ref": "#/definitions/accountPasswordLockoutDurationMinutes", - "description": "Metadata that indicates whether the `lockoutDurationMinutes` property is editable.\n" + "tabOrderMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `tabOrder` property is editable." }, - "lockoutDurationType": { - "description": "", + "tabType": { + "description": "Indicates the type of tab (for example, `signHere` or `initialHere`).", "type": "string" }, - "lockoutDurationTypeMetadata": { - "$ref": "#/definitions/accountPasswordLockoutDurationType", - "description": "Metadata that indicates whether the `lockoutDurationType` property is editable.\n" + "tabTypeMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `tabType` property is editable." }, - "minimumPasswordAgeDays": { - "description": "", + "templateLocked": { + "description": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ", "type": "string" }, - "minimumPasswordAgeDaysMetadata": { - "$ref": "#/definitions/accountPasswordMinimumPasswordAgeDays", - "description": "Metadata that indicates whether the `minimumPasswordAgeDays` property is editable.\n" + "templateLockedMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `templateLocked` property is editable." }, - "minimumPasswordLength": { - "description": "", + "templateRequired": { + "description": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.", "type": "string" }, - "minimumPasswordLengthMetadata": { - "$ref": "#/definitions/accountMinimumPasswordLength", - "description": "Metadata that indicates whether the `minimumPasswordLength` property is editable.\n" + "templateRequiredMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `templateRequired` property is editable." }, - "passwordIncludeDigit": { - "description": "", + "tooltip": { + "description": "The text of a tooltip that appears when a user hovers over a form field or tab.", "type": "string" }, - "passwordIncludeDigitOrSpecialCharacter": { - "description": "", - "type": "string" + "toolTipMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `toolTip` property is editable." }, - "passwordIncludeLowerCase": { - "description": "", + "underline": { + "description": "When set to **true**, the information in the tab is underlined.", "type": "string" }, - "passwordIncludeSpecialCharacter": { - "description": "", - "type": "string" + "underlineMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `underline` property is editable." }, - "passwordIncludeUpperCase": { - "description": "", + "width": { + "description": "The width of the tab in pixels.", "type": "string" }, - "passwordStrengthType": { - "description": "", + "widthMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `width` property is editable." + }, + "xPosition": { + "description": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-7, -6)\n", "type": "string" }, - "passwordStrengthTypeMetadata": { - "$ref": "#/definitions/accountPasswordStrengthType", - "description": "Metadata that indicates whether the `passwordStrengthType` property is editable.\n" + "xPositionMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `xPosition` property is editable." }, - "questionsRequired": { - "description": "", + "yPosition": { + "description": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-7, -6)\n", + "type": "string" + }, + "yPositionMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `yPosition` property is editable." + } + }, + "x-ds-definition-name": "checkbox", + "description": "A tab that allows the recipient to select a yes/no (on/off) option.\n", + "x-ms-summary": "A tab that allows the recipient to select a yes/no (on/off) option.\n" + }, + "chunkedUploadPart": { + "type": "object", + "properties": { + "sequence": { + "description": "The order of the part in the chunked upload.", "type": "string" }, - "questionsRequiredMetadata": { - "$ref": "#/definitions/accountPasswordQuestionsRequired", - "description": "Metadata that indicates whether the `questionsRequired` property is editable.\n" + "size": { + "description": "The size of the part in bytes. \n\nWe recommend that a chunked upload part is no larger than a few MB in size.", + "type": "string" } }, - "x-ds-definition-name": "accountPasswordRules", - "description": "", - "x-ms-summary": "" + "x-ds-definition-name": "chunkedUploadPart", + "description": "An object that contains information about the chunked upload part.", + "x-ms-summary": "An object that contains information about the chunked upload part." }, - "accountPasswordStrengthType": { + "chunkedUploadRequest": { "type": "object", "properties": { - "options": { - "description": "An array of option strings supported by this setting.", - "type": "array", - "items": { - "$ref": "#/definitions/accountPasswordStrengthTypeOption" - } + "chunkedUploadId": { + "description": "The id of the chunked upload.\n\n**Note**: This property is ignored in requests, and overridden with an auto-generated value in responses.", + "type": "string" + }, + "data": { + "description": "A Base64-encoded representation of the content hat is used to upload the file. \n\nMaximum size: 50 MB. However, data is also subject to REST API limits regarding request sizes, and Internet Information Systems (IIS) might place further constraints on file size.", + "type": "string" } }, - "x-ds-definition-name": "accountPasswordStrengthType", - "description": "", - "x-ms-summary": "" + "x-ds-definition-name": "chunkedUploadRequest", + "description": "This is the request object for uploading a chunked upload.", + "x-ms-summary": "This is the request object for uploading a chunked upload." }, - "accountPasswordStrengthTypeOption": { + "chunkedUploadResponse": { "type": "object", "properties": { - "minimumLength": { - "description": "Minimum length of the access code string.", + "checksum": { + "description": "A 64-byte, Secure Hash Algorithm 256 (SHA256) checksum that the caller computes across the entirety of the original content that has been uploaded to the chunked upload. DocuSign compares this value to its own computation. If the two values are not equal, the original content and received content are not the same and the commit action is refused.", "type": "string" }, - "name": { - "description": "", + "chunkedUploadId": { + "description": "The id of the chunked upload. ", "type": "string" }, - "passwordIncludeDigit": { - "description": "", + "chunkedUploadParts": { + "description": "A list of the parts that compose the chunked upload, including their byte sizes. The list must be contiguous before you can commit the chunked upload.", + "type": "array", + "items": { + "$ref": "#/definitions/chunkedUploadPart" + } + }, + "chunkedUploadUri": { + "description": "The URI that you use to reference the chunked upload in other API requests, such as envelope document and envelope attachment requests. ", "type": "string" }, - "passwordIncludeDigitOrSpecialCharacter": { - "description": "", + "committed": { + "description": "When **true**, the chunked upload has been committed. A committed chunked upload can no longer receive any additional parts and is ready for use within other API requests. ", "type": "string" }, - "passwordIncludeLowerCase": { - "description": "", + "expirationDateTime": { + "description": "The UTC time at which the chunked upload expires and is no longer addressable. \n\n**Note**: You must fully upload and use a chunked upload within 20 minutes of initializing it.\n", "type": "string" }, - "passwordIncludeSpecialCharacter": { - "description": "", + "maxChunkedUploadParts": { + "description": "The maximum number of parts allowed for a chunked upload. This value is configurable per DocuSign environment, account, or integrator. The default value is 128. The maximum possible value is 256. ", "type": "string" }, - "passwordIncludeUpperCase": { - "description": "", + "maxTotalSize": { + "description": "The maximum total size allowed for a chunked upload. This value is configured per DocuSign environment, account, or integrator. The default value is 50 MB.", + "type": "string" + }, + "totalSize": { + "description": "The total size of the parts of the chunked upload.\n\n**Note**: When a chunked upload is used as an envelope document, it is subject to the PDF size limit (25 MB) and page count limit that apply to all envelope documents.", "type": "string" } }, - "x-ds-definition-name": "accountPasswordStrengthTypeOption", - "description": "", - "x-ms-summary": "" + "x-ds-definition-name": "chunkedUploadResponse", + "description": "This response object is returned after you upload a chunked upload.", + "x-ms-summary": "This response object is returned after you upload a chunked upload." }, - "accountRoleSettings": { + "cloudStorageProvider": { "type": "object", "properties": { - "allowAccountManagement": { - "description": "When **true**, users have full administrative access to the account.", + "authenticationUrl": { + "description": "The authentication URL used for the cloud storage provider. This information is only included in the response if the user has not passed authentication for the cloud storage provider. If the redirectUrl query string is provided, the returnUrl is appended to the authenticationUrl. ", "type": "string" }, - "allowAccountManagementMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `allowAccountManagement` property is editable.\n" + "errorDetails": { + "$ref": "#/definitions/errorDetails", + "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." }, - "allowApiAccess": { - "description": "When **true**, users can manage documents by using the API.", + "redirectUrl": { + "description": "The URL the user is redirected to after the cloud storage provider authenticates the user. Using this will append the redirectUrl to the authenticationUrl.\n\nThe redirectUrl is restricted to URLs in the docusign.com or docusign.net domains.", "type": "string" }, - "allowApiAccessMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `allowApiAccess` property is editable.\n" - }, - "allowApiAccessToAccount": { - "description": "When **true**, users can access the account by using the eSignature API.", + "service": { + "description": "The service name for the cloud storage provider.", "type": "string" }, - "allowApiAccessToAccountMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `allowApiAccessToAccount` property is editable.\n" - }, - "allowApiSendingOnBehalfOfOthers": { - "description": "When **true**, users can send envelopes on behalf of others.", + "serviceId": { + "description": "The DocuSign-generated ID for the cloud storage provider.", "type": "string" - }, - "allowApiSendingOnBehalfOfOthersMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `allowApiSendingOnBehalfOfOthers` property is editable.\n" - }, - "allowApiSequentialSigning": { - "description": "When **true**, users may specify sequential signing recipients when they send documents by using the API.", + } + }, + "x-ds-definition-name": "cloudStorageProvider", + "description": "Contains details about a specific cloud storage provider.", + "x-ms-summary": "Contains details about a specific cloud storage provider." + }, + "cloudStorageProviders": { + "type": "object", + "properties": { + "storageProviders": { + "description": "An Array containing the storage providers associated with the user.", + "type": "array", + "items": { + "$ref": "#/definitions/cloudStorageProvider" + } + } + }, + "x-ds-definition-name": "cloudStorageProviders", + "description": "", + "x-ms-summary": "" + }, + "comment": { + "type": "object", + "properties": { + "envelopeId": { + "description": "The Guid of the envelope the comment thread belongs to.", "type": "string" }, - "allowApiSequentialSigningMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `allowApiSequentialSigning` property is editable.\n" - }, - "allowBulkSending": { - "description": "When **true**, bulk sending is enabled for users.", + "hmac": { + "description": "Reserved for DocuSign.", "type": "string" }, - "allowBulkSendingMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `allowBulkSending` property is editable.\n" - }, - "allowDocuSignDesktopClient": { - "description": "When **true**, the DocuSign Desktop Client is enabled for users.\n", + "id": { + "description": "The unique identifier for the comment.", "type": "string" }, - "allowDocuSignDesktopClientMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `allowDocuSignDesktopClient` property is editable.\n" - }, - "allowedAddressBookAccess": { - "description": "Specifies the level of access that users have to the account's address book. Valid values are:\n\n- `personal`\n- `useShared`\n- `usePersonalAndShared`\n- `personalAndShared`\n", - "type": "string" + "mentions": { + "description": "An array of userIds that are mentioned directly in the body of a comment.", + "type": "array", + "items": { + "type": "string" + } }, - "allowedAddressBookAccessMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `allowedAddressBookAccess` property is editable.\n" + "read": { + "description": "When **true**, indicates that the comment was read.", + "type": "boolean" }, - "allowedTemplateAccess": { - "description": "Specifies the level of access that users have to account templates. Valid values are: \n\n- `none` \n- `use`\n- `create`\n- `share`", + "sentByEmail": { + "description": "The email address of the user who created the comment.", "type": "string" }, - "allowedTemplateAccessMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `allowedTemplateAccess` property is editable.\n" - }, - "allowedToBeEnvelopeTransferRecipient": { - "description": "When **true**, users can be recipients of envelopes transferred to them by administrators of other accounts. ", + "sentByFullName": { + "description": "The full name of the user who created the comment.", "type": "string" }, - "allowedToBeEnvelopeTransferRecipientMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `allowedToBeEnvelopeTransferRecipient` property is editable.\n" - }, - "allowEnvelopeSending": { - "description": "When **true**, users can send envelopes.", + "sentByImageId": { + "description": "Reserved for DocuSign.", "type": "string" }, - "allowEnvelopeSendingMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `allowEnvelopeSending` property is editable.\n" - }, - "allowESealRecipients": { - "description": "When **true**, users can add electronic seal ([eSeal](https://support.docusign.com/en/guides/ndse-user-guide-apply-electronic-seals)) recipients.", + "sentByInitials": { + "description": "The initials of the user who created the comment.", "type": "string" }, - "allowESealRecipientsMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `allowESealRecipients` property is editable." - }, - "allowPowerFormsAdminToAccessAllPowerFormEnvelopes": { - "description": "When **true**, PowerForm Administrators can access all of the PowerForm envelopes associated with the account.", + "sentByRecipientId": { + "description": "The recipient id of the user who created the comment.", "type": "string" }, - "allowPowerFormsAdminToAccessAllPowerFormEnvelopesMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `allowPowerFormsAdminToAccessAllPowerFormEnvelopes` property is editable." - }, - "allowSendersToSetRecipientEmailLanguage": { - "description": "When **true**, senders can set the language of the email that is sent to recipients.", + "sentByUserId": { + "description": "The user id of the user who created the comment.", "type": "string" }, - "allowSendersToSetRecipientEmailLanguageMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `allowSendersToSetRecipientEmailLanguage` property is editable.\n" - }, - "allowSignerAttachments": { - "description": "When **true**, users can add requests for attachments from signers.", + "signingGroupId": { + "description": "The id of the signing group that can view the comment or that created the comment.", "type": "string" }, - "allowSignerAttachmentsMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `allowSignerAttachments` property is editable.\n" - }, - "allowSupplementalDocuments": { - "description": "When **true**, senders can include supplemental documents.", + "signingGroupName": { + "description": "Optional. The name of the signing group. \n\nMaximum Length: 100 characters. ", "type": "string" }, - "allowSupplementalDocumentsMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `allowSupplementalDocuments` property is editable." - }, - "allowTaggingInSendAndCorrect": { - "description": "When **true**, the tagger palette is visible during the sending and correct flows and users can add tabs to documents.", + "subject": { + "description": "The subject of the envelope.", "type": "string" }, - "allowTaggingInSendAndCorrectMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `allowTaggingInSendAndCorrect` property is editable.\n" - }, - "allowVaulting": { - "description": "Reserved for DocuSign.", + "tabId": { + "description": "The unique identifier for the tab that represents the comment thread.", "type": "string" }, - "allowVaultingMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Reserved for DocuSign." - }, - "allowWetSigningOverride": { - "description": "When **true**, users can override the default account setting that controls whether recipients can sign documents on paper. The option to overrride this setting occurs during the sending process on a per-envelope basis.", + "text": { + "description": "The content of the comment, as UTF-8 text. \n\nMaximum Length: 500 characters.\n\n**Note**: The maximum size allowed for the entire message body is 32 KB. ", "type": "string" }, - "allowWetSigningOverrideMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `allowWetSigningOverride` property is editable.\n" + "threadId": { + "description": "The unique identifier for the comment thread.", + "type": "string" }, - "canCreateWorkspaces": { - "description": "Reserved for DocuSign.", + "threadOriginatorId": { + "description": "The userId of the user who created the thread.", "type": "string" }, - "canCreateWorkspacesMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Reserved for DocuSign." + "timestamp": { + "description": "The time the comment was created.", + "type": "string" }, - "disableDocumentUpload": { - "description": "When **true**, users cannot upload documents.", + "timeStampFormatted": { + "description": "The time the comment was created, formatted according to the format of the user who created the comment.", "type": "string" }, - "disableDocumentUploadMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `disableDocumentUpload` property is editable.\n" + "visibleTo": { + "description": "The user ids of the users that the comment is visible to.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ds-definition-name": "comment", + "description": "", + "x-ms-summary": "" + }, + "commentHistoryResult": { + "type": "object", + "properties": { + "comments": { + "description": "An array of comment tabs that contain information about users' comments on documents.", + "type": "array", + "items": { + "$ref": "#/definitions/comment" + } }, - "disableOtherActions": { - "description": "When **true**, users can access the **Other Actions** menu.", - "type": "string" + "count": { + "format": "int32", + "description": "The maximum number of results to return.", + "type": "integer" }, - "disableOtherActionsMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `disableOtherActions` property is editable.\n" + "endTimetoken": { + "description": "", + "type": "string" }, - "enableApiRequestLogging": { - "description": "When **true**, API request logging is enabled.\n\n**Note**: Logging limits apply.", + "startTimetoken": { + "description": "", + "type": "string" + } + }, + "x-ds-definition-name": "commentHistoryResult", + "description": "", + "x-ms-summary": "" + }, + "commentPublish": { + "type": "object", + "properties": { + "id": { + "description": "A unique ID for the Salesforce object.", "type": "string" }, - "enableApiRequestLoggingMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `enableApiRequestLogging` property is editable.\n" + "mentions": { + "description": "An array of userIds that are mentioned directly in the body of a comment.", + "type": "array", + "items": { + "type": "string" + } }, - "enableRecipientViewingNotifications": { - "description": "When **true**, senders are notified when recipients view the documents that they send.", + "text": { + "description": "Specifies the text that is shown in the dropdown list. ", "type": "string" }, - "enableRecipientViewingNotificationsMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `enableRecipientViewingNotifications` property is editable.\n" + "threadAnchorKeys": { + "description": "", + "type": "object", + "additionalProperties": { + "type": "string" + } }, - "enableSequentialSigningInterface": { - "description": "When **true**, the sequential signing user interface is enabled.", + "threadId": { + "description": "The unique identifier for the comment thread.", "type": "string" }, - "enableSequentialSigningInterfaceMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `enableSequentialSigningInterface` property is editable.\n" - }, - "enableTransactionPointIntegration": { - "description": "Reserved for DocuSign.", + "visibleTo": { + "description": "", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ds-definition-name": "commentPublish", + "description": "", + "x-ms-summary": "" + }, + "commentsPublish": { + "type": "object", + "properties": { + "commentsToPublish": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/commentPublish" + } + } + }, + "x-ds-definition-name": "commentsPublish", + "description": "", + "x-ms-summary": "" + }, + "commentThread": { + "type": "object", + "properties": { + "anchorAllowWhiteSpaceInCharacters": { + "description": "", "type": "string" }, - "enableTransactionPointIntegrationMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Reserved for DocuSign." + "anchorAllowWhiteSpaceInCharactersMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "" }, - "powerFormRole": { - "description": "The PowerForms rights associated with the account permission profile. Valid values are:\n\n- `none` \n- `user` \n- `admin`\n", + "anchorCaseSensitive": { + "description": "This property controls how [anchor tabs][AnchorTabs] are placed. When **true**, the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false**.\n\nFor example, when set to **true**, if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When set to **false**, `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**.\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place", "type": "string" }, - "powerFormRoleMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `powerFormRole` property is editable.\n" + "anchorCaseSensitiveMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorCaseSensitive` property is editable." }, - "receiveCompletedSelfSignedDocumentsAsEmailLinks": { - "description": "When **true**, senders receive emails about completed, self-signed documents that contain links to the completed documents instead of PDF attachments.", + "anchorHorizontalAlignment": { + "description": "This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are :\n\n- `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value.\n- `right`: Aligns the tab’s left side with the last character of the matching anchor word.\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place\n", "type": "string" }, - "receiveCompletedSelfSignedDocumentsAsEmailLinksMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `receiveCompletedSelfSignedDocumentsAsEmailLinks` property is editable.\n" - }, - "signingUiVersionMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Reserved for DocuSign." + "anchorHorizontalAlignmentMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorHorizontalAlignment` property is editable." }, - "supplementalDocumentsMustAccept": { - "description": "When **true**, senders can require recipients to accept supplemental documents.", + "anchorIgnoreIfNotPresent": { + "description": "When set to **true**, this tab is ignored if the `anchorString` is not found in the document.", "type": "string" }, - "supplementalDocumentsMustAcceptMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `supplementalDocumentsMustAccept` property is editable.\n" + "anchorIgnoreIfNotPresentMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable." }, - "supplementalDocumentsMustRead": { - "description": "When **true**, senders can require recipients to read supplemental documents.", + "anchorMatchWholeWord": { + "description": "When set to **true**, the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false**.\n\nFor example, when set to **true**, if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When set to **false**, if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**.\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTab]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place\n", "type": "string" }, - "supplementalDocumentsMustReadMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `supplementalDocumentsMustRead` property is editable.\n" + "anchorMatchWholeWordMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorMatchWholeWord` property is editable." }, - "supplementalDocumentsMustView": { - "description": "When **true**, users can require recipients to view supplemental documents.", + "anchorString": { + "description": "Specifies the string to find in the document and use as the basis for tab placement.", "type": "string" }, - "supplementalDocumentsMustViewMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `supplementalDocumentsMustView` property is editable.\n" + "anchorStringMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorString` property is editable." }, - "useNewDocuSignExperienceInterface": { + "anchorTabProcessorVersion": { "description": "Reserved for DocuSign.", "type": "string" }, - "useNewDocuSignExperienceInterfaceMetadata": { - "$ref": "#/definitions/settingsMetadata", + "anchorTabProcessorVersionMetadata": { + "$ref": "#/definitions/propertyMetadata", "description": "Reserved for DocuSign." }, - "useNewSendingInterface": { - "description": "Reserved for DocuSign.", + "anchorUnits": { + "description": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n", "type": "string" }, - "useNewSendingInterfaceMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Reserved for DocuSign." + "anchorUnitsMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorUnits` property is editable." }, - "vaultingMode": { - "description": "Reserved for DocuSign.", + "anchorXOffset": { + "description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n", "type": "string" }, - "vaultingModeMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Reserved for DocuSign." - } - }, - "x-ds-definition-name": "accountRoleSettings", - "description": "This object defines account permissions for users who are associated with the account permission profile. ", - "x-ms-summary": "This object defines account permissions for users who are associated with the account permission profile. " - }, - "accountSeals": { - "type": "object", - "properties": { - "seals": { - "description": "A list of electronic seals to apply to documents.", - "type": "array", - "items": { - "$ref": "#/definitions/sealIdentifier" - } - } - }, - "x-ds-definition-name": "accountSeals", - "description": "", - "x-ms-summary": "" - }, - "accountSettingsInformation": { - "description": "Contains account settings information. Used in requests to set property values. Used in responses to report property values.", - "type": "object", - "properties": { - "accessCodeFormat": { - "$ref": "#/definitions/accessCodeFormat", - "description": "Format of the string provided to a recipient in order to access an envelope." + "anchorXOffsetMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorXOffset` property is editable." }, - "accountDateTimeFormat": { - "description": "UTC date/time format for the account.", + "anchorYOffset": { + "description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n", "type": "string" }, - "accountDateTimeFormatMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `accountDateTimeFormat` property is editable." + "anchorYOffsetMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorYOffset` property is editable." }, - "accountName": { - "description": "The name of the account associated with the current workspace user.", + "bold": { + "description": "When set to **true**, the information in the tab is bold.", "type": "string" }, - "accountNameMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `accountName` property is editable." + "boldMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `bold` property is editable." }, - "accountNotification": { - "$ref": "#/definitions/accountNotification", - "description": "An object that specifies notifications (expirations and reminders) for the envelope." + "comments": { + "description": "An array of comment tabs that contain information about users' comments on documents.", + "type": "array", + "items": { + "$ref": "#/definitions/comment" + } }, - "adoptSigConfig": { - "description": "If **true**, [Signature Adoption Configuration](https://support.docusign.com/en/guides/ndse-admin-guide-signature-adopt-config) is enabled.", + "conditionalParentLabel": { + "description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility.", "type": "string" }, - "adoptSigConfigMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `adoptSigConfig` property is editable.\n" + "conditionalParentLabelMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `conditionalParentLabel` property is editable." }, - "advancedCorrect": { - "description": "If **true**, the Advanced Correction feature is enabled for this account.", + "conditionalParentValue": { + "description": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use \"on\" as the value to show that the parent tab is active.\n", "type": "string" }, - "advancedCorrectMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `advancedCorrect` property is editable.\n" + "conditionalParentValueMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `conditionalParentValue` property is editable." }, - "allowAccessCodeFormat": { - "description": "Boolean that specifies whether the configured [access code format](https://developers.docusign.com/esign-rest-api/reference/Accounts/Accounts/get#accessCodeFormat) is enabled for the account.", + "customTabId": { + "description": "The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.", "type": "string" }, - "allowAccessCodeFormatMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `allowAccessCodeFormat` property is editable.\n" + "customTabIdMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `customTabId` property is editable." }, - "allowAccountManagementGranular": { - "description": "Boolean that specifies whether the account can be managed on a per-user basis.", + "documentId": { + "description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.", "type": "string" }, - "allowAccountManagementGranularMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `allowAccountManagementGranular` property is editable.\n" + "documentIdMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `documentId` property is editable." }, - "allowAccountMemberNameChange": { - "description": "Boolean that specifies whether member names can be changed in the account.", - "type": "string" + "errorDetails": { + "$ref": "#/definitions/errorDetails", + "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." }, - "allowAccountMemberNameChangeMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `allowAccountMemberNameChange` property is editable.\n" + "font": { + "description": "The font to be used for the tab value. Supported fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n", + "type": "string" }, - "allowAgentNameEmailEdit": { - "description": " If **true**, an agent recipient can change the email addresses of recipients later in the signing order.\n", + "fontColor": { + "description": "The font color to use for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n", "type": "string" }, - "allowAgentNameEmailEditMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `allowAgentNameEmailEdit` property is editable.\n" + "fontColorMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `fontColor` property is editable." }, - "allowAutoNavSettings": { - "description": " If **true**, auto-navigation can be enabled for this account.\n", + "fontMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `font` property is editable." + }, + "fontSize": { + "description": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72", "type": "string" }, - "allowAutoNavSettingsMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `allowAutoNavSettings` property is editable.\n" + "fontSizeMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `fontSize` property is editable." }, - "allowBulkSend": { - "description": "If **true**, the account is able to bulk send.", + "formOrder": { + "description": "An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block.", "type": "string" }, - "allowBulkSendMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `allowBulkSend` property is editable.\n" + "formOrderMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `formOrder` property is editable." }, - "allowCDWithdraw": { - "description": "Indicates whether the customer can withdraw their acceptance of the consumer disclosure.", + "formPageLabel": { + "description": "A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience.", "type": "string" }, - "allowCDWithdrawMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `allowCDWithdraw` property is editable.\n" + "formPageLabelMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `formPageLabel` property is editable." }, - "allowConnectHttpListenerConfigs": { - "description": "Boolean that specifies whether a Connect configuration can use HTTP listeners.", + "formPageNumber": { + "description": "An integer specifying the order in which to present the guided form pages.", "type": "string" }, - "allowConnectSendFinishLater": { - "description": "If **true**, Connect will send FinishLater messages\n", + "formPageNumberMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `fromPageNumber` property is editable." + }, + "height": { + "description": "The height of the tab in pixels.", "type": "string" }, - "allowConnectSendFinishLaterMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `allowConnectSendFinishLater` property is editable.\n" + "heightMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `height` property is editable." }, - "allowConsumerDisclosureOverride": { - "description": "If **true**,\nthe account has the ability to change the\n[Consumer Disclosure](https://support.docusign.com/en/guides/ndse-admin-guide-legal-disclosure)\nsettin.\n", + "italic": { + "description": "When set to **true**, the information in the tab is italic.", "type": "string" }, - "allowConsumerDisclosureOverrideMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `allowConsumerDisclosureOverride` property is editable.\n" + "italicMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `italic` property is editable." }, - "allowDataDownload": { - "description": "If **true**,\nsenders can download form data from an envelope.\n", - "type": "string" + "localePolicy": { + "$ref": "#/definitions/localePolicyTab", + "description": "Reserved for DocuSign." }, - "allowDataDownloadMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `allowDataDownload` property is editable.\n" + "mergeField": { + "$ref": "#/definitions/mergeField", + "description": "Contains the information necessary to map the tab to a field in SalesForce." }, - "allowDocumentDisclosures": { - "description": "Boolean that specifies whether disclosure documents can be included in envelopes.", + "mergeFieldXml": { + "description": "", "type": "string" }, - "allowDocumentDisclosuresMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `allowDocumentDisclosures` property is editable.\n" - }, - "allowDocumentsOnSignedEnvelopes": { - "description": "Boolean that specifies whether notifications can include the envelope's signed document.", + "pageNumber": { + "description": "Specifies the page number on which the tab is located.", "type": "string" }, - "allowDocumentsOnSignedEnvelopesMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `allowDocumentsOnSignedEnvelopes` property is editable.\n" + "pageNumberMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `pageNumber` property is editable." }, - "allowDocumentVisibility": { - "description": "When **true**, the [Document Visibility](https://support.docusign.com/guides/ndse-user-guide-document-visibility) feature is enabled for the account.\n", + "recipientId": { + "description": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.", "type": "string" }, - "allowDocumentVisibilityMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `allowDocumentVisibility` property is editable.\n" - }, - "allowEHankoStamps": { - "description": "If **true**,\n[eHanko stamps](https://support.docusign.com/en/guides/ndse-user-guide-manage-your-stamps)\nare enabled.\n", + "recipientIdGuid": { + "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only.", "type": "string" }, - "allowEHankoStampsMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `allowEHankoStamps` property is editable.\n" + "recipientIdGuidMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `recipientIdGuid` property is editable." }, - "allowENoteEOriginal": { - "description": "Specifies whether eNote eOriginal integration is enabled.\n", - "type": "string" + "recipientIdMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `recipientId` property is editable." }, - "allowENoteEOriginalMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `allowENoteEOriginal` property is editable.\n" + "smartContractInformation": { + "$ref": "#/definitions/smartContractInformation", + "description": "" }, - "allowEnvelopeCorrect": { - "description": "Specifies whether the correction feature is enabled.\n", + "status": { + "description": "The status of the tab. Possible values are:\n\n- `active`: The tab is active, but the recipient has not yet interacted with it.\n- `signed`: The recipient signed the tab.\n- `declined`: The recipient declined the envelope.\n- `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`).", "type": "string" }, - "allowEnvelopeCorrectMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `allowEnvelopeCorrect` property is editable.\n" + "statusMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `status` property is editable." }, - "allowEnvelopeCustodyTransfer": { - "description": "Specifies whether the account is able to\nmanage rules that [transfer ownership](https://support.docusign.com/en/guides/ndse-admin-guide-custody-transfer)\nof envelopes wthin the same account.\n\n\n\n", - "type": "string" + "tabGroupLabels": { + "description": "An array of tab group labels that uniquely identify tab groups. To assign a tab to a `tabGroup`, you assign the `TabGroupLabel` to the `Tab.TabGroupLabels` array.", + "type": "array", + "items": { + "type": "string" + } }, - "allowEnvelopeCustodyTransferMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `allowEnvelopeCustodyTransfer` property is editable.\n" + "tabGroupLabelsMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `tabGroupLabels` property is editable." }, - "allowEnvelopeCustomFields": { - "description": "Specifies whether\n[envelope custom fields](https://support.docusign.com/en/guides/ndse-user-guide-manage-custom-fields)\nare enabled.\n", + "tabId": { + "description": "The unique identifier for the tab.", "type": "string" }, - "allowEnvelopeCustomFieldsMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `allowEnvelopeCustomFields` property is editable.\n" + "tabIdMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `tabId` property is editable." }, - "allowEnvelopePublishReporting": { - "description": "Specifies whether envelope publishing reporting is enabled.\n", + "tabLabel": { + "description": "The label associated with the tab. This value may be an empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum Length: 500 characters.\n", "type": "string" }, - "allowEnvelopePublishReportingMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `allowEnvelopePublishReporting` property is editable.\n" + "tabLabelMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `tabLabel` property is editable." }, - "allowEnvelopeReporting": { - "description": "Specifies whether the account has access to reports.\n", + "tabOrder": { + "description": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.", "type": "string" }, - "allowEnvelopeReportingMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `allowEnvelopeReporting` property is editable.\n" + "tabOrderMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `tabOrder` property is editable." }, - "allowExpression": { - "description": "If the account plan does not include calculated fields, this setting allows an account to use them.\n\n", + "tabType": { + "description": "Indicates the type of tab (for example, `signHere` or `initialHere`).", "type": "string" }, - "allowExpressionMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `allowExpression` property is editable.\n" + "tabTypeMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `tabType` property is editable." }, - "allowExpressSignerCertificate": { - "description": "Specifies whether signers\nare required to use Express Digital Signatures.\n", + "templateLocked": { + "description": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ", "type": "string" }, - "allowExpressSignerCertificateMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `allowExpressSignerCertificate` property is editable.\n" + "templateLockedMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `templateLocked` property is editable." }, - "allowExtendedSendingResourceFile": { - "description": "Boolean that specifies whether resource files can be used for extended sending.", + "templateRequired": { + "description": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.", "type": "string" }, - "allowExtendedSendingResourceFileMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `allowExtendedSendingResourceFile` property is editable.\n" + "templateRequiredMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `templateRequired` property is editable." }, - "allowExternalSignaturePad": { - "description": "Specifies whether the account can\nconfigure and use signature pads for their recipients.\n", + "threadId": { + "description": "The unique identifier for the comment thread.", "type": "string" }, - "allowExternalSignaturePadMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `allowExternalSignaturePad` property is editable.\n" - }, - "allowInPerson": { - "description": "Specifies whether the account administrator can\nenable\nin person signing.\n\n", + "tooltip": { + "description": "The text of a tooltip that appears when a user hovers over a form field or tab.", "type": "string" }, - "allowInPersonMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `allowInPerson` property is editable.\n" + "toolTipMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `toolTip` property is editable." }, - "allowManagedStamps": { - "description": "Boolean that specifies whether managed stamps can be used in the account.", + "underline": { + "description": "When set to **true**, the information in the tab is underlined.", "type": "string" }, - "allowManagedStampsMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `allowManagedStamps` property is editable.\n" + "underlineMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `underline` property is editable." }, - "allowMarkup": { - "description": "When **true**, Document Markup is enabled for envelope. The account must have Document Markup enabled to use this.", + "width": { + "description": "The width of the tab in pixels.", "type": "string" }, - "allowMarkupMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `allowMarkup` property is editable.\n" + "widthMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `width` property is editable." }, - "allowMemberTimeZone": { - "description": "Specifies whether users can set their own\n[time zone settings](https://support.docusign.com/en/articles/How-do-I-modify-time-zone-settings-for-my-account).\n", + "xPosition": { + "description": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n", "type": "string" }, - "allowMemberTimeZoneMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `allowMemberTimeZone` property is editable.\n" + "xPositionMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `xPosition` property is editable." }, - "allowMergeFields": { - "description": "Specified whether\n[merge fields](https://support.docusign.com/en/guides/dfs-user-guide-merge-fields-user)\nare enabled for the account.\n", + "yPosition": { + "description": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n", "type": "string" }, - "allowMergeFieldsMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `allowMergeFields` property is editable.\n" - }, - "allowMultipleBrandProfiles": { - "description": "Specifies whether the account supports multiple brands.\n", + "yPositionMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `yPosition` property is editable." + } + }, + "x-ds-definition-name": "commentThread", + "description": "", + "x-ms-summary": "" + }, + "commissionCounty": { + "type": "object", + "properties": { + "anchorAllowWhiteSpaceInCharacters": { + "description": "", "type": "string" }, - "allowMultipleBrandProfilesMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `allowMultipleBrandProfiles` property is editable.\n" + "anchorAllowWhiteSpaceInCharactersMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "" }, - "allowMultipleSignerAttachments": { - "description": "Specifies whether recipients are able to\nupload multiple signer attachments with a single attachment.\n", + "anchorCaseSensitive": { + "description": "This property controls how [anchor tabs][AnchorTabs] are placed. When **true**, the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false**.\n\nFor example, when set to **true**, if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When set to **false**, `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**.\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place", "type": "string" }, - "allowMultipleSignerAttachmentsMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `allowMultipleSignerAttachments` property is editable.\n" + "anchorCaseSensitiveMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorCaseSensitive` property is editable." }, - "allowNonUSPhoneAuth": { - "description": "Specifies whether users can use\ninternational numbers\nfor phone authentication.\n", + "anchorHorizontalAlignment": { + "description": "This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are :\n\n- `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value.\n- `right`: Aligns the tab’s left side with the last character of the matching anchor word.\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place\n", "type": "string" }, - "allowNonUSPhoneAuthMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `allowNonUSPhoneAuth` property is editable.\n" + "anchorHorizontalAlignmentMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorHorizontalAlignment` property is editable." }, - "allowOfflineSigning": { - "description": "Specifies whether\n[offline signing](https://support.docusign.com/articles/Offline-access-with-the-DocuSign-Mobile-App-for-iOS-iPad-iPhone-iPod-Touch)\nis enabled for the account.\n", + "anchorIgnoreIfNotPresent": { + "description": "When set to **true**, this tab is ignored if the `anchorString` is not found in the document.", "type": "string" }, - "allowOfflineSigningMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `allowOfflineSigning` property is editable.\n" + "anchorIgnoreIfNotPresentMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable." }, - "allowOpenTrustSignerCertificate": { - "description": "Boolean that specifies whether OpenTrust signer certificates can be used in the account.", + "anchorMatchWholeWord": { + "description": "When set to **true**, the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false**.\n\nFor example, when set to **true**, if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When set to **false**, if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**.\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTab]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place\n", "type": "string" }, - "allowOpenTrustSignerCertificateMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `allowOpenTrustSignerCertificate` property is editable.\n" + "anchorMatchWholeWordMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorMatchWholeWord` property is editable." }, - "allowOrganizations": { - "description": "Boolean that specifies whether [Organization Administration](https://developers.docusign.com/orgadmin-api) is enabled for the account.", + "anchorString": { + "description": "Specifies the string to find in the document and use as the basis for tab placement.", "type": "string" }, - "allowOrganizationsMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `allowOrganizations` property is editable.\n" + "anchorStringMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorString` property is editable." }, - "allowPaymentProcessing": { - "description": "Boolean that specifies whether payment processing is enabled for the account.", + "anchorTabProcessorVersion": { + "description": "Reserved for DocuSign.", "type": "string" }, - "allowPaymentProcessingMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `allowPaymentProcessing` property is editable.\n" + "anchorTabProcessorVersionMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Reserved for DocuSign." }, - "allowPersonalSignerCertificate": { - "description": "Boolean that specifies whether a signer certificate is allowed to be used for signing on the account.", + "anchorUnits": { + "description": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n", "type": "string" }, - "allowPersonalSignerCertificateMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `allowPersonalSignerCertificate` property is editable.\n" + "anchorUnitsMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorUnits` property is editable." }, - "allowPhoneAuthentication": { - "description": "Boolean that specifies whether phone authentication is enabled for the account.", + "anchorXOffset": { + "description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n", "type": "string" }, - "allowPhoneAuthenticationMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `allowPhoneAuthentication` property is editable.\n" + "anchorXOffsetMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorXOffset` property is editable." }, - "allowPhoneAuthOverride": { - "description": "Boolean that specifies whether users can override phone authentication.", + "anchorYOffset": { + "description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n", "type": "string" }, - "allowPhoneAuthOverrideMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `allowPhoneAuthOverride` property is editable.\n" + "anchorYOffsetMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorYOffset` property is editable." }, - "allowPrivateSigningGroups": { - "description": "Boolean that specifies whether the account allows private signing groups.", + "bold": { + "description": "When set to **true**, the information in the tab is bold.", "type": "string" }, - "allowPrivateSigningGroupsMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `allowPrivateSigningGroups` property is editable.\n" + "boldMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `bold` property is editable." }, - "allowReminders": { - "description": "If **true**,\nallows an account administrator to turn on reminders\nand expiration defaults for the account.\n", + "concealValueOnDocument": { + "description": "When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender.\n\nWhen an envelope is completed the information is only available to the sender through the Form Data link in the DocuSign Console. The information on the downloaded document remains masked by asterisks.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.", "type": "string" }, - "allowRemindersMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `allowReminders` property is editable.\n" + "concealValueOnDocumentMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `concealValueOnDocument` property is editable." }, - "allowResourceFileBranding": { - "description": "If **true**,\nresource files can be uploaded in branding.\n", + "conditionalParentLabel": { + "description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility.", "type": "string" }, - "allowResourceFileBrandingMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `allowResourceFileBranding` property is editable.\n" + "conditionalParentLabelMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `conditionalParentLabel` property is editable." }, - "allowSafeBioPharmaSignerCertificate": { - "description": "If **true**,\nallows the account administrator\nto specify that signers are\nrequired to use SAFE digital signatures.\n", + "conditionalParentValue": { + "description": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use \"on\" as the value to show that the parent tab is active.\n", "type": "string" }, - "allowSafeBioPharmaSignerCertificateMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `allowSafeBioPharmaSignerCertificate` property is editable.\n" + "conditionalParentValueMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `conditionalParentValue` property is editable." }, - "allowSecurityAppliance": { - "description": "Boolean that specifies whether a DocuSign Signature Appliance can be used with the account.", + "customTabId": { + "description": "The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.", "type": "string" }, - "allowSecurityApplianceMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `allowSecurityAppliance` property is editable.\n" + "customTabIdMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `customTabId` property is editable." }, - "allowSendToCertifiedDelivery": { - "description": "If **true**,\nthe account admin can enable the\nSend to Certified Delivery\nfeature on the account.\n", + "disableAutoSize": { + "description": "When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes.", "type": "string" }, - "allowSendToCertifiedDeliveryMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `allowSendToCertifiedDelivery` property is editable.\n" + "disableAutoSizeMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `disableAutoSize` property is editable." }, - "allowSendToIntermediary": { - "description": "If **true**,\nthe account admin can enable the Send to Intermediary\nfeature on the account.\n", + "documentId": { + "description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.", "type": "string" }, - "allowSendToIntermediaryMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `allowSendToIntermediary` property is editable.\n" + "documentIdMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `documentId` property is editable." }, - "allowServerTemplates": { - "description": "If **true**,\nthe account can use templates.\n", + "errorDetails": { + "$ref": "#/definitions/errorDetails", + "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." + }, + "font": { + "description": "The font to be used for the tab value. Supported fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n", "type": "string" }, - "allowServerTemplatesMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `allowServerTemplates` property is editable.\n" + "fontColor": { + "description": "The font color to use for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n", + "type": "string" }, - "allowSharedTabs": { - "description": "If **true**,\nthe account can use shared tabs.\n", + "fontColorMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `fontColor` property is editable." + }, + "fontMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `font` property is editable." + }, + "fontSize": { + "description": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72", "type": "string" }, - "allowSharedTabsMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `allowSharedTabs` property is editable.\n" + "fontSizeMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `fontSize` property is editable." }, - "allowSignatureStamps": { - "description": "Boolean that specifies whether signature stamps can be used with the account.", + "formOrder": { + "description": "An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block.", "type": "string" }, - "allowSignatureStampsMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `allowSignatureStamps` property is editable.\n" + "formOrderMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `formOrder` property is editable." }, - "allowSignDocumentFromHomePage": { - "description": "Boolean that specifies whether recipients can sign documents from the homepage.", + "formPageLabel": { + "description": "A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience.", "type": "string" }, - "allowSignDocumentFromHomePageMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `allowSignDocumentFromHomePage` property is editable.\n" + "formPageLabelMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `formPageLabel` property is editable." }, - "allowSignerReassign": { - "description": "Account setting that determines whether the recipient of an envelope sent from this account can reassign it to another person.\n", + "formPageNumber": { + "description": "An integer specifying the order in which to present the guided form pages.", "type": "string" }, - "allowSignerReassignMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `allowSignerReassign` property is editable.\n" + "formPageNumberMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `fromPageNumber` property is editable." }, - "allowSignerReassignOverride": { - "description": "Account setting that determines whether an account administrator can override the ability of an envelope recipient to reassign it to another person.", + "height": { + "description": "The height of the tab in pixels.", "type": "string" }, - "allowSignerReassignOverrideMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `allowSignerReassignOverride` property is editable.\n" + "heightMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `height` property is editable." }, - "allowSigningExtensions": { - "description": "Boolean that specifies whether Signing and App Extensions are allowed.", + "italic": { + "description": "When set to **true**, the information in the tab is italic.", "type": "string" }, - "allowSigningExtensionsMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `allowSigningExtensions` property is editable.\n" + "italicMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `italic` property is editable." }, - "allowSigningGroups": { - "description": "Boolean that specifies whether the account allows signing groups.", + "localePolicy": { + "$ref": "#/definitions/localePolicyTab", + "description": "Reserved for DocuSign." + }, + "locked": { + "description": "When set to **true**, the signer cannot change the data of the custom tab.", "type": "string" }, - "allowSigningGroupsMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `allowSigningGroups` property is editable.\n" + "lockedMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `locked` property is editable." }, - "allowSigningRadioDeselect": { - "description": "Boolean that specifies whether the account supports radio buttons on tabs [Radio CustomTabType](https://developers.docusign.com/esign-soap-api/reference/Sending-Group/Tab).", + "maxLength": { + "description": "An optional value that describes the maximum length of the property when the property is a string.", "type": "string" }, - "allowSigningRadioDeselectMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `allowSigningRadioDeselect` property is editable.\n" + "maxLengthMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `maxLength` property is editable." }, - "allowSignNow": { - "description": "If **true**,\nthe account administrator can enable\nthe Sign Now feature.\n", + "mergeField": { + "$ref": "#/definitions/mergeField", + "description": "Contains the information necessary to map the tab to a field in SalesForce." + }, + "mergeFieldXml": { + "description": "", "type": "string" }, - "allowSignNowMetadata": { - "description": "Metadata that indicates whether the `allowSignNow` property is editable.\n", + "name": { + "description": "", "type": "string" }, - "allowSocialIdLogin": { - "description": "If **true**,\nthe account administrator can enable [social id login](https://support.docusign.com/guides/signer-authentication) for the account.\n", + "nameMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `name` property is editable. Read only." + }, + "originalValue": { + "description": "The initial value of the tab when it was sent to the recipient. ", "type": "string" }, - "allowSocialIdLoginMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `allowSocialIdLogin` property is editable.\n" + "originalValueMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `originalValue` property is editable." }, - "allowSupplementalDocuments": { - "description": "When **true**, this user can include supplemental documents.", + "pageNumber": { + "description": "Specifies the page number on which the tab is located.", "type": "string" }, - "allowSupplementalDocumentsMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `allowSupplementalDocuments` property is editable." + "pageNumberMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `pageNumber` property is editable." }, - "anchorPopulationScope": { - "description": "Valid values are:\n\n- `document`\n- `envelope`\n\n", + "recipientId": { + "description": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.", "type": "string" }, - "anchorPopulationScopeMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `anchorPopulationScope` property is editable.\n" + "recipientIdGuid": { + "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only.", + "type": "string" }, - "anchorTagVersionedPlacementEnabled": { - "description": "Valid values are:\n\n- `system_default`\n- `off`\n- `on`\n", + "recipientIdGuidMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `recipientIdGuid` property is editable." + }, + "recipientIdMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `recipientId` property is editable." + }, + "required": { + "description": "When set to **true**, the signer is required to fill out this tab.", "type": "string" }, - "anchorTagVersionedPlacementMetadataEnabled": { - "$ref": "#/definitions/settingsMetadata", + "requiredMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `required` property is editable." + }, + "smartContractInformation": { + "$ref": "#/definitions/smartContractInformation", "description": "" }, - "attachCompletedEnvelope": { - "description": "Boolean that specifies whether envelope documents are included as a PDF file attachment for signing completed emails.", + "status": { + "description": "Indicates the envelope status. Valid values are:\n\n* sent - The envelope is sent to the recipients. \n* created - The envelope is saved as a draft and can be modified and sent later.", "type": "string" }, - "attachCompletedEnvelopeMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `attachCompletedEnvelope` property is editable." + "statusMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `status` property is editable." }, - "authenticationCheck": { - "description": "Specifies how often\nto check authentication.\nValid values are:\n\n- `initial_access`\n- `each_access`\n", - "type": "string" + "tabGroupLabels": { + "description": "An array of tab group labels that uniquely identify tab groups. To assign a tab to a `tabGroup`, you assign the `TabGroupLabel` to the `Tab.TabGroupLabels` array.", + "type": "array", + "items": { + "type": "string" + } }, - "authenticationCheckMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `authenticationCheck` property is editable.\n" + "tabGroupLabelsMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `tabGroupLabels` property is editable." }, - "autoNavRule": { - "description": "Specifies how auto-navigation works.\nValid values are:\n\n- `off`\n- `required_fields`\n- `required_and_blank_fields`\n- `all_fields`\n- `page_then_required_fields`\n- `page_then_required_and_blank_fields`\n- `page_then_all_fields`\n", + "tabId": { + "description": "The unique identifier for the tab.", "type": "string" }, - "autoNavRuleMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `autoNavRule` property is editable.\n" + "tabIdMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `tabId` property is editable." }, - "autoProvisionSignerAccount": { - "description": "Boolean that specifies whether to automatically provision a user membership in the account for accountless recipients. (Also known as Just-in-Time provisioning.)", + "tabLabel": { + "description": "The label associated with the tab. This value may be an empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum Length: 500 characters.\n", "type": "string" }, - "autoProvisionSignerAccountMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `autoProvisionSignerAccount` property is editable.\n" + "tabLabelMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `tabLabel` property is editable." }, - "bccEmailArchive": { - "description": "Boolean that specifies whether BCC for Email Archive is enabled for the account. BCC for Email Archive allows you to set up an archive email address so that a BCC copy of an envelope is sent only to that address.", + "tabOrder": { + "description": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.", "type": "string" }, - "bccEmailArchiveMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `bccEmailArchive` property is editable.\n" + "tabOrderMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `tabOrder` property is editable." }, - "betaSwitchConfiguration": { - "description": "Reserved for DocuSign.\n", + "tabType": { + "description": "Indicates the type of tab (for example, `signHere` or `initialHere`).", "type": "string" }, - "betaSwitchConfigurationMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `betaSwitchConfiguration` property is editable.\n" + "tabTypeMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `tabType` property is editable." }, - "billingAddress": { - "$ref": "#/definitions/addressInformation", - "description": "The billing address for the account." + "templateLocked": { + "description": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ", + "type": "string" }, - "billingAddressMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `billingAddress` property is editable.\n" + "templateLockedMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `templateLocked` property is editable." }, - "bulkSend": { - "description": "When **true**, this user can use the bulk send feature for the account.", + "templateRequired": { + "description": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.", "type": "string" }, - "bulkSendMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `bulkSend` property is editable.\n" + "templateRequiredMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `templateRequired` property is editable." }, - "canSelfBrandSend": { - "description": "Boolean that specifies whether account administrators can self-brand their sending console through the DocuSign Console.", + "tooltip": { + "description": "The text of a tooltip that appears when a user hovers over a form field or tab.", "type": "string" }, - "canSelfBrandSendMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `canSelfBrandSend` property is editable.\n" + "toolTipMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `toolTip` property is editable." }, - "canSelfBrandSign": { - "description": "Boolean that specifies whether account administrators can self-brand their signing console through the DocuSign Console.", + "underline": { + "description": "When set to **true**, the information in the tab is underlined.", "type": "string" }, - "canSelfBrandSignMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `canSelfBrandSign` property is editable.\n" + "underlineMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `underline` property is editable." }, - "captureVoiceRecording": { - "description": "Boolean that specifies whether voice recording is supported for the account.", + "value": { + "description": "Specifies the value of the tab. ", "type": "string" }, - "captureVoiceRecordingMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `captureVoiceRecording` property is editable.\n" + "valueMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `value` property is editable." }, - "cfrUseWideImage": { - "description": "Boolean that specifies whether to use a shorter/wider format when generating the CFR Part 11 signature image.", + "width": { + "description": "The width of the tab in pixels.", "type": "string" }, - "cfrUseWideImageMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `cfrUseWideImage` property is editable.\n" + "widthMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `width` property is editable." }, - "chromeSignatureEnabled": { - "description": "Boolean that specifies whether the signers of the envelopes from this account use a signature with a DocuSign chrome around it or not.", + "xPosition": { + "description": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n", "type": "string" }, - "chromeSignatureEnabledMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `chromeSignatureEnabled` property is editable.\n" + "xPositionMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `xPosition` property is editable." }, - "commentEmailShowMessageText": { + "yPosition": { + "description": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n", + "type": "string" + }, + "yPositionMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `yPosition` property is editable." + } + }, + "x-ds-definition-name": "commissionCounty", + "description": "", + "x-ms-summary": "" + }, + "commissionExpiration": { + "type": "object", + "properties": { + "anchorAllowWhiteSpaceInCharacters": { "description": "", "type": "string" }, - "commentEmailShowMessageTextMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `commentEmailShowMessageText` property is editable.\n" + "anchorAllowWhiteSpaceInCharactersMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "" }, - "commentsAllowEnvelopeOverride": { - "description": "Boolean that specifies whether recipients can make and respond to comments in documents belonging to the envelopes that they are sent.", + "anchorCaseSensitive": { + "description": "This property controls how [anchor tabs][AnchorTabs] are placed. When **true**, the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false**.\n\nFor example, when set to **true**, if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When set to **false**, `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**.\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place", "type": "string" }, - "commentsAllowEnvelopeOverrideMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `commentsAllowEnvelopeOverride` property is editable.\n" + "anchorCaseSensitiveMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorCaseSensitive` property is editable." }, - "conditionalFieldsEnabled": { - "description": "Boolean that specifies whether conditional fields can be used in documents.", + "anchorHorizontalAlignment": { + "description": "This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are :\n\n- `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value.\n- `right`: Aligns the tab’s left side with the last character of the matching anchor word.\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place\n", "type": "string" }, - "conditionalFieldsEnabledMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `conditionalFieldsEnabled` property is editable.\n" + "anchorHorizontalAlignmentMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorHorizontalAlignment` property is editable." }, - "consumerDisclosureFrequency": { - "description": "Speficies how often to display\nthe consumer disclosure.\nValid values are:\n\n- `once`\n- `always`\n- `each_access`\n", + "anchorIgnoreIfNotPresent": { + "description": "When set to **true**, this tab is ignored if the `anchorString` is not found in the document.", "type": "string" }, - "consumerDisclosureFrequencyMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `consumerDisclosureFrequency` property is editable.\n" + "anchorIgnoreIfNotPresentMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable." }, - "convertPdfFields": { - "description": "Boolean that specifies whether to enable PDF form fields to get converted to DocuSign secure fields when the document is added or uploaded to an envelope.", + "anchorMatchWholeWord": { + "description": "When set to **true**, the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false**.\n\nFor example, when set to **true**, if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When set to **false**, if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**.\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTab]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place\n", "type": "string" }, - "convertPdfFieldsMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `convertPdfFields` property is editable.\n" + "anchorMatchWholeWordMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorMatchWholeWord` property is editable." }, - "dataPopulationScope": { - "description": "Valid values are:\n\n- `document`\n- `envelope`\n", + "anchorString": { + "description": "Specifies the string to find in the document and use as the basis for tab placement.", "type": "string" }, - "dataPopulationScopeMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `dataPopulationScope` property is editable.\n" + "anchorStringMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorString` property is editable." }, - "disableMobileApp": { - "description": "When **true**, the mobile app distributor key is prevented from connecting for account users.", + "anchorTabProcessorVersion": { + "description": "Reserved for DocuSign.", "type": "string" }, - "disableMobileAppMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `disableMobileApp` property is editable.\n" + "anchorTabProcessorVersionMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Reserved for DocuSign." }, - "disableMobilePushNotifications": { - "description": "When **true**, push notifications are disabled for the account.", + "anchorUnits": { + "description": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n", "type": "string" }, - "disableMobilePushNotificationsMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `disableMobilePushNotifications` property is editable.\n" + "anchorUnitsMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorUnits` property is editable." }, - "disableMobileSending": { - "description": "When **true**, sending from a mobile application is disabled.", + "anchorXOffset": { + "description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n", "type": "string" }, - "disableMobileSendingMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `disableMobileSending` property is editable.\n" + "anchorXOffsetMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorXOffset` property is editable." }, - "disableMultipleSessions": { - "description": "When **true**, account users cannot be logged into multiple sessions at the same time.", + "anchorYOffset": { + "description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n", "type": "string" }, - "disableMultipleSessionsMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `disableMultipleSessions` property is editable.\n" + "anchorYOffsetMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorYOffset` property is editable." }, - "disablePurgeNotificationsForSenderMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `disablePurgeNotificationsForSender` property is editable.\n" + "bold": { + "description": "When set to **true**, the information in the tab is bold.", + "type": "string" }, - "disableSignerCertView": { - "description": "When **true**, signers cannot view certificates of completion.", + "boldMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `bold` property is editable." + }, + "concealValueOnDocument": { + "description": "When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender.\n\nWhen an envelope is completed the information is only available to the sender through the Form Data link in the DocuSign Console. The information on the downloaded document remains masked by asterisks.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.", "type": "string" }, - "disableSignerCertViewMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `disableSignerCertView` property is editable.\n" + "concealValueOnDocumentMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `concealValueOnDocument` property is editable." }, - "disableSignerHistoryView": { - "description": "When **true**, signers cannot view envelope history.", + "conditionalParentLabel": { + "description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility.", "type": "string" }, - "disableSignerHistoryViewMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `disableSignerHistoryView` property is editable.\n" + "conditionalParentLabelMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `conditionalParentLabel` property is editable." }, - "disableStyleSignature": { - "description": "When **true**, the **Select Style** option is hidden from signers and they must draw their signature instead. ", + "conditionalParentValue": { + "description": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use \"on\" as the value to show that the parent tab is active.\n", "type": "string" }, - "disableStyleSignatureMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `disableStyleSignature` property is editable.\n" + "conditionalParentValueMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `conditionalParentValue` property is editable." }, - "disableUploadSignature": { - "description": "When **true**, signers cannot upload custom image files of their signature and initials.", + "customTabId": { + "description": "The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.", "type": "string" }, - "disableUploadSignatureMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `disableUploadSignature` property is editable.\n" + "customTabIdMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `customTabId` property is editable." }, - "disableUserSharing": { - "description": "When **true**, the User Sharing feature is disabled for the account.", + "disableAutoSize": { + "description": "When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes.", "type": "string" }, - "disableUserSharingMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `disableUserSharing` property is editable.\n" + "disableAutoSizeMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `disableAutoSize` property is editable." }, - "displayBetaSwitch": { - "description": "Boolean that specifies whether to display a Beta switch for your app.", + "documentId": { + "description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.", "type": "string" }, - "displayBetaSwitchMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `displayBetaSwitch` property is editable.\n" + "documentIdMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `documentId` property is editable." }, - "documentConversionRestrictions": { - "description": "Valid values are:\n\n- `no_restrictions`\n- `allow_pdf_only`\n- `no_upload`\n", + "errorDetails": { + "$ref": "#/definitions/errorDetails", + "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." + }, + "font": { + "description": "The font to be used for the tab value. Supported fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n", "type": "string" }, - "documentConversionRestrictionsMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `documentConversionRestrictions` property is editable.\n" + "fontColor": { + "description": "The font color to use for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n", + "type": "string" }, - "documentRetention": { - "description": "", + "fontColorMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `fontColor` property is editable." + }, + "fontMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `font` property is editable." + }, + "fontSize": { + "description": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72", "type": "string" }, - "documentRetentionMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `documentRetention` property is editable.\n" + "fontSizeMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `fontSize` property is editable." }, - "documentRetentionPurgeTabs": { - "description": "Specifies when to purge tabs according to the Document Retention policy for the account.", + "formOrder": { + "description": "An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block.", "type": "string" }, - "documentVisibility": { - "description": "Configures the Document Visibility feature for the account. Valid values are:\n\n- `Off`: Document Visibility is not active for the account.\n- `MustSignToViewUnlessSenderAccount`: Document Visibility is enabled for all envelopes sent from the account. Any member of the sending account can view all of the documents in an envelope.\n- `MustSignToViewUnlessSender`: Document Visibility is enabled for all envelopes sent from the account. Only the sender can view all of the documents in an envelope.\n- `SenderCanSetMustSignToViewUnlessSenderAccount`: The sender has the option to enable Document Visibility for an envelope. When enabled for an envelope, all of the documents within it are still visible to any member of the sending account.\nVd- `SenderCanSetMustSignToViewUnlessSender`: The sender has the option to enable Document Visibility for an envelope. When enabled for an envelope, all of the documents in the envelope are visible only to the sender.\n\n**Note**: For this configuration to take effect, `allowDocumentVisibility` must be set to **true**.", + "formOrderMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `formOrder` property is editable." + }, + "formPageLabel": { + "description": "A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience.", "type": "string" }, - "documentVisibilityMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `documentVisibility` property is editable.\n" + "formPageLabelMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `formPageLabel` property is editable." }, - "emailTemplateVersion": { - "description": "Specifies the version of the email templates used in an account. If new signing is selected in a member's Admin page, the user is updated to the newest version (1.1), the minumum version of email supported for the account.", + "formPageNumber": { + "description": "An integer specifying the order in which to present the guided form pages.", "type": "string" }, - "emailTemplateVersionMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `emailTemplateVersion` property is editable.\n" + "formPageNumberMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `fromPageNumber` property is editable." }, - "enableAccessCodeGenerator": { - "description": "When **true**, enables Access Code Generator on the account.", + "height": { + "description": "The height of the tab in pixels.", "type": "string" }, - "enableAccessCodeGeneratorMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `enableAccessCodeGenerator` property is editable.\n" + "heightMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `height` property is editable." }, - "enableAdvancedPayments": { - "description": "When **true**, enables Advanced Payments for the account.", + "italic": { + "description": "When set to **true**, the information in the tab is italic.", "type": "string" }, - "enableAdvancedPaymentsMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `enableAdvancedPayments` property is editable.\n" + "italicMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `italic` property is editable." }, - "enableAdvancedPowerForms": { - "description": "When **true**, enables advanced PowerForms for the account.", + "localePolicy": { + "$ref": "#/definitions/localePolicyTab", + "description": "Reserved for DocuSign." + }, + "locked": { + "description": "When set to **true**, the signer cannot change the data of the custom tab.", "type": "string" }, - "enableAdvancedPowerFormsMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `enableAdvancedPowerForms` property is editable.\n" + "lockedMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `locked` property is editable." }, - "enableAutoNav": { - "description": "When **true**, enables the account to set the AutoNav rule setting, which allows a sender to override the auto navigation setting per envelope.", + "maxLength": { + "description": "An optional value that describes the maximum length of the property when the property is a string.", "type": "string" }, - "enableAutoNavMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `enableAutoNav` property is editable.\n" + "maxLengthMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `maxLength` property is editable." + }, + "mergeField": { + "$ref": "#/definitions/mergeField", + "description": "Contains the information necessary to map the tab to a field in SalesForce." }, - "enableCalculatedFields": { - "description": "When **true**, the account is enabled to use calculated fields (must be allowed at the account level for this setting to be changeable).", + "mergeFieldXml": { + "description": "", "type": "string" }, - "enableCalculatedFieldsMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `enableCalculatedFields` property is editable.\n" - }, - "enableClickwraps": { - "description": "Boolean that specifies whether clickwraps are enabled in your app. A [clickwrap])(https://developers.docusign.com/click-api/guides/) is an iframe that you embed in your own website or app.", + "name": { + "description": "", "type": "string" }, - "enableClickwrapsMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `enableClickwraps` property is editable.\n" + "nameMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `name` property is editable. Read only." }, - "enableCustomerSatisfactionMetricTracking": { - "description": "When **true**, enables customer satisfaction metric tracking for the account.", + "originalValue": { + "description": "The initial value of the tab when it was sent to the recipient. ", "type": "string" }, - "enableCustomerSatisfactionMetricTrackingMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `enableCustomerSatisfactionMetricTracking` property is editable.\n" + "originalValueMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `originalValue` property is editable." }, - "enableDSPro": { - "description": "Reserved for DocuSign.", + "pageNumber": { + "description": "Specifies the page number on which the tab is located.", "type": "string" }, - "enableDSProMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `enableDSPro` property is editable.\n" + "pageNumberMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `pageNumber` property is editable." }, - "enableEnvelopeStampingByAccountAdmin": { - "description": "When **true**, enables the account administrator to control envelope stamping for an account (placement of the EnvelopeID).", + "recipientId": { + "description": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.", "type": "string" }, - "enableEnvelopeStampingByAccountAdminMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `enableEnvelopeStampingByAccountAdmin` property is editable.\n" - }, - "enableEnvelopeStampingByDSAdmin": { - "description": "When **true**, enables the DocuSign administrator to control envelope stamping for an account (placement of the EnvelopeID).", + "recipientIdGuid": { + "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only.", "type": "string" }, - "enableEnvelopeStampingByDSAdminMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `enableEnvelopeStampingByDSAdmin` property is editable.\n" + "recipientIdGuidMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `recipientIdGuid` property is editable." }, - "enablePaymentProcessing": { - "description": "When **true**, enables payment processing for this account.", + "recipientIdMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `recipientId` property is editable." + }, + "required": { + "description": "When set to **true**, the signer is required to fill out this tab.", "type": "string" }, - "enablePaymentProcessingMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `enablePaymentProcessing` property is editable.\n" + "requiredMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `required` property is editable." }, - "enablePowerForm": { - "description": "When **true**, enables PowerForms for an account.", - "type": "string" + "smartContractInformation": { + "$ref": "#/definitions/smartContractInformation", + "description": "" }, - "enablePowerFormDirect": { - "description": "When **true**, enables direct PowerForms for an account. Direct PowerForms are in-session PowerForms.", + "status": { + "description": "Indicates the envelope status. Valid values are:\n\n* sent - The envelope is sent to the recipients. \n* created - The envelope is saved as a draft and can be modified and sent later.", "type": "string" }, - "enablePowerFormDirectMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `enablePowerFormDirect` property is editable.\n" + "statusMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `status` property is editable." }, - "enablePowerFormMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `enablePowerForm` property is editable.\n" + "tabGroupLabels": { + "description": "An array of tab group labels that uniquely identify tab groups. To assign a tab to a `tabGroup`, you assign the `TabGroupLabel` to the `Tab.TabGroupLabels` array.", + "type": "array", + "items": { + "type": "string" + } }, - "enableRecipientDomainValidation": { - "description": "Reserved for DocuSign.", + "tabGroupLabelsMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `tabGroupLabels` property is editable." + }, + "tabId": { + "description": "The unique identifier for the tab.", "type": "string" }, - "enableRecipientDomainValidationMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `enableRecipientDomainValidation` property is editable.\n" + "tabIdMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `tabId` property is editable." }, - "enableReportLinks": { - "description": "Enables direct links to envelopes in reports for administrators in the following scopes:\n- `NoEnvelopes`\n- `AllEnvelopes`\n- `OnlyOwnEnvelopes`", + "tabLabel": { + "description": "The label associated with the tab. This value may be an empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum Length: 500 characters.\n", "type": "string" }, - "enableReportLinksMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `enableReportLinks` property is editable.\n" + "tabLabelMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `tabLabel` property is editable." }, - "enableRequireSignOnPaper": { - "description": "When true, the account can use the `requireSignOnPaper` option.\n", + "tabOrder": { + "description": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.", "type": "string" }, - "enableRequireSignOnPaperMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `enableRequireSignOnPaper` property is editable.\n" + "tabOrderMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `tabOrder` property is editable." }, - "enableReservedDomain": { - "description": "When **true**, enables reserved domains for an account. This is configured by the account administrators on a page which they can specify reserved domain and reserved users in their domain. This allows them to lock down email address domains to exist only in their account and in no other location in DocuSign.", + "tabType": { + "description": "Indicates the type of tab (for example, `signHere` or `initialHere`).", "type": "string" }, - "enableReservedDomainMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `enableReservedDomain` property is editable.\n" + "tabTypeMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `tabType` property is editable." }, - "enableResponsiveSigning": { - "description": "When **true**, enables responsive signing.", + "templateLocked": { + "description": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ", "type": "string" }, - "enableResponsiveSigningMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `enableResponsiveSigning` property is editable.\n" + "templateLockedMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `templateLocked` property is editable." }, - "enableScheduledRelease": { - "description": "", + "templateRequired": { + "description": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.", "type": "string" }, - "enableScheduledReleaseMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `enableScheduledRelease` property is editable.\n" + "templateRequiredMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `templateRequired` property is editable." }, - "enableSendingTagsFontSettings": { - "description": "When **true**, enables fonts to be set on tags for the account.", + "tooltip": { + "description": "The text of a tooltip that appears when a user hovers over a form field or tab.", "type": "string" }, - "enableSendingTagsFontSettingsMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `enableSendingTagsFontSettings` property is editable.\n" + "toolTipMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `toolTip` property is editable." }, - "enableSendToAgent": { - "description": "When **true**, this account can use the agent recipient type.\n", + "underline": { + "description": "When set to **true**, the information in the tab is underlined.", "type": "string" }, - "enableSendToAgentMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `enableSendToAgent` property is editable.\n" + "underlineMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `underline` property is editable." }, - "enableSendToIntermediary": { - "description": "When true, this account can use the intermediary recipient type.\n", + "value": { + "description": "Specifies the value of the tab. ", "type": "string" }, - "enableSendToIntermediaryMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `enableSendToIntermediary` property is editable.\n" + "valueMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `value` property is editable." }, - "enableSendToManage": { - "description": "When true, this account can use the editor recipient type.\n", + "width": { + "description": "The width of the tab in pixels.", "type": "string" }, - "enableSendToManageMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `enableSendToManage` property is editable.\n" + "widthMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `width` property is editable." }, - "enableSequentialSigningAPI": { - "description": "When **true**, the account can define the routing\norder of recipients for envelopes sent using the DocuSign API.\n", + "xPosition": { + "description": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n", "type": "string" }, - "enableSequentialSigningAPIMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `enableSequentialSigningAPI` property is editable.\n" + "xPositionMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `xPosition` property is editable." }, - "enableSequentialSigningUI": { - "description": "When **true**, the account can define the routing order\nof recipients for envelopes sent using the DocuSign application.\n", + "yPosition": { + "description": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n", "type": "string" }, - "enableSequentialSigningUIMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `enableSequentialSigningUI` property is editable.\n" - }, - "enableSignerAttachments": { - "description": "When **true**, this user can use the signing attachments feature.", + "yPositionMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `yPosition` property is editable." + } + }, + "x-ds-definition-name": "commissionExpiration", + "description": "", + "x-ms-summary": "" + }, + "commissionNumber": { + "type": "object", + "properties": { + "anchorAllowWhiteSpaceInCharacters": { + "description": "", "type": "string" }, - "enableSignerAttachmentsMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `enableSignerAttachments` property is editable.\n" + "anchorAllowWhiteSpaceInCharactersMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "" }, - "enableSigningExtensionComments": { - "description": "When **true**, enables commenting functionality.", + "anchorCaseSensitive": { + "description": "This property controls how [anchor tabs][AnchorTabs] are placed. When **true**, the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false**.\n\nFor example, when set to **true**, if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When set to **false**, `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**.\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place", "type": "string" }, - "enableSigningExtensionCommentsMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `enableSigningExtensionComments` property is editable.\n" + "anchorCaseSensitiveMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorCaseSensitive` property is editable." }, - "enableSigningExtensionConversations": { - "description": "When **true**, enables conversation functionality.", + "anchorHorizontalAlignment": { + "description": "This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are :\n\n- `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value.\n- `right`: Aligns the tab’s left side with the last character of the matching anchor word.\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place\n", "type": "string" }, - "enableSigningExtensionConversationsMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `enableSigningExtensionConversations` property is editable.\n" + "anchorHorizontalAlignmentMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorHorizontalAlignment` property is editable." }, - "enableSigningOrderSettingsForAccount": { - "description": "When **true**, switches Signing Order to On by default for new envelopes.", + "anchorIgnoreIfNotPresent": { + "description": "When set to **true**, this tab is ignored if the `anchorString` is not found in the document.", "type": "string" }, - "enableSigningOrderSettingsForAccountMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `enableSigningOrderSettingsForAccount` property is editable.\n" + "anchorIgnoreIfNotPresentMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable." }, - "enableSignOnPaper": { - "description": "When **true**, a sender can allow signers to use the sign on paper option.\n", + "anchorMatchWholeWord": { + "description": "When set to **true**, the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false**.\n\nFor example, when set to **true**, if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When set to **false**, if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**.\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTab]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place\n", "type": "string" }, - "enableSignOnPaperMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `enableSignOnPaper` property is editable.\n" + "anchorMatchWholeWordMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorMatchWholeWord` property is editable." }, - "enableSignOnPaperOverride": { - "description": "When **true**, this user can override the Sign on Paper account setting, which specifies whether signers can sign documents on paper as an option to signing electronically.", + "anchorString": { + "description": "Specifies the string to find in the document and use as the basis for tab placement.", "type": "string" }, - "enableSignOnPaperOverrideMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `enableSignOnPaperOverride` property is editable.\n" + "anchorStringMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorString` property is editable." }, - "enableSignWithNotary": { - "description": "When set to **true**, Sign with Notary functionality is enabled on the envelope.", + "anchorTabProcessorVersion": { + "description": "Reserved for DocuSign.", "type": "string" }, - "enableSignWithNotaryMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `enableSignWithNotary` property is editable.\n" + "anchorTabProcessorVersionMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Reserved for DocuSign." }, - "enableSMSAuthentication": { - "description": "When **true**, the account can use SMS authentication.\n", + "anchorUnits": { + "description": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n", "type": "string" }, - "enableSMSAuthenticationMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `enableSMSAuthentication` property is editable.\n" + "anchorUnitsMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorUnits` property is editable." }, - "enableSocialIdLogin": { - "description": "When **true**, enables the ability to use social IDs to login to an account.", + "anchorXOffset": { + "description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n", "type": "string" }, - "enableSocialIdLoginMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `enableSocialIdLogin` property is editable.\n" + "anchorXOffsetMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorXOffset` property is editable." }, - "enableStrikeThrough": { - "description": "When **true**, enables strikethrough formatting in documents.", + "anchorYOffset": { + "description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n", "type": "string" }, - "enableStrikeThroughMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `enableStrikeThrough` property is editable.\n" + "anchorYOffsetMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorYOffset` property is editable." }, - "enableTransactionPoint": { - "description": "Reserved for DocuSign.", + "bold": { + "description": "When set to **true**, the information in the tab is bold.", "type": "string" }, - "enableTransactionPointMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `enableTransactionPoint` property is editable.\n" + "boldMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `bold` property is editable." }, - "enableVaulting": { - "description": "When true, Vaulting is enabled for the account. ", + "concealValueOnDocument": { + "description": "When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender.\n\nWhen an envelope is completed the information is only available to the sender through the Form Data link in the DocuSign Console. The information on the downloaded document remains masked by asterisks.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.", "type": "string" }, - "enableVaultingMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `enableVaulting` property is editable.\n" + "concealValueOnDocumentMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `concealValueOnDocument` property is editable." }, - "enableWitnessing": { - "description": "When **true**, enables documents to be signed by a witness.", + "conditionalParentLabel": { + "description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility.", "type": "string" }, - "enableWitnessingMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `enableWitnessing` property is editable.\n" + "conditionalParentLabelMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `conditionalParentLabel` property is editable." }, - "enforceTemplateNameUniqueness": { - "description": "When **true**, the template name must be unique.", + "conditionalParentValue": { + "description": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use \"on\" as the value to show that the parent tab is active.\n", "type": "string" }, - "enforceTemplateNameUniquenessMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `enforceTemplateNameUniqueness` property is editable.\n" + "conditionalParentValueMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `conditionalParentValue` property is editable." }, - "envelopeIntegrationAllowed": { - "description": "When **true**, allows custom admins to enable Connect for their accounts.", + "customTabId": { + "description": "The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.", "type": "string" }, - "envelopeIntegrationAllowedMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `envelopeIntegrationAllowed` property is editable.\n" + "customTabIdMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `customTabId` property is editable." }, - "envelopeIntegrationEnabled": { - "description": "When **true**, enables Connect for an account. Note that Connect integration requires additional configuration that must be set up for it to take effect; this switch is only the on/off control for the account.", + "disableAutoSize": { + "description": "When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes.", "type": "string" }, - "envelopeIntegrationEnabledMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `envelopeIntegrationEnabled` property is editable.\n" + "disableAutoSizeMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `disableAutoSize` property is editable." }, - "envelopeStampingDefaultValue": { - "description": "Specifies the default value for Envelope ID stamping.", + "documentId": { + "description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.", "type": "string" }, - "envelopeStampingDefaultValueMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `envelopeStampingDefaultValue` property is editable.\n" + "documentIdMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `documentId` property is editable." }, - "expressSend": { - "description": "Boolean that specifies whether a member of an account can express send (without tags) or must send with tags on documents.", - "type": "string" + "errorDetails": { + "$ref": "#/definitions/errorDetails", + "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." }, - "expressSendAllowTabs": { - "description": "Boolean that specifies whether a member of an account can send templates without the tags being stripped out, even when the account is configured to let its users express send only (they cannot use the tagger).", + "font": { + "description": "The font to be used for the tab value. Supported fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n", "type": "string" }, - "expressSendAllowTabsMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `expressSendAllowTabs` property is editable.\n" + "fontColor": { + "description": "The font color to use for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n", + "type": "string" }, - "expressSendMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `expressSend` property is editable.\n" + "fontColorMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `fontColor` property is editable." }, - "externalDocumentSources": { - "$ref": "#/definitions/externalDocumentSources", - "description": "A list of external document sources such as DropBox and OneDrive." + "fontMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `font` property is editable." }, - "externalSignaturePadType": { - "description": "Specifies the signature pad type.\nValid values are:\n\n- `none`\n- `topaz`\n- `e_padv9`\n- `e_pad_integrisign`\n- `topaz_sigplusextlite`\n", + "fontSize": { + "description": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72", "type": "string" }, - "externalSignaturePadTypeMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `externalSignaturePadType` property is editable.\n" + "fontSizeMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `fontSize` property is editable." }, - "faxOutEnabled": { - "description": "Boolean that specifies whether fax delivery to recipients is allowed for the account.", + "formOrder": { + "description": "An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block.", "type": "string" }, - "faxOutEnabledMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `faxOutEnabled` property is editable.\n" + "formOrderMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `formOrder` property is editable." }, - "hideAccountAddressInCoC": { - "description": "Boolean that specifies whether to hide the account address in the Certificate of Completion.", + "formPageLabel": { + "description": "A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience.", "type": "string" }, - "hideAccountAddressInCoCMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `hideAccountAddressInCoC` property is editable.\n" + "formPageLabelMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `formPageLabel` property is editable." }, - "hidePricing": { - "description": "Boolean that specifies whether to hide the pricing functionality for an account.", + "formPageNumber": { + "description": "An integer specifying the order in which to present the guided form pages.", "type": "string" }, - "hidePricingMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `hidePricing` property is editable.\n" - }, - "idCheckConfigurations": { - "description": "A list of ID check configuration objects.", - "type": "array", - "items": { - "$ref": "#/definitions/idCheckConfiguration" - } + "formPageNumberMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `fromPageNumber` property is editable." }, - "idCheckExpire": { - "description": "Determines when a user's authentication with the account expires. Valid values are:\n\n- `always`: Users are required to authenticate each time.\n- `variable`: If the authentication for a user is valid and falls within the value for the `idCheckExpireDays` property, the user is not required to authenticate again.", + "height": { + "description": "The height of the tab in pixels.", "type": "string" }, - "idCheckExpireDays": { - "description": "The number of days before user authentication credentials expire. A value of `0` specifies that users must re-authenticate for each new session.", + "heightMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `height` property is editable." + }, + "italic": { + "description": "When set to **true**, the information in the tab is italic.", "type": "string" }, - "idCheckExpireDaysMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `idCheckExpireDays` property is editable.\n" + "italicMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `italic` property is editable." }, - "idCheckExpireMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `idCheckExpire` property is editable.\n" + "localePolicy": { + "$ref": "#/definitions/localePolicyTab", + "description": "Reserved for DocuSign." }, - "idCheckExpireMinutes": { - "description": "The number of minutes before user authentication credentials expire.", + "locked": { + "description": "When set to **true**, the signer cannot change the data of the custom tab.", "type": "string" }, - "idCheckExpireMinutesMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `idCheckExpireMinutes` property is editable.\n" + "lockedMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `locked` property is editable." }, - "idCheckRequired": { - "description": "Determines how authentication is configured for the account. Valid values are:\n\n- `always`: Authentication checks are performed on every envelope. \n- `never`: Authentication checks are not performed on any envelopes. \n- `optional:` Authentication is configurable per envelope.", + "maxLength": { + "description": "An optional value that describes the maximum length of the property when the property is a string.", "type": "string" }, - "idCheckRequiredMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `idCheckRequired` property is editable.\n" - }, - "identityVerification": { - "description": " ", - "type": "array", - "items": { - "$ref": "#/definitions/accountIdentityVerificationWorkflow" - } + "maxLengthMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `maxLength` property is editable." }, - "identityVerificationMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `identityVerification` property is editable.\n" + "mergeField": { + "$ref": "#/definitions/mergeField", + "description": "Contains the information necessary to map the tab to a field in SalesForce." }, - "ignoreErrorIfAnchorTabNotFound": { - "description": "Reserved for DocuSign.", + "mergeFieldXml": { + "description": "", "type": "string" }, - "ignoreErrorIfAnchorTabNotFoundMetadataEnabled": { - "$ref": "#/definitions/settingsMetadata", - "description": "Reserved for DocuSign." - }, - "inPersonIDCheckQuestion": { - "description": "A text field containing the question that an in-person signing host uses to collect personal information from the recipient. The recipient's response to this question is saved and can be viewed in the certificate associated with the envelope.", + "name": { + "description": "", "type": "string" }, - "inPersonIDCheckQuestionMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `inPersonIDCheckQuestion` property is editable.\n" + "nameMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `name` property is editable. Read only." }, - "inPersonSigningEnabled": { - "description": "When **true**, in-person signing is enabled for the account.", + "originalValue": { + "description": "The initial value of the tab when it was sent to the recipient. ", "type": "string" }, - "inPersonSigningEnabledMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `inPersonSigningEnabled` property is editable.\n" + "originalValueMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `originalValue` property is editable." }, - "inSessionEnabled": { - "description": "When **true**, the account can send in-session (embedded) envelopes.", + "pageNumber": { + "description": "Specifies the page number on which the tab is located.", "type": "string" }, - "inSessionEnabledMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `inSessionEnabled` property is editable.\n" + "pageNumberMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `pageNumber` property is editable." }, - "inSessionSuppressEmails": { - "description": "When **true**, emails cannot be sent to the in-session (embedded) recipients on an envelope.", + "recipientId": { + "description": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.", "type": "string" }, - "inSessionSuppressEmailsMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `inSessionSuppressEmails` property is editable.\n" - }, - "maximumSigningGroups": { - "description": "The maximum number of signing groups allowed for the account.", + "recipientIdGuid": { + "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only.", "type": "string" }, - "maximumSigningGroupsMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `maximumSigningGroups` property is editable.\n" + "recipientIdGuidMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `recipientIdGuid` property is editable." }, - "maximumUsersPerSigningGroup": { - "description": "The maximum number of users per signing group.", + "recipientIdMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `recipientId` property is editable." + }, + "required": { + "description": "When set to **true**, the signer is required to fill out this tab.", "type": "string" }, - "maximumUsersPerSigningGroupMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `maximumUsersPerSigningGroup` property is editable.\n" + "requiredMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `required` property is editable." }, - "maxNumberOfCustomStamps": { - "description": "The maximum number of custom stamps.", - "type": "string" + "smartContractInformation": { + "$ref": "#/definitions/smartContractInformation", + "description": "" }, - "mobileSessionTimeout": { - "description": "The number of minutes of inactivity before a mobile user is automatically logged out of the system. Valid values are `1` to `120` minutes. The default value is `20` minutes.", + "status": { + "description": "Indicates the envelope status. Valid values are:\n\n* sent - The envelope is sent to the recipients. \n* created - The envelope is saved as a draft and can be modified and sent later.", "type": "string" }, - "mobileSessionTimeoutMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `mobileSessionTimeout` property is editable.\n" + "statusMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `status` property is editable." }, - "numberOfActiveCustomStamps": { - "description": "The number of custom stamps currently active.", - "type": "string" + "tabGroupLabels": { + "description": "An array of tab group labels that uniquely identify tab groups. To assign a tab to a `tabGroup`, you assign the `TabGroupLabel` to the `Tab.TabGroupLabels` array.", + "type": "array", + "items": { + "type": "string" + } }, - "optInMobileSigningV02": { - "description": "Boolean that specifies whether to opt in for Signing v02 on Mobile Devices functionality.", + "tabGroupLabelsMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `tabGroupLabels` property is editable." + }, + "tabId": { + "description": "The unique identifier for the tab.", "type": "string" }, - "optInMobileSigningV02Metadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `optInMobileSigningV02` property is editable.\n" + "tabIdMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `tabId` property is editable." }, - "optOutAutoNavTextAndTabColorUpdates": { - "description": "Boolean that allows envelope senders to opt out of the recipient signing auto-navigation feature and opt out of updating tab font color.", + "tabLabel": { + "description": "The label associated with the tab. This value may be an empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum Length: 500 characters.\n", "type": "string" }, - "optOutAutoNavTextAndTabColorUpdatesMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `optOutAutoNavTextAndTabColorUpdates` property is editable.\n" + "tabLabelMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `tabLabel` property is editable." }, - "optOutNewPlatformSeal": { - "description": "Boolean that specifies whether to allow envelope senders to opt out of using the new platform seal.", + "tabOrder": { + "description": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.", "type": "string" }, - "optOutNewPlatformSealPlatformMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `optOutNewPlatformSealPlatform` property is editable.\n" + "tabOrderMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `tabOrder` property is editable." }, - "phoneAuthRecipientMayProvidePhoneNumber": { - "description": "Boolean that specifies whether to allow a recipient to provide a phone number, for an account that uses Phone Authentication.", + "tabType": { + "description": "Indicates the type of tab (for example, `signHere` or `initialHere`).", "type": "string" }, - "phoneAuthRecipientMayProvidePhoneNumberMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `phoneAuthRecipientMayProvidePhoneNumber` property is editable.\n" + "tabTypeMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `tabType` property is editable." }, - "pkiSignDownloadedPDFDocs": { - "description": "Always **true**.\nSpecifies that PDF files\ndownloaded from the platform\nare signed.\n", + "templateLocked": { + "description": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ", "type": "string" }, - "pkiSignDownloadedPDFDocsMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `pkiSignDownloadedPDFDocs` property is editable.\n" + "templateLockedMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `templateLocked` property is editable." }, - "recipientsCanSignOffline": { - "description": "If **true**,\nrecipients recieving envelopes from this account\ncan sign offline.\n", + "templateRequired": { + "description": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.", "type": "string" }, - "recipientsCanSignOfflineMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `recipientsCanSignOffline` property is editable.\n" + "templateRequiredMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `templateRequired` property is editable." }, - "recipientSigningAutoNavigationControl": { - "description": "Boolean that specifies whether recipients recieving envelopes from this account can override autonav functionality.", + "tooltip": { + "description": "The text of a tooltip that appears when a user hovers over a form field or tab.", "type": "string" }, - "recipientSigningAutoNavigationControlMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `recipientSigningAutoNavigationControl` property is editable.\n" + "toolTipMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `toolTip` property is editable." }, - "require21CFRpt11Compliance": { - "description": "If **true**,\nrecipients are required\nto use a 21 CFR part 11-compliant signing experience.\n", + "underline": { + "description": "When set to **true**, the information in the tab is underlined.", "type": "string" }, - "require21CFRpt11ComplianceMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `require21CFRpt11Compliance` property is editable.\n" + "underlineMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `underline` property is editable." }, - "requireDeclineReason": { - "description": "If **true**,\nrequires signers who decline to sign an envelope sent from this account\nto provide a reason for declining.\n", + "value": { + "description": "Specifies the value of the tab. ", "type": "string" }, - "requireDeclineReasonMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `requireDeclineReason` property is editable.\n" + "valueMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `value` property is editable." }, - "requireExternalUserManagement": { - "description": "Boolean that specifies whether to require external managing of users in an account.", + "width": { + "description": "The width of the tab in pixels.", "type": "string" }, - "requireExternalUserManagementMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `requireExternalUserManagement` property is editable.\n" + "widthMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `width` property is editable." }, - "requireSignerCertificateType": { - "description": "Valid values are:\n\n- `none`\n- `docusign_express`\n- `docusign_personal`\n- `safe`\n- `open_trust`\n", + "xPosition": { + "description": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n", "type": "string" }, - "requireSignerCertificateTypeMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `requireSignerCertificateType` property is editable.\n" + "xPositionMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `xPosition` property is editable." }, - "rsaVeridAccountName": { - "description": "The RSA account name.\n\n**Note:**\nModifying this value may disrupt your ID Check capability.\nEnsure you have the correct value before changing it.\n", + "yPosition": { + "description": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n", "type": "string" }, - "rsaVeridPassword": { - "description": "The password used with the RSA account.\n\n\n**Note:**\nModifying this value may disrupt your ID Check capability.\nEnsure you have the correct value before changing it.\n\n\n", + "yPositionMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `yPosition` property is editable." + } + }, + "x-ds-definition-name": "commissionNumber", + "description": "", + "x-ms-summary": "" + }, + "commissionState": { + "type": "object", + "properties": { + "anchorAllowWhiteSpaceInCharacters": { + "description": "", "type": "string" }, - "rsaVeridRuleset": { - "description": "The RSA rule set used with the account.\n\n**Note:**\nModifying this value may disrupt your ID Check capability.\nEnsure you have the correct value before changing it.\n\n\n", - "type": "string" + "anchorAllowWhiteSpaceInCharactersMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "" }, - "rsaVeridUserId": { - "description": "The user ID for the RSA account.\n\n**Note:**\nModifying this value may disrupt your ID Check capability.\nEnsure you have the correct value before changing it.\n\n", + "anchorCaseSensitive": { + "description": "This property controls how [anchor tabs][AnchorTabs] are placed. When **true**, the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false**.\n\nFor example, when set to **true**, if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When set to **false**, `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**.\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place", "type": "string" }, - "selfSignedRecipientEmailDocument": { - "description": "Valid values are:\n\n- `include_pdf`\n- `include_link`\n", + "anchorCaseSensitiveMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorCaseSensitive` property is editable." + }, + "anchorHorizontalAlignment": { + "description": "This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are :\n\n- `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value.\n- `right`: Aligns the tab’s left side with the last character of the matching anchor word.\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place\n", "type": "string" }, - "selfSignedRecipientEmailDocumentMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `selfSignedRecipientEmailDocument` property is editable.\n" + "anchorHorizontalAlignmentMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorHorizontalAlignment` property is editable." }, - "selfSignedRecipientEmailDocumentUserOverride": { - "description": "When **true** the `selfSignedRecipientEmailDocument` user setting can be set for an individual user.\nThe user setting overrides the account setting.\n\n", + "anchorIgnoreIfNotPresent": { + "description": "When set to **true**, this tab is ignored if the `anchorString` is not found in the document.", "type": "string" }, - "selfSignedRecipientEmailDocumentUserOverrideMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `selfSignedRecipientEmailDocumentUserOverride` property is editable.\n" + "anchorIgnoreIfNotPresentMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable." }, - "senderCanSignInEachLocation": { - "description": "Boolean that specifies whether a signer can draw their signature in each location where a sign or initial tab exsts. This is typically used for mobile signing.", + "anchorMatchWholeWord": { + "description": "When set to **true**, the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false**.\n\nFor example, when set to **true**, if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When set to **false**, if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**.\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTab]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place\n", "type": "string" }, - "senderCanSignInEachLocationMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `senderCanSignInEachLocation` property is editable.\n" + "anchorMatchWholeWordMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorMatchWholeWord` property is editable." }, - "senderMustAuthenticateSigning": { - "description": "When *true*, a sender who is also a recipient of an envelope\nmust follow the authentication requirements for the envelope.\n", + "anchorString": { + "description": "Specifies the string to find in the document and use as the basis for tab placement.", "type": "string" }, - "senderMustAuthenticateSigningMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `senderMustAuthenticateSigning` property is editable.\n" + "anchorStringMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorString` property is editable." }, - "sendingTagsFontColor": { - "description": "The account-wide default font color to use for the content of the tab:\n\n- `Black`\n- `BrightBlue`\n- `BrightRed`\n- `DarkGreen`\n- `DarkRed`\n- `Gold`\n- `Green`\n- `NavyBlue`\n- `Purple`\n- `White`", + "anchorTabProcessorVersion": { + "description": "Reserved for DocuSign.", "type": "string" }, - "sendingTagsFontColorMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `sendingTagsFontColor` property is editable.\n" + "anchorTabProcessorVersionMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Reserved for DocuSign." }, - "sendingTagsFontName": { - "description": "The account-wide default font to be used for the tab value. Supported fonts include:\n\n- `Default`\n- `Arial`\n- `ArialNarrow`\n- `Calibri`\n- `CourierNew`\n- `Garamond`\n- `Georgia`\n- `Helvetica`\n- `LucidaConsole`\n- `MSGothic`\n- `MSMincho`\n- `OCR-A`\n- `Tahoma`\n- `TimesNewRoman`\n- `Trebuchet`\n- `Verdana`", + "anchorUnits": { + "description": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n", "type": "string" }, - "sendingTagsFontNameMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `sendingTagsFontName` property is editable.\n" + "anchorUnitsMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorUnits` property is editable." }, - "sendingTagsFontSize": { - "description": "The account-wide default font size used for the information in the tab:\n\n- `Size7`\n- `Size8`\n- `Size9`\n- `Size10`\n- `Size11`\n- `Size12`\n- `Size14`\n- `Size16`\n- `Size18`\n- `Size20`\n- `Size22`\n- `Size24`\n- `Size26`\n- `Size28`\n- `Size36`\n- `Size48`\n- `Size72`", + "anchorXOffset": { + "description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n", "type": "string" }, - "sendingTagsFontSizeMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `sendingTagsFontSize` property is editable.\n" + "anchorXOffsetMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorXOffset` property is editable." }, - "sendToCertifiedDeliveryEnabled": { - "description": "When true,\nthe account can use the\ncertified deliveries recipient type.\n", + "anchorYOffset": { + "description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n", "type": "string" }, - "sendToCertifiedDeliveryEnabledMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `sendToCertifiedDeliveryEnabled` property is editable.\n" + "anchorYOffsetMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorYOffset` property is editable." }, - "sessionTimeout": { - "description": "The amount of idle activity time, in minutes, before a user is automatically logged out of the system. The minimum setting is 20 minutes and the maximum setting is 120 minutes.\n", + "bold": { + "description": "When set to **true**, the information in the tab is bold.", "type": "string" }, - "sessionTimeoutMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `sessionTimeout` property is editable.\n" + "boldMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `bold` property is editable." }, - "setRecipEmailLang": { - "description": "The language to be used for email to a recipient. If set for one recipient, this overrides the Envelope Subject and EmailBlurb. Supported languages, with the language value shown in parenthesis, are:\n- Arabic (ar)\n- Bahasa Indonesia (id)\n- Bahasa Melayu (ms)\n- Bulgarian (bg)\n- Czech (cs)\n- Chinese Simplified (zh_CN)\n- Chinese Traditional (zh_TW)\n- Croatian (hr)\n- Danish (da)\n- Dutch (nl)\n- English US (en)\n- English UK (en_GB)\n- Estonian (et)\n- Farsi (fa)\n- Finnish (fi)\n- French (fr)\n- French Canada (fr_CA)\n- German (de)\n- Greek (el)\n- Hebrew (he)\n- Hindi (hi)\n- Hungarian (hu)\n- Italian (it)\n- Japanese (ja)\n- Korean (ko)\n- Latvian (lv)\n- Lithuanian (lt)\n- Norwegian (no)\n- Polish (pl)\n- Portuguese (pt)\n- Portuguese Brazil (pt_BR)\n- Romanian (ro),Russian (ru)\n- Serbian (sr)\n- Slovak (sk)\n- Slovenian (sl)\n- Spanish (es),Spanish Latin America (es_MX)\n- Swedish (sv)\n- Thai (th)\n- Turkish (tr)\n- Ukrainian (uk)\n- Vietnamese (vi)", + "concealValueOnDocument": { + "description": "When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender.\n\nWhen an envelope is completed the information is only available to the sender through the Form Data link in the DocuSign Console. The information on the downloaded document remains masked by asterisks.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.", "type": "string" }, - "setRecipEmailLangMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `setRecipEmailLang` property is editable.\n" + "concealValueOnDocumentMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `concealValueOnDocument` property is editable." }, - "setRecipSignLang": { - "description": "If **true**,\nsetting a unique language for a recipient\nnot only affects the email language, but also the signing\nlanguage they are presented with. If **false**, only the email will\nbe affected by the sender specifying a unique language for a\nrecipient\n", + "conditionalParentLabel": { + "description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility.", "type": "string" }, - "setRecipSignLangMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `setRecipSignLang` property is editable.\n" + "conditionalParentLabelMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `conditionalParentLabel` property is editable." }, - "sharedTemplateFolders": { - "description": "Boolean that specifies whether an account can use Shared Template Folders.", + "conditionalParentValue": { + "description": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use \"on\" as the value to show that the parent tab is active.\n", "type": "string" }, - "sharedTemplateFoldersMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `sharedTemplateFolders` property is editable.\n" + "conditionalParentValueMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `conditionalParentValue` property is editable." }, - "showCompleteDialogInEmbeddedSession": { - "description": "Boolean that specifies whether complete dialogs are displayed directly within an application in embedded signing sessions.", + "customTabId": { + "description": "The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.", "type": "string" }, - "showCompleteDialogInEmbeddedSessionMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `showCompleteDialogInEmbeddedSession` property is editable.\n" + "customTabIdMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `customTabId` property is editable." }, - "showInitialConditionalFields": { - "description": "Boolean that specifies whether conditional field options are initially displayed (before a user makes entries).", + "disableAutoSize": { + "description": "When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes.", "type": "string" }, - "showInitialConditionalFieldsMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `showInitialConditionalFields` property is editable.\n" + "disableAutoSizeMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `disableAutoSize` property is editable." }, - "showLocalizedWatermarks": { - "description": "Boolean that specifies whether localized watermarks are displayed.", + "documentId": { + "description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.", "type": "string" }, - "showLocalizedWatermarksMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `showLocalizedWatermarks` property is editable.\n" + "documentIdMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `documentId` property is editable." }, - "showTutorials": { - "description": "If **true**,\nshow tutorials.\n", + "errorDetails": { + "$ref": "#/definitions/errorDetails", + "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." + }, + "font": { + "description": "The font to be used for the tab value. Supported fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n", "type": "string" }, - "showTutorialsMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `showTutorials` property is editable.\n" + "fontColor": { + "description": "The font color to use for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n", + "type": "string" }, - "signatureProviders": { - "description": "Names of electronic or digital signature providers that can be used.", - "type": "array", - "items": { - "type": "string" - } + "fontColorMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `fontColor` property is editable." }, - "signatureProvidersMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `signatureProviders` property is editable.\n" + "fontMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `font` property is editable." }, - "signDateFormat": { - "description": "The format for the signature date. Valid values are:\n\n\n- `d/M/yyyy`\n- `dd-MM-yy`\n- `dd-MMM-yy`\n- `dd-MM-yyyy`\n- `dd.MM.yyyy`\n- `dd-MMM-yyyy`\n- `dd MMMM yyyy`\n- `M/d/yyyy`\n- `MM-dd-yyyy`\n- `MM/dd/yyyy`\n- `MM/dd/yy`\n- `MMM-dd-yyyy`\n- `MMM d, yyyy`\n- `MMMM d, yyyy`\n- `yyyy-MM-dd`\n- `yyyy-MMM-dd`\n- `yyyy/MM/dd`\n- `yyyy MMMM d`\n\n\n", + "fontSize": { + "description": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72", "type": "string" }, - "signDateFormatMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `signDateFormat` property is editable.\n" + "fontSizeMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `fontSize` property is editable." }, - "signerAttachCertificateToEnvelopePDF": { - "description": "If **true**,\nthe certificate of completion is included in the envelope documents PDF when it is downloaded.\n", + "formOrder": { + "description": "An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block.", "type": "string" }, - "signerAttachCertificateToEnvelopePDFMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `signerAttachCertificateToEnvelopePDF` property is editable.\n" + "formOrderMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `formOrder` property is editable." }, - "signerAttachConcat": { - "description": "If **true**, signer attachments are added to the parent document\nthat contains the attachment.\nThe default behavior creates\na new document in the envelope for every signer attachment.\n", + "formPageLabel": { + "description": "A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience.", "type": "string" }, - "signerAttachConcatMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `signerAttachConcat` property is editable.\n" + "formPageLabelMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `formPageLabel` property is editable." }, - "signerCanCreateAccount": { - "description": "If **true**,\nthe signer can create a DocuSign account\nafter signing.\n", + "formPageNumber": { + "description": "An integer specifying the order in which to present the guided form pages.", "type": "string" }, - "signerCanCreateAccountMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `signerCanCreateAccount` property is editable.\n" + "formPageNumberMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `fromPageNumber` property is editable." }, - "signerCanSignOnMobile": { - "description": "When set to **true**, the recipient can sign on a mobile device.", + "height": { + "description": "The height of the tab in pixels.", "type": "string" }, - "signerCanSignOnMobileMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `signerCanSignOnMobile` property is editable.\n" + "heightMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `height` property is editable." }, - "signerInSessionUseEnvelopeCompleteEmail": { - "description": "If **true**,\nsend only a completed email to an in-session signer\nand only if in-session emails are not supressed.\n", + "italic": { + "description": "When set to **true**, the information in the tab is italic.", "type": "string" }, - "signerInSessionUseEnvelopeCompleteEmailMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `signerInSessionUseEnvelopeCompleteEmail` property is editable.\n" + "italicMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `italic` property is editable." }, - "signerLoginRequirements": { - "description": "Speficies whether a signer has\nto log in. Valid values are:\n\n- `login_not_required`\n- `login_required_if_account_holder`\n- `login_required_per_session`\n- `login_required_per_envelope`\n", + "localePolicy": { + "$ref": "#/definitions/localePolicyTab", + "description": "Reserved for DocuSign." + }, + "locked": { + "description": "When set to **true**, the signer cannot change the data of the custom tab.", "type": "string" }, - "signerLoginRequirementsMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `signerLoginRequirements` property is editable.\n" + "lockedMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `locked` property is editable." }, - "signerMustHaveAccount": { - "description": "When **true**, senders can only send an envelope to a recipient that has a DocuSign account.\n", + "maxLength": { + "description": "An optional value that describes the maximum length of the property when the property is a string.", "type": "string" }, - "signerMustHaveAccountMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `signerMustHaveAccount` property is editable.\n" + "maxLengthMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `maxLength` property is editable." }, - "signerMustLoginToSign": { - "description": "When **true**,\nsigners must log in to the DocuSign platform to sign an envelope.\n", - "type": "string" + "mergeField": { + "$ref": "#/definitions/mergeField", + "description": "Contains the information necessary to map the tab to a field in SalesForce." }, - "signerMustLoginToSignMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `signerMustLoginToSign` property is editable.\n" + "mergeFieldXml": { + "description": "", + "type": "string" }, - "signerShowSecureFieldInitialValues": { - "description": "When **true**, the initial value of all SecureFields is written to the document when sent.\n", + "name": { + "description": "", "type": "string" }, - "signerShowSecureFieldInitialValuesMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `signerShowSecureFieldInitialValues` property is editable.\n" + "nameMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `name` property is editable. Read only." }, - "signingSessionTimeout": { - "description": "The number of minutes\nthat a signing session stays\nalive without any activity.\n", + "originalValue": { + "description": "The initial value of the tab when it was sent to the recipient. ", "type": "string" }, - "signingSessionTimeoutMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `signingSessionTimeout` property is editable.\n" + "originalValueMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `originalValue` property is editable." }, - "signingUiVersion": { - "description": "Reserved for DocuSign.\n", + "pageNumber": { + "description": "Specifies the page number on which the tab is located.", "type": "string" }, - "signingUiVersionMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Reserved for DocuSign." + "pageNumberMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `pageNumber` property is editable." }, - "signTimeFormat": { - "description": "The format for the signature time. Valid values are:\n\n- `none`\n- `HH:mm`\n- `h:mm`\n- `HH:mm:ss`\n- `h:mm:ss`\n", + "recipientId": { + "description": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.", "type": "string" }, - "signTimeFormatMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `signTimeFormat` property is editable.\n" - }, - "signTimeShowAmPm": { - "description": "If **true**,\nthe time shows the AM or PM indicator.\n", + "recipientIdGuid": { + "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only.", "type": "string" }, - "signTimeShowAmPmMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `signTimeShowAmPm` property is editable.\n" + "recipientIdGuidMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `recipientIdGuid` property is editable." }, - "simplifiedSendingEnabled": { - "description": "", + "recipientIdMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `recipientId` property is editable." + }, + "required": { + "description": "When set to **true**, the signer is required to fill out this tab.", "type": "string" }, - "simplifiedSendingEnabledMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `simplifiedSendingEnabled` property is editable.\n" + "requiredMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `required` property is editable." }, - "singleSignOnEnabled": { - "description": "If **true**,\nsingle sign-on (SSO) is enabled.\n", + "smartContractInformation": { + "$ref": "#/definitions/smartContractInformation", + "description": "" + }, + "status": { + "description": "Indicates the envelope status. Valid values are:\n\n* sent - The envelope is sent to the recipients. \n* created - The envelope is saved as a draft and can be modified and sent later.", "type": "string" }, - "singleSignOnEnabledMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `singleSignOnEnabled` property is editable.\n" + "statusMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `status` property is editable." }, - "skipAuthCompletedEnvelopes": { - "description": "If **true**,\ndo not require authentication prompt for viewing completed envelopes\n", + "tabGroupLabels": { + "description": "An array of tab group labels that uniquely identify tab groups. To assign a tab to a `tabGroup`, you assign the `TabGroupLabel` to the `Tab.TabGroupLabels` array.", + "type": "array", + "items": { + "type": "string" + } + }, + "tabGroupLabelsMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `tabGroupLabels` property is editable." + }, + "tabId": { + "description": "The unique identifier for the tab.", "type": "string" }, - "skipAuthCompletedEnvelopesMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `skipAuthCompletedEnvelopes` property is editable.\n" + "tabIdMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `tabId` property is editable." }, - "socialIdRecipAuth": { - "description": "If **true**,\nrecipients can use\n[social ids](https://support.docusign.com/guides/signer-authentication)\nwhen signing\n", + "tabLabel": { + "description": "The label associated with the tab. This value may be an empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum Length: 500 characters.\n", "type": "string" }, - "socialIdRecipAuthMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `socialIdRecipAuth` property is editable.\n" + "tabLabelMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `tabLabel` property is editable." }, - "specifyDocumentVisibility": { - "description": "When **true**, senders can specify the visibility of the documents in an envelope at the recipient level.\n", + "tabOrder": { + "description": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.", "type": "string" }, - "specifyDocumentVisibilityMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `specifyDocumentVisibility` property is editable.\n" + "tabOrderMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `tabOrder` property is editable." }, - "startInAdvancedCorrect": { - "description": "If **true**,\nwhen initiating correction of an in-flight envelope\nthe sender starts in advanced correct mode.\n", + "tabType": { + "description": "Indicates the type of tab (for example, `signHere` or `initialHere`).", "type": "string" }, - "startInAdvancedCorrectMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `startInAdvancedCorrect` property is editable.\n" + "tabTypeMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `tabType` property is editable." }, - "supplementalDocumentsMustAccept": { - "description": "When **true**, this user must accept supplemental documents.", + "templateLocked": { + "description": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ", "type": "string" }, - "supplementalDocumentsMustAcceptMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `supplementalDocumentsMustAccept` property is editable.\n" + "templateLockedMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `templateLocked` property is editable." }, - "supplementalDocumentsMustRead": { - "description": "When **true**, this user must read supplemental documents.", + "templateRequired": { + "description": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.", "type": "string" }, - "supplementalDocumentsMustReadMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `supplementalDocumentsMustRead` property is editable.\n" + "templateRequiredMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `templateRequired` property is editable." }, - "supplementalDocumentsMustView": { - "description": "When **true**, this user must view supplemental documents.", + "tooltip": { + "description": "The text of a tooltip that appears when a user hovers over a form field or tab.", "type": "string" }, - "supplementalDocumentsMustViewMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `supplementalDocumentsMustView` property is editable.\n" + "toolTipMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `toolTip` property is editable." }, - "suppressCertificateEnforcement": { - "description": "Boolean that specifies whether or not API calls require a x509 cert in the header of the call.", + "underline": { + "description": "When set to **true**, the information in the tab is underlined.", "type": "string" }, - "suppressCertificateEnforcementMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `suppressCertificateEnforcement` property is editable.\n" - }, - "tabAccountSettings": { - "$ref": "#/definitions/AccountTabSettings", - "description": "Account-wide tab settings." + "underlineMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `underline` property is editable." }, - "timezoneOffsetAPI": { - "description": "Specifies the time zone\nto use with the API.\n\nValid values are:\n\n- `TZ_01_AfghanistanStandardTime`\n- `TZ_02_AlaskanStandardTime`\n- `TZ_03_ArabStandardTime`\n- `TZ_04_ArabianStandardTime`\n- `TZ_05_ArabicStandardTime`\n- `TZ_06_ArgentinaStandardTime`\n- `TZ_07_AtlanticStandardTime`\n- `TZ_08_AUS_CentralStandardTime`\n- `TZ_09_AUS_EasternStandardTime`\n- `TZ_10_AzerbaijanStandardTime`\n- `TZ_11_AzoresStandardTime`\n- `TZ_12_BangladeshStandardTime`\n- `TZ_13_CanadaCentralStandardTime`\n- `TZ_14_CapeVerdeStandardTime`\n- `TZ_15_CaucasusStandardTime`\n- `TZ_16_CentralAustraliaStandardTime`\n- `TZ_17_CentralAmericaStandardTime`\n- `TZ_18_CentralAsiaStandardTime`\n- `TZ_19_CentralBrazilianStandardTime`\n- `TZ_20_CentralEuropeStandardTime`\n- `TZ_21_CentralEuropeanStandardTime`\n- `TZ_22_CentralPacificStandardTime`\n- `TZ_23_CentralStandardTime`\n- `TZ_24_CentralStandardTimeMexico`\n- `TZ_25_ChinaStandardTime`\n- `TZ_26_DatelineStandardTime`\n- `TZ_27_E_AfricaStandardTime`\n- `TZ_28_E_AustraliaStandardTime`\n- `TZ_29_E_EuropeStandardTime`\n- `TZ_30_E_SouthAmericaStandardTime`\n- `TZ_31_EasternStandardTime`\n- `TZ_32_EgyptStandardTime`\n- `TZ_33_EkaterinburgStandardTime`\n- `TZ_34_FijiStandardTime`\n- `TZ_35_FLE_StandardTime`\n- `TZ_36_GeorgianStandardTime`\n- `TZ_37_GMT_StandardTime`\n- `TZ_38_GreenlandStandardTime`\n- `TZ_39_GreenwichStandardTime`\n- `TZ_40_GTB_StandardTime`\n- `TZ_41_HawaiianStandardTime`\n- `TZ_42_IndiaStandardTime`\n- `TZ_43_IranStandardTime`\n- `TZ_44_IsraelStandardTime`\n- `TZ_45_JordanStandardTime`\n- `TZ_46_KaliningradStandardTime`\n- `TZ_47_KamchatkaStandardTime`\n- `TZ_48_KoreaStandardTime`\n- `TZ_49_MagadanStandardTime`\n- `TZ_50_MauritiusStandardTime`\n- `TZ_51_MidAtlanticStandardTime`\n- `TZ_52_MiddleEastStandardTime`\n- `TZ_53_MontevideoStandardTime`\n- `TZ_54_MoroccoStandardTime`\n- `TZ_55_MountainStandardTime`\n- `TZ_56_MountainStandardTimeMMexico`\n- `TZ_57_MyanmarStandardTime`\n- `TZ_58_N_CentralAsiaStandardTime`\n- `TZ_59_NamibiaStandardTime`\n- `TZ_60_NepalStandardTime`\n- `TZ_61_NewZealandStandardTime`\n- `TZ_62_NewfoundlandStandardTime`\n- `TZ_63_NorthAsiaEastStandardTime`\n- `TZ_64_NorthAsiaStandardTime`\n- `TZ_65_PacificSAStandardTime`\n- `TZ_66_PacificStandardTime`\n- `TZ_67_PacificStandardTimeMexico`\n- `TZ_68_PakistanStandardTime`\n- `TZ_69_ParaguayStandardTime`\n- `TZ_70_RomanceStandardTime`\n- `TZ_71_RussianStandardTime`\n- `TZ_72_SAEasternStandardTime`\n- `TZ_73_SAPacificStandardTime`\n- `TZ_74_SAWesternStandardTime`\n- `TZ_75_SamoaStandardTime`\n- `TZ_76_SE_AsiaStandardTime`\n- `TZ_77_SingaporeStandardTime`\n- `TZ_78_SouthAfricaStandardTime`\n- `TZ_79_SriLankaStandardTime`\n- `TZ_80_SyriaStandardTime`\n- `TZ_81_TaipeiStandardTime`\n- `TZ_82_TasmaniaStandardTime`\n- `TZ_83_TokyoStandardTime`\n- `TZ_84_TongaStandardTime`\n- `TZ_85_TurkeyStandardTime`\n- `TZ_86_UlaanbaatarStandardTime`\n- `TZ_87_US_EasternStandardTime`\n- `TZ_88_USMountainStandardTime`\n- `TZ_89_VenezuelaStandardTime`\n- `TZ_90_VladivostokStandardTime`\n- `TZ_91_W_AustraliaStandardTime`\n- `TZ_92_W_CentralAfricaStandardTime`\n- `TZ_93_W_EuropeStandardTime`\n- `TZ_94_WestAsiaStandardTime`\n- `TZ_95_WestPacificStandardTime`\n- `TZ_96_YakutskStandardTime`\n", + "value": { + "description": "Specifies the value of the tab. ", "type": "string" }, - "timezoneOffsetAPIMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `timezoneOffsetAPI` property is editable.\n" + "valueMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `value` property is editable." }, - "timezoneOffsetUI": { - "description": "Specifies the time zone\nto use in the UI.\n\nValid values are:\n\n- `TZ_01_AfghanistanStandardTime`\n- `TZ_02_AlaskanStandardTime`\n- `TZ_03_ArabStandardTime`\n- `TZ_04_ArabianStandardTime`\n- `TZ_05_ArabicStandardTime`\n- `TZ_06_ArgentinaStandardTime`\n- `TZ_07_AtlanticStandardTime`\n- `TZ_08_AUS_CentralStandardTime`\n- `TZ_09_AUS_EasternStandardTime`\n- `TZ_10_AzerbaijanStandardTime`\n- `TZ_11_AzoresStandardTime`\n- `TZ_12_BangladeshStandardTime`\n- `TZ_13_CanadaCentralStandardTime`\n- `TZ_14_CapeVerdeStandardTime`\n- `TZ_15_CaucasusStandardTime`\n- `TZ_16_CentralAustraliaStandardTime`\n- `TZ_17_CentralAmericaStandardTime`\n- `TZ_18_CentralAsiaStandardTime`\n- `TZ_19_CentralBrazilianStandardTime`\n- `TZ_20_CentralEuropeStandardTime`\n- `TZ_21_CentralEuropeanStandardTime`\n- `TZ_22_CentralPacificStandardTime`\n- `TZ_23_CentralStandardTime`\n- `TZ_24_CentralStandardTimeMexico`\n- `TZ_25_ChinaStandardTime`\n- `TZ_26_DatelineStandardTime`\n- `TZ_27_E_AfricaStandardTime`\n- `TZ_28_E_AustraliaStandardTime`\n- `TZ_29_E_EuropeStandardTime`\n- `TZ_30_E_SouthAmericaStandardTime`\n- `TZ_31_EasternStandardTime`\n- `TZ_32_EgyptStandardTime`\n- `TZ_33_EkaterinburgStandardTime`\n- `TZ_34_FijiStandardTime`\n- `TZ_35_FLE_StandardTime`\n- `TZ_36_GeorgianStandardTime`\n- `TZ_37_GMT_StandardTime`\n- `TZ_38_GreenlandStandardTime`\n- `TZ_39_GreenwichStandardTime`\n- `TZ_40_GTB_StandardTime`\n- `TZ_41_HawaiianStandardTime`\n- `TZ_42_IndiaStandardTime`\n- `TZ_43_IranStandardTime`\n- `TZ_44_IsraelStandardTime`\n- `TZ_45_JordanStandardTime`\n- `TZ_46_KaliningradStandardTime`\n- `TZ_47_KamchatkaStandardTime`\n- `TZ_48_KoreaStandardTime`\n- `TZ_49_MagadanStandardTime`\n- `TZ_50_MauritiusStandardTime`\n- `TZ_51_MidAtlanticStandardTime`\n- `TZ_52_MiddleEastStandardTime`\n- `TZ_53_MontevideoStandardTime`\n- `TZ_54_MoroccoStandardTime`\n- `TZ_55_MountainStandardTime`\n- `TZ_56_MountainStandardTimeMMexico`\n- `TZ_57_MyanmarStandardTime`\n- `TZ_58_N_CentralAsiaStandardTime`\n- `TZ_59_NamibiaStandardTime`\n- `TZ_60_NepalStandardTime`\n- `TZ_61_NewZealandStandardTime`\n- `TZ_62_NewfoundlandStandardTime`\n- `TZ_63_NorthAsiaEastStandardTime`\n- `TZ_64_NorthAsiaStandardTime`\n- `TZ_65_PacificSAStandardTime`\n- `TZ_66_PacificStandardTime`\n- `TZ_67_PacificStandardTimeMexico`\n- `TZ_68_PakistanStandardTime`\n- `TZ_69_ParaguayStandardTime`\n- `TZ_70_RomanceStandardTime`\n- `TZ_71_RussianStandardTime`\n- `TZ_72_SAEasternStandardTime`\n- `TZ_73_SAPacificStandardTime`\n- `TZ_74_SAWesternStandardTime`\n- `TZ_75_SamoaStandardTime`\n- `TZ_76_SE_AsiaStandardTime`\n- `TZ_77_SingaporeStandardTime`\n- `TZ_78_SouthAfricaStandardTime`\n- `TZ_79_SriLankaStandardTime`\n- `TZ_80_SyriaStandardTime`\n- `TZ_81_TaipeiStandardTime`\n- `TZ_82_TasmaniaStandardTime`\n- `TZ_83_TokyoStandardTime`\n- `TZ_84_TongaStandardTime`\n- `TZ_85_TurkeyStandardTime`\n- `TZ_86_UlaanbaatarStandardTime`\n- `TZ_87_US_EasternStandardTime`\n- `TZ_88_USMountainStandardTime`\n- `TZ_89_VenezuelaStandardTime`\n- `TZ_90_VladivostokStandardTime`\n- `TZ_91_W_AustraliaStandardTime`\n- `TZ_92_W_CentralAfricaStandardTime`\n- `TZ_93_W_EuropeStandardTime`\n- `TZ_94_WestAsiaStandardTime`\n- `TZ_95_WestPacificStandardTime`\n- `TZ_96_YakutskStandardTime`\n", + "width": { + "description": "The width of the tab in pixels.", "type": "string" }, - "timezoneOffsetUIMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `timezoneOffsetUI` property is editable.\n" + "widthMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `width` property is editable." }, - "universalSignatureOptIn": { - "description": "Reserved for DocuSign.\n", + "xPosition": { + "description": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n", "type": "string" }, - "useAccountLevelEmail": { - "description": "Reserved for DocuSign.\n", - "type": "string" + "xPositionMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `xPosition` property is editable." }, - "useAccountLevelEmailMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `useAccountLevelEmail` property is editable.\n" + "yPosition": { + "description": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n", + "type": "string" }, - "useConsumerDisclosure": { - "description": "Boolean that specifies whether the account uses an Electronic Record and Signature Disclosure Statement.", + "yPositionMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `yPosition` property is editable." + } + }, + "x-ds-definition-name": "commissionState", + "description": "", + "x-ms-summary": "" + }, + "company": { + "type": "object", + "properties": { + "anchorAllowWhiteSpaceInCharacters": { + "description": "", "type": "string" }, - "useConsumerDisclosureMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `useConsumerDisclosure` property is editable.\n" + "anchorAllowWhiteSpaceInCharactersMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "" }, - "useConsumerDisclosureWithinAccount": { - "description": "Boolean that specifies whether recipients in the same account as the sender must agree to eSign an Electronic Record and Signature Disclosure Statement.", + "anchorCaseSensitive": { + "description": "This property controls how [anchor tabs][AnchorTabs] are placed. When **true**, the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false**.\n\nFor example, when set to **true**, if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When set to **false**, `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**.\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place", "type": "string" }, - "useConsumerDisclosureWithinAccountMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `useConsumerDisclosureWithinAccount` property is editable.\n" + "anchorCaseSensitiveMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorCaseSensitive` property is editable." }, - "useDerivedKeys": { - "description": "Reserved for DocuSign.\n", + "anchorHorizontalAlignment": { + "description": "This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are :\n\n- `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value.\n- `right`: Aligns the tab’s left side with the last character of the matching anchor word.\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place\n", "type": "string" }, - "useDerivedKeysMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `useDerivedKeys` property is editable.\n" + "anchorHorizontalAlignmentMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorHorizontalAlignment` property is editable." }, - "useDocuSignExpressSignerCertificate": { - "description": "If **true**,\nsigners\nare required to use Express Digital Signatures.\n", + "anchorIgnoreIfNotPresent": { + "description": "When set to **true**, this tab is ignored if the `anchorString` is not found in the document.", "type": "string" }, - "useDocuSignExpressSignerCertificateMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `useDocuSignExpressSignerCertificate` property is editable.\n" + "anchorIgnoreIfNotPresentMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable." }, - "useNewBlobForPdf": { - "description": "Reserved for DocuSign.\n", + "anchorMatchWholeWord": { + "description": "When set to **true**, the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false**.\n\nFor example, when set to **true**, if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When set to **false**, if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**.\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTab]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place\n", "type": "string" }, - "useNewBlobForPdfMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `useNewBlobForPdf` property is editable.\n" + "anchorMatchWholeWordMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorMatchWholeWord` property is editable." }, - "useSAFESignerCertificates": { - "description": "If **true**,\nsigners are\nrequired to use SAFE digital signatures.\n", + "anchorString": { + "description": "Specifies the string to find in the document and use as the basis for tab placement.", "type": "string" }, - "useSAFESignerCertificatesMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `useSAFESignerCertificates` property is editable.\n" + "anchorStringMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorString` property is editable." }, - "usesAPI": { - "description": "If **true**,\nthe account can use the API.\n", + "anchorTabProcessorVersion": { + "description": "Reserved for DocuSign.", "type": "string" }, - "usesAPIMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `usesAPI` property is editable.\n" + "anchorTabProcessorVersionMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Reserved for DocuSign." }, - "useSignatureProviderPlatform": { - "description": "Boolean that specifies whether the account uses the digital signature provider platform to eSign.", + "anchorUnits": { + "description": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n", "type": "string" }, - "useSignatureProviderPlatformMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `useSignatureProviderPlatform` property is editable.\n" + "anchorUnitsMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorUnits` property is editable." }, - "validationsAllowed": { - "description": "Boolean that specifies whether validations on recipient email domains are allowed.", + "anchorXOffset": { + "description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n", "type": "string" }, - "validationsAllowedMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `validationsAllowed` property is editable.\n" + "anchorXOffsetMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorXOffset` property is editable." }, - "validationsBrand": { - "description": "Valid values are:\n\n- `docusign`\n- `account`\n", + "anchorYOffset": { + "description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n", "type": "string" }, - "validationsBrandMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `validationsBrand` property is editable.\n" + "anchorYOffsetMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorYOffset` property is editable." }, - "validationsCadence": { - "description": "Valid values are:\n\n- `none`\n- `monthly`\n", + "bold": { + "description": "When set to **true**, the information in the tab is bold.", "type": "string" }, - "validationsCadenceMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `validationsCadence` property is editable.\n" + "boldMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `bold` property is editable." }, - "validationsEnabled": { - "description": "If **true**,\nenables validations.\n", + "concealValueOnDocument": { + "description": "When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender.\n\nWhen an envelope is completed the information is only available to the sender through the Form Data link in the DocuSign Console. The information on the downloaded document remains masked by asterisks.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.", "type": "string" }, - "validationsEnabledMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `validationsEnabled` property is editable.\n" + "concealValueOnDocumentMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `concealValueOnDocument` property is editable." }, - "validationsReport": { - "description": "Valid values are:\n\n- `none`\n- `life_sciences_part11`\n", + "conditionalParentLabel": { + "description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility.", "type": "string" }, - "validationsReportMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `validationsReport` property is editable.\n" + "conditionalParentLabelMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `conditionalParentLabel` property is editable." }, - "waterMarkEnabled": { - "description": "If **true**,\nthe\n[watermark feature](https://support.docusign.com/en/articles/How-do-I-manage-the-watermark-for-In-Process-envelopes-sent-from-my-account)\nis enabled for the account.\n", + "conditionalParentValue": { + "description": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use \"on\" as the value to show that the parent tab is active.\n", "type": "string" }, - "waterMarkEnabledMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `waterMarkEnabled` property is editable.\n" + "conditionalParentValueMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `conditionalParentValue` property is editable." }, - "writeReminderToEnvelopeHistory": { - "description": "If **true**,\nsent reminders are included in the envelope history.", + "customTabId": { + "description": "The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.", "type": "string" }, - "writeReminderToEnvelopeHistoryMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `writeReminderToEnvelopeHistory` property is editable.\n" + "customTabIdMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `customTabId` property is editable." }, - "wurflMinAllowableScreenSize": { - "description": "The smallest screen allowed.", + "disableAutoSize": { + "description": "When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes.", "type": "string" }, - "wurflMinAllowableScreenSizeMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `wurflMinAllowableScreenSize` property is editable.\n" - } - }, - "x-ds-definition-name": "accountSettingsInformation", - "x-ms-summary": "Contains account settings information. Used in requests to set property values. Used in responses to report property values." - }, - "accountSharedAccess": { - "description": "Contains shared access information.", - "type": "object", - "properties": { - "accountId": { - "description": "The account ID associated with the envelope.", - "type": "string" + "disableAutoSizeMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `disableAutoSize` property is editable." }, - "endPosition": { - "description": "The last position in the result set. ", + "documentId": { + "description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.", "type": "string" }, + "documentIdMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `documentId` property is editable." + }, "errorDetails": { "$ref": "#/definitions/errorDetails", - "description": "A complex type containing an errorCode and message identifying the error that occurred." + "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." }, - "nextUri": { - "description": "The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. ", + "font": { + "description": "The font to be used for the tab value. Supported fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n", "type": "string" }, - "previousUri": { - "description": "The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. ", + "fontColor": { + "description": "The font color to use for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n", "type": "string" }, - "resultSetSize": { - "description": "The number of results returned in this response. Because you can filter which entries are included in the response, this value is always less than or equal to `totalSetSize`.", - "type": "string" + "fontColorMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `fontColor` property is editable." }, - "sharedAccess": { - "description": "A list of shared access information of envelope and templates for the users specified in the request.", - "type": "array", - "items": { - "$ref": "#/definitions/memberSharedItems" - } + "fontMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `font` property is editable." }, - "startPosition": { - "description": "The starting position of the current result set.", + "fontSize": { + "description": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72", "type": "string" }, - "totalSetSize": { - "description": "The total number of items in the search's result set. This value is always greater than or equal to the value of `resultSetSize`.", - "type": "string" - } - }, - "x-ds-definition-name": "accountSharedAccess", - "x-ms-summary": "Contains shared access information." - }, - "accountSignatureProvider": { - "type": "object", - "properties": { - "signatureProviderName": { - "description": "The name of an Electronic or Standards Based Signature (digital signature) provider for the signer to use. [The current provider list.](https://developers.docusign.com/esign-rest-api/guides/standards-based-signatures)", - "type": "string" - } - }, - "x-ds-definition-name": "accountSignatureProvider", - "description": "Signature provider associated with the identity verification workflow. \nIf empty, then this specific workflow is not intended for signers\n", - "x-ms-summary": "Signature provider associated with the identity verification workflow. \nIf empty, then this specific workflow is not intended for signers\n" - }, - "accountSignatureProviderOption": { - "type": "object", - "properties": { - "signatureProviderOptionDisplayName": { - "description": "", - "type": "string" + "fontSizeMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `fontSize` property is editable." }, - "signatureProviderOptionId": { - "description": "", + "formOrder": { + "description": "An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block.", "type": "string" }, - "signatureProviderOptionName": { - "description": "", - "type": "string" - } - }, - "x-ds-definition-name": "accountSignatureProviderOption", - "description": "", - "x-ms-summary": "" - }, - "accountSignatureProviders": { - "type": "object", - "properties": { - "signatureProviders": { - "description": "Names of electronic or digital signature providers that can be used.", - "type": "array", - "items": { - "$ref": "#/definitions/accountSignatureProvider" - } - } - }, - "x-ds-definition-name": "accountSignatureProviders", - "description": "", - "x-ms-summary": "" - }, - "addOn": { - "description": "Contains information about add ons.", - "type": "object", - "properties": { - "active": { - "description": "Reserved:", - "type": "string" + "formOrderMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `formOrder` property is editable." }, - "addOnId": { - "description": "Reserved:", + "formPageLabel": { + "description": "A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience.", "type": "string" }, - "id": { - "description": "A unique ID for the Salesforce object.", - "type": "string" + "formPageLabelMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `formPageLabel` property is editable." }, - "name": { - "description": "Reserved:", - "type": "string" - } - }, - "x-ds-definition-name": "addOn", - "x-ms-summary": "Contains information about add ons." - }, - "addressInformation": { - "description": "Contains address information.", - "type": "object", - "properties": { - "address1": { - "description": "The first line of the user's address.\nMaximum length: 100 characters.", + "formPageNumber": { + "description": "An integer specifying the order in which to present the guided form pages.", "type": "string" }, - "address2": { - "description": "The second line of the user's address.\nMaximum length: 100 characters.", - "type": "string" + "formPageNumberMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `fromPageNumber` property is editable." }, - "city": { - "description": "The user's city.", + "height": { + "description": "The height of the tab in pixels.", "type": "string" }, - "country": { - "description": "The user's country.", - "type": "string" + "heightMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `height` property is editable." }, - "fax": { - "description": "A fax number associated with the address, if one is available.", + "italic": { + "description": "When set to **true**, the information in the tab is italic.", "type": "string" }, - "phone": { - "description": "A phone number associated with the address.", - "type": "string" + "italicMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `italic` property is editable." }, - "postalCode": { - "description": "The user's postal code.", - "type": "string" + "localePolicy": { + "$ref": "#/definitions/localePolicyTab", + "description": "Reserved for DocuSign." }, - "stateOrProvince": { - "description": "The user's state or province.", + "locked": { + "description": "When set to **true**, the signer cannot change the data of the custom tab.", "type": "string" - } - }, - "x-ds-definition-name": "addressInformation", - "x-ms-summary": "Contains address information." - }, - "addressInformationInput": { - "description": "", - "type": "object", - "properties": { - "addressInformation": { - "$ref": "#/definitions/addressInformation", - "description": "A complex type that contains the following information for the new account: `address1`, `address2`, `city`, `country`, `fax`, `phone`, `postalCode` and `stateOrProvince`.\n\nThe maximum characters for the strings are:\n* `address1`, `address2`, `city`, `country` and `stateOrProvince`: 100 characters\n* `postalCode`, `phone`, and `fax`: 20 characters\n\n**Note:** If country is US (United States), `stateOrProvince` codes are validated. Otherwise, `stateOrProvince` is treated as a non-validated string used to specify a state, province, or region." }, - "displayLevelCode": { - "description": "Specifies the display level for the recipient. Valid values are:\n* `ReadOnly`\n* `Editable`\n* `DoNotDisplay`", - "type": "string" + "lockedMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `locked` property is editable." }, - "receiveInResponse": { - "description": "A Boolean value that specifies whether the information must be returned in the response.", - "type": "string" - } - }, - "x-ds-definition-name": "addressInformationInput", - "x-ms-summary": "" - }, - "agent": { - "description": "Contains information about agent recipients.", - "type": "object", - "properties": { - "accessCode": { - "description": "If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. \n\nMaximum Length: 50 characters and it must conform to the account's access code format setting.\n\nIf blank, but the signer `accessCode` property is set in the envelope, then that value is used.\n\nIf blank and the signer `accessCode` property is not set, then the access code is not required.", + "maxLength": { + "description": "An optional value that describes the maximum length of the property when the property is a string.", "type": "string" }, - "accessCodeMetadata": { + "maxLengthMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `accessCode` property is editable.\n" + "description": "Metadata that indicates whether the `maxLength` property is editable." }, - "addAccessCodeToEmail": { - "description": "This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient.", - "type": "string" + "mergeField": { + "$ref": "#/definitions/mergeField", + "description": "Contains the information necessary to map the tab to a field in SalesForce." }, - "clientUserId": { - "description": "Specifies whether the recipient is embedded or remote. \n\nIf the `clientUserId` property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing.\n\nNote: if the `clientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true**, an error is generated on sending. \n\nMaximum length: 100 characters. ", + "mergeFieldXml": { + "description": "", "type": "string" }, - "completedCount": { - "description": "Indicates the number of times that the recipient has been through a signing completion for the envelope.\n\nIf this number is greater than 0 for a signing group, only the user who previously completed may sign again.", + "name": { + "description": "The name of the tab. For example, `Sign Here` or `Initial Here`.", "type": "string" }, - "customFields": { - "description": "An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters.", - "type": "array", - "items": { - "type": "string" - } + "nameMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `name` property is editable. Read only." }, - "declinedDateTime": { - "description": "The date and time the recipient declined the document.", + "originalValue": { + "description": "The initial value of the tab when it was sent to the recipient. ", "type": "string" }, - "declinedReason": { - "description": "The reason the recipient declined the document.", + "originalValueMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `originalValue` property is editable." + }, + "pageNumber": { + "description": "The page number on which the tab is located.\nFor supplemental documents, this value must be `1`.", "type": "string" }, - "deliveredDateTime": { - "description": "The date and time that the envelope was delivered to the recipient.", + "pageNumberMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `pageNumber` property is editable." + }, + "recipientId": { + "description": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.", "type": "string" }, - "deliveryMethod": { - "description": "Reserved for DocuSign.", + "recipientIdGuid": { + "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only.", "type": "string" }, - "deliveryMethodMetadata": { + "recipientIdGuidMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `deliveryMethod` property is editable.\n" + "description": "Metadata that indicates whether the `recipientIdGuid` property is editable." }, - "documentVisibility": { - "description": "A list of documentVisibility objects, which define a recipient's read/write access to a document.", - "type": "array", - "items": { - "$ref": "#/definitions/documentVisibility" - } + "recipientIdMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `recipientId` property is editable." }, - "email": { - "description": "The email id of the agent. Notification of the document to sign is sent to this email id. \n\nMaximum length: 100 characters. ", + "required": { + "description": "When set to **true**, the signer is required to fill out this tab.", "type": "string" }, - "emailMetadata": { + "requiredMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the email id of the agent." + "description": "Metadata that indicates whether the `required` property is editable." }, - "emailNotification": { - "$ref": "#/definitions/recipientEmailNotification", - "description": "An optional complex type that sets a specific email subject and body for this recipient's notification email. \n\n**Note**: If you use this field to set a specific email notification for one recipient, you must also set the email notification for the other recipients. Using this field for one or more recipients negates the Envelope `Subject` and `EmailBlurb` property settings. " + "smartContractInformation": { + "$ref": "#/definitions/smartContractInformation", + "description": "" }, - "embeddedRecipientStartURL": { - "description": "Specifies a sender-provided valid URL string for redirecting an embedded recipient. When this option is used, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the recipient clicks the document link in the email, the recipient is redirected through DocuSign to the specified URL to complete the required actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. \n\nIf set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation launched by a partner.\n\nIt is important to understand that in a typical embedded workflow, the authentication of an embedded recipient is the responsibility of the sending application. DocuSign expects that senders will follow their own processes for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process is initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process, bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient.\n\nIf the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: `envelopeId`, `recipientId`, `recipientName`, `recipientEmail`, and `customFields`. The `customFields` property must be set for the recipient or envelope. The merge fields are enclosed in double brackets. \n\n*Example*: \n\n`http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` ", + "status": { + "description": "The status of the tab. Possible values are:\n\n- `active`: The tab is active, but the recipient has not yet interacted with it.\n- `signed`: The recipient signed the tab.\n- `declined`: The recipient declined the envelope.\n- `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`).\n", "type": "string" }, - "errorDetails": { - "$ref": "#/definitions/errorDetails", - "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." + "statusMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `status` property is editable." }, - "excludedDocuments": { - "description": "Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true** for the envelope to use this.\n\nWhen enforce signer visibility is enabled, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent.", + "tabGroupLabels": { + "description": "An array of tab group labels that uniquely identify tab groups. To assign a tab to a `tabGroup`, you assign the `TabGroupLabel` to the `Tab.TabGroupLabels` array.", "type": "array", "items": { "type": "string" } }, - "faxNumber": { - "description": "Reserved for DocuSign.", + "tabGroupLabelsMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `tabGroupLabels` property is editable." + }, + "tabId": { + "description": "The unique identifier for the tab.", "type": "string" }, - "faxNumberMetadata": { + "tabIdMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `faxNumber` property is editable.\n" + "description": "Metadata that indicates whether the `tabId` property is editable." }, - "firstName": { - "description": "The agent's first name. Maximum Length: 50 characters.", + "tabLabel": { + "description": "The label associated with the tab. This value may be an empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum Length: 500 characters.\n", "type": "string" }, - "firstNameMetadata": { + "tabLabelMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the agent's first name." + "description": "Metadata that indicates whether the `tabLabel` property is editable." }, - "fullName": { - "description": "Reserved for DocuSign.", + "tabOrder": { + "description": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.", "type": "string" }, - "fullNameMetadata": { + "tabOrderMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "description": "Metadata that indicates whether the `tabOrder` property is editable." }, - "idCheckConfigurationName": { - "description": "The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting.\n\n**Example**: Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node.", + "tabType": { + "description": "Indicates the type of tab (for example, `signHere` or `initialHere`).", "type": "string" }, - "idCheckConfigurationNameMetadata": { + "tabTypeMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `idCheckConfigurationName` property is editable.\n" - }, - "idCheckInformationInput": { - "$ref": "#/definitions/idCheckInformationInput", - "description": "An object that contains input information related to a recipient ID check." + "description": "Metadata that indicates whether the `tabType` property is editable." }, - "inheritEmailNotificationConfiguration": { - "description": "When set to **true** and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account. ", + "templateLocked": { + "description": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ", "type": "string" }, - "lastName": { - "description": "The agent's last name.", + "templateLockedMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `templateLocked` property is editable." + }, + "templateRequired": { + "description": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.", "type": "string" }, - "lastNameMetadata": { + "templateRequiredMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the agent's last name." + "description": "Metadata that indicates whether the `templateRequired` property is editable." }, - "lockedRecipientPhoneAuthEditable": { - "description": "Reserved for DocuSign.", + "tooltip": { + "description": "The text of a tooltip that appears when a user hovers over a form field or tab.", "type": "string" }, - "lockedRecipientSmsEditable": { - "description": "Reserved for DocuSign.", + "toolTipMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `toolTip` property is editable." + }, + "underline": { + "description": "When set to **true**, the information in the tab is underlined.", "type": "string" }, - "name": { - "description": "The full legal name of the agent.", + "underlineMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `underline` property is editable." + }, + "value": { + "description": "Specifies the value of the tab. ", "type": "string" }, - "nameMetadata": { + "valueMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the full legal name of the agent." + "description": "Metadata that indicates whether the `value` property is editable." }, - "note": { - "description": "A note sent to the recipient in the signing email.\nThis note is unique to this recipient.\nIn the user interface,\nit appears near the upper left corner\nof the document\non the signing screen.\n\nMaximum Length: 1000 characters.\n", + "width": { + "description": "The width of the tab in pixels.", "type": "string" }, - "noteMetadata": { + "widthMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the note sent to the recipient in the signing email." + "description": "Metadata that indicates whether the `width` property is editable." }, - "phoneAuthentication": { - "$ref": "#/definitions/recipientPhoneAuthentication", - "description": "A complex type that contains the following elements:\n\n* `recipMayProvideNumber` - Boolean. When set to **true**, the recipient can use whatever phone number they choose.\n* `senderProvidedNumbers` - ArrayOfString. A list of phone numbers the recipient can use.\n* `recordVoicePrint` - Reserved.\n* `validateRecipProvidedNumber` - Reserved." + "xPosition": { + "description": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n", + "type": "string" }, - "recipientAttachments": { - "description": "Reserved for DocuSign.", - "type": "array", - "items": { - "$ref": "#/definitions/recipientAttachment" - } + "xPositionMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `xPosition` property is editable." }, - "recipientAuthenticationStatus": { - "$ref": "#/definitions/authenticationStatus", - "description": "Information about the recipient's authentication status." + "yPosition": { + "description": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n", + "type": "string" }, - "recipientFeatureMetadata": { - "description": "Metadata that indicates whether the `recipientFeature` property is editable.\n", + "yPositionMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `yPosition` property is editable." + } + }, + "x-ds-definition-name": "company", + "description": "A tab that displays the recipient's company name.\n", + "x-ms-summary": "A tab that displays the recipient's company name.\n" + }, + "completeSignHashResponse": { + "type": "object", + "properties": { + "documents": { + "description": "A complex element that contains details about the documents associated with the envelope.", "type": "array", "items": { - "$ref": "#/definitions/featureAvailableMetadata" + "$ref": "#/definitions/signHashDocument" } }, - "recipientId": { - "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", + "redirectionUrl": { + "description": "", "type": "string" }, - "recipientIdGuid": { - "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one.", + "remainingSignatureRequests": { + "description": "For documents that require multiple signatures, this is the number of signature requests remaining.", "type": "string" - }, - "recipientType": { - "description": "The recipient type, as specified by the following values:\n- `agents`: Agent recipients can add name and email information for recipients that appear after the agent in routing order.\n- `carbonCopies`: Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date, or add information to any of the documents. This type of recipient can be used in any routing order.\n- `certifiedDeliveries`: Certified delivery recipients must receive the completed documents for the envelope to be completed. They don't need to sign, initial, date, or add information to any of the documents.\n- `editors`: Editors have the same management and access rights for the envelope as the sender. Editors can add name and email information, add or change the routing order, set authentication options, and can edit signature/initial tabs and data fields for the remaining recipients.\n- `inPersonSigners`: In-person recipients are DocuSign users who act as signing hosts in the same physical location as the signer.\n- `intermediaries`: Intermediary recipients can optionally add name and email information for recipients at the same or subsequent level in the routing order.\n- `seals`: Electronic seal recipients represent legal entities.\n- `signers`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope.\n- `witnesses`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope.", + } + }, + "x-ds-definition-name": "completeSignHashResponse", + "description": "", + "x-ms-summary": "" + }, + "signHashDocument": { + "type": "object", + "properties": { + "data": { + "description": "A Base64-encoded representation of the attachment that is used to upload and download the file. File attachments may be up to 50 MB in size.", "type": "string" }, - "recipientTypeMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `recipientType` property is editable.\n" - }, - "requireIdLookup": { - "description": "When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. ", + "documentId": { + "description": "Integer that identifies the document in the envelope.", "type": "string" }, - "requireIdLookupMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `requireIdLookup` property is editable.\n" - }, - "roleName": { - "description": "Optional element. Specifies the role name associated with the recipient.

This is required when working with template recipients.", + "format": { + "description": "", "type": "string" }, - "routingOrder": { - "description": "Specifies the routing order of the recipient in the envelope. ", + "name": { + "description": "", "type": "string" }, - "routingOrderMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the routing order for the recipient." + "remainingSignatures": { + "format": "int64", + "description": "", + "type": "integer" }, - "sentDateTime": { - "description": "The date and time the envelope was sent.", + "revisions": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/revision" + } + }, + "signatureProperties": { + "$ref": "#/definitions/signatureProperties", + "description": "" + }, + "signatureType": { + "description": "Specifies the type of signature.", + "type": "string" + } + }, + "x-ds-definition-name": "signHashDocument", + "description": "", + "x-ms-summary": "" + }, + "revision": { + "type": "object", + "properties": { + "endData": { + "description": "", "type": "string" }, - "signedDateTime": { - "description": "Reserved for DocuSign.", + "fieldName": { + "description": "", "type": "string" }, - "signingGroupId": { - "description": "The id of the signing group of which the agent is a member, if applicable.", + "maxSignatureLength": { + "description": "", "type": "string" }, - "signingGroupIdMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `signingGroupId` property is editable.\n" + "signatureProperties": { + "$ref": "#/definitions/signatureProperties", + "description": "" }, - "signingGroupName": { - "description": "The display name for the signing group. \n\nMaximum Length: 100 characters. ", + "signatureType": { + "description": "Specifies the type of signature.", "type": "string" }, - "signingGroupUsers": { - "description": "A complex type that contains information about users in the signing group.", + "startData": { + "description": "", + "type": "string" + } + }, + "x-ds-definition-name": "revision", + "description": "", + "x-ms-summary": "" + }, + "compositeTemplate": { + "type": "object", + "properties": { + "compositeTemplateId": { + "description": "The id of this composite template. This id is used as a reference when adding document object information. If used, the document's `content-disposition` must include the composite template ID to which the document should be added. If a composite template ID is not specified in the content-disposition, the document is applied based on the value of the `documentId` property only. If no document object is specified, the composite template inherits the first document.", + "type": "string" + }, + "document": { + "$ref": "#/definitions/document", + "description": "An optional document object that will act as the primary document in the composite template object. If the document node is present, it will take precedence over any server template or inline template documents. It always comes first. Only use this when you want to supply the document dynamically." + }, + "inlineTemplates": { + "description": " Zero or more inline templates and their position in the overlay. If supplied, they are overlaid into the envelope in the order of their Sequence value.", "type": "array", "items": { - "$ref": "#/definitions/userInfo" + "$ref": "#/definitions/inlineTemplate" } }, - "smsAuthentication": { - "$ref": "#/definitions/recipientSMSAuthentication", - "description": "Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication. \n" + "pdfMetaDataTemplateSequence": { + "description": "A number representing the sequence in which to apply the template that contains the PDF metadata.\n\nExample: `4`", + "type": "string" }, - "socialAuthentications": { - "description": " Lists the social ID type that can be used for recipient authentication.", + "serverTemplates": { + "description": "Zero or more server-side templates and their position in the overlay. If supplied, they are overlaid into the envelope in the order of their Sequence value", "type": "array", "items": { - "$ref": "#/definitions/socialAuthentication" + "$ref": "#/definitions/serverTemplate" + } + } + }, + "x-ds-definition-name": "compositeTemplate", + "description": "This object contains information about a [composite template][composite], which you can use to to apply multiple templates to a single envelope, combine templates with PDF forms, and combine templates with documents from cloud sources.\n\n[composite]: https://developers.docusign.com/esign-rest-api/guides/features/templates#composite-templates", + "x-ms-summary": "This object contains information about a [composite template][composite], which you can use to to apply multiple templates to a single envelope, combine templates with PDF forms, and combine templates with documents from cloud sources.\n\n[composite]: https://developers.docusign.com/esign-rest-api/guides/features/templates#composite-templates" + }, + "conditionalRecipientRule": { + "type": "object", + "properties": { + "conditions": { + "description": "An array of conditions that satisfy the rule.", + "type": "array", + "items": { + "$ref": "#/definitions/conditionalRecipientRuleCondition" } }, - "status": { - "description": "Recipient status.\n\n", - "type": "string" - }, - "statusCode": { - "description": "Reserved for DocuSign.", + "order": { + "description": "An integer that specifies the order in which rules are processed.\nLower values are processed before higher values.", "type": "string" }, - "templateLocked": { - "description": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ", - "type": "string" + "recipientGroup": { + "$ref": "#/definitions/recipientGroup", + "description": "" }, - "templateRequired": { - "description": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.", + "recipientId": { + "description": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.", "type": "string" + } + }, + "x-ds-definition-name": "conditionalRecipientRule", + "description": "", + "x-ms-summary": "" + }, + "conditionalRecipientRuleCondition": { + "type": "object", + "properties": { + "filters": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/conditionalRecipientRuleFilter" + } }, - "totalTabCount": { - "description": "The total number of tabs in the documents.", + "order": { + "description": "An integer that specifies the order in which rules are processed.\nLower values are processed before higher values.", "type": "string" }, - "userId": { - "description": "The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.\n", + "recipientLabel": { + "description": "", "type": "string" } }, - "x-ds-definition-name": "agent", - "x-ms-summary": "Contains information about agent recipients." + "x-ds-definition-name": "conditionalRecipientRuleCondition", + "description": "", + "x-ms-summary": "" }, - "apiRequestLog": { - "description": "Contains API request log information.", + "conditionalRecipientRuleFilter": { "type": "object", "properties": { - "createdDateTime": { - "description": "The date and time the item was created.", + "operator": { + "description": "", "type": "string" }, - "description": { - "description": "A sender-defined description of the line item.\n", + "recipientId": { + "description": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.", "type": "string" }, - "requestLogId": { - "description": "", + "scope": { + "description": "Must be set to \"api\".", "type": "string" }, - "status": { - "description": "The status of the item.", + "tabId": { + "description": "The unique identifier for the tab.", + "type": "string" + }, + "tabLabel": { + "description": "The label associated with the tab. This value may be an empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum Length: 500 characters.\n", + "type": "string" + }, + "value": { + "description": "Specifies the value of the tab. ", "type": "string" } }, - "x-ds-definition-name": "apiRequestLog", - "x-ms-summary": "Contains API request log information." + "x-ds-definition-name": "conditionalRecipientRuleFilter", + "description": "", + "x-ms-summary": "" }, - "apiRequestLogsResult": { - "description": "Contains information about mutiple API request logs.", + "connectConfigResults": { "type": "object", "properties": { - "apiRequestLogs": { - "description": "Reserved: TBD", + "configurations": { + "description": "An array of DocuSign Connect configurations.", "type": "array", "items": { - "$ref": "#/definitions/apiRequestLog" + "$ref": "#/definitions/connectCustomConfiguration" } + }, + "totalRecords": { + "description": "The number of results.", + "type": "string" } }, - "x-ds-definition-name": "apiRequestLogsResult", - "x-ms-summary": "Contains information about mutiple API request logs." + "x-ds-definition-name": "connectConfigResults", + "description": "This object contains the results of a ConnectConfigurations::GET method.", + "x-ms-summary": "This object contains the results of a ConnectConfigurations::GET method." }, - "approve": { + "connectCustomConfiguration": { "type": "object", "properties": { - "anchorCaseSensitive": { - "description": "Reserved for DocuSign.\n", + "allowEnvelopePublish": { + "description": "When set to **true**, data is sent to the urlToPublishTo web address. This option can be set to false to stop sending data while maintaining the Connect configuration information.", "type": "string" }, - "anchorCaseSensitiveMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." - }, - "anchorHorizontalAlignment": { - "description": "Reserved for DocuSign.\n\n", + "allowSalesforcePublish": { + "description": "When set to **true** (default), DocuSign sends data to the designated Salesforce account through Connect.", "type": "string" }, - "anchorHorizontalAlignmentMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." - }, - "anchorIgnoreIfNotPresent": { - "description": "When set to **true**, this tab is ignored if the `anchorString` is not found in the document.", + "allUsers": { + "description": "When set to **true**, the tracked envelope and recipient events for all users, including users that are added a later time, are sent through Connect.", "type": "string" }, - "anchorIgnoreIfNotPresentMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable." - }, - "anchorMatchWholeWord": { - "description": "Reserved for DocuSign.\n\n", + "configurationType": { + "description": "If you are using merge fields, this property specifies the type of the merge field. The only supported value is `salesforce`.", "type": "string" }, - "anchorMatchWholeWordMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." - }, - "anchorString": { - "description": "Specifies the string to find in the document and use as the basis for tab placement.", + "connectId": { + "description": " Specifies the DocuSign generated ID for the Connect configuration. ", "type": "string" }, - "anchorStringMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `anchorString` property is editable." - }, - "anchorTabProcessorVersion": { - "description": "Reserved for DocuSign.", + "enableLog": { + "description": "When set to **true**, Connect logging is turned on. We recommend that you enable this functionality, which helps you troubleshoot any issues. \n\nYou can have a maximum of 100 active logs in your account. You can view the entries in active logs in the **Logs** tab in the console.", "type": "string" }, - "anchorTabProcessorVersionMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." - }, - "anchorUnits": { - "description": "Specifies the units of the X and Y offset. Units may be pixels, millimeters, centimeters, or inches.", - "type": "string" + "envelopeEvents": { + "description": "A list of envelope-level event statuses that will trigger Connect to send updates to the endpoint specified in the `url` property. \n\nTo receive notifications, you must include either an `envelopeEvents` node or a `recipientEvents` node. You do not need to specify both.", + "type": "array", + "items": { + "type": "string" + } }, - "anchorUnitsMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `anchorUnits` property is editable." + "eventData": { + "$ref": "#/definitions/connectEventData", + "description": "Allows you to specify the format of the information the Connect webhooks returns. For more information, see [Connect webhooks with JSON notifications](https://www.docusign.com/blog/developers/connect-webhooks-json-notifications)" }, - "anchorXOffset": { - "description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.", + "externalFolderId": { + "description": "The id of an external folder.", "type": "string" }, - "anchorXOffsetMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `anchorXOffset` property is editable." - }, - "anchorYOffset": { - "description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.", + "externalFolderLabel": { + "description": "The label for an external folder.", "type": "string" }, - "anchorYOffsetMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `anchorYOffset` property is editable." - }, - "bold": { - "description": "When set to **true**, the information in the tab is bold.", + "includeCertificateOfCompletion": { + "description": "When set to **true**, the Connect Service includes the Certificate of Completion with completed envelopes. ", "type": "string" }, - "boldMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `bold` property is editable." - }, - "buttonText": { - "description": " Specifies the approval text that displays in the tab. ", + "includeCertSoapHeader": { + "description": "", "type": "string" }, - "buttonTextMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `buttonText` property is editable." - }, - "conditionalParentLabel": { - "description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility.", + "includeDocumentFields": { + "description": "When set to **true**, the Document Fields associated with the envelope's documents are included in the notification messages. Document Fields are optional custom name-value pairs added to documents using the API. ", "type": "string" }, - "conditionalParentLabelMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `conditionalParentLabel` property is editable." - }, - "conditionalParentValue": { - "description": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use \"on\" as the value to show that the parent tab is active.\n", + "includeDocuments": { + "description": "reserved", "type": "string" }, - "conditionalParentValueMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `conditionalParentValue` property is editable." - }, - "customTabId": { - "description": "The DocuSign-generated custom tab ID for the custom tab to be applied. You can only use this when adding new tabs for a recipient. When used, the new tab inherits all of the properties of the custom tab.", + "includeEnvelopeVoidReason": { + "description": "When set to **true**, if the envelope is voided, the Connect Service notification will include the void reason, as entered by the person that voided the envelope. ", "type": "string" }, - "customTabIdMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `customTabId` property is editable." - }, - "documentId": { - "description": "Integer that identifies the document in the envelope.", + "includeHMAC": { + "description": "", "type": "string" }, - "documentIdMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `documentId` property is editable." - }, - "errorDetails": { - "$ref": "#/definitions/errorDetails", - "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." - }, - "font": { - "description": "The font to be used for the tab value. Supported fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n", + "includeSenderAccountasCustomField": { + "description": "When set to **true**, Connect will include the sender account as Custom Field in the data.", "type": "string" }, - "fontColor": { - "description": "The font color to use for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n", + "includeTimeZoneInformation": { + "description": "When set to **true**, Connect will include the envelope time zone information.", "type": "string" }, - "fontColorMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `fontColor` property is editable." - }, - "fontMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `font` property is editable." - }, - "fontSize": { - "description": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72", + "name": { + "description": "The name of the Connect configuration. The name helps identify the configuration in the list.", "type": "string" }, - "fontSizeMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `fontSize` property is editable." - }, - "formOrder": { - "description": "An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block.", + "password": { + "description": "The user's encrypted password hash.", "type": "string" }, - "formOrderMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `formOrder` property is editable." + "recipientEvents": { + "description": "An array of recipient event statuses that will trigger Connect to send notifications to your webhook listener at the url endpoint specified in the `url` property. \n\nTo receive notifications, you must include either an `envelopeEvents` node or a `recipientEvents` node. You do not need to specify both.", + "type": "array", + "items": { + "type": "string" + } }, - "formPageLabel": { - "description": "A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience.", + "requireMutualTls": { + "description": "When set to **true**, [Mutual TLS](https://developers.docusign.com/esign-rest-api/guides/mutual-tls-intro) authentication is enabled.", "type": "string" }, - "formPageLabelMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `formPageLabel` property is editable." - }, - "formPageNumber": { - "description": "An integer specifying the order in which to present the guided form pages.", + "requiresAcknowledgement": { + "description": "When set to **true**, event delivery acknowledgements are enabled for your Connect configuration.\n\nDocuSign Connect awaits a valid 200 response from your application acknowledging that it received a message. If you do not acknowledge receiving an event notification message within 100 seconds, DocuSign treats the message as a failure and places it into a failure queue. It is imperative that you acknowledge successful receipt of Connect events as they occur by sending a 200 event back.\n\n#### When set to **true** and Send Individual Messages (SIM) mode is activated\n\nIf the HTTP status response to a notification message is not in the range of 200-299,\nthen the message delivery failed, and the configuration is marked as down.\n\nThe message will be queued and retried once per day.\nWhile a Connect configuration is marked down, subsequent notifications will not be tried. Instead they will be immediately queued with the reason `Pending`.\nWhen a message succeeds, all queued messages for the configuration will be tried immediately, in order.\n\nThere is a maximum of ten retries. Alternately, you can use **Republish Connect Information** to manually republish the notification.\n\n#### When set to **true** and SIM mode is not activated\n\nIf the HTTP Status response to a notification message is not in the range of 200-299, then the message delivery failed, and the message is queued.\n\nThe message will be retried after at least a day the next time a subsequent message is successfully sent to this configuration (subscription). Subsequent notifications will be tried when they occur.\nThere is a maximum of ten retries. Alternately, you can use **Republish Connect Information** to manually republish the notification.\n\n#### When set to **false**\n\nWhen `requiresAcknowledgement` is set to **false** and you do not acknowledge receiving an event notification message within 100 seconds, DocuSign treats the message as a failure and determines that the server is unavailable. It does not retry to send the notification message, and you must handle the failure manually.\n\n", "type": "string" }, - "formPageNumberMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `fromPageNumber` property is editable." + "salesforceApiVersion": { + "description": "The version of the Salesforce API that you are using.", + "type": "string" }, - "height": { - "description": "The height of the tab in pixels.", + "salesforceAuthcode": { + "description": "", + "type": "string" + }, + "salesforceCallBackUrl": { + "description": "", "type": "string" }, - "heightMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `height` property is editable." + "salesforceDocumentsAsContentFiles": { + "description": "When set to **true**, DocuSign can use documents in your Salesforce account for sending and signing.", + "type": "string" }, - "italic": { - "description": "When set to **true**, the information in the tab is italic.", + "senderOverride": { + "description": "", "type": "string" }, - "italicMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `italic` property is editable." + "senderSelectableItems": { + "description": "This property sets the items that are available for selection when adding or editing Connect objects. ", + "type": "array", + "items": { + "type": "string" + } }, - "localePolicy": { - "$ref": "#/definitions/localePolicyTab", - "description": "Reserved for DocuSign." + "sfObjects": { + "description": "An array of Salesforce objects.", + "type": "array", + "items": { + "$ref": "#/definitions/connectSalesforceObject" + } }, - "mergeField": { - "$ref": "#/definitions/mergeField", - "description": "Contains the information necessary to map the tab to a field in SalesForce." + "signMessageWithX509Certificate": { + "description": "When set to **true**, Mutual TLS will be enabled for notifications. Mutual TLS must be initiated by the listener (the customer's web server) during the TLS handshake protocol. ", + "type": "string" }, - "pageNumber": { - "description": "Specifies the page number on which the tab is located. For supplemental documents, this value must be `1`.\n", + "soapNamespace": { + "description": "The namespace of the SOAP interface.\n\n**Note**: If `useSoapInterface` is set to **true**, you must set this value.", "type": "string" }, - "pageNumberMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `pageNumber` property is editable." + "urlToPublishTo": { + "description": "This is the web address and name of your listener or Retrieving Service endpoint. You need to include HTTPS:// in the web address.", + "type": "string" }, - "recipientId": { - "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", + "userIds": { + "description": "A comma-separated list of userIds. This sets the users associated with the tracked envelope and recipient events. When a tracked event occurs for a set user, the a notification message is sent to your Connect listener.\n\n**Note**: If allUsers is set to `false` then you must provide a list of user ids.", + "type": "array", + "items": { + "type": "string" + } + }, + "userName": { + "description": "The name of the user.", "type": "string" }, - "recipientIdGuid": { - "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one.", + "useSoapInterface": { + "description": "When set to **true**, the notifications are sent to your endpoint as SOAP requests. ", + "type": "string" + } + }, + "x-ds-definition-name": "connectCustomConfiguration", + "description": "", + "x-ms-summary": "" + }, + "connectDebugLog": { + "type": "object", + "properties": { + "connectConfig": { + "description": "The name of the Connect configuration.", "type": "string" }, - "recipientIdGuidMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `recipientIdGuid` property is editable." + "errorDetails": { + "$ref": "#/definitions/errorDetails", + "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." }, - "recipientIdMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `recipientId` property is editable." + "eventDateTime": { + "description": "The UTC date and time of the event.", + "type": "string" }, - "status": { - "description": "The status of the tab. Possible values are:\n\n- `active`: The tab is active, but the recipient has not yet interacted with it.\n- `signed`: The recipient signed the tab.\n- `declined`: The recipient declined the envelope.\n- `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`).", + "eventDescription": { + "description": "A description of the event.", "type": "string" }, - "statusMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `status` property is editable." + "payload": { + "description": "Log output.", + "type": "string" + } + }, + "x-ds-definition-name": "connectDebugLog", + "description": "", + "x-ms-summary": "" + }, + "connectEventData": { + "type": "object", + "properties": { + "format": { + "description": "The format of the response. One of:\n\nIf the value of `version` is `restv2.1`, the value of this property is one of:\n\n- `json` (Default when `version` is `rest2.1`.\n- `xml`\n\nIf the value of `version` is `legacy` or empty, the only valid value is `xml`.\n\n\nFor more information about formats, see the *Data format* section in [Choose the architecture of your webhook](https://developers.docusign.com/platform/webhooks/connect/architecture/).\n\n", + "type": "string" }, - "tabGroupLabels": { - "description": "An array of tab group labels that uniquely identify tab groups. To assign a tab to a `tabGroup`, you assign the `TabGroupLabel` to the `Tab.TabGroupLabels` array.", + "includeData": { + "description": "A string array of the data to be included.\nThe default is the empty array `[]`.\n\n- `attachments`: Include attachments associated with the envelope.\n- `custom_fields`: Include the custom fields associated with the envelope.\n- `documents`: Include the documents associated with the envelope.\n- `extensions`: Include information about the email settings associated with the envelope.\n- `folders`: Include the folder where the envelope exists.\n- `payment_tabs`: Include the payment tabs associated with the envelope.\n- `powerform`: Include the PowerForms associated with the envelope.\n- `recipients`: Include the recipients associated with the envelope.\n- `tabs`: Include the tabs associated with the envelope.\n", "type": "array", "items": { "type": "string" } }, - "tabGroupLabelsMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `tabGroupLabels` property is editable." - }, - "tabId": { - "description": "The unique identifier for the tab.", + "version": { + "description": "Specifies how the connection data is returned.\n\n- `legacy`: (Default) The response follows the original Connect Message format.\n- `restv2.1`: The response follows the new Connect Message format.", "type": "string" + } + }, + "x-ds-definition-name": "connectEventData", + "description": "This object lets you choose the data format of your Connect response.\nFor more information about using this object, see [Connect webhooks with JSON notifications](https://www.docusign.com/blog/developers/connect-webhooks-json-notifications). ", + "x-ms-summary": "This object lets you choose the data format of your Connect response.\nFor more information about using this object, see [Connect webhooks with JSON notifications](https://www.docusign.com/blog/developers/connect-webhooks-json-notifications). " + }, + "connectFailureFilter": { + "type": "object", + "properties": { + "envelopeIds": { + "description": "An array of envelope GUIDs.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", + "type": "array", + "items": { + "type": "string" + } }, - "tabIdMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `tabId` property is editable." + "synchronous": { + "description": "Must be **false**. Setting this property to any other value will result in errors.", + "type": "string" + } + }, + "x-ds-definition-name": "connectFailureFilter", + "description": "A list of failed envelope IDs to retry.", + "x-ms-summary": "A list of failed envelope IDs to retry." + }, + "connectFailureResult": { + "type": "object", + "properties": { + "configId": { + "description": "Reserved for DocuSign.", + "type": "string" }, - "tabLabel": { - "description": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n", + "configUrl": { + "description": "Reserved for DocuSign.\n", "type": "string" }, - "tabLabelMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `tabLabel` property is editable." + "envelopeId": { + "description": "The envelope ID of the envelope status that failed to post.", + "type": "string" }, - "tabOrder": { - "description": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.", + "status": { + "description": "The connection status.", "type": "string" }, - "tabOrderMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `tabOrder` property is editable." + "statusMessage": { + "description": "A human-readable message describing the connection status.", + "type": "string" + } + }, + "x-ds-definition-name": "connectFailureResult", + "description": "This object contains details about a Connect failure result.", + "x-ms-summary": "This object contains details about a Connect failure result." + }, + "connectFailureResults": { + "type": "object", + "properties": { + "retryQueue": { + "description": "Details about a Connect failure result.", + "type": "array", + "items": { + "$ref": "#/definitions/connectFailureResult" + } + } + }, + "x-ds-definition-name": "connectFailureResults", + "description": "", + "x-ms-summary": "" + }, + "connectLog": { + "type": "object", + "properties": { + "accountId": { + "description": "The account ID associated with the envelope.", + "type": "string" }, - "tabType": { - "description": "Indicates the type of tab (for example, `signHere` or `initialHere`).", + "configUrl": { + "description": "The web address of the listener or retrieving service endpoint for Connect.", "type": "string" }, - "tabTypeMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `tabType` property is editable." + "connectDebugLog": { + "description": "A complex element containing information about the Connect configuration, error details, date/time, description and payload.\nThis information is included in the response only when the `additional_info` query is set to **true**.\nThis additional information is only available when retrieving general logs with [ConnectEvents:get](https://developers.docusign.com/docs/esign-rest-api/reference/Connect/ConnectEvents/get), but not when retrieving failure logs with [ConnectEvents:listFailures](https://developers.docusign.com/docs/esign-rest-api/reference/Connect/ConnectEvents/listFailures).", + "type": "array", + "items": { + "$ref": "#/definitions/connectDebugLog" + } }, - "templateLocked": { - "description": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ", + "connectId": { + "description": "The id of the Connect configuration that failed. If an account has multiple Connect configurations, this value is used to look up the Connect configuration for the failed post.", "type": "string" }, - "templateLockedMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `templateLocked` property is editable." + "created": { + "description": "The UTC DateTime when the Connect post was created.", + "type": "string" }, - "templateRequired": { - "description": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.", + "email": { + "description": "The email address of the envelope sender.", "type": "string" }, - "templateRequiredMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `templateRequired` property is editable." + "envelopeId": { + "description": "The id of the envelope that failed to post.", + "type": "string" }, - "tooltip": { - "description": "The text of a tooltip that appears when a user hovers over a form field or tab.", + "error": { + "description": "The error that caused the Connect post to fail.", "type": "string" }, - "toolTipMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `toolTip` property is editable." + "failureId": { + "description": "The failure log ID for the failure.", + "type": "string" }, - "underline": { - "description": "When set to **true**, the information in the tab is underlined.", + "failureUri": { + "description": "The URI for the Connect post failure.", "type": "string" }, - "underlineMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `underline` property is editable." + "lastTry": { + "description": "The UTC DateTime of the last attempt to post.", + "type": "string" }, - "width": { - "description": "The width of the tab in pixels.", + "logId": { + "description": "The Connect log ID for the entry.", "type": "string" }, - "widthMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `width` property is editable." + "logUri": { + "description": "The URI for the Connect log entry.", + "type": "string" }, - "xPosition": { - "description": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n", + "retryCount": { + "description": "The number of times the Connect post has been retried.", "type": "string" }, - "xPositionMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `xPosition` property is editable." + "retryUri": { + "description": "A URI that you can use to retry to publish the Connect post.", + "type": "string" }, - "yPosition": { - "description": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n", + "status": { + "description": "The envelope status for the Connect post. Possible values are:\n- `Any`\n- `Voided`\n- `Created`\n- `Deleted`\n- `Sent`\n- `Delivered`\n- `Signed`\n- `Completed`\n- `Declined`\n- `TimedOut`\n- `Template`\n- `Processing`\n\nFor details about these statuses, see [Envelope Status Code Descriptions](https://developers.docusign.com/esign-rest-api/guides/status-and-error-codes#envelope-status-code-descriptions).", "type": "string" }, - "yPositionMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `yPosition` property is editable." + "subject": { + "description": "The subject of the envelope.", + "type": "string" + }, + "userName": { + "description": "The name of the sender of the envelope.", + "type": "string" } }, - "x-ds-definition-name": "approve", - "description": "A tab that allows the recipient to approve documents\nwithout placing a signature or initials on the\ndocument.\n", - "x-ms-summary": "A tab that allows the recipient to approve documents\nwithout placing a signature or initials on the\ndocument.\n" + "x-ds-definition-name": "connectLog", + "description": "Contains information about a Connect log entry.", + "x-ms-summary": "Contains information about a Connect log entry." }, - "appStoreProduct": { - "description": "Contains information about an APP store product.", + "connectLogs": { "type": "object", "properties": { - "marketPlace": { - "description": "", + "failures": { + "description": "A list of Connect failure logs.", + "type": "array", + "items": { + "$ref": "#/definitions/connectLog" + } + }, + "logs": { + "description": "A list of Connect general logs.", + "type": "array", + "items": { + "$ref": "#/definitions/connectLog" + } + }, + "totalRecords": { + "description": "The count of records in the log list.", "type": "string" }, - "productId": { - "description": "The Product ID from the AppStore.", + "type": { + "description": "", "type": "string" } }, - "x-ds-definition-name": "appStoreProduct", - "x-ms-summary": "Contains information about an APP store product." + "x-ds-definition-name": "connectLogs", + "description": "", + "x-ms-summary": "" }, - "appStoreReceipt": { - "description": "Contains information about an APP store receipt.", + "connectSalesforceField": { "type": "object", "properties": { - "productId": { - "description": "The Product ID from the AppStore.", + "dsAttribute": { + "description": "", "type": "string" }, - "receiptData": { - "description": "Reserved: TBD", + "dsLink": { + "description": "A URL that links to the information in the DocuSign field.", + "type": "string" + }, + "dsNode": { + "description": "", + "type": "string" + }, + "id": { + "description": "A unique ID for the Salesforce object.", + "type": "string" + }, + "sfField": { + "description": "", + "type": "string" + }, + "sfFieldName": { + "description": "The name of the Salesforce field.", + "type": "string" + }, + "sfFolder": { + "description": "The name of the Salesforce folder.", + "type": "string" + }, + "sfLockedValue": { + "description": "", "type": "string" } }, - "x-ds-definition-name": "appStoreReceipt", - "x-ms-summary": "Contains information about an APP store receipt." + "x-ds-definition-name": "connectSalesforceField", + "description": "This object is used to match a DocuSign field to a Salesforce field so that Docusign can send information to your Salesforce account.", + "x-ms-summary": "This object is used to match a DocuSign field to a Salesforce field so that Docusign can send information to your Salesforce account." }, - "attachment": { - "description": "Contains information about an attachment.", + "connectSalesforceObject": { "type": "object", "properties": { - "accessControl": { - "description": "Valid values are `sender` and `senderAndAllRecipients`.", + "active": { + "description": "When set to **true**, the `connectSalesforceObject` is active.", "type": "string" }, - "attachmentId": { - "description": "The unique identifier for the attachment.", + "description": { + "description": "A description of the `connectSalesforceObject`.", "type": "string" }, - "attachmentType": { - "description": "Specifies the type of the attachment for the recipient. Possible values are:\n\n- `.htm`\n- `.xml`", + "id": { + "description": "The id of the `connectSalesforceObject`.", "type": "string" }, - "data": { - "description": "A Base64-encoded representation of the attachment that is used to upload and download the file. File attachments may be up to 50 MB in size.", + "insert": { + "description": "", "type": "string" }, - "label": { - "description": "A label for the attachment. Potential values include: \n\n- `guidedForm`: [Guided forms](https://www.docusign.com/products/guided-forms) provide a step-by-step, mobile-ready experience to help signers easily complete long or complex forms.\n- `eventNotifications`: A list of envelope-level event statuses that trigger Connect to send updates to the endpoint specified in the `url` property. \n", + "onCompleteOnly": { + "description": "When **true**, Salesforce is updated only when the envelope is complete.", "type": "string" }, - "name": { - "description": "The name of the attachment.", + "selectFields": { + "description": "The DocuSign and Salesforce fields that you want to use to match a Salesforce object with DocuSign information. This information tells Connect when to send updates to Salesforce.", + "type": "array", + "items": { + "$ref": "#/definitions/connectSalesforceField" + } + }, + "sfObject": { + "description": "The Salesforce.com object type, such as `case`, `contact`, or `opportunity`.", "type": "string" }, - "remoteUrl": { - "description": "The URL of a previously staged chunked upload. Using a chunked upload enables you to stage a large, chunkable temp file. You then use the `remoteUrl` property to reference the chunked upload as the content in attachment and document-related requests. The `remoteUrl` property cannot be used for downloads.", + "sfObjectName": { + "description": "A name for the Salesforce object.\n\n**Note**: You can enter any name for the object. It does not have to match the `sfObject` property.", "type": "string" + }, + "updateFields": { + "description": "The DocuSign and Salesforce fields that you want to update. \n\n**Note**: You can choose to update SalesForce (with information from DocuSign) only, update DocuSign only, or both.", + "type": "array", + "items": { + "$ref": "#/definitions/connectSalesforceField" + } } }, - "x-ds-definition-name": "attachment", - "x-ms-summary": "Contains information about an attachment." + "x-ds-definition-name": "connectSalesforceObject", + "description": "A `connectSalesforceObject` is an object that updates envelope and document status or recipient status in your Salesforce account.\n\nWhen you install DocuSign Connect for Salesforce, the service automatically sets up two Connect objects: one that updates envelope status and documents and one that updates recipient status. You can also customize DocuSign Connect for Salesforce by associating DocuSign objects with Salesforce objects so that DocuSign Connect for Salesforce updates or inserts the information into the Salesforce object. For more information, see \n[DocuSign for Salesforce - Adding Completed Documents to the Notes and Attachments](https://support.docusign.com/articles/DocuSign-for-Salesforce-Adding-Completed-Documents-to-the-Notes-and-Attachments-New).", + "x-ms-summary": "A `connectSalesforceObject` is an object that updates envelope and document status or recipient status in your Salesforce account.\n\nWhen you install DocuSign Connect for Salesforce, the service automatically sets up two Connect objects: one that updates envelope status and documents and one that updates recipient status. You can also customize DocuSign Connect for Salesforce by associating DocuSign objects with Salesforce objects so that DocuSign Connect for Salesforce updates or inserts the information into the Salesforce object. For more information, see \n[DocuSign for Salesforce - Adding Completed Documents to the Notes and Attachments](https://support.docusign.com/articles/DocuSign-for-Salesforce-Adding-Completed-Documents-to-the-Notes-and-Attachments-New)." }, - "authenticationMethod": { - "description": "Contains information about the method used for authentication.", + "connectUserObject": { "type": "object", "properties": { - "authenticationType": { - "description": "Indicates the type of authentication. Valid values are: \n\n- `PhoneAuth`\n- `STAN`\n- `ISCheck` \n- `OFAC`\n- `AccessCode`\n- `AgeVerify`\n- `SSOAuth`", + "configurationtype": { + "description": "The type of custom Connect configuration being accessed.", "type": "string" }, - "lastProvider": { - "description": "The last provider that authenticated the user. ", + "connectId": { + "description": "The ID of the custom Connect configuration being accessed.", "type": "string" }, - "lastTimestamp": { - "description": " The data and time the user last used the authentication method. ", + "enabled": { + "description": "Boolean value that indicates whether the custom Connect configuration is enabled or not.", "type": "string" }, - "totalCount": { - "description": "The number of times the authentication method was used. ", + "hasAccess": { + "description": "", "type": "string" + }, + "senderSearchableItems": { + "description": "", + "type": "array", + "items": { + "type": "string" + } } }, - "x-ds-definition-name": "authenticationMethod", - "x-ms-summary": "Contains information about the method used for authentication." + "x-ds-definition-name": "connectUserObject", + "description": "", + "x-ms-summary": "" }, - "authenticationStatus": { - "description": "A complex element that contains information about the authentication status.", + "consoleViewRequest": { "type": "object", "properties": { - "accessCodeResult": { - "$ref": "#/definitions/eventResult", - "description": "Success/failure result of authentication using an access code." - }, - "ageVerifyResult": { - "$ref": "#/definitions/eventResult", - "description": "Success/failure result of authentication using age verification." - }, - "anySocialIDResult": { - "$ref": "#/definitions/eventResult", - "description": "Success/failure result of authentication using sign-in with any social media account." + "envelopeId": { + "description": "The id of the envelope.", + "type": "string" }, - "facebookResult": { - "$ref": "#/definitions/eventResult", - "description": "Success/failure result of authentication using sign-in with a Facebook account." + "returnUrl": { + "description": "(Optional) The URL to which the user should be redirected after the console view session has ended.\n\nMaximum Length: 500 characters. If the `returnUrl` exceeds this limit, the user is redirected to a truncated URL.", + "type": "string" + } + }, + "x-ds-definition-name": "consoleViewRequest", + "description": "The request object for the EnvelopeViews::createConsole method.", + "x-ms-summary": "The request object for the EnvelopeViews::createConsole method." + }, + "consumerDisclosure": { + "type": "object", + "properties": { + "accountEsignId": { + "description": "The GUID of the account associated with the consumer disclosure.", + "type": "string" }, - "googleResult": { - "$ref": "#/definitions/eventResult", - "description": "Success/failure result of authentication using sign-in with a Google+ account." + "allowCDWithdraw": { + "description": "When set to **true**, indicates that the customer can withdraw their consent to the consumer disclosure when they decline to sign documents. If these recipients sign documents sent to them from your account in the future, they will be required to agree to the terms in the disclosure. The default value is **false**.\n**Note**: Only Admin users can change this setting.", + "type": "string" }, - "idLookupResult": { - "$ref": "#/definitions/eventResult", - "description": "Result of an ID lookup." + "allowCDWithdrawMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `allowCDWithdraw` property is editable.\n" }, - "idQuestionsResult": { - "$ref": "#/definitions/eventResult", - "description": "Result of the user answering ID challenge questions." + "changeEmail": { + "description": "If the customer needs to change their email address, this is the email address to which they should the change request.\n\nMaximum length: 100 characters.", + "type": "string" }, - "linkedinResult": { - "$ref": "#/definitions/eventResult", - "description": "Success/failure result of authentication using sign-in with a LinkedIn account." + "changeEmailOther": { + "description": "Other information about the requirements for the user to change their email address.\n\nMaximum length: 255 characters.\n\nExample: \n\n`We do not require any other information from you to change your email address.`", + "type": "string" }, - "liveIDResult": { - "$ref": "#/definitions/eventResult", - "description": "Success/failure result of authentication using sign-in with a Windows LiveID account." + "companyName": { + "description": "Specifies the company name used in the disclosure. The default value is the account name.\n\nHowever, if your account uses signing brands that specify a company name, you can substitute the brand's company name by setting the `useBrand` property to **true**. Whenever an envelope is sent from the account that uses a signing brand with a specified `companyName`, that value is used in email notifications and in the signing experience.\n\n**Note**: This substitution only works if you use the default legal disclosure or if you apply the `companyName` to the merge fields in a custom ERSD. You must also set the value of the `useBrand` property to **true**.", + "type": "string" }, - "ofacResult": { - "$ref": "#/definitions/eventResult", - "description": "" + "companyPhone": { + "description": "The phone number of the company associated with the consumer disclosure, as a free-formatted string.", + "type": "string" }, - "openIDResult": { - "$ref": "#/definitions/eventResult", - "description": "Success/failure result of authentication using sign-in with a Yahoo OpenID account." + "copyCostPerPage": { + "description": "The cost per page if the customer requests paper copies.\n\nExample: \n\n`0.0000`", + "type": "string" }, - "phoneAuthResult": { - "$ref": "#/definitions/eventResult", - "description": "Success/failure result of two-factor authentication (2FA) using phone messaging." + "copyFeeCollectionMethod": { + "description": "Specifies the fee collection method for cases in which the customer requires paper copies of the document.\n\nMaximum length: 255 characters.\n\nExample: \n\n`We will bill you for any fees at that time, if any.`", + "type": "string" }, - "salesforceResult": { - "$ref": "#/definitions/eventResult", - "description": "Success/failure result of authentication using sign-in with a Salesforce account." + "copyRequestEmail": { + "description": "The email address to which the customer should send a request for copies of a document.\n\nMaximum length: 100 characters.", + "type": "string" }, - "signatureProviderResult": { - "$ref": "#/definitions/eventResult", - "description": "Success/failure result of authentication using a signature provider." + "custom": { + "description": "When set to **true**, indicates that the consumer disclosure is a custom disclosure. The default is **false**.", + "type": "string" }, - "smsAuthResult": { - "$ref": "#/definitions/eventResult", - "description": "Success/failure result of two-factor authentication (2FA) using phone SMS." + "enableEsign": { + "description": "When set to **true** (default), indicates that eSign is enabled.", + "type": "string" }, - "sTANPinResult": { - "$ref": "#/definitions/eventResult", - "description": "" + "esignAgreement": { + "description": "The final, assembled text of the Electronic Record and Signature Disclosure that includes the appropriate `companyName` and other specifics. It also includes the HTML tags used for formatting.", + "type": "string" }, - "twitterResult": { - "$ref": "#/definitions/eventResult", - "description": "Success/failure result of authentication using sign-in with a Twitter account." + "esignText": { + "description": "The template for the Electronic Record and Signature Disclosure, which contains placeholders for information such as the `companyName`. It also includes the HTML tags used for formatting.\n\n**Note**: If you are switching to or updating a custom disclosure, you can edit both the text and the HTML formatting.", + "type": "string" }, - "yahooResult": { - "$ref": "#/definitions/eventResult", - "description": "Success/failure result of authentication using sign-in with a Yahoo account." - } - }, - "x-ds-definition-name": "authenticationStatus", - "x-ms-summary": "A complex element that contains information about the authentication status." - }, - "bccEmailAddress": { - "description": "Contains information about the BCC email address.", - "type": "object", - "properties": { - "bccEmailAddressId": { - "description": "Only users with canManageAccount setting can use this option. An array of up to 5 email addresses the envelope is sent to as a BCC email. \n \nExample: If your account has BCC for Email Archive set up for the email address 'archive@mycompany.com' and you send an envelope using the BCC Email Override to send a BCC email to 'salesarchive@mycompany.com', then a copy of the envelope is only sent to the 'salesarchive@mycompany.com' email address.", + "languageCode": { + "description": "The code for the language version of the disclosure. The following languages are supported:\n\n- Arabic (`ar`)\n- Bulgarian (`bg`)\n- Czech (`cs`)\n- Chinese Simplified (`zh_CN`)\n- Chinese Traditional (`zh_TW`)\n- Croatian (`hr`)\n- Danish (`da`)\n- Dutch (`nl`)\n- English US (`en`)\n- English UK (`en_GB`)\n- Estonian (`et`)\n- Farsi (`fa`)\n- Finnish (`fi`)\n- French (`fr`)\n- French Canadian (`fr_CA`)\n- German (`de`)\n- Greek (`el`)\n- Hebrew (`he`)\n- Hindi (`hi`)\n- Hungarian (`hu`)\n- Bahasa Indonesian (`id`)\n- Italian (`it`)\n- Japanese (`ja`)\n- Korean (`ko`)\n- Latvian (`lv`)\n- Lithuanian (`lt`)\n- Bahasa Melayu (`ms`)\n- Norwegian (`no`)\n- Polish (`pl`)\n- Portuguese (`pt`)\n- Portuguese Brazil (`pt_BR`)\n- Romanian (`ro`)\n- Russian (`ru`)\n- Serbian (`sr`)\n- Slovak (`sk`)\n- Slovenian (`sl`)\n- Spanish (`es`)\n- Spanish Latin America (`es_MX`)\n- Swedish (`sv`)\n- Thai (`th`)\n- Turkish (`tr`)\n- Ukrainian (`uk`) \n- Vietnamese (`vi`)\n\nAdditionally, you can automatically detect the browser language being used by the viewer and display the disclosure in that language by setting the value to `browser`.", "type": "string" }, - "email": { - "description": "Specifies the BCC email address. DocuSign verifies that the email format is correct, but does not verify that the email is active.Using this overrides the BCC for Email Archive information setting for this envelope.\n\nMaximum of length: 100 characters. ", + "mustAgreeToEsign": { + "description": "When set to **true**, the recipient must agree to the consumer disclosure. The value of this property is read only. It is calculated based on the account setting `consumerDisclosureFrequency` and the user's actions.", "type": "string" - } - }, - "x-ds-definition-name": "bccEmailAddress", - "x-ms-summary": "Contains information about the BCC email address." - }, - "billingCharge": { - "description": "Contains information about a billing charge.", - "type": "object", - "properties": { - "allowedQuantity": { - "description": "Reserved: TBD", + }, + "pdfId": { + "description": "**Deprecated**. \n\nThe `pdfId` property in the consumer_disclosure PUT request is deprecated. For security reasons going forward, any value provided in the request packet must be ignored. ", "type": "string" }, - "blocked": { - "description": "Reserved: TBD", + "useBrand": { + "description": "When set to **true**, specifies that the company name in the signing brand is used for the disclosure. Whenever an envelope is sent from the account that uses a signing brand with a specified company name, that value is used in email notifications and in the signing experience. \n\nWhen set to **false** (default), or if the signing brand does not specify a company name, the account name is used instead.\n\n**Note**: This substitution only works if you use the default legal disclosure or if you apply the `companyName` to the merge fields in a custom ERSD. ", "type": "string" }, - "chargeName": { - "description": "Provides information on what services the charge item is for.\n\nThe following table provides a description of the different chargeName values available at this time.\n\n| chargeName | Description |\n| --- | --- |\n| id_check | ID Check Charge |\n| in_person_signing | In Person Signing charge |\n| envelopes Included | Sent Envelopes for the account |\n| age_verify | Age verification check |\n| ofac | OFAC Check |\n| id_confirm | ID confirmation check |\n| student_authentication | STAN PIN authentication check |\n| wet_sign_fax | Pages for returning signed documents by fax |\n| attachment_fax | Pages for returning attachments by fax |\n| phone_authentication | Phone authentication charge |\n| powerforms | PowerForm envelopes sent |\n| signer_payments | Payment processing charge |\n| outbound_fax | Send by fax charge |\n| bulk_recipient_envelopes | Bulk Recipient Envelopes sent |\n| sms_authentications | SMS authentication charge |\n| saml_authentications | SAML authentication charge |\n| express_signer_certificate | DocuSign Express Certificate charge |\n| personal_signer_certificate | Personal Signer Certificate charge |\n| safe_certificate | SAFE BioPharma Signer Certificate charge |\n| seats | Included active seats charge |\n| open_trust_certificate | OpenTrust Signer Certificate charge |", + "useConsumerDisclosureWithinAccount": { + "description": "When set to **true**, specifies that recipients in the same account as the sender must agree to eSign an Electronic Record and Signature Disclosure Statement.", "type": "string" }, - "chargeType": { - "description": "Reserved: TBD", + "useConsumerDisclosureWithinAccountMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `useConsumerDisclosureWithinAccount` property is editable.\n" + }, + "withdrawAddressLine1": { + "description": "Contains the first address line of the postal address to which a customer can send a consent withdrawal notification.\n\nMaximum length: 100 characters. ", "type": "string" }, - "chargeUnitOfMeasure": { - "description": "Reserved: TBD", + "withdrawAddressLine2": { + "description": "Contains the second address line of the postal address to which a customer can send a consent withdrawal notification.\n\nMaximum length: 100 characters. ", "type": "string" }, - "discounts": { - "description": "", - "type": "array", - "items": { - "$ref": "#/definitions/billingDiscount" - } - }, - "firstEffectiveDate": { - "description": "", + "withdrawByEmail": { + "description": "When set to **true** (default), indicates that the customer can withdraw consent by email.", "type": "string" }, - "includedQuantity": { - "description": "", + "withdrawByMail": { + "description": "When set to **true**, indicates that the customer can withdraw consent by postal mail. The default is **false**.", "type": "string" }, - "incrementalQuantity": { - "description": "Reserved: TBD", + "withdrawByPhone": { + "description": "When set to **true**, indicates that the customer can withdraw consent by phone. The default is **false**.", "type": "string" }, - "lastEffectiveDate": { - "description": "", + "withdrawCity": { + "description": "Contains the city of the postal address to which a customer can send a consent withdrawal notification.\n\nMaximum length: 50 characters. ", "type": "string" }, - "prices": { - "description": "", - "type": "array", - "items": { - "$ref": "#/definitions/billingPrice" - } + "withdrawConsequences": { + "description": "Text indicating the consequences of withdrawing consent.\n\nMaximum length: 255 characters.", + "type": "string" }, - "unitPrice": { - "description": "Reserved: TBD", + "withdrawEmail": { + "description": "Contains the email address to which a customer can send a consent withdrawal notification.\n\nMaximum length: 100 characters. ", "type": "string" }, - "usedQuantity": { - "description": "", + "withdrawOther": { + "description": "Contains any other information needed to withdraw consent.\n\nMaximum length: 255 characters.\n\nExample:\n\n`We do not need any other information from you to withdraw consent.`", "type": "string" - } - }, - "x-ds-definition-name": "billingCharge", - "x-ms-summary": "Contains information about a billing charge." - }, - "billingChargeResponse": { - "description": "Defines a billing charge response object.", - "type": "object", - "properties": { - "billingChargeItems": { - "description": "Reserved: TBD", - "type": "array", - "items": { - "$ref": "#/definitions/billingCharge" - } - } - }, - "x-ds-definition-name": "billingChargeResponse", - "x-ms-summary": "Defines a billing charge response object." - }, - "billingDiscount": { - "type": "object", - "properties": { - "beginQuantity": { - "description": "Reserved: TBD", + }, + "withdrawPhone": { + "description": "Contains the phone number that a customer can call to register consent withdrawal notification as a free-formatted string.\n\nMaximum length: 20 characters. ", "type": "string" }, - "discount": { - "description": "", + "withdrawPostalCode": { + "description": "Contains the postal code of the postal address to which a customer can send a consent withdrawal notification.\n\nMaximum length: 20 characters. ", "type": "string" }, - "endQuantity": { - "description": "", + "withdrawState": { + "description": "Contains the state of the postal address to which a customer can send a consent withdrawal notification.\n\nExample: `PA`", "type": "string" } }, - "x-ds-definition-name": "billingDiscount", - "description": "", - "x-ms-summary": "" + "x-ds-definition-name": "consumerDisclosure", + "description": "Details about consumer disclosures.", + "x-ms-summary": "Details about consumer disclosures." }, - "billingInvoice": { - "description": "", + "contact": { "type": "object", "properties": { - "amount": { - "description": "The total amount of the purchase.", - "type": "string" - }, - "balance": { - "description": "Reserved: TBD", + "cloudProvider": { + "description": "The cloud service that provided the contact. Valid values are:\n\n- `rooms`\n- `docusignCore` (default)\n\n", "type": "string" }, - "dueDate": { - "description": "Reserved: TBD", + "cloudProviderContainerId": { + "description": "The id of the container at the cloud provider. For example, this might be the room id for a DocuSign Transaction Room.", "type": "string" }, - "invoiceId": { - "description": "", + "contactId": { + "description": "The id of a contact person in the account's address book.", "type": "string" }, - "invoiceItems": { - "description": "Reserved: TBD", + "contactPhoneNumbers": { + "description": "A list of the contact's phone numbers.\n\n**Note**: The phone numbers associated with shared contacts do not display to users other than the user who added the contact. Additionally, in the following scenarios, the phone number of a shared contact does not populate automatically for anyone other than the user who added the contact:\n\n- Sending an envelope by using SMS\n- Using phone authentication\n\nYou must ask the user who added the contact for the phone number and then manually enter it into the authentication box.", "type": "array", "items": { - "$ref": "#/definitions/billingInvoiceItem" + "$ref": "#/definitions/contactPhoneNumber" } }, - "invoiceNumber": { - "description": "Reserved: TBD", - "type": "string" - }, - "invoiceUri": { - "description": "Contains a URI for an endpoint that you can use to retrieve invoice information.", + "contactUri": { + "description": "The URI for retrieving information about the contact.", "type": "string" }, - "nonTaxableAmount": { + "emails": { "description": "", - "type": "string" + "type": "array", + "items": { + "type": "string" + } }, - "pdfAvailable": { + "errorDetails": { + "$ref": "#/definitions/errorDetails", + "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." + }, + "isOwner": { "description": "", - "type": "string" + "type": "boolean" }, - "taxableAmount": { + "name": { "description": "", "type": "string" - } - }, - "x-ds-definition-name": "billingInvoice", - "x-ms-summary": "" - }, - "billingInvoiceItem": { - "description": "Contains information about an item on a billing invoice.", - "type": "object", - "properties": { - "chargeAmount": { - "description": "Reserved: TBD", - "type": "string" }, - "chargeName": { - "description": "Reserved: TBD", + "organization": { + "description": "", "type": "string" }, - "invoiceItemId": { - "description": "Reserved: TBD", + "shared": { + "description": "When set to **true**, this custom tab is shared.", "type": "string" }, - "quantity": { - "description": "The quantity of envelopes to add to the account.", + "signingGroup": { + "description": "", "type": "string" }, - "unitPrice": { - "description": "Reserved: TBD", + "signingGroupName": { + "description": "Optional. The name of the signing group. \n\nMaximum Length: 100 characters. ", "type": "string" } }, - "x-ds-definition-name": "billingInvoiceItem", - "x-ms-summary": "Contains information about an item on a billing invoice." + "x-ds-definition-name": "contact", + "description": "", + "x-ms-summary": "" }, - "billingInvoicesResponse": { - "description": "Defines a billing invoice response object.", + "contactGetResponse": { "type": "object", "properties": { - "billingInvoices": { - "description": "Reserved: TBD", + "contacts": { + "description": "A list of contacts.", "type": "array", "items": { - "$ref": "#/definitions/Invoices" + "$ref": "#/definitions/contact" } }, + "endPosition": { + "description": "The last index position in the result set. ", + "type": "string" + }, "nextUri": { "description": "The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. ", "type": "string" @@ -23487,1678 +34295,1637 @@ "previousUri": { "description": "The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. ", "type": "string" - } - }, - "x-ds-definition-name": "billingInvoicesResponse", - "x-ms-summary": "Defines a billing invoice response object." - }, - "billingInvoicesSummary": { - "type": "object", - "properties": { - "billingInvoices": { - "description": "Reserved: TBD", - "type": "array", - "items": { - "$ref": "#/definitions/Invoices" - } - }, - "pastDueBalance": { - "description": "", - "type": "string" }, - "paymentAllowed": { - "description": "", - "type": "string" - } - }, - "x-ds-definition-name": "billingInvoicesSummary", - "description": "", - "x-ms-summary": "" - }, - "billingPayment": { - "description": "Contains information on a billing plan.", - "type": "object", - "properties": { - "amount": { - "description": "Reserved: TBD", + "resultSetSize": { + "description": "The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`.", "type": "string" }, - "invoiceId": { - "description": "Reserved: TBD", + "startPosition": { + "description": "The starting index position of the current result set.", "type": "string" }, - "paymentId": { - "description": "", + "totalSetSize": { + "description": "The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`.", "type": "string" } }, - "x-ds-definition-name": "billingPayment", - "x-ms-summary": "Contains information on a billing plan." + "x-ds-definition-name": "contactGetResponse", + "description": "This response object contains information about the contacts associated with an account.", + "x-ms-summary": "This response object contains information about the contacts associated with an account." }, - "billingPaymentItem": { - "description": "", + "contactModRequest": { "type": "object", "properties": { - "amount": { - "description": "The total amount of the purchase.", - "type": "string" - }, - "description": { - "description": "A sender-defined description of the line item.\n", - "type": "string" - }, - "paymentDate": { - "description": "", - "type": "string" - }, - "paymentId": { - "description": "", - "type": "string" - }, - "paymentNumber": { - "description": "When set to **true**, a PDF version of the invoice is available. \n\nTo get the PDF, make the call again and change \"Accept:\" in the header to \"Accept: application/pdf\".", - "type": "string" + "contactList": { + "description": "A list of contacts.", + "type": "array", + "items": { + "$ref": "#/definitions/contact" + } } }, - "x-ds-definition-name": "billingPaymentItem", - "x-ms-summary": "" + "x-ds-definition-name": "contactModRequest", + "description": "The request object containing the new information for the contacts.", + "x-ms-summary": "The request object containing the new information for the contacts." }, - "billingPaymentRequest": { + "contactPhoneNumber": { "type": "object", "properties": { - "paymentAmount": { - "description": "The payment amount for the past due invoices. This value must match the pastDueBalance value retrieved using Get Past Due Invoices.", + "phoneNumber": { + "description": "The contact's phone number.\n\nExample: `+12223334444`", + "type": "string" + }, + "phoneType": { + "description": "The type of phone number. Valid values are:\n\n- `home`\n- `mobile`\n- `work`\n- `other`\n- `fax`", "type": "string" } }, - "x-ds-definition-name": "billingPaymentRequest", - "description": "", - "x-ms-summary": "" + "x-ds-definition-name": "contactPhoneNumber", + "description": "Details about the phone numbers associated with a specific contact.", + "x-ms-summary": "Details about the phone numbers associated with a specific contact." }, - "billingPaymentResponse": { - "description": "Defines an billing payment response object.", + "contactUpdateResponse": { "type": "object", "properties": { - "billingPayments": { - "description": "Reserved: TBD", + "contacts": { + "description": "A list of contacts.", "type": "array", "items": { - "$ref": "#/definitions/billingPayment" + "$ref": "#/definitions/contact" } } }, - "x-ds-definition-name": "billingPaymentResponse", - "x-ms-summary": "Defines an billing payment response object." + "x-ds-definition-name": "contactUpdateResponse", + "description": "This response objects shows the updated details for the contacts.", + "x-ms-summary": "This response objects shows the updated details for the contacts." }, - "billingPaymentsResponse": { - "description": "Defines a billing payments response object.", + "correctViewRequest": { "type": "object", "properties": { - "billingPayments": { - "description": "Reserved: TBD", - "type": "array", - "items": { - "$ref": "#/definitions/Payments" - } + "returnUrl": { + "description": "(Optional) The URL to which the user should be redirected after the correct/send view session has ended. DocuSign redirects to this URL and includes an event parameter that your app can use.\n\nMaximum Length: 500 characters. If the `returnUrl` exceeds this limit, the user is redirected to a truncated URL.\n\nThe event parameters returned are:\n\n* `send` (user corrected and sent the envelope)\n* `save` (user saved the envelope)\n* `cancel` (user canceled the transaction.)\n* `error` (there was an error when performing the correct or send)\n* `sessionEnd` (the session ended before the user completed a different action)\n\n**Note**: Include `https://` in the URL or the redirect might not succeed on some browsers.", + "type": "string" }, - "nextUri": { - "description": "The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. ", + "suppressNavigation": { + "description": "Specifies whether the window is displayed with or without dressing.", "type": "string" }, - "previousUri": { - "description": "The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. ", + "viewUrl": { + "description": "", "type": "string" } }, - "x-ds-definition-name": "billingPaymentsResponse", - "x-ms-summary": "Defines a billing payments response object." + "x-ds-definition-name": "correctViewRequest", + "description": "The request body for the EnvelopeViews::createCorrect method.", + "x-ms-summary": "The request body for the EnvelopeViews::createCorrect method." }, - "billingPlan": { - "description": "Contains information about a billing plan.", + "country": { "type": "object", "properties": { - "appStoreProducts": { - "description": "Reserved for DocuSign.", - "type": "array", - "items": { - "$ref": "#/definitions/appStoreProduct" - } + "isoCode": { + "description": "", + "type": "string" }, - "currencyPlanPrices": { - "description": "Contains the currencyCode and currencySymbol for the alternate currency values for envelopeFee, fixedFee, and seatFee that are configured for this plan feature set.", + "name": { + "description": "", + "type": "string" + }, + "provinces": { + "description": "", "type": "array", "items": { - "$ref": "#/definitions/currencyPlanPrice" + "$ref": "#/definitions/province" } }, - "enableSupport": { - "description": "When set to **true**, then customer support is provided as part of the account plan.", - "type": "string" - }, - "includedSeats": { - "description": "The number of seats (users) included.", - "type": "string" - }, - "otherDiscountPercent": { + "provinceValidated": { "description": "", "type": "string" + } + }, + "x-ds-definition-name": "country", + "description": "", + "x-ms-summary": "" + }, + "creditCardInformation": { + "type": "object", + "properties": { + "address": { + "$ref": "#/definitions/addressInformation", + "description": "A complex element containing the credit card billing address information." }, - "paymentCycle": { - "description": " The payment cycle associated with the plan. The possible values are: Monthly or Annually. ", + "cardNumber": { + "description": "The credit card number.", "type": "string" }, - "paymentMethod": { - "description": "The payment method used for the billing plan. Valid values are:\n\n- `NotSupported`\n- `CreditCard`\n- `PurchaseOrder`\n- `Premium`\n- `Freemium`\n- `FreeTrial`\n- `AppStore`\n- `DigitalExternal`\n- `DirectDebit`", + "cardType": { + "description": "The type of credit card. Valid values are: \n\n- `visa` \n- `mastercard` \n- `amex`", "type": "string" }, - "perSeatPrice": { - "description": "The per-seat price for the plan.", + "cvNumber": { + "description": "The 3 or 4-digit card verification value (CVV) number associated with the credit card. CVV numbers are also referred to as card security codes (CSCs).", "type": "string" }, - "planClassification": { - "description": "Identifies the type of plan. Examples include:\n\n- `business`\n- `corporate`\n- `enterprise` \n- `free`", + "expirationMonth": { + "description": "The month that the credit card expires, expressed as a number from 1 to 12.", "type": "string" }, - "planFeatureSets": { - "description": "Reserved for DocuSign.", - "type": "array", - "items": { - "$ref": "#/definitions/featureSet" - } - }, - "planId": { - "description": "The DocuSign plan id for the account.", + "expirationYear": { + "description": "The year in which the credit card expires, in 4-digit format.", "type": "string" }, - "planName": { - "description": "The name of the billing plan.", + "nameOnCard": { + "description": "The exact name as it appears on the credit card.", "type": "string" - }, - "seatDiscounts": { - "description": "", + } + }, + "x-ds-definition-name": "creditCardInformation", + "description": "This object contains information about a credit card that is associated with an account.", + "x-ms-summary": "This object contains information about a credit card that is associated with an account." + }, + "creditCardTypes": { + "type": "object", + "properties": { + "cardTypes": { + "description": "An array containing supported credit card types.", "type": "array", "items": { - "$ref": "#/definitions/seatDiscount" + "type": "string" } - }, - "supportIncidentFee": { - "description": "The support incident fee charged for each support incident.", - "type": "string" - }, - "supportPlanFee": { - "description": "The support plan fee charged for this plan.", - "type": "string" } }, - "x-ds-definition-name": "billingPlan", - "x-ms-summary": "Contains information about a billing plan." + "x-ds-definition-name": "creditCardTypes", + "description": "", + "x-ms-summary": "" }, - "billingPlanInformation": { + "currency": { "type": "object", "properties": { - "appStoreReceipt": { - "$ref": "#/definitions/appStoreReceipt", - "description": "" - }, - "billingAddress": { - "$ref": "#/definitions/accountAddress", - "description": "The billing address for the account." - }, - "creditCardInformation": { - "$ref": "#/definitions/creditCardInformation", - "description": "A complex type that has information about the credit card used to pay for this account." - }, - "directDebitProcessorInformation": { - "$ref": "#/definitions/directDebitProcessorInformation", - "description": "Information about the bank that processes direct debits for the payment plan." - }, - "downgradeReason": { + "anchorAllowWhiteSpaceInCharacters": { "description": "", "type": "string" }, - "enableSupport": { - "description": "When set to **true**, then customer support is provided as part of the account plan.", - "type": "string" - }, - "includedSeats": { - "description": "The number of seats (users) included.", - "type": "string" - }, - "incrementalSeats": { - "description": "Reserved for DocuSign.", - "type": "string" + "anchorAllowWhiteSpaceInCharactersMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "" }, - "paymentMethod": { - "description": "The payment method used for the billing plan. Valid values are:\n\n- `NotSupported`\n- `CreditCard`\n- `PurchaseOrder`\n- `Premium`\n- `Freemium`\n- `FreeTrial`\n- `AppStore`\n- `DigitalExternal`\n- `DirectDebit`", + "anchorCaseSensitive": { + "description": "This property controls how [anchor tabs][AnchorTabs] are placed. When **true**, the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false**.\n\nFor example, when set to **true**, if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When set to **false**, `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**.\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place", "type": "string" }, - "paymentProcessorInformation": { - "$ref": "#/definitions/paymentProcessorInformation", - "description": "Information about the entity that processes payments for the billing plan." - }, - "planInformation": { - "$ref": "#/definitions/planInformation", - "description": "An object used to identify the features and attributes of the account being created." - }, - "referralInformation": { - "$ref": "#/definitions/referralInformation", - "description": "A complex type that contains the following information for entering referral and discount information. The following items are included in the referral information (all string content): enableSupport, includedSeats, saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, saleDiscountSeatPriceOverride, planStartMonth, referralCode, referrerName, advertisementId, publisherId, shopperId, promoCode, groupMemberId, idType, and industry \n\n###### Note: saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, and saleDiscountSeatPriceOverride are reserved for DoucSign use only. \n" - }, - "renewalStatus": { - "description": "", - "type": "string" + "anchorCaseSensitiveMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorCaseSensitive` property is editable." }, - "saleDiscountAmount": { - "description": "Reserved for DocuSign use only.", + "anchorHorizontalAlignment": { + "description": "This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are :\n\n- `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value.\n- `right`: Aligns the tab’s left side with the last character of the matching anchor word.\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place\n", "type": "string" }, - "saleDiscountFixedAmount": { - "description": "Reserved for DocuSign use only.", - "type": "string" + "anchorHorizontalAlignmentMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorHorizontalAlignment` property is editable." }, - "saleDiscountPercent": { - "description": "Reserved for DocuSign use only.", + "anchorIgnoreIfNotPresent": { + "description": "When set to **true**, this tab is ignored if the `anchorString` is not found in the document.", "type": "string" }, - "saleDiscountPeriods": { - "description": "Reserved for DocuSign use only.", - "type": "string" + "anchorIgnoreIfNotPresentMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable." }, - "saleDiscountSeatPriceOverride": { - "description": "Reserved for DocuSign use only.", - "type": "string" - } - }, - "x-ds-definition-name": "billingPlanInformation", - "description": "", - "x-ms-summary": "" - }, - "billingPlanPreview": { - "description": "Contains information about a preview billing plan.", - "type": "object", - "properties": { - "currencyCode": { - "description": "Specifies the ISO currency code for the account.", + "anchorMatchWholeWord": { + "description": "When set to **true**, the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false**.\n\nFor example, when set to **true**, if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When set to **false**, if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**.\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTab]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place\n", "type": "string" }, - "invoice": { - "$ref": "#/definitions/Invoices", - "description": "" + "anchorMatchWholeWordMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorMatchWholeWord` property is editable." }, - "isProrated": { - "description": "", + "anchorString": { + "description": "Specifies the string to find in the document and use as the basis for tab placement.", "type": "string" }, - "subtotalAmount": { - "description": "", - "type": "string" + "anchorStringMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorString` property is editable." }, - "taxAmount": { - "description": "", + "anchorTabProcessorVersion": { + "description": "Reserved for DocuSign.", "type": "string" }, - "totalAmount": { - "description": "", - "type": "string" - } - }, - "x-ds-definition-name": "billingPlanPreview", - "x-ms-summary": "Contains information about a preview billing plan." - }, - "billingPlanResponse": { - "description": "Defines a billing plan response object.", - "type": "object", - "properties": { - "billingPlan": { - "$ref": "#/definitions/billingPlan", - "description": "An object that contains details about the billing plan." + "anchorTabProcessorVersionMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Reserved for DocuSign." }, - "successorPlans": { - "description": "", - "type": "array", - "items": { - "$ref": "#/definitions/billingPlan" - } - } - }, - "x-ds-definition-name": "billingPlanResponse", - "x-ms-summary": "Defines a billing plan response object." - }, - "billingPlansResponse": { - "description": "Defines a billing plans response object.", - "type": "object", - "properties": { - "billingPlans": { - "description": "Reserved: TBD", - "type": "array", - "items": { - "$ref": "#/definitions/billingPlan" - } - } - }, - "x-ds-definition-name": "billingPlansResponse", - "x-ms-summary": "Defines a billing plans response object." - }, - "billingPlanUpdateResponse": { - "description": "Defines a billing plan update response object.", - "type": "object", - "properties": { - "accountPaymentMethod": { - "description": "", + "anchorUnits": { + "description": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n", "type": "string" }, - "billingPlanPreview": { - "$ref": "#/definitions/billingPlanPreview", - "description": "" + "anchorUnitsMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorUnits` property is editable." }, - "currencyCode": { - "description": "Specifies the ISO currency code for the account.", + "anchorXOffset": { + "description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n", "type": "string" }, - "includedSeats": { - "description": "The number of seats (users) included.", - "type": "string" + "anchorXOffsetMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorXOffset` property is editable." }, - "paymentCycle": { - "description": "", + "anchorYOffset": { + "description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n", "type": "string" }, - "paymentMethod": { - "description": "The payment method used for the billing plan. Valid values are:\n\n- `NotSupported`\n- `CreditCard`\n- `PurchaseOrder`\n- `Premium`\n- `Freemium`\n- `FreeTrial`\n- `AppStore`\n- `DigitalExternal`\n- `DirectDebit`", - "type": "string" + "anchorYOffsetMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorYOffset` property is editable." }, - "planId": { - "description": "The DocuSign plan id for the account.", + "bold": { + "description": "When set to **true**, the information in the tab is bold.", "type": "string" }, - "planName": { - "description": "The name of the billing plan used for the account.", - "type": "string" - } - }, - "x-ds-definition-name": "billingPlanUpdateResponse", - "x-ms-summary": "Defines a billing plan update response object." - }, - "billingPrice": { - "type": "object", - "properties": { - "beginQuantity": { - "description": "Reserved: TBD", - "type": "string" + "boldMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `bold` property is editable." }, - "endQuantity": { - "description": "", + "concealValueOnDocument": { + "description": "When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender.\n\nWhen an envelope is completed the information is only available to the sender through the Form Data link in the DocuSign Console. The information on the downloaded document remains masked by asterisks.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.", "type": "string" }, - "unitPrice": { - "description": "Reserved: TBD", + "concealValueOnDocumentMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `concealValueOnDocument` property is editable." + }, + "conditionalParentLabel": { + "description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility.", "type": "string" - } - }, - "x-ds-definition-name": "billingPrice", - "description": "", - "x-ms-summary": "" - }, - "brand": { - "type": "object", - "properties": { - "brandCompany": { - "description": "The name of the company associated with the brand.", + }, + "conditionalParentLabelMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `conditionalParentLabel` property is editable." + }, + "conditionalParentValue": { + "description": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use \"on\" as the value to show that the parent tab is active.\n", "type": "string" }, - "brandId": { - "description": "The id of the brand.", + "conditionalParentValueMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `conditionalParentValue` property is editable." + }, + "customTabId": { + "description": "The DocuSign-generated custom tab id for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.", "type": "string" }, - "brandLanguages": { - "description": "An array of [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes that specifies the languages that the brand supports.", - "type": "array", - "items": { - "type": "string" - } + "customTabIdMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `customTabId` property is editable." }, - "brandName": { - "description": "The name of the brand.", + "disableAutoSize": { + "description": "When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes.", "type": "string" }, - "colors": { - "description": "An array of name-value pairs specifying the colors that the brand uses for the following elements:\n\n- Button background\n- Button text\n- Header background\n- Header text", - "type": "array", - "items": { - "$ref": "#/definitions/nameValue" - } + "disableAutoSizeMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `disableAutoSize` property is editable." }, - "defaultBrandLanguage": { - "description": "The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of this brand's default language.", + "documentId": { + "description": "The `documentId` is set by the API client. It is an integer that falls between `1` and 2,147,483,647. The value is encoded as a string without commas. The values `1`, `2`, `3`, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a `documentId` property that specifies the document on which to place the tab.", "type": "string" }, - "emailContent": { - "description": "Deprecated.", - "type": "array", - "items": { - "$ref": "#/definitions/brandEmailContent" - } + "documentIdMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `documentId` property is editable." }, "errorDetails": { "$ref": "#/definitions/errorDetails", "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." }, - "isOverridingCompanyName": { - "description": "When **true**, the `brandCompany` property is overriding the name of the company in the account settings.", - "type": "boolean" + "font": { + "description": "The font to be used for the tab value. Supported fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n", + "type": "string" }, - "isSendingDefault": { - "description": "When **true**, the sending brand is the default brand for sending new envelopes.", - "type": "boolean" + "fontColor": { + "description": "The font color to use for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n", + "type": "string" }, - "isSigningDefault": { - "description": "When **true**, the siging brand is the default brand for the signing experience.", - "type": "boolean" + "fontColorMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `fontColor` property is editable." }, - "landingPages": { - "description": "An array of name/value pairs specifying the pages to which the user is redirected after the following events occur:\n\n- Signing Completed\n- Viewed Exit\n- Finish Later\n- Decline\n- Session Timeout\n- Authentication Failure\n\nIf you do not specify landing pages, the DocuSign default pages are used.", - "type": "array", - "items": { - "$ref": "#/definitions/nameValue" - } + "fontMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `font` property is editable." }, - "links": { - "description": "An array of `brandLink` objects that contain information about the links that the brand uses.", - "type": "array", - "items": { - "$ref": "#/definitions/brandLink" - } + "fontSize": { + "description": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72", + "type": "string" }, - "logos": { - "$ref": "#/definitions/brandLogos", - "description": "The URIs for retrieving the logos that are associated with the brand." + "fontSizeMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `fontSize` property is editable." }, - "resources": { - "$ref": "#/definitions/brandResourceUrls", - "description": "An object containing the URLs for the four DocuSign master resource files that the brand uses for sending, signing, email messages, and captive (embedded) signing. You can modify the default email messages and formats in these file to customize the user experience.\n\n**Note**: This object is returned only when the `resourceContentType` is `sending`, `signing`, `email`, or `signing_captive`." - } - }, - "x-ds-definition-name": "brand", - "description": "Information about a brand that is associated with an account. A brand applies custom styles and text to an envelope.", - "x-ms-summary": "Information about a brand that is associated with an account. A brand applies custom styles and text to an envelope." - }, - "brandEmailContent": { - "type": "object", - "properties": { - "content": { - "description": "Deprecated.", + "formOrder": { + "description": "An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block.", "type": "string" }, - "emailContentType": { - "description": "Deprecated.", - "type": "string" + "formOrderMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `formOrder` property is editable." }, - "emailToLink": { - "description": "Deprecated.", + "formPageLabel": { + "description": "A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience.", "type": "string" }, - "linkText": { - "description": "Deprecated.", + "formPageLabelMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `formPageLabel` property is editable." + }, + "formPageNumber": { + "description": "An integer specifying the order in which to present the guided form pages.", "type": "string" - } - }, - "x-ds-definition-name": "brandEmailContent", - "description": "Deprecated.", - "x-ms-summary": "Deprecated." - }, - "brandLink": { - "type": "object", - "properties": { - "linkText": { - "description": "The text used for the link.", + }, + "formPageNumberMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `fromPageNumber` property is editable." + }, + "height": { + "description": "The height of the tab in pixels.", "type": "string" }, - "linkType": { - "description": "The type of link. Valid values include:\n\n- `aboutDocusign`\n- `closeButton`", + "heightMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `height` property is editable." + }, + "italic": { + "description": "When set to **true**, the information in the tab is italic.", "type": "string" }, - "showLink": { - "description": "When **true**, the link displays to the recipient.", + "italicMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `italic` property is editable." + }, + "localePolicy": { + "$ref": "#/definitions/localePolicyTab", + "description": "Reserved for DocuSign." + }, + "locked": { + "description": "When set to **true**, the signer cannot change the data of the custom tab.", "type": "string" }, - "urlOrMailTo": { - "description": "The URL or mailto address of the link.", + "lockedMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `locked` property is editable." + }, + "maxLength": { + "description": "An optional value that describes the maximum length of the property when the property is a string.", "type": "string" - } - }, - "x-ds-definition-name": "brandLink", - "description": "Information about a link that a brand uses.", - "x-ms-summary": "Information about a link that a brand uses." - }, - "brandLogos": { - "type": "object", - "properties": { - "email": { - "description": "The URI for the logo that the brand uses in the header of email messages.", + }, + "maxLengthMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `maxLength` property is editable." + }, + "mergeField": { + "$ref": "#/definitions/mergeField", + "description": "Contains the information necessary to map the tab to a field in SalesForce." + }, + "mergeFieldXml": { + "description": "", "type": "string" }, - "primary": { - "description": "The URI for the brand's primary logo.", + "name": { + "description": "", "type": "string" }, - "secondary": { - "description": "The URI for the brand's secondary logo.", + "nameMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `name` property is editable. Read only." + }, + "numericalValue": { + "description": "", "type": "string" - } - }, - "x-ds-definition-name": "brandLogos", - "description": "Information about the logos associated with the brand.", - "x-ms-summary": "Information about the logos associated with the brand." - }, - "brandRequest": { - "type": "object", - "properties": { - "brandId": { - "description": "The ID of the brand.", + }, + "originalValue": { + "description": "The initial value of the tab when it was sent to the recipient. ", "type": "string" - } - }, - "x-ds-definition-name": "brandRequest", - "description": "", - "x-ms-summary": "" - }, - "brandResources": { - "type": "object", - "properties": { - "createdByUserInfo": { - "$ref": "#/definitions/userInfo", - "description": "The user id of the user who created the brand resource." }, - "createdDate": { - "description": "The date and time that the brand resource was created.", + "originalValueMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `originalValue` property is editable." + }, + "pageNumber": { + "description": "The page number being accessed.", "type": "string" }, - "dataNotSavedNotInMaster": { - "description": "Deprecated.", - "type": "array", - "items": { - "type": "string" - } + "pageNumberMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `pageNumber` property is editable." }, - "modifiedByUserInfo": { - "$ref": "#/definitions/userInfo", - "description": "Information about the user who last modified the brand resource." + "recipientId": { + "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", + "type": "string" }, - "modifiedDate": { - "description": "Most recent date on which this user record was modified.", + "recipientIdGuid": { + "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only.", "type": "string" }, - "modifiedTemplates": { - "description": "This property is returned in the response to the [AccountBrands::listResources][listResources] request. It contains a list of any email templates that have been modified to differ from the master resource files.\n\n[listResources]: ./categories/Accounts/AccountBrands/listResources.html", - "type": "array", - "items": { - "type": "string" - } + "recipientIdGuidMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `recipientIdGuid` property is editable." }, - "resourcesContentType": { - "description": "The type of brand resource file. A brand uses a different resource file to control each of the following experiences:\n\n- Sending (`sending`)\n- Signing (`signing`)\n- Email messages (`email`)\n- Captive (embedded) signing (`signing_captive`)\n\nYou can modify the default email messages and formats in these files and upload them to your brand to customize the user experience.", + "recipientIdMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `recipientId` property is editable." + }, + "requireAll": { + "description": "When set to **true** and shared is true, information must be entered in this field to complete the envelope. ", "type": "string" }, - "resourcesContentUri": { - "description": "The URI for the brand resource file.", + "requireAllMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `requireAll` property is editable." + }, + "required": { + "description": "When set to **true**, the signer is required to fill out this tab.", "type": "string" - } - }, - "x-ds-definition-name": "brandResources", - "description": "Information about the resource files that the brand uses for the email, signing, sending, and captive (embedded) signing experiences.", - "x-ms-summary": "Information about the resource files that the brand uses for the email, signing, sending, and captive (embedded) signing experiences." - }, - "brandResourcesList": { - "type": "object", - "properties": { - "resourcesContentTypes": { - "description": "A list of resources that the brand uses.", - "type": "array", - "items": { - "$ref": "#/definitions/brandResources" - } - } - }, - "x-ds-definition-name": "brandResourcesList", - "description": "", - "x-ms-summary": "" - }, - "brandResourceUrls": { - "type": "object", - "properties": { - "email": { - "description": "The URI for the email resource file that the brand uses.", + }, + "requiredMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `required` property is editable." + }, + "requireInitialOnSharedChange": { + "description": "Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.", "type": "string" }, - "sending": { - "description": "The URI for the sending resource file that the brand uses.", + "requireInitialOnSharedChangeMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `requireInitialOnSharedChange` property is editable." + }, + "senderRequired": { + "description": "When set to **true**, the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope.", "type": "string" }, - "signing": { - "description": "The URI for the signing resource file that the brand uses.", + "senderRequiredMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `senderRequired` property is editable." + }, + "shared": { + "description": "When **true**, the tab is shared.", "type": "string" }, - "signingCaptive": { - "description": "The URI for the captive (embedded) signing resource file that the brand uses.", + "sharedMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `shared` property is editable." + }, + "smartContractInformation": { + "$ref": "#/definitions/smartContractInformation", + "description": "" + }, + "status": { + "description": "The status of the item.", "type": "string" - } - }, - "x-ds-definition-name": "brandResourceUrls", - "description": "Brands use resource files to style the following experiences: \n\n- Email\n- Sending\n- Signing\n- Captive (embedded) signing \n\nYou can modify these resource files to customize these experiences.", - "x-ms-summary": "Brands use resource files to style the following experiences: \n\n- Email\n- Sending\n- Signing\n- Captive (embedded) signing \n\nYou can modify these resource files to customize these experiences." - }, - "brandsRequest": { - "type": "object", - "properties": { - "brands": { - "description": "A list of brands.", - "type": "array", - "items": { - "$ref": "#/definitions/brandRequest" - } - } - }, - "x-ds-definition-name": "brandsRequest", - "description": "", - "x-ms-summary": "" - }, - "brandsResponse": { - "type": "object", - "properties": { - "brands": { - "description": "A list of brands.", + }, + "statusMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `status` property is editable." + }, + "tabGroupLabels": { + "description": "An array of tab group labels that uniquely identify tab groups. To assign a tab to a `tabGroup`, you assign the `TabGroupLabel` to the `Tab.TabGroupLabels` array.", "type": "array", "items": { - "$ref": "#/definitions/brand" + "type": "string" } }, - "recipientBrandIdDefault": { - "description": "The brand that envelope recipients see when a brand is not explicitly set.", - "type": "string" + "tabGroupLabelsMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `tabGroupLabels` property is editable." }, - "senderBrandIdDefault": { - "description": "The brand that envelope senders see when a brand is not explicitly set.", - "type": "string" - } - }, - "x-ds-definition-name": "brandsResponse", - "description": "", - "x-ms-summary": "" - }, - "bulkEnvelope": { - "type": "object", - "properties": { - "bulkRecipientRow": { - "description": "The row of the recipient in the CSV file used to create the bulk recipient list.", + "tabId": { + "description": "The unique identifier for the tab.", "type": "string" }, - "bulkStatus": { - "description": "Indicates the status of the bulk send operation. Returned values can be:\n- `queued`\n- `processing`\n- `sent`\n- `failed`", - "type": "string" + "tabIdMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `tabId` property is editable." }, - "email": { - "description": "The email address of the recipient assigned to this envelope transaction.", + "tabLabel": { + "description": "The label associated with the tab. This value may be an empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum Length: 500 characters.\n", "type": "string" }, - "envelopeId": { - "description": "GUID of the bulk envelope.", - "type": "string" + "tabLabelMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `tabLabel` property is editable." }, - "envelopeUri": { - "description": "URI that you can use to retrieve the bulk envelopes.", + "tabOrder": { + "description": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.", "type": "string" }, - "errorDetails": { - "$ref": "#/definitions/errorDetails", - "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." + "tabOrderMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `tabOrder` property is editable." }, - "name": { - "description": "The name of the recipient assigned to this envelope transaction.", + "tabType": { + "description": "Indicates the type of tab (for example, `signHere` or `initialHere`).", "type": "string" }, - "submittedDateTime": { - "description": "The date and time on which the bulk envelope was created.", + "tabTypeMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `tabType` property is editable." + }, + "templateLocked": { + "description": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ", "type": "string" }, - "transactionId": { - "description": "Identifier for the envelope transaction. The ID is a sender-generated value and is valid in the DocuSign system for 7 days. We recommend that you use a transaction ID for offline signing to ensure that an envelope is not sent multiple times. You can use the transaction ID to determine an envelope's status (queued, processing, sent, or failed) in cases where the Internet connection is lost before envelope status is returned.", + "templateLockedMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `templateLocked` property is editable." + }, + "templateRequired": { + "description": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.", "type": "string" - } - }, - "x-ds-definition-name": "bulkEnvelope", - "description": "", - "x-ms-summary": "" - }, - "bulkEnvelopesResponse": { - "type": "object", - "properties": { - "bulkEnvelopeStatuses": { - "description": "Reserved: TBD", - "type": "array", - "items": { - "$ref": "#/definitions/bulkEnvelopeStatus" - } }, - "endPosition": { - "description": "The last position in the result set. ", + "templateRequiredMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `templateRequired` property is editable." + }, + "tooltip": { + "description": "The text of a tooltip that appears when a user hovers over a form field or tab.", "type": "string" }, - "nextUri": { - "description": "The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. ", + "toolTipMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `toolTip` property is editable." + }, + "underline": { + "description": "When set to **true**, the information in the tab is underlined.", "type": "string" }, - "previousUri": { - "description": "The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. ", + "underlineMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `underline` property is editable." + }, + "value": { + "description": "Specifies the value of the tab. ", "type": "string" }, - "resultSetSize": { - "description": "The number of results returned in this response. Because you can filter which entries are included in the response, this value is always less than or equal to `totalSetSize`.", + "valueMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `value` property is editable." + }, + "width": { + "description": "The width of the tab in pixels.", "type": "string" }, - "startPosition": { - "description": "The starting position of the current result set.", + "widthMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `width` property is editable." + }, + "xPosition": { + "description": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n", "type": "string" }, - "totalSetSize": { - "description": "The total number of items in the search's result set. This value is always greater than or equal to the value of `resultSetSize`.", + "xPositionMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `xPosition` property is editable." + }, + "yPosition": { + "description": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n", "type": "string" + }, + "yPositionMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `yPosition` property is editable." } }, - "x-ds-definition-name": "bulkEnvelopesResponse", + "x-ds-definition-name": "currency", "description": "", "x-ms-summary": "" }, - "bulkEnvelopeStatus": { + "currencyFeatureSetPrice": { "type": "object", "properties": { - "batchId": { - "description": "Identifier used to query the status of an individual bulk recipient batch.", - "type": "string" - }, - "batchSize": { - "description": "The total number of items in the batch being queried.", - "type": "string" - }, - "bulkEnvelopes": { - "description": "A list of bulk envelope objects.", - "type": "array", - "items": { - "$ref": "#/definitions/bulkEnvelope" - } - }, - "bulkEnvelopesBatchUri": { - "description": "URI at which you can retrieve the batch envelopes.", + "currencyCode": { + "description": "Reserved for DocuSign.", "type": "string" }, - "endPosition": { - "description": "The last position in the result set. ", + "currencySymbol": { + "description": "Reserved for DocuSign.", "type": "string" }, - "failed": { - "description": "The number of entries with a status of `failed`. ", + "envelopeFee": { + "description": "Reserved for DocuSign.", "type": "string" }, - "nextUri": { - "description": "The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. ", + "fixedFee": { + "description": "Reserved for DocuSign.", "type": "string" }, - "previousUri": { - "description": "The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. ", + "seatFee": { + "description": "Reserved for DocuSign.", "type": "string" - }, - "queued": { - "description": "The number of entries with a status of `queued`.", + } + }, + "x-ds-definition-name": "currencyFeatureSetPrice", + "description": "Information about the price and currency associated with the feature set. Reserved for internal DocuSign use only.", + "x-ms-summary": "Information about the price and currency associated with the feature set. Reserved for internal DocuSign use only." + }, + "currencyPlanPrice": { + "type": "object", + "properties": { + "currencyCode": { + "description": "Specifies the ISO currency code for the account.", "type": "string" }, - "resultSetSize": { - "description": "The number of results returned in this response. Because you can filter which entries are included in the response, this value is always less than or equal to `totalSetSize`.", + "currencySymbol": { + "description": "Specifies the currency symbol for the account.", "type": "string" }, - "sent": { - "description": "The number of entries with a status of `sent`.", + "perSeatPrice": { + "description": "The per-seat price associated with the plan.\n\nExample: `\"456.0000\"`", "type": "string" }, - "startPosition": { - "description": "The starting position of the current result set.", - "type": "string" + "supportedCardTypes": { + "$ref": "#/definitions/creditCardTypes", + "description": "A simple type enumeration of the language used. The supported languages, with the language value shown in parenthesis, are: Arabic (ar), Bahasa Indonesia (id), Bahasa Melayu (ms) Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro),Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi)." }, - "submittedDate": { - "description": "The date on which the bulk envelope was created.", + "supportIncidentFee": { + "description": "The support incident fee charged for each support incident.\n\nExample: `\"$0.00\"`", "type": "string" }, - "totalSetSize": { - "description": "The total number of items in the search's result set. This value is always greater than or equal to the value of `resultSetSize`.", + "supportPlanFee": { + "description": "The support plan fee charged for this plan.\n\nExample: `\"$0.00\"`", "type": "string" } }, - "x-ds-definition-name": "bulkEnvelopeStatus", + "x-ds-definition-name": "currencyPlanPrice", "description": "", "x-ms-summary": "" }, - "bulkRecipient": { + "customField": { "type": "object", "properties": { - "accessCode": { - "description": "If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. \n\nMaximum Length: 50 characters and it must conform to the account's access code format setting.\n\nIf blank, but the signer `accessCode` property is set in the envelope, then that value is used.\n\nIf blank and the signer `accessCode` property is not set, then the access code is not required.", + "customFieldType": { + "description": "The type of custom field. Valid values are:\n\n- `text` (default)\n- `list`", "type": "string" }, - "email": { - "description": "Specifies the recipient's email address. \n\nMaximum length: 100 characters.", + "errorDetails": { + "$ref": "#/definitions/errorDetails", + "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." + }, + "fieldId": { + "description": "The id of the custom field.", "type": "string" }, - "errorDetails": { - "description": "Array or errors.", + "listItems": { + "description": "For a list custom field, this is an array of strings that represent the items in a list. \n\nMaximum Length: 2,000 characters.", "type": "array", "items": { - "$ref": "#/definitions/errorDetails" + "type": "string" } }, - "identification": { - "description": "Specifies the authentication check used for the signer. If blank then no authentication check is required for the signer. Only one value can be used in this field.\n\nThe acceptable values are:\n\n* KBA: Enables the normal ID check authentication set up for your account.\n* Phone: Enables phone authentication.\n* SMS: Enables SMS authentication.", - "type": "string" - }, "name": { - "description": "Specifies the recipient's name. \n\nMaximum length: 50 characters.", + "description": "The name of the custom field.", "type": "string" }, - "note": { - "description": "A note sent to the recipient in the signing email.\nThis note is unique to this recipient.\nIn the user interface,\nit appears near the upper left corner\nof the document\non the signing screen.\n\nMaximum Length: 1000 characters.\n", + "required": { + "description": "When set to **true**, the signer must complete the custom field.", "type": "string" }, - "phoneNumber": { - "description": "This is only used if the Identification field value is Phone or SMS. The value for this field can be a valid telephone number or, if Phone, usersupplied (SMS authentication cannot use a user supplied number). Parenthesis and dashes can be used in the telephone number.\n\nIf `usersupplied` is used, the signer supplies his or her own telephone number.", + "show": { + "description": "When set to **true**, the custom field displays at the top of the Certificate of Completion.", "type": "string" }, - "recipientSignatureProviderInfo": { - "description": "", + "value": { + "description": "Specifies the value of the custom field. \n\nMaximum Length: 2,000 characters.", + "type": "string" + } + }, + "x-ds-definition-name": "customField", + "description": "This object provides details about a custom field.", + "x-ms-summary": "This object provides details about a custom field." + }, + "customFields": { + "description": "Contains information about custom fields.", + "type": "object", + "properties": { + "listCustomFields": { + "description": "An array of list custom fields.", "type": "array", "items": { - "$ref": "#/definitions/bulkRecipientSignatureProvider" + "$ref": "#/definitions/listCustomField" } }, - "rowNumber": { - "description": "", - "type": "string" - }, - "tabLabels": { - "description": "Specifies values used to populate recipient tabs with information. This allows each bulk recipient signer to have different values for their associated tabs. Any number of `tabLabel` columns can be added to the bulk recipient file.\n\nThe information used in the bulk recipient file header must be the same as the `tabLabel` for the tab.\n\nThe values entered in this column are automatically inserted into the corresponding tab for the recipient in the same row.\n\nNote that this option cannot be used for tabs that do not have data or that are automatically populated data such as Signature, Full Name, Email Address, Company, Title, and Date Signed tabs.", + "textCustomFields": { + "description": "An array of text custom fields.", "type": "array", "items": { - "$ref": "#/definitions/bulkRecipientTabLabel" + "$ref": "#/definitions/textCustomField" } } }, - "x-ds-definition-name": "bulkRecipient", - "description": "", - "x-ms-summary": "" + "x-ds-definition-name": "customFields", + "x-ms-summary": "Contains information about custom fields." }, - "bulkRecipientSignatureProvider": { + "customFieldsEnvelope": { "type": "object", "properties": { - "name": { - "description": "", - "type": "string" + "listCustomFields": { + "description": "An array of list custom fields.", + "type": "array", + "items": { + "$ref": "#/definitions/listCustomField" + } }, - "value": { - "description": "Specifies the value of the tab. ", - "type": "string" + "textCustomFields": { + "description": "An array of text custom fields.", + "type": "array", + "items": { + "$ref": "#/definitions/textCustomField" + } } }, - "x-ds-definition-name": "bulkRecipientSignatureProvider", + "x-ds-definition-name": "customFieldsEnvelope", "description": "", "x-ms-summary": "" }, - "bulkRecipientsRequest": { + "customSettingsInformation": { "type": "object", "properties": { - "bulkRecipients": { - "description": "A complex type containing information about the bulk recipients in the request.", + "customSettings": { + "description": "The name/value pair information for the user custom setting.", "type": "array", "items": { - "$ref": "#/definitions/bulkRecipient" + "$ref": "#/definitions/nameValue" } } }, - "x-ds-definition-name": "bulkRecipientsRequest", + "x-ds-definition-name": "customSettingsInformation", "description": "", "x-ms-summary": "" }, - "bulkRecipientsResponse": { + "date": { "type": "object", "properties": { - "bulkRecipients": { - "description": "A complex type containing information about the bulk recipients in the response.", - "type": "array", - "items": { - "$ref": "#/definitions/bulkRecipient" - } + "anchorAllowWhiteSpaceInCharacters": { + "description": "", + "type": "string" }, - "endPosition": { - "description": "The last position in the result set. ", + "anchorAllowWhiteSpaceInCharactersMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "" + }, + "anchorCaseSensitive": { + "description": "This property controls how [anchor tabs][AnchorTabs] are placed. When **true**, the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false**.\n\nFor example, when set to **true**, if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When set to **false**, `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**.\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place", "type": "string" }, - "nextUri": { - "description": "The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. ", + "anchorCaseSensitiveMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorCaseSensitive` property is editable." + }, + "anchorHorizontalAlignment": { + "description": "This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are :\n\n- `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value.\n- `right`: Aligns the tab’s left side with the last character of the matching anchor word.\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place\n", "type": "string" }, - "previousUri": { - "description": "The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. ", + "anchorHorizontalAlignmentMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorHorizontalAlignment` property is editable." + }, + "anchorIgnoreIfNotPresent": { + "description": "When set to **true**, this tab is ignored if the `anchorString` is not found in the document.", "type": "string" }, - "resultSetSize": { - "description": "The number of results returned in this response. Because you can filter which entries are included in the response, this value is always less than or equal to `totalSetSize`.", + "anchorIgnoreIfNotPresentMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable." + }, + "anchorMatchWholeWord": { + "description": "When set to **true**, the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false**.\n\nFor example, when set to **true**, if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When set to **false**, if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**.\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTab]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place\n", "type": "string" }, - "startPosition": { - "description": "The starting position of the current result set.", + "anchorMatchWholeWordMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorMatchWholeWord` property is editable." + }, + "anchorString": { + "description": "Specifies the string to find in the document and use as the basis for tab placement.", "type": "string" }, - "totalSetSize": { - "description": "The total number of items in the search's result set. This value is always greater than or equal to the value of `resultSetSize`.", + "anchorStringMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorString` property is editable." + }, + "anchorTabProcessorVersion": { + "description": "Reserved for DocuSign.", "type": "string" - } - }, - "x-ds-definition-name": "bulkRecipientsResponse", - "description": "", - "x-ms-summary": "" - }, - "bulkRecipientsSummaryResponse": { - "type": "object", - "properties": { - "bulkRecipients": { - "description": "A complex type containing information about the bulk recipients in the response.", - "type": "array", - "items": { - "$ref": "#/definitions/bulkRecipient" - } }, - "bulkRecipientsCount": { - "description": "The number of items returned in this response.", + "anchorTabProcessorVersionMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Reserved for DocuSign." + }, + "anchorUnits": { + "description": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n", "type": "string" }, - "bulkRecipientsUri": { - "description": "Contains a URI for an endpoint that allows you to easily retrieve bulk recipient information.", + "anchorUnitsMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorUnits` property is editable." + }, + "anchorXOffset": { + "description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n", "type": "string" }, - "errorDetails": { - "description": "Array or errors.", - "type": "array", - "items": { - "$ref": "#/definitions/errorDetails" - } - } - }, - "x-ds-definition-name": "bulkRecipientsSummaryResponse", - "description": "", - "x-ms-summary": "" - }, - "bulkRecipientsUpdateResponse": { - "type": "object", - "properties": { - "signer": { - "$ref": "#/definitions/signer", - "description": "" - } - }, - "x-ds-definition-name": "bulkRecipientsUpdateResponse", - "description": "", - "x-ms-summary": "" - }, - "bulkRecipientTabLabel": { - "type": "object", - "properties": { - "name": { - "description": "", + "anchorXOffsetMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorXOffset` property is editable." + }, + "anchorYOffset": { + "description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n", "type": "string" }, - "value": { - "description": "Specifies the value of the tab. ", + "anchorYOffsetMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorYOffset` property is editable." + }, + "bold": { + "description": "When set to **true**, the information in the tab is bold.", "type": "string" - } - }, - "x-ds-definition-name": "bulkRecipientTabLabel", - "description": "", - "x-ms-summary": "" - }, - "captiveRecipient": { - "type": "object", - "properties": { - "clientUserId": { - "description": "Specifies whether the recipient is embedded or remote. \n\nIf the `clientUserId` property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing.\n\nNote: if the `clientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true**, an error is generated on sending. \n\nMaximum length: 100 characters. ", + }, + "boldMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `bold` property is editable." + }, + "concealValueOnDocument": { + "description": "When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender.\n\nWhen an envelope is completed the information is only available to the sender through the Form Data link in the DocuSign Console. The information on the downloaded document remains masked by asterisks.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.", "type": "string" }, - "email": { - "description": "Specifies the email address associated with the captive recipient.", + "concealValueOnDocumentMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `concealValueOnDocument` property is editable." + }, + "conditionalParentLabel": { + "description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility.", + "type": "string" + }, + "conditionalParentLabelMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `conditionalParentLabel` property is editable." + }, + "conditionalParentValue": { + "description": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use \"on\" as the value to show that the parent tab is active.\n", + "type": "string" + }, + "conditionalParentValueMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `conditionalParentValue` property is editable." + }, + "customTabId": { + "description": "The DocuSign-generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.", + "type": "string" + }, + "customTabIdMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `customTabId` property is editable." + }, + "disableAutoSize": { + "description": "When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes.", + "type": "string" + }, + "disableAutoSizeMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `disableAutoSize` property is editable." + }, + "documentId": { + "description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.", "type": "string" }, + "documentIdMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `documentId` property is editable." + }, "errorDetails": { "$ref": "#/definitions/errorDetails", "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." }, - "userName": { - "description": "Specifies the user name associated with the captive recipient.", + "font": { + "description": "The font to be used for the tab value. Supported fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n", "type": "string" - } - }, - "x-ds-definition-name": "captiveRecipient", - "description": "", - "x-ms-summary": "" - }, - "captiveRecipientInformation": { - "type": "object", - "properties": { - "captiveRecipients": { - "description": "A complex type containing information about one or more captive recipients.", - "type": "array", - "items": { - "$ref": "#/definitions/captiveRecipient" - } - } - }, - "x-ds-definition-name": "captiveRecipientInformation", - "description": "", - "x-ms-summary": "" - }, - "carbonCopy": { - "type": "object", - "properties": { - "accessCode": { - "description": "If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. \n\nMaximum Length: 50 characters and it must conform to the account's access code format setting.\n\nIf blank, but the signer `accessCode` property is set in the envelope, then that value is used.\n\nIf blank and the signer `accessCode` property is not set, then the access code is not required.", + }, + "fontColor": { + "description": "The font color to use for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n", "type": "string" }, - "accessCodeMetadata": { + "fontColorMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `fontColor` property is editable." + }, + "fontMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `font` property is editable." + }, + "fontSize": { + "description": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72", + "type": "string" + }, + "fontSizeMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `fontSize` property is editable." + }, + "formOrder": { + "description": "An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block.", + "type": "string" + }, + "formOrderMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `formOrder` property is editable." + }, + "formPageLabel": { + "description": "A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience.", + "type": "string" + }, + "formPageLabelMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `formPageLabel` property is editable." + }, + "formPageNumber": { + "description": "An integer specifying the order in which to present the guided form pages.", + "type": "string" + }, + "formPageNumberMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `fromPageNumber` property is editable." + }, + "height": { + "description": "The height of the tab in pixels.", + "type": "string" + }, + "heightMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `height` property is editable." + }, + "italic": { + "description": "When set to **true**, the information in the tab is italic.", + "type": "string" + }, + "italicMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `italic` property is editable." + }, + "localePolicy": { + "$ref": "#/definitions/localePolicyTab", + "description": "Reserved for DocuSign." + }, + "locked": { + "description": "When set to **true**, the signer cannot change the data of the custom tab.", + "type": "string" + }, + "lockedMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `locked` property is editable." + }, + "maxLength": { + "description": "An optional value that describes the maximum length of the property when the property is a string.", + "type": "string" + }, + "maxLengthMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `maxLength` property is editable." + }, + "mergeField": { + "$ref": "#/definitions/mergeField", + "description": "Contains the information necessary to map the tab to a field in SalesForce." + }, + "mergeFieldXml": { + "description": "", + "type": "string" + }, + "name": { + "description": "The name of the tab. For example, `Sign Here` or `Initial Here`.", + "type": "string" + }, + "nameMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `name` property is editable. Read only." + }, + "originalValue": { + "description": "The initial value of the tab when it was sent to the recipient. ", + "type": "string" + }, + "originalValueMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `originalValue` property is editable." + }, + "pageNumber": { + "description": "The page number on which the tab is located.\nFor supplemental documents, this value must be `1`.", + "type": "string" + }, + "pageNumberMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `accessCode` property is editable.\n" + "description": "Metadata that indicates whether the `pageNumber` property is editable." }, - "addAccessCodeToEmail": { - "description": "This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient.", + "recipientId": { + "description": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.", "type": "string" }, - "agentCanEditEmail": { - "description": "Optional element. When set to true, the agents recipient associated with this recipient can change the recipient's pre-populated email address. This element is only active if enabled for the account.", + "recipientIdGuid": { + "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only.", "type": "string" }, - "agentCanEditName": { - "description": "Optional element. When set to **true**, the agents recipient associated with this recipient can change the recipient's pre-populated name. This element is only active if enabled for the account.", - "type": "string" + "recipientIdGuidMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `recipientIdGuid` property is editable." }, - "clientUserId": { - "description": "Not applicable for Carbon Copy recipients.", - "type": "string" + "recipientIdMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `recipientId` property is editable." }, - "completedCount": { - "description": "Indicates the number of times that the recipient has been through a signing completion for the envelope.\n\nIf this number is greater than 0 for a signing group, only the user who previously completed may sign again.", + "requireAll": { + "description": "When set to **true** and shared is true, information must be entered in this field to complete the envelope. ", "type": "string" }, - "customFields": { - "description": "An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters.", - "type": "array", - "items": { - "type": "string" - } + "requireAllMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `requireAll` property is editable." }, - "declinedDateTime": { - "description": "The date and time the recipient declined the document.", + "required": { + "description": "When set to **true**, the signer is required to fill out this tab.", "type": "string" }, - "declinedReason": { - "description": "The reason the recipient declined the document.", - "type": "string" + "requiredMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `required` property is editable." }, - "deliveredDateTime": { - "description": "The date and time that the envelope was delivered to the recipient.", + "requireInitialOnSharedChange": { + "description": "Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.", "type": "string" }, - "deliveryMethod": { - "description": "Reserved for DocuSign.", + "requireInitialOnSharedChangeMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `requireInitialOnSharedChange` property is editable." + }, + "senderRequired": { + "description": "When set to **true**, the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope.", "type": "string" }, - "deliveryMethodMetadata": { + "senderRequiredMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." - }, - "documentVisibility": { - "description": "A list of documentVisibility objects, which define a recipient's read/write access to a document.", - "type": "array", - "items": { - "$ref": "#/definitions/documentVisibility" - } + "description": "Metadata that indicates whether the `senderRequired` property is editable." }, - "email": { - "description": "Email id of the recipient. Notification of the document to sign is sent to this email id. \n\nMaximum length: 100 characters. ", + "shared": { + "description": "When set to **true**, this custom tab is shared.", "type": "string" }, - "emailMetadata": { + "sharedMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the email id of the recipient." + "description": "Metadata that indicates whether the `shared` property is editable." }, - "emailNotification": { - "$ref": "#/definitions/recipientEmailNotification", - "description": "An optional complex type that sets a specific email subject and body for this recipient's notification email. \n\n**Note**: If you use this field to set a specific email notification for one recipient, you must also set the email notification for the other recipients. Using this field for one or more recipients negates the Envelope `Subject` and `EmailBlurb` property settings. " + "smartContractInformation": { + "$ref": "#/definitions/smartContractInformation", + "description": "" }, - "embeddedRecipientStartURL": { - "description": "Specifies a sender-provided valid URL string for redirecting an embedded recipient. When this option is used, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the recipient clicks the document link in the email, the recipient is redirected through DocuSign to the specified URL to complete the required actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. \n\nIf set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation launched by a partner.\n\nIt is important to understand that in a typical embedded workflow, the authentication of an embedded recipient is the responsibility of the sending application. DocuSign expects that senders will follow their own processes for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process is initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process, bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient.\n\nIf the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: `envelopeId`, `recipientId`, `recipientName`, `recipientEmail`, and `customFields`. The `customFields` property must be set for the recipient or envelope. The merge fields are enclosed in double brackets. \n\n*Example*: \n\n`http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` ", + "status": { + "description": "The status of the tab. Possible values are:\n\n- `active`: The tab is active, but the recipient has not yet interacted with it.\n- `signed`: The recipient signed the tab.\n- `declined`: The recipient declined the envelope.\n- `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`).\n", "type": "string" }, - "errorDetails": { - "$ref": "#/definitions/errorDetails", - "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." + "statusMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `status` property is editable." }, - "excludedDocuments": { - "description": "Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true** for the envelope to use this.\n\nWhen enforce signer visibility is enabled, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent.", + "tabGroupLabels": { + "description": "An array of tab group labels that uniquely identify tab groups. To assign a tab to a `tabGroup`, you assign the `TabGroupLabel` to the `Tab.TabGroupLabels` array.", "type": "array", "items": { "type": "string" } }, - "faxNumber": { - "description": "Reserved for DocuSign.", - "type": "string" - }, - "faxNumberMetadata": { + "tabGroupLabelsMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "description": "Metadata that indicates whether the `tabGroupLabels` property is editable." }, - "firstName": { - "description": "The recipient's first name. Maximum Length: 50 characters.", + "tabId": { + "description": "The unique identifier for the tab.", "type": "string" }, - "firstNameMetadata": { + "tabIdMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the recipient's first name." + "description": "Metadata that indicates whether the `tabId` property is editable." }, - "fullName": { - "description": "Reserved for DocuSign.", + "tabLabel": { + "description": "The label associated with the tab. This value may be an empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum Length: 500 characters.\n", "type": "string" }, - "fullNameMetadata": { + "tabLabelMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "description": "Metadata that indicates whether the `tabLabel` property is editable." }, - "idCheckConfigurationName": { - "description": "The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting.\n\n**Example**: Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node.", + "tabOrder": { + "description": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.", "type": "string" }, - "idCheckConfigurationNameMetadata": { + "tabOrderMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the `idCheckConfigurationName` property." - }, - "idCheckInformationInput": { - "$ref": "#/definitions/idCheckInformationInput", - "description": "An object that contains input information related to a recipient ID check." + "description": "Metadata that indicates whether the `tabOrder` property is editable." }, - "inheritEmailNotificationConfiguration": { - "description": "When set to **true** and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account. ", + "tabType": { + "description": "Indicates the type of tab (for example, `signHere` or `initialHere`).", "type": "string" }, - "lastName": { - "description": "The recipient's last name.", + "tabTypeMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `tabType` property is editable." + }, + "templateLocked": { + "description": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ", "type": "string" }, - "lastNameMetadata": { + "templateLockedMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the recipient's last name." + "description": "Metadata that indicates whether the `templateLocked` property is editable." }, - "lockedRecipientPhoneAuthEditable": { - "description": "Reserved for DocuSign.", + "templateRequired": { + "description": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.", "type": "string" }, - "lockedRecipientSmsEditable": { - "description": "Reserved for DocuSign.", - "type": "string" + "templateRequiredMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `templateRequired` property is editable." }, - "name": { - "description": "The full legal name of the recipient. Maximum Length: 100 characters.", + "tooltip": { + "description": "The text of a tooltip that appears when a user hovers over a form field or tab.", "type": "string" }, - "nameMetadata": { + "toolTipMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the full legal name of the recipient." + "description": "Metadata that indicates whether the `toolTip` property is editable." }, - "note": { - "description": "A note sent to the recipient in the signing email.\nThis note is unique to this recipient.\nIn the user interface,\nit appears near the upper left corner\nof the document\non the signing screen.\n\nMaximum Length: 1000 characters.\n", + "underline": { + "description": "When set to **true**, the information in the tab is underlined.", "type": "string" }, - "noteMetadata": { + "underlineMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata indicating if the sender can edit the note sent to the recipient in the signing email." + "description": "Metadata that indicates whether the `underline` property is editable." }, - "phoneAuthentication": { - "$ref": "#/definitions/recipientPhoneAuthentication", - "description": "A complex type that contains the following elements:\n\n* `recipMayProvideNumber` - Boolean. When set to **true**, the recipient can use whatever phone number they choose.\n* `senderProvidedNumbers` - ArrayOfString. A list of phone numbers the recipient can use.\n* `recordVoicePrint` - Reserved.\n* `validateRecipProvidedNumber` - Reserved." + "validationMessage": { + "description": "The message displayed if the custom tab fails input validation (either custom of embedded).", + "type": "string" }, - "recipientAttachments": { - "description": "Reserved for DocuSign.", - "type": "array", - "items": { - "$ref": "#/definitions/recipientAttachment" - } + "validationMessageMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `validationMessage` property is editable." }, - "recipientAuthenticationStatus": { - "$ref": "#/definitions/authenticationStatus", - "description": "Information about the recipient's authentication status." + "validationPattern": { + "description": "A regular expression used to validate input for the tab.", + "type": "string" }, - "recipientFeatureMetadata": { - "description": "Metadata about the features that are supported for the recipient type.", - "type": "array", - "items": { - "$ref": "#/definitions/featureAvailableMetadata" - } + "validationPatternMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `validationPattern` property is editable." }, - "recipientId": { - "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", + "value": { + "description": "Specifies the value of the tab. ", "type": "string" }, - "recipientIdGuid": { - "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one.", - "type": "string" + "valueMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `value` property is editable." }, - "recipientType": { - "description": "The recipient type, as specified by the following values:\n- `agents`: Agent recipients can add name and email information for recipients that appear after the agent in routing order.\n- `carbonCopies`: Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date, or add information to any of the documents. This type of recipient can be used in any routing order.\n- `certifiedDeliveries`: Certified delivery recipients must receive the completed documents for the envelope to be completed. They don't need to sign, initial, date, or add information to any of the documents.\n- `editors`: Editors have the same management and access rights for the envelope as the sender. Editors can add name and email information, add or change the routing order, set authentication options, and can edit signature/initial tabs and data fields for the remaining recipients.\n- `inPersonSigners`: In-person recipients are DocuSign users who act as signing hosts in the same physical location as the signer.\n- `intermediaries`: Intermediary recipients can optionally add name and email information for recipients at the same or subsequent level in the routing order.\n- `seals`: Electronic seal recipients represent legal entities.\n- `signers`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope.\n- `witnesses`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope.", + "width": { + "description": "The width of the tab in pixels.", "type": "string" }, - "recipientTypeMetadata": { + "widthMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the recipient type." + "description": "Metadata that indicates whether the `width` property is editable." }, - "requireIdLookup": { - "description": "When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. ", + "xPosition": { + "description": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n", "type": "string" }, - "requireIdLookupMetadata": { + "xPositionMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `requireIdLookup` property is editable.\n" + "description": "Metadata that indicates whether the `xPosition` property is editable." }, - "roleName": { - "description": "Optional element. Specifies the role name associated with the recipient.

This is required when working with template recipients.", + "yPosition": { + "description": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n", "type": "string" }, - "routingOrder": { - "description": "Specifies the routing order of the recipient in the envelope. ", + "yPositionMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `yPosition` property is editable." + } + }, + "x-ds-definition-name": "date", + "description": "A tab that allows the recipient to enter a date. Date tabs\nare one-line fields that allow date information to be\nentered in any format. The tooltip for this tab recommends\nentering the date as MM/DD/YYYY, but this is not enforced.\nThe format entered by the signer is retained. If you need a\nparticular date format enforced, DocuSign recommends using a\nText tab with a validation pattern and a validation message\nto enforce the format.\n", + "x-ms-summary": "A tab that allows the recipient to enter a date. Date tabs\nare one-line fields that allow date information to be\nentered in any format. The tooltip for this tab recommends\nentering the date as MM/DD/YYYY, but this is not enforced.\nThe format entered by the signer is retained. If you need a\nparticular date format enforced, DocuSign recommends using a\nText tab with a validation pattern and a validation message\nto enforce the format.\n" + }, + "dateSigned": { + "type": "object", + "properties": { + "anchorAllowWhiteSpaceInCharacters": { + "description": "", "type": "string" }, - "routingOrderMetadata": { + "anchorAllowWhiteSpaceInCharactersMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the routing order for the recipient." + "description": "" }, - "sentDateTime": { - "description": "The date and time the envelope was sent.", + "anchorCaseSensitive": { + "description": "This property controls how [anchor tabs][AnchorTabs] are placed. When **true**, the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false**.\n\nFor example, when set to **true**, if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When set to **false**, `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**.\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place", "type": "string" }, - "signedDateTime": { - "description": "Reserved for DocuSign.", - "type": "string" + "anchorCaseSensitiveMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorCaseSensitive` property is editable." }, - "signingGroupId": { - "description": "The ID of the signing group of which the recipient is a member, if applicable.", + "anchorHorizontalAlignment": { + "description": "This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are :\n\n- `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value.\n- `right`: Aligns the tab’s left side with the last character of the matching anchor word.\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place\n", "type": "string" }, - "signingGroupIdMetadata": { + "anchorHorizontalAlignmentMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the signing group id." + "description": "Metadata that indicates whether the `anchorHorizontalAlignment` property is editable." }, - "signingGroupName": { - "description": "The display name for the signing group. \n\nMaximum Length: 100 characters. ", + "anchorIgnoreIfNotPresent": { + "description": "When set to **true**, this tab is ignored if the `anchorString` is not found in the document.", "type": "string" }, - "signingGroupUsers": { - "description": "A complex type that contains information about users in the signing group.", - "type": "array", - "items": { - "$ref": "#/definitions/userInfo" - } + "anchorIgnoreIfNotPresentMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable." }, - "smsAuthentication": { - "$ref": "#/definitions/recipientSMSAuthentication", - "description": "Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication. \n" + "anchorMatchWholeWord": { + "description": "When set to **true**, the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false**.\n\nFor example, when set to **true**, if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When set to **false**, if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**.\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTab]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place\n", + "type": "string" }, - "socialAuthentications": { - "description": " Lists the social ID type that can be used for recipient authentication.", - "type": "array", - "items": { - "$ref": "#/definitions/socialAuthentication" - } + "anchorMatchWholeWordMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorMatchWholeWord` property is editable." }, - "status": { - "description": "Recipient status.\n\n", + "anchorString": { + "description": "Specifies the string to find in the document and use as the basis for tab placement.", "type": "string" }, - "statusCode": { - "description": "The code for recipient's status.", + "anchorStringMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorString` property is editable." + }, + "anchorTabProcessorVersion": { + "description": "Reserved for DocuSign.", "type": "string" }, - "tabs": { - "$ref": "#/definitions/EnvelopeRecipientTabs", - "description": "A list of `commentTabs` that contains the carbon copy recipient's comments." + "anchorTabProcessorVersionMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Reserved for DocuSign." }, - "templateLocked": { - "description": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ", + "anchorUnits": { + "description": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n", "type": "string" }, - "templateRequired": { - "description": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.", - "type": "string" + "anchorUnitsMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorUnits` property is editable." }, - "totalTabCount": { - "description": "The total number of tabs in the documents.", + "anchorXOffset": { + "description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n", "type": "string" }, - "userId": { - "description": "The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.\n", - "type": "string" - } - }, - "x-ds-definition-name": "carbonCopy", - "description": "A carbon copy recipient.", - "x-ms-summary": "A carbon copy recipient." - }, - "certifiedDelivery": { - "type": "object", - "properties": { - "accessCode": { - "description": "If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. \n\nMaximum Length: 50 characters and it must conform to the account's access code format setting.\n\nIf blank, but the signer `accessCode` property is set in the envelope, then that value is used.\n\nIf blank and the signer `accessCode` property is not set, then the access code is not required.", + "anchorXOffsetMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorXOffset` property is editable." + }, + "anchorYOffset": { + "description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n", "type": "string" }, - "accessCodeMetadata": { + "anchorYOffsetMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `accessCode` property is editable.\n" + "description": "Metadata that indicates whether the `anchorYOffset` property is editable." }, - "addAccessCodeToEmail": { - "description": "This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient.", + "bold": { + "description": "When set to **true**, the information in the tab is bold.", "type": "string" }, - "agentCanEditEmail": { - "description": "Optional element. When set to true, the agents recipient associated with this recipient can change the recipient's pre-populated email address. This element is only active if enabled for the account.", - "type": "string" + "boldMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `bold` property is editable." }, - "agentCanEditName": { - "description": "Optional element. When set to **true**, the agents recipient associated with this recipient can change the recipient's pre-populated name. This element is only active if enabled for the account.", + "conditionalParentLabel": { + "description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility.", "type": "string" }, - "clientUserId": { - "description": "Specifies whether the recipient is embedded or remote. \n\nIf the `clientUserId` property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing.\n\nNote: if the `clientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true**, an error is generated on sending. \n\nMaximum length: 100 characters. ", - "type": "string" + "conditionalParentLabelMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `conditionalParentLabel` property is editable." }, - "completedCount": { - "description": "Indicates the number of times that the recipient has been through a signing completion for the envelope.\n\nIf this number is greater than 0 for a signing group, only the user who previously completed may sign again.", + "conditionalParentValue": { + "description": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use \"on\" as the value to show that the parent tab is active.\n", "type": "string" }, - "customFields": { - "description": "An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters.", - "type": "array", - "items": { - "type": "string" - } + "conditionalParentValueMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `conditionalParentValue` property is editable." }, - "declinedDateTime": { - "description": "The date and time the recipient declined the document.", + "customTabId": { + "description": "The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.", "type": "string" }, - "declinedReason": { - "description": "The reason the recipient declined the document.", + "customTabIdMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `customTabId` property is editable." + }, + "documentId": { + "description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.", "type": "string" }, - "deliveredDateTime": { - "description": "The date and time that the envelope was delivered to the recipient.", + "documentIdMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `documentId` property is editable." + }, + "errorDetails": { + "$ref": "#/definitions/errorDetails", + "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." + }, + "font": { + "description": "The font to be used for the tab value. Supported fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n", "type": "string" }, - "deliveryMethod": { - "description": "Reserved for DocuSign.", + "fontColor": { + "description": "The font color to use for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n", "type": "string" }, - "deliveryMethodMetadata": { + "fontColorMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "description": "Metadata that indicates whether the `fontColor` property is editable." }, - "documentVisibility": { - "description": "A list of documentVisibility objects, which define a recipient's read/write access to a document.", - "type": "array", - "items": { - "$ref": "#/definitions/documentVisibility" - } + "fontMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `font` property is editable." }, - "email": { - "description": "The email id of the recipient.", + "fontSize": { + "description": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72", "type": "string" }, - "emailMetadata": { + "fontSizeMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the email address of the recipient." - }, - "emailNotification": { - "$ref": "#/definitions/recipientEmailNotification", - "description": "An optional complex type that sets a specific email subject and body for this recipient's notification email. \n\n**Note**: If you use this field to set a specific email notification for one recipient, you must also set the email notification for the other recipients. Using this field for one or more recipients negates the Envelope `Subject` and `EmailBlurb` property settings. " + "description": "Metadata that indicates whether the `fontSize` property is editable." }, - "embeddedRecipientStartURL": { - "description": "Specifies a sender-provided valid URL string for redirecting an embedded recipient. When this option is used, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the recipient clicks the document link in the email, the recipient is redirected through DocuSign to the specified URL to complete the required actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. \n\nIf set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation launched by a partner.\n\nIt is important to understand that in a typical embedded workflow, the authentication of an embedded recipient is the responsibility of the sending application. DocuSign expects that senders will follow their own processes for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process is initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process, bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient.\n\nIf the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: `envelopeId`, `recipientId`, `recipientName`, `recipientEmail`, and `customFields`. The `customFields` property must be set for the recipient or envelope. The merge fields are enclosed in double brackets. \n\n*Example*: \n\n`http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` ", + "formOrder": { + "description": "An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block.", "type": "string" }, - "errorDetails": { - "$ref": "#/definitions/errorDetails", - "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." - }, - "excludedDocuments": { - "description": "Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true** for the envelope to use this.\n\nWhen enforce signer visibility is enabled, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent.", - "type": "array", - "items": { - "type": "string" - } + "formOrderMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `formOrder` property is editable." }, - "faxNumber": { - "description": "Reserved for DocuSign.", + "formPageLabel": { + "description": "A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience.", "type": "string" }, - "faxNumberMetadata": { + "formPageLabelMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `faxNumber` property is editable.\n" + "description": "Metadata that indicates whether the `formPageLabel` property is editable." }, - "firstName": { - "description": "The recipient's first name. Maximum Length: 50 characters.", + "formPageNumber": { + "description": "An integer specifying the order in which to present the guided form pages.", "type": "string" }, - "firstNameMetadata": { + "formPageNumberMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the recipient's first name." + "description": "Metadata that indicates whether the `fromPageNumber` property is editable." }, - "fullName": { - "description": "Reserved for DocuSign.", + "height": { + "description": "The height of the tab in pixels.", "type": "string" }, - "fullNameMetadata": { + "heightMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "description": "Metadata that indicates whether the `height` property is editable." }, - "idCheckConfigurationName": { - "description": "The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting.\n\n**Example**: Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node.", + "italic": { + "description": "When set to **true**, the information in the tab is italic.", "type": "string" }, - "idCheckConfigurationNameMetadata": { + "italicMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the `idCheckConfigurationName` property." + "description": "Metadata that indicates whether the `italic` property is editable." }, - "idCheckInformationInput": { - "$ref": "#/definitions/idCheckInformationInput", - "description": "An object that contains input information related to a recipient ID check." + "localePolicy": { + "$ref": "#/definitions/localePolicyTab", + "description": "Reserved for DocuSign." }, - "inheritEmailNotificationConfiguration": { - "description": "When set to **true** and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account. ", + "mergeField": { + "$ref": "#/definitions/mergeField", + "description": "Contains the information necessary to map the tab to a field in SalesForce." + }, + "mergeFieldXml": { + "description": "", "type": "string" }, - "lastName": { - "description": "The last name of the recipient.", + "name": { + "description": "The name of the tab. For example, `Sign Here` or `Initial Here`.", "type": "string" }, - "lastNameMetadata": { + "nameMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender is able to edit the last name of the recipient." + "description": "Metadata that indicates whether the `name` property is editable. Read only." }, - "lockedRecipientPhoneAuthEditable": { - "description": "Reserved for DocuSign.", + "pageNumber": { + "description": "The page number on which the tab is located.\nFor supplemental documents, this value must be `1`.", "type": "string" }, - "lockedRecipientSmsEditable": { - "description": "Reserved for DocuSign.", + "pageNumberMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `pageNumber` property is editable." + }, + "recipientId": { + "description": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.", "type": "string" }, - "name": { - "description": "The full legal name of the recipient.", + "recipientIdGuid": { + "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only.", "type": "string" }, - "nameMetadata": { + "recipientIdGuidMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `recipientIdGuid` property is editable." + }, + "recipientIdMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the user can edit the full legal name of the recipient." + "description": "Metadata that indicates whether the `recipientId` property is editable." }, - "note": { - "description": "A note sent to the recipient in the signing email.\nThis note is unique to this recipient.\nIn the user interface,\nit appears near the upper left corner\nof the document\non the signing screen.\n\nMaximum Length: 1000 characters.\n", + "smartContractInformation": { + "$ref": "#/definitions/smartContractInformation", + "description": "" + }, + "status": { + "description": "The status of the tab. Possible values are:\n\n- `active`: The tab is active, but the recipient has not yet interacted with it.\n- `signed`: The recipient signed the tab.\n- `declined`: The recipient declined the envelope.\n- `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`).", "type": "string" }, - "noteMetadata": { + "statusMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the note sent to the recipient in the signing email." - }, - "phoneAuthentication": { - "$ref": "#/definitions/recipientPhoneAuthentication", - "description": "A complex type that contains the following elements:\n\n* `recipMayProvideNumber` - Boolean. When set to **true**, the recipient can use whatever phone number they choose.\n* `senderProvidedNumbers` - ArrayOfString. A list of phone numbers the recipient can use.\n* `recordVoicePrint` - Reserved.\n* `validateRecipProvidedNumber` - Reserved." + "description": "Metadata that indicates whether the `status` property is editable." }, - "recipientAttachments": { - "description": "Reserved for DocuSign.", + "tabGroupLabels": { + "description": "An array of tab group labels that uniquely identify tab groups. To assign a tab to a `tabGroup`, you assign the `TabGroupLabel` to the `Tab.TabGroupLabels` array.", "type": "array", "items": { - "$ref": "#/definitions/recipientAttachment" + "type": "string" } }, - "recipientAuthenticationStatus": { - "$ref": "#/definitions/authenticationStatus", - "description": "Information about the recipient's authentication status." + "tabGroupLabelsMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `tabGroupLabels` property is editable." }, - "recipientFeatureMetadata": { - "description": "Metadata about the features that are supported for the recipient type.", - "type": "array", - "items": { - "$ref": "#/definitions/featureAvailableMetadata" - } + "tabId": { + "description": "The unique identifier for the tab.", + "type": "string" }, - "recipientId": { - "description": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.", + "tabIdMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `tabId` property is editable." + }, + "tabLabel": { + "description": "The label associated with the tab. This value may be an empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum Length: 500 characters.\n", "type": "string" }, - "recipientIdGuid": { - "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one.", + "tabLabelMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `tabLabel` property is editable." + }, + "tabOrder": { + "description": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.", "type": "string" }, - "recipientType": { - "description": "The recipient type, as specified by the following values:\n- `agents`: Agent recipients can add name and email information for recipients that appear after the agent in routing order.\n- `carbonCopies`: Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date, or add information to any of the documents. This type of recipient can be used in any routing order.\n- `certifiedDeliveries`: Certified delivery recipients must receive the completed documents for the envelope to be completed. They don't need to sign, initial, date, or add information to any of the documents.\n- `editors`: Editors have the same management and access rights for the envelope as the sender. Editors can add name and email information, add or change the routing order, set authentication options, and can edit signature/initial tabs and data fields for the remaining recipients.\n- `inPersonSigners`: In-person recipients are DocuSign users who act as signing hosts in the same physical location as the signer.\n- `intermediaries`: Intermediary recipients can optionally add name and email information for recipients at the same or subsequent level in the routing order.\n- `seals`: Electronic seal recipients represent legal entities.\n- `signers`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope.\n- `witnesses`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope.", + "tabOrderMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `tabOrder` property is editable." + }, + "tabType": { + "description": "Indicates the type of tab (for example, `signHere` or `initialHere`).", "type": "string" }, - "recipientTypeMetadata": { + "tabTypeMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the recipient type." + "description": "Metadata that indicates whether the `tabType` property is editable." }, - "requireIdLookup": { - "description": "When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. ", + "templateLocked": { + "description": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ", "type": "string" }, - "requireIdLookupMetadata": { + "templateLockedMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `requireIdLookup` property is editable.\n" - }, - "roleName": { - "description": "Optional element. Specifies the role name associated with the recipient.

This is required when working with template recipients.", - "type": "string" + "description": "Metadata that indicates whether the `templateLocked` property is editable." }, - "routingOrder": { - "description": "Specifies the routing order of the recipient in the envelope. ", + "templateRequired": { + "description": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.", "type": "string" }, - "routingOrderMetadata": { + "templateRequiredMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the routing order for the recipient." + "description": "Metadata that indicates whether the `templateRequired` property is editable." }, - "sentDateTime": { - "description": "The date and time the envelope was sent.", + "tooltip": { + "description": "The text of a tooltip that appears when a user hovers over a form field or tab.", "type": "string" }, - "signedDateTime": { - "description": "Reserved for DocuSign.", - "type": "string" + "toolTipMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `toolTip` property is editable." }, - "signingGroupId": { - "description": "The id of the signing group of which the recipient is a member, if applicable.", + "underline": { + "description": "When set to **true**, the information in the tab is underlined.", "type": "string" }, - "signingGroupIdMetadata": { + "underlineMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the signing group id." + "description": "Metadata that indicates whether the `underline` property is editable." }, - "signingGroupName": { - "description": "The display name for the signing group. \n\nMaximum Length: 100 characters. ", + "value": { + "description": "Specifies the value of the tab. ", "type": "string" }, - "signingGroupUsers": { - "description": "A complex type that contains information about users in the signing group.", - "type": "array", - "items": { - "$ref": "#/definitions/userInfo" - } + "valueMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `value` property is editable." }, - "smsAuthentication": { - "$ref": "#/definitions/recipientSMSAuthentication", - "description": "Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication. \n" + "width": { + "description": "The width of the tab in pixels.", + "type": "string" }, - "socialAuthentications": { - "description": " Lists the social ID type that can be used for recipient authentication.", - "type": "array", - "items": { - "$ref": "#/definitions/socialAuthentication" - } + "widthMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `width` property is editable." }, - "status": { - "description": "Recipient status.\n\n", + "xPosition": { + "description": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n", "type": "string" }, - "statusCode": { - "description": "Reserved for DocuSign.", + "xPositionMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `xPosition` property is editable." + }, + "yPosition": { + "description": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n", "type": "string" }, - "templateLocked": { - "description": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ", + "yPositionMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `yPosition` property is editable." + } + }, + "x-ds-definition-name": "dateSigned", + "description": "A tab that displays the date that the recipient signed the\ndocument.\n", + "x-ms-summary": "A tab that displays the date that the recipient signed the\ndocument.\n" + }, + "dateStampProperties": { + "type": "object", + "properties": { + "dateAreaHeight": { + "description": "The height of the rectangle.", "type": "string" }, - "templateRequired": { - "description": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.", + "dateAreaWidth": { + "description": "The width of the rectangle.", "type": "string" }, - "totalTabCount": { - "description": "The total number of tabs in the documents.", + "dateAreaX": { + "description": "The X axis position of the top-left corner.", "type": "string" }, - "userId": { - "description": "The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.\n", + "dateAreaY": { + "description": "The Y axis position of the top-left corner.", "type": "string" } }, - "x-ds-definition-name": "certifiedDelivery", - "description": "", - "x-ms-summary": "" + "x-ds-definition-name": "dateStampProperties", + "description": "Specifies the area in which a date stamp is placed. This parameter uses pixel positioning to draw a rectangle at the center of the stamp area. The stamp is superimposed on top of this central area.\n\nThis property contains the following information about the central rectangle:\n\n- `DateAreaX`: The X axis position of the top-left corner.\n- `DateAreaY`: The Y axis position of the top-left corner.\n- `DateAreaWidth`: The width of the rectangle.\n- `DateAreaHeight`: The height of the rectangle.", + "x-ms-summary": "Specifies the area in which a date stamp is placed. This parameter uses pixel positioning to draw a rectangle at the center of the stamp area. The stamp is superimposed on top of this central area.\n\nThis property contains the following information about the central rectangle:\n\n- `DateAreaX`: The X axis position of the top-left corner.\n- `DateAreaY`: The Y axis position of the top-left corner.\n- `DateAreaWidth`: The width of the rectangle.\n- `DateAreaHeight`: The height of the rectangle." }, - "checkbox": { + "decline": { "type": "object", "properties": { + "anchorAllowWhiteSpaceInCharacters": { + "description": "", + "type": "string" + }, + "anchorAllowWhiteSpaceInCharactersMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "" + }, "anchorCaseSensitive": { - "description": "Reserved for DocuSign.\n", + "description": "This property controls how [anchor tabs][AnchorTabs] are placed. When **true**, the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false**.\n\nFor example, when set to **true**, if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When set to **false**, `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**.\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place", "type": "string" }, "anchorCaseSensitiveMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "description": "Metadata that indicates whether the `anchorCaseSensitive` property is editable." }, "anchorHorizontalAlignment": { - "description": "Reserved for DocuSign.\n\n", + "description": "This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are :\n\n- `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value.\n- `right`: Aligns the tab’s left side with the last character of the matching anchor word.\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place\n", "type": "string" }, "anchorHorizontalAlignmentMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "description": "Metadata that indicates whether the `anchorHorizontalAlignment` property is editable." }, "anchorIgnoreIfNotPresent": { "description": "When set to **true**, this tab is ignored if the `anchorString` is not found in the document.", @@ -25169,12 +35936,12 @@ "description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable." }, "anchorMatchWholeWord": { - "description": "Reserved for DocuSign.\n\n", + "description": "When set to **true**, the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false**.\n\nFor example, when set to **true**, if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When set to **false**, if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**.\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTab]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place\n", "type": "string" }, "anchorMatchWholeWordMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "description": "Metadata that indicates whether the `anchorMatchWholeWord` property is editable." }, "anchorString": { "description": "Specifies the string to find in the document and use as the basis for tab placement.", @@ -25193,7 +35960,7 @@ "description": "Reserved for DocuSign." }, "anchorUnits": { - "description": "Specifies the units of the X and Y offset. Units may be pixels, millimeters, centimeters, or inches.", + "description": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n", "type": "string" }, "anchorUnitsMetadata": { @@ -25201,7 +35968,7 @@ "description": "Metadata that indicates whether the `anchorUnits` property is editable." }, "anchorXOffset": { - "description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.", + "description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n", "type": "string" }, "anchorXOffsetMetadata": { @@ -25209,7 +35976,7 @@ "description": "Metadata that indicates whether the `anchorXOffset` property is editable." }, "anchorYOffset": { - "description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.", + "description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n", "type": "string" }, "anchorYOffsetMetadata": { @@ -25224,6 +35991,14 @@ "$ref": "#/definitions/propertyMetadata", "description": "Metadata that indicates whether the `bold` property is editable." }, + "buttonText": { + "description": " Specifies the decline text displayed in the tab.", + "type": "string" + }, + "buttonTextMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `buttonText` property is editable." + }, "conditionalParentLabel": { "description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility.", "type": "string" @@ -25241,15 +36016,23 @@ "description": "Metadata that indicates whether the `conditionalParentValue` property is editable." }, "customTabId": { - "description": "The DocuSign-generated custom tab ID for the custom tab to apply. This property can only be used when adding new tabs for a recipient. When used, the new tab inherits all custom tab properties.", + "description": "The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.", "type": "string" }, "customTabIdMetadata": { "$ref": "#/definitions/propertyMetadata", "description": "Metadata that indicates whether the `customTabId` property is editable." }, + "declineReason": { + "description": "The reason the recipient declined the document.", + "type": "string" + }, + "declineReasonMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `declineReason` property is editable." + }, "documentId": { - "description": "Integer that identifies the document in the envelope.", + "description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.", "type": "string" }, "documentIdMetadata": { @@ -25324,26 +36107,18 @@ "$ref": "#/definitions/propertyMetadata", "description": "Metadata that indicates whether the `italic` property is editable." }, - "locked": { - "description": "When set to **true**, the signer cannot change the data of the custom tab.", - "type": "string" - }, - "lockedMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `locked` property is editable." + "localePolicy": { + "$ref": "#/definitions/localePolicyTab", + "description": "Reserved for DocuSign." }, "mergeField": { "$ref": "#/definitions/mergeField", "description": "Contains the information necessary to map the tab to a field in SalesForce." }, - "name": { - "description": "The name of the tab. For example, `Sign Here` or `Initial Here`.", + "mergeFieldXml": { + "description": "", "type": "string" }, - "nameMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `name` property is editable." - }, "pageNumber": { "description": "The page number on which the tab is located.\nFor supplemental documents, this value must be `1`.", "type": "string" @@ -25353,11 +36128,11 @@ "description": "Metadata that indicates whether the `pageNumber` property is editable." }, "recipientId": { - "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", + "description": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.", "type": "string" }, "recipientIdGuid": { - "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one.", + "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only.", "type": "string" }, "recipientIdGuidMetadata": { @@ -25368,37 +36143,9 @@ "$ref": "#/definitions/propertyMetadata", "description": "Metadata that indicates whether the `recipientId` property is editable." }, - "required": { - "description": "This property does not apply to `checkbox` tabs. Check boxes are always optional.", - "type": "string" - }, - "requiredMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `required` property is editable." - }, - "requireInitialOnSharedChange": { - "description": "Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.", - "type": "string" - }, - "requireInitialOnSharedChangeMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `requireInitialOnSharedChange` property is editable." - }, - "selected": { - "description": "When **true**, the checkbox is selected.", - "type": "string" - }, - "selectedMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `selected` property is editable." - }, - "shared": { - "description": "When **true**, this tab is shared.", - "type": "string" - }, - "sharedMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `shared` property is editable.\n" + "smartContractInformation": { + "$ref": "#/definitions/smartContractInformation", + "description": "" }, "status": { "description": "The status of the tab. Possible values are:\n\n- `active`: The tab is active, but the recipient has not yet interacted with it.\n- `signed`: The recipient signed the tab.\n- `declined`: The recipient declined the envelope.\n- `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`).", @@ -25428,7 +36175,7 @@ "description": "Metadata that indicates whether the `tabId` property is editable." }, "tabLabel": { - "description": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n", + "description": "The label associated with the tab. This value may be an empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum Length: 500 characters.\n", "type": "string" }, "tabLabelMetadata": { @@ -25492,7 +36239,7 @@ "description": "Metadata that indicates whether the `width` property is editable." }, "xPosition": { - "description": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n", + "description": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n", "type": "string" }, "xPositionMetadata": { @@ -25500,7 +36247,7 @@ "description": "Metadata that indicates whether the `xPosition` property is editable." }, "yPosition": { - "description": "This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.", + "description": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n", "type": "string" }, "yPositionMetadata": { @@ -25508,670 +36255,711 @@ "description": "Metadata that indicates whether the `yPosition` property is editable." } }, - "x-ds-definition-name": "checkbox", - "description": "A tab that allows the recipient to select a yes/no (on/off) option.\n", - "x-ms-summary": "A tab that allows the recipient to select a yes/no (on/off) option.\n" + "x-ds-definition-name": "decline", + "description": "A tab that allows the recipient the option of declining an\nenvelope. If the recipient clicks the tab during the signing\nprocess, the envelope is voided.\n", + "x-ms-summary": "A tab that allows the recipient the option of declining an\nenvelope. If the recipient clicks the tab during the signing\nprocess, the envelope is voided.\n" }, - "chunkedUploadPart": { + "diagnosticsSettingsInformation": { "type": "object", "properties": { - "sequence": { - "description": "The order of the part in the chunked upload.", + "apiRequestLogging": { + "description": " When set to **true**, enables API request logging for the user. ", "type": "string" }, - "size": { - "description": "The size of the part in bytes. \n\nWe recommend that a chunked upload part is no larger than a few MB in size.", + "apiRequestLogMaxEntries": { + "description": "Specifies the maximum number of API requests to log.", + "type": "string" + }, + "apiRequestLogRemainingEntries": { + "description": "Indicates the remaining number of API requests that can be logged.", "type": "string" } }, - "x-ds-definition-name": "chunkedUploadPart", - "description": "An object that contains information about the chunked upload part.", - "x-ms-summary": "An object that contains information about the chunked upload part." + "x-ds-definition-name": "diagnosticsSettingsInformation", + "description": "", + "x-ms-summary": "" }, - "chunkedUploadRequest": { + "directDebitProcessorInformation": { "type": "object", "properties": { - "chunkedUploadId": { - "description": "The id of the chunked upload.\n\n**Note**: This property is ignored in requests, and overridden with an auto-generated value in responses.", + "bankBranchCode": { + "description": "The branch code of the bank used for direct debit.\n\nMaximum Length: 10 characters.", "type": "string" }, - "data": { - "description": "A Base64-encoded representation of the content hat is used to upload the file. \n\nMaximum size: 50 MB. However, data is also subject to REST API limits regarding request sizes, and Internet Information Systems (IIS) might place further constraints on file size.", + "bankCheckDigit": { + "description": "The check digit or digits in the international bank account number. These digits are used to confirm the validity of the account.\n\nMaximum Length: 4 characters.", + "type": "string" + }, + "bankCode": { + "description": "The code or number that identifies the bank. This is also known as the sort code.\n\nExample: `200000`\n\nMaximum Length: 18 characters.", + "type": "string" + }, + "bankName": { + "description": "The name of the direct debit bank.\n\nMaximum Length: 80 characters.", + "type": "string" + }, + "bankTransferAccountName": { + "description": "The name on the direct debit bank account. This field is required for POST and PUT requests.\n\nMaximum Length: 60 characters.", + "type": "string" + }, + "bankTransferAccountNumber": { + "description": "The customer's bank account number. This value will be obfuscated. This field is required for POST and PUT requests.\n\nMaximum Length: 30 characters.", + "type": "string" + }, + "bankTransferType": { + "description": "Specifies the type of direct debit transfer. The value of this field is dependent on the user's country. This field is required for POST and PUT requests. Possible values are:\n\n- `DirectDebitUK`\n- `DirectEntryAU`\n- `SEPA`", + "type": "string" + }, + "country": { + "description": "The user's country. The system populates this value automatically.\n\n", + "type": "string" + }, + "email": { + "description": "The email address of the user who is associated with the payment method. This field is required for POST and PUT requests.\n\nMaximum Length: 80 characters.", + "type": "string" + }, + "firstName": { + "description": "The user's first name. This field is required for POST and PUT requests.\n\nMaximum Length: 30 characters.", + "type": "string" + }, + "iBAN": { + "description": "The International Bank Account Number (IBAN). \n\nExample: `DE89370400440532013000`\n\nFor more information, see [PeopleSoft's guide to Setting Up Banks](https://docs.oracle.com/cd/E16365_01/fscm91pbr0/eng/psbooks/fsbk/chapter.htm?File=fsbk/htm/fsbk03.htm).\n\n**Note**: This number will be obfuscated.", + "type": "string" + }, + "lastName": { + "description": "The user's last name. This field is required for POST and PUT requests.\n\nMaximum Length: 70 characters.", "type": "string" } }, - "x-ds-definition-name": "chunkedUploadRequest", - "description": "This is the request object for uploading a chunked upload.", - "x-ms-summary": "This is the request object for uploading a chunked upload." + "x-ds-definition-name": "directDebitProcessorInformation", + "description": "Contains information about a bank that processes a customer's direct debit payments.", + "x-ms-summary": "Contains information about a bank that processes a customer's direct debit payments." }, - "chunkedUploadResponse": { + "displayApplianceAccount": { "type": "object", "properties": { - "checksum": { - "description": "A 64-byte, Secure Hash Algorithm 256 (SHA256) checksum that the caller computes across the entirety of the original content that has been uploaded to the chunked upload. DocuSign compares this value to its own computation. If the two values are not equal, the original content and received content are not the same and the commit action is refused.", + "accountId": { + "description": "The account ID associated with the envelope.", "type": "string" }, - "chunkedUploadId": { - "description": "The id of the chunked upload. ", + "optOutAutoNavTextAndTabColorUpdates": { + "description": "Boolean that allows envelope senders to opt out of the recipient signing auto-navigation feature and opt out of updating tab font color.", + "type": "boolean" + }, + "showInitialConditionalFields": { + "description": "Boolean that specifies whether conditional field options are initially displayed (before a user makes entries).", + "type": "boolean" + }, + "signingVersion": { + "description": "", "type": "string" }, - "chunkedUploadParts": { - "description": "A list of the parts that compose the chunked upload, including their byte sizes. The list must be contiguous before you can commit the chunked upload.", + "tagHasSigBlock": { + "description": "", + "type": "boolean" + } + }, + "x-ds-definition-name": "displayApplianceAccount", + "description": "", + "x-ms-summary": "" + }, + "displayApplianceInfo": { + "type": "object", + "properties": {}, + "x-ds-definition-name": "displayApplianceInfo", + "description": "", + "x-ms-summary": "" + }, + "displayAppliancePdf": { + "type": "object", + "properties": {}, + "x-ds-definition-name": "displayAppliancePdf", + "description": "", + "x-ms-summary": "" + }, + "displayApplianceSignerAttachment": { + "type": "object", + "properties": {}, + "x-ds-definition-name": "displayApplianceSignerAttachment", + "description": "", + "x-ms-summary": "" + }, + "dobInformationInput": { + "description": "Complex type containing:\n\n* dateOfBirth\n* displayLevelCode\n* receiveInResponse", + "type": "object", + "properties": { + "dateOfBirth": { + "description": "Specifies the recipient's date, month, and year of birth.", + "type": "string" + }, + "displayLevelCode": { + "description": "Specifies the display level for the recipient. Valid values are:\n* `ReadOnly`\n* `Editable`\n* `DoNotDisplay`", + "type": "string" + }, + "receiveInResponse": { + "description": "A Boolean value that specifies whether the information must be returned in the response.", + "type": "string" + } + }, + "x-ds-definition-name": "dobInformationInput", + "x-ms-summary": "Complex type containing:\n\n* dateOfBirth\n* displayLevelCode\n* receiveInResponse" + }, + "document": { + "type": "object", + "properties": { + "applyAnchorTabs": { + "description": "Reserved for DocuSign.", + "type": "string" + }, + "assignTabsToRecipientId": { + "description": "", + "type": "string" + }, + "display": { + "description": "This string sets the display and behavior properties of\nthe document during signing. The possible values are:\n\n* `modal`
\n The document is shown as a supplement action strip\n and can be viewed, downloaded, or printed in a modal window.\n This is the recommended value for supplemental documents. \n\n* `download`
\n The document is shown as a supplement action strip\n and can be viewed, downloaded, or printed in a new browser window. \n\n* `inline`
\n The document is shown in the normal signing window.\n This value is not used with supplemental documents,\n but is the default value for all other documents.\n", + "type": "string" + }, + "documentBase64": { + "description": "The document's bytes. This field can be used to include a base64 version of the document bytes within an envelope definition instead of sending the document using a multi-part HTTP request. The maximum document size is smaller if this field is used due to the overhead of the base64 encoding.", + "type": "string" + }, + "documentFields": { + "description": "The array of name/value custom data strings to be added to a document. Custom document field information is returned in the status, but otherwise is not used by DocuSign. The array contains the elements: \n\n* name – A string that can be a maximum of 50 characters. \n* value – A string that can be a maximum of 200 characters.\n\n*IMPORTANT*: If you are using xml, the name/value pair is contained in a nameValue element. \n", "type": "array", "items": { - "$ref": "#/definitions/chunkedUploadPart" + "$ref": "#/definitions/nameValue" } }, - "chunkedUploadUri": { - "description": "The URI that you use to reference the chunked upload in other API requests, such as envelope document and envelope attachment requests. ", + "documentId": { + "description": "Specifies the document ID of this document. This value is used by tabs to determine which document they appear in.", "type": "string" }, - "committed": { - "description": "When **true**, the chunked upload has been committed. A committed chunked upload can no longer receive any additional parts and is ready for use within other API requests. ", + "encryptedWithKeyManager": { + "description": "When set to **true**, the document is been already encrypted by the sender for use with the DocuSign Key Manager Security Appliance.\n ", "type": "string" }, - "expirationDateTime": { - "description": "The UTC time at which the chunked upload expires and is no longer addressable. ", + "fileExtension": { + "description": "The file extension type of the document. Non-PDF documents are converted to PDF.\n\nIf the document is not a PDF, `fileExtension` is required.\n\nIf you try to upload a non-PDF document without a `fileExtension`, you will receive an \"unable to load document\" error message. \n ", "type": "string" }, - "maxChunkedUploadParts": { - "description": "The maximum number of parts allowed for a chunked upload. This value is configurable per DocuSign environment, account, or integrator. The default value is 128. The maximum possible value is 256. ", + "fileFormatHint": { + "description": "", "type": "string" }, - "maxTotalSize": { - "description": "The maximum total size allowed for a chunked upload. This value is configured per DocuSign environment, account, or integrator. The default value is 50 MB.", + "htmlDefinition": { + "$ref": "#/definitions/documentHtmlDefinition", + "description": "" + }, + "includeInDownload": { + "description": "When set to **true**,\nthe document is included in the combined document download (`documentsCombinedUri`). \nThe default value is **true**.\n", "type": "string" }, - "totalSize": { - "description": "The total size of the parts of the chunked upload.\n\n**Note**: When a chunked upload is used as an envelope document, it is subject to the PDF size limit (25 MB) and page count limit that apply to all envelope documents.", + "matchBoxes": { + "description": "Matchboxes define areas in a document for document matching when you are creating envelopes. They are only used when you upload and edit a template. \n\nA matchbox consists of 5 elements:\n\n* pageNumber - The document page number on which the matchbox will appear. \n* xPosition - The x position of the matchbox on a page. \n* yPosition - The y position of the matchbox on a page.\n* width - The width of the matchbox. \n* height - The height of the matchbox. \n", + "type": "array", + "items": { + "$ref": "#/definitions/matchBox" + } + }, + "name": { + "description": "The name of the document.", "type": "string" - } - }, - "x-ds-definition-name": "chunkedUploadResponse", - "description": "This response object is returned after you upload a chunked upload.", - "x-ms-summary": "This response object is returned after you upload a chunked upload." - }, - "cloudStorageProvider": { - "type": "object", - "properties": { - "authenticationUrl": { - "description": "The authentication URL used for the cloud storage provider. This information is only included in the response if the user has not passed authentication for the cloud storage provider. If the redirectUrl query string is provided, the returnUrl is appended to the authenticationUrl. ", + }, + "order": { + "description": "(Optional) The order in which to sort the results.\n\nValid values are: \n\n\n* `asc`: Ascending order.\n* `desc`: Descending order. ", "type": "string" }, - "errorDetails": { - "$ref": "#/definitions/errorDetails", - "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." + "pages": { + "description": "An array of page objects.", + "type": "string" }, - "redirectUrl": { - "description": "The URL the user is redirected to after the cloud storage provider authenticates the user. Using this will append the redirectUrl to the authenticationUrl.\n\nThe redirectUrl is restricted to URLs in the docusign.com or docusign.net domains.", + "password": { + "description": "The user's encrypted password hash.", "type": "string" }, - "service": { - "description": "The service name for the cloud storage provider.", + "pdfFormFieldOption": { + "description": "", "type": "string" }, - "serviceId": { - "description": "The DocuSign generated ID for the cloud storage provider", + "remoteUrl": { + "description": "The file id from the cloud storage service where\nthe document is located. This information is\nreturned using\n[CloudStorage::listFolders](https://developers.docusign.com/docs/esign-rest-api/reference/CloudStorage/CloudStorage/listFolders/) or\n[CloudStorage::list](https://developers.docusign.com/docs/esign-rest-api/reference/CloudStorage/CloudStorage/list/).\n", + "type": "string" + }, + "signerMustAcknowledge": { + "description": "Sets how the signer interacts with the supplemental document.\nThe possible values are: \n\n*\t`no_interaction`
\n No recipient action is required. \n\n*\t`view`
\n The recipient is required to view the document. \n\n*\t`accept`
\n The recipient is required to accept the document by selecting accept during signing, but is not required to view the document. \n\n*\t`view_accept`
\n The recipient is required to view and accept the document. \n\n", + "type": "string" + }, + "signerMustAcknowledgeUseAccountDefault": { + "description": "", + "type": "boolean" + }, + "tabs": { + "$ref": "#/definitions/EnvelopeRecipientTabs", + "description": "A list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients." + }, + "templateLocked": { + "description": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ", + "type": "string" + }, + "templateRequired": { + "description": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.", + "type": "string" + }, + "transformPdfFields": { + "description": "When set to **true**, PDF form field data is transformed into document tab values when the PDF form field name matches the DocuSign custom tab tabLabel. The resulting PDF form data is also returned in the PDF meta data when requesting the document PDF.\n", + "type": "string" + }, + "uri": { + "description": "A URI containing the user ID.", "type": "string" } }, - "x-ds-definition-name": "cloudStorageProvider", - "description": "", - "x-ms-summary": "" + "x-ds-definition-name": "document", + "description": "A document object.", + "x-ms-summary": "A document object." }, - "cloudStorageProviders": { + "documentFieldsInformation": { "type": "object", "properties": { - "storageProviders": { - "description": "An Array containing the storage providers associated with the user.", + "documentFields": { + "description": "The array of name/value custom data strings to be added to a document. Custom document field information is returned in the status, but otherwise is not used by DocuSign. The array contains the elements: \n\n* name – A string that can be a maximum of 50 characters. \n* value – A string that can be a maximum of 200 characters.\n\n*IMPORTANT*: If you are using xml, the name/value pair is contained in a nameValue element. \n", "type": "array", "items": { - "$ref": "#/definitions/cloudStorageProvider" + "$ref": "#/definitions/nameValue" } } }, - "x-ds-definition-name": "cloudStorageProviders", + "x-ds-definition-name": "documentFieldsInformation", "description": "", "x-ms-summary": "" }, - "comment": { + "documentHtmlCollapsibleDisplaySettings": { "type": "object", "properties": { - "envelopeId": { - "description": "The Guid of the envelope the comment thread belongs to.", + "arrowClosed": { + "description": "", "type": "string" }, - "hmac": { - "description": "Reserved for DocuSign.", + "arrowColor": { + "description": "", "type": "string" }, - "id": { - "description": "The unique identifier for the comment.", + "arrowLocation": { + "description": "", "type": "string" }, - "mentions": { - "description": "An array of userIds that are mentioned directly in the body of a comment.", - "type": "array", - "items": { - "type": "string" - } - }, - "read": { - "description": "When **true**, indicates that the comment was read.", - "type": "boolean" - }, - "sentByEmail": { - "description": "The email address of the user who created the comment.", + "arrowOpen": { + "description": "", "type": "string" }, - "sentByFullName": { - "description": "The full name of the user who created the comment.", + "arrowSize": { + "description": "", "type": "string" }, - "sentByImageId": { - "description": "Reserved for DocuSign.", + "arrowStyle": { + "description": "", "type": "string" }, - "sentByInitials": { - "description": "The initials of the user who created the comment.", + "containerStyle": { + "description": "", "type": "string" }, - "sentByRecipientId": { - "description": "The recipient id of the user who created the comment.", + "labelStyle": { + "description": "", "type": "string" }, - "sentByUserId": { - "description": "The user id of the user who created the comment.", - "type": "string" + "onlyArrowIsClickable": { + "description": "", + "type": "boolean" }, - "signingGroupId": { - "description": "The id of the signing group that can view the comment or that created the comment.", + "outerLabelAndArrowStyle": { + "description": "", + "type": "string" + } + }, + "x-ds-definition-name": "documentHtmlCollapsibleDisplaySettings", + "description": "", + "x-ms-summary": "" + }, + "documentHtmlDefinition": { + "type": "object", + "properties": { + "displayAnchorPrefix": { + "description": "Contains text that all display anchors must start with. Using at least 4 characters will improve anchor processing performance.", "type": "string" }, - "signingGroupName": { - "description": "The display name for the signing group. \n\nMaximum Length: 100 characters. ", + "displayAnchors": { + "description": "An object that defines how to handle a section of the HTML in signing. This property enables an incoming request to make a section of the HTML collapsible and expandable or hidden from view. A start anchor, end anchor, or both are required. If the anchors are not found, the display anchor will be ignored. For a list of the available types, see the `display` enum.", + "type": "array", + "items": { + "$ref": "#/definitions/documentHtmlDisplayAnchor" + } + }, + "displayOrder": { + "description": "The position on the page where the display section appears.", "type": "string" }, - "subject": { - "description": "The subject of the envelope.", + "displayPageNumber": { + "description": "The number of the page on which the display section appears.", "type": "string" }, - "tabId": { - "description": "The unique identifier for the tab that represents the comment thread.", + "documentGuid": { + "description": "The GUID of the document.", "type": "string" }, - "text": { - "description": "The content of the comment, as UTF-8 text. \n\nMaximum Length: 500 characters.\n\n**Note**: The maximum size allowed for the entire message body is 32 KB. ", + "documentId": { + "description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.", "type": "string" }, - "threadId": { - "description": "The unique identifier for the comment thread.", + "headerLabel": { + "description": "Header text or an HTML tag to place above the responsive HTML block.", "type": "string" }, - "threadOriginatorId": { - "description": "The userId of the user who created the thread.", + "maxScreenWidth": { + "description": "If set, the responsive HTML version of the signing document will only display on screens with the specified pixel width or less. If the screen is larger than the value that you specify, the default PDF version of the content displays instead.", "type": "string" }, - "timestamp": { - "description": "The time the comment was created.", + "removeEmptyTags": { + "description": "Holds a comma-separated list of HTML tags to remove if they have no text within their node (including child nodes).", "type": "string" }, - "timeStampFormatted": { - "description": "The time the comment was created, formatted according to the format of the user who created the comment.", + "showMobileOptimizedToggle": { + "description": "When set to **true**, the **Mobile-Friendly** toggle displays at the top of the screen on the user's mobile device. This toggle enables the user to switch between the mobile-friendly and PDF versions of a document. For example, the recipient can use this toggle to review the document using the PDF view before they finish signing.", "type": "string" }, - "visibleTo": { - "description": "The user ids of the users that the comment is visible to.", - "type": "array", - "items": { - "type": "string" - } + "source": { + "description": "Specifies the type of responsive signing that will be used with the document. Valid strings are:\n\n- `document`: The HTML signing page will be generated from the provided document. For details, see [Converting a PDF to a signable HTML document](https://developers.docusign.com/esign-rest-api/guides/responsive-signing/converting-pdf).\n- `html`: The HTML signing page will be passed directly. For details, see [Converting a PDF to a signable HTML document](https://developers.docusign.com/esign-rest-api/guides/responsive-signing/converting-pdf).", + "type": "string" } }, - "x-ds-definition-name": "comment", - "description": "", - "x-ms-summary": "" + "x-ds-definition-name": "documentHtmlDefinition", + "description": "Holds the properties that define how to generate the responsive-formatted HTML for the document.", + "x-ms-summary": "Holds the properties that define how to generate the responsive-formatted HTML for the document." }, - "commentHistoryResult": { + "documentHtmlDefinitionOriginal": { "type": "object", "properties": { - "comments": { - "description": "An array of comment tabs that contain information about users' comments on documents.", - "type": "array", - "items": { - "$ref": "#/definitions/comment" - } - }, - "count": { - "format": "int32", - "description": "The maximum number of results to return.", - "type": "integer" - }, - "endTimetoken": { - "description": "", + "documentId": { + "description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.", "type": "string" }, - "startTimetoken": { - "description": "", + "documentIdGuid": { + "description": "The GUID of the document.", "type": "string" + }, + "htmlDefinition": { + "$ref": "#/definitions/documentHtmlDefinition", + "description": "" } }, - "x-ds-definition-name": "commentHistoryResult", + "x-ds-definition-name": "documentHtmlDefinitionOriginal", "description": "", "x-ms-summary": "" }, - "commentPublish": { + "documentHtmlDefinitionOriginals": { "type": "object", "properties": { - "id": { - "description": "A unique ID for the Salesforce object.", - "type": "string" - }, - "mentions": { - "description": "An array of userIds that are mentioned directly in the body of a comment.", - "type": "array", - "items": { - "type": "string" - } - }, - "text": { - "description": "Specifies the text that is shown in the dropdown list. ", - "type": "string" - }, - "threadAnchorKeys": { - "description": "", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "threadId": { - "description": "The unique identifier for the comment thread.", - "type": "string" - }, - "visibleTo": { - "description": "", + "htmlDefinitions": { + "description": "Holds the properties that define how to generate the responsive-formatted HTML for the document.", "type": "array", "items": { - "type": "string" + "$ref": "#/definitions/documentHtmlDefinitionOriginal" } } }, - "x-ds-definition-name": "commentPublish", + "x-ds-definition-name": "documentHtmlDefinitionOriginals", "description": "", "x-ms-summary": "" }, - "commentsPublish": { + "documentHtmlDefinitions": { "type": "object", "properties": { - "commentsToPublish": { - "description": "", + "htmlDefinitions": { + "description": "Holds the properties that define how to generate the responsive-formatted HTML for the document.", "type": "array", "items": { - "$ref": "#/definitions/commentPublish" + "type": "string" } } }, - "x-ds-definition-name": "commentsPublish", + "x-ds-definition-name": "documentHtmlDefinitions", "description": "", "x-ms-summary": "" }, - "commentThread": { + "documentHtmlDisplayAnchor": { "type": "object", "properties": { - "anchorCaseSensitive": { - "description": "Reserved for DocuSign.\n", - "type": "string" + "caseSensitive": { + "description": "When set to **true**, the start or end anchor strings must match the strings specified by the start and end anchor settings in case as well as in content.", + "type": "boolean" }, - "anchorCaseSensitiveMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "displaySettings": { + "$ref": "#/definitions/documentHtmlDisplaySettings", + "description": "This object defines how the HTML section inside the `startAnchor` and `endAnchor` displays." }, - "anchorHorizontalAlignment": { - "description": "Reserved for DocuSign.\n\n", + "endAnchor": { + "description": "Specifies the end of the area in the HTML where the display settings will be applied. If you do not specify an end anchor, the end of the document will be used by default.\n\n**Note**: A start anchor, an end anchor, or both are required.", "type": "string" }, - "anchorHorizontalAlignmentMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." - }, - "anchorIgnoreIfNotPresent": { - "description": "When set to **true**, this tab is ignored if the `anchorString` is not found in the document.", - "type": "string" + "removeEndAnchor": { + "description": "When **true**, removes the end anchor string for the Smart Section from the HTML, preventing it from displaying.", + "type": "boolean" }, - "anchorIgnoreIfNotPresentMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable." + "removeStartAnchor": { + "description": "When **true**, removes the start anchor string for the Smart Section from the HTML, preventing it from displaying.", + "type": "boolean" }, - "anchorMatchWholeWord": { - "description": "Reserved for DocuSign.\n\n", + "startAnchor": { + "description": "Specifies the beginning of the area in the HTML where the display settings will be applied. If you do not specify a start anchor, the beginning of the document will be used by default.\n\n**Note**: A start anchor, an end anchor, or both are required.", "type": "string" - }, - "anchorMatchWholeWordMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." - }, - "anchorString": { - "description": "Specifies the string to find in the document and use as the basis for tab placement.", + } + }, + "x-ds-definition-name": "documentHtmlDisplayAnchor", + "description": "", + "x-ms-summary": "" + }, + "documentHtmlDisplaySettings": { + "type": "object", + "properties": { + "cellStyle": { + "description": "Specifies the valid CSS-formatted styles to use on responsive table cells. Only valid in display sections of `responsive_table` or `responsive_table_single_column` types.", "type": "string" }, - "anchorStringMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `anchorString` property is editable." + "collapsibleSettings": { + "$ref": "#/definitions/documentHtmlCollapsibleDisplaySettings", + "description": "This object defines the appearance and function of a collapsible section or item." }, - "anchorTabProcessorVersion": { - "description": "Reserved for DocuSign.", + "display": { + "description": "This string sets the display and behavior properties of\nthe document during signing. The possible values are:\n\n* `modal`
\n The document is shown as a supplement action strip\n and can be viewed, downloaded, or printed in a modal window.\n This is the recommended value for supplemental documents. \n\n* `download`
\n The document is shown as a supplement action strip\n and can be viewed, downloaded, or printed in a new browser window. \n\n* `inline`
\n The document is shown in the normal signing window.\n This value is not used with supplemental documents,\n but is the default value for all other documents.\n", "type": "string" }, - "anchorTabProcessorVersionMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." - }, - "anchorUnits": { - "description": "Specifies the units of the X and Y offset. Units may be pixels, millimeters, centimeters, or inches.", + "displayLabel": { + "description": "The label for the display section.", "type": "string" }, - "anchorUnitsMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `anchorUnits` property is editable." + "displayOrder": { + "format": "int32", + "description": "The position on the page where the display section appears.", + "type": "integer" }, - "anchorXOffset": { - "description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.", - "type": "string" + "displayPageNumber": { + "format": "int32", + "description": "The number of the page on which the display section appears.", + "type": "integer" }, - "anchorXOffsetMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `anchorXOffset` property is editable." + "hideLabelWhenOpened": { + "description": "When **true**, the `displayLabel` is hidden when the display section is expanded and the display section is no longer collapsible. This property is valid only when the value of the `display` property is `collapsed`.", + "type": "boolean" }, - "anchorYOffset": { - "description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.", + "inlineOuterStyle": { + "description": "Specifies the valid CSS-formatted styles to use on inline display sections. This property is valid only when the value of the `display` property is `inline`.", "type": "string" }, - "anchorYOffsetMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `anchorYOffset` property is editable." - }, - "bold": { - "description": "When set to **true**, the information in the tab is bold.", + "labelWhenOpened": { + "description": "The label for the display section when it is expanded from a collapsed state. This label displays only on the first opening and is only valid with the value of the `display` property is `collapsed`.", "type": "string" }, - "boldMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `bold` property is editable." - }, - "comments": { - "description": "An array of comment tabs that contain information about users' comments on documents.", - "type": "array", - "items": { - "$ref": "#/definitions/comment" - } - }, - "conditionalParentLabel": { - "description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility.", + "preLabel": { + "description": "Enables you to add descriptive text that appears before a collapsed section or continue button.", "type": "string" }, - "conditionalParentLabelMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `conditionalParentLabel` property is editable." + "scrollToTopWhenOpened": { + "description": "When **true** and the section is expanded, the position of the section close is scrolled to the top of the screen. This property is only valid when the value of the `display` property is `collapsed`.", + "type": "boolean" }, - "conditionalParentValue": { - "description": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use \"on\" as the value to show that the parent tab is active.\n", + "tableStyle": { + "description": "Specifies the valid CSS-formatted styles to use on responsive tables. This property is valid only when the value of the `display` property is `responsive_table` or `responsive_table_single_column`.", "type": "string" - }, - "conditionalParentValueMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `conditionalParentValue` property is editable." - }, - "customTabId": { - "description": "The DocuSign-generated custom tab id for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.", + } + }, + "x-ds-definition-name": "documentHtmlDisplaySettings", + "description": "", + "x-ms-summary": "" + }, + "documentTemplate": { + "type": "object", + "properties": { + "documentEndPage": { + "description": "", "type": "string" }, - "customTabIdMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `customTabId` property is editable." - }, "documentId": { - "description": "Integer that identifies the document in the envelope.", + "description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.", "type": "string" }, - "documentIdMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `documentId` property is editable." + "documentStartPage": { + "description": "", + "type": "string" }, "errorDetails": { "$ref": "#/definitions/errorDetails", "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." }, - "font": { - "description": "The font to be used for the tab value. Supported fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n", - "type": "string" - }, - "fontColor": { - "description": "The font color to use for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n", - "type": "string" - }, - "fontColorMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `fontColor` property is editable." - }, - "fontMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `font` property is editable." - }, - "fontSize": { - "description": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72", - "type": "string" - }, - "fontSizeMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `fontSize` property is editable." - }, - "formOrder": { - "description": "An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block.", - "type": "string" - }, - "formOrderMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `formOrder` property is editable." - }, - "formPageLabel": { - "description": "A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience.", - "type": "string" - }, - "formPageLabelMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `formPageLabel` property is editable." - }, - "formPageNumber": { - "description": "An integer specifying the order in which to present the guided form pages.", - "type": "string" - }, - "formPageNumberMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `fromPageNumber` property is editable." - }, - "height": { - "description": "The height of the tab in pixels.", - "type": "string" - }, - "heightMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `height` property is editable." - }, - "italic": { - "description": "When set to **true**, the information in the tab is italic.", + "templateId": { + "description": "The unique identifier of the template. If this is not provided, DocuSign generates an error and the call fails.", "type": "string" - }, - "italicMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `italic` property is editable." - }, - "localePolicy": { - "$ref": "#/definitions/localePolicyTab", - "description": "Reserved for DocuSign." - }, - "mergeField": { - "$ref": "#/definitions/mergeField", - "description": "Contains the information necessary to map the tab to a field in SalesForce." - }, - "pageNumber": { - "description": "The page number being accessed.", + } + }, + "x-ds-definition-name": "documentTemplate", + "description": "", + "x-ms-summary": "" + }, + "documentTemplateList": { + "type": "object", + "properties": { + "documentTemplates": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/documentTemplate" + } + } + }, + "x-ds-definition-name": "documentTemplateList", + "description": "", + "x-ms-summary": "" + }, + "documentVisibility": { + "type": "object", + "properties": { + "documentId": { + "description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.", "type": "string" }, - "pageNumberMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `pageNumber` property is editable." + "errorDetails": { + "$ref": "#/definitions/errorDetails", + "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." }, "recipientId": { - "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", + "description": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.", "type": "string" }, - "recipientIdGuid": { - "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one.", + "rights": { + "description": "Indicates whether the document is editable:\n\n- `editable`\n- `read_only`", "type": "string" }, - "recipientIdGuidMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `recipientIdGuid` property is editable." - }, - "recipientIdMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `recipientId` property is editable." - }, - "status": { - "description": "The status of the tab. Possible values are:\n\n- `active`: The tab is active, but the recipient has not yet interacted with it.\n- `signed`: The recipient signed the tab.\n- `declined`: The recipient declined the envelope.\n- `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`).", + "visible": { + "description": "When **true**, the document is visible to the recipient.", "type": "string" - }, - "statusMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `status` property is editable." - }, - "tabGroupLabels": { - "description": "An array of tab group labels that uniquely identify tab groups. To assign a tab to a `tabGroup`, you assign the `TabGroupLabel` to the `Tab.TabGroupLabels` array.", + } + }, + "x-ds-definition-name": "documentVisibility", + "description": "This object configures a recipient's read/write access to a document.", + "x-ms-summary": "This object configures a recipient's read/write access to a document." + }, + "documentVisibilityList": { + "type": "object", + "properties": { + "documentVisibility": { + "description": "An array of `documentVisibility` objects that specifies which documents are visible to which recipients.", "type": "array", "items": { - "type": "string" + "$ref": "#/definitions/documentVisibility" } - }, - "tabGroupLabelsMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `tabGroupLabels` property is editable." - }, - "tabId": { - "description": "The unique identifier for the tab.", - "type": "string" - }, - "tabIdMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `tabId` property is editable." - }, - "tabLabel": { - "description": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n", - "type": "string" - }, - "tabLabelMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `tabLabel` property is editable." - }, - "tabOrder": { - "description": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.", - "type": "string" - }, - "tabOrderMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `tabOrder` property is editable." - }, - "tabType": { - "description": "Indicates the type of tab (for example, `signHere` or `initialHere`).", + } + }, + "x-ds-definition-name": "documentVisibilityList", + "description": "A list of `documentVisibility` objects that specify whether documents are visible to recipients.", + "x-ms-summary": "A list of `documentVisibility` objects that specify whether documents are visible to recipients." + }, + "downgradeBillingPlanInformation": { + "type": "object", + "properties": { + "downgradeEventType": { + "description": "", "type": "string" }, - "tabTypeMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `tabType` property is editable." - }, - "templateLocked": { - "description": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ", + "planInformation": { + "$ref": "#/definitions/planInformation", + "description": "An object used to identify the features and attributes of the account being created." + } + }, + "x-ds-definition-name": "downgradeBillingPlanInformation", + "description": "", + "x-ms-summary": "" + }, + "downgradePlanUpdateResponse": { + "type": "object", + "properties": { + "accountPaymentMethod": { + "description": "The type of payment method used for the account. Valid values are:\n\n- `credit_card`\n- ", "type": "string" }, - "templateLockedMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `templateLocked` property is editable." - }, - "templateRequired": { - "description": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.", + "downgradeEffectiveDate": { + "description": "", "type": "string" }, - "templateRequiredMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `templateRequired` property is editable." - }, - "threadId": { - "description": "The unique identifier for the comment thread.", + "downgradePaymentCycle": { + "description": "", "type": "string" }, - "tooltip": { - "description": "The text of a tooltip that appears when a user hovers over a form field or tab.", + "downgradePlanId": { + "description": "", "type": "string" }, - "toolTipMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `toolTip` property is editable." - }, - "underline": { - "description": "When set to **true**, the information in the tab is underlined.", + "downgradePlanName": { + "description": "", "type": "string" }, - "underlineMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `underline` property is editable." - }, - "width": { - "description": "The width of the tab in pixels.", + "downgradeRequestStatus": { + "description": "", "type": "string" }, - "widthMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `width` property is editable." - }, - "xPosition": { - "description": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n", + "message": { + "description": "", "type": "string" + } + }, + "x-ds-definition-name": "downgradePlanUpdateResponse", + "description": "", + "x-ms-summary": "" + }, + "downgradRequestBillingInfoResponse": { + "type": "object", + "properties": { + "downgradePlanInformation": { + "$ref": "#/definitions/downgradePlanUpdateResponse", + "description": "" }, - "xPositionMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `xPosition` property is editable." - }, - "yPosition": { - "description": "This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.", + "paymentMethod": { + "description": "The payment method used for the billing plan. Valid values are:\n\n- `NotSupported`\n- `CreditCard`\n- `PurchaseOrder`\n- `Premium`\n- `Freemium`\n- `FreeTrial`\n- `AppStore`\n- `DigitalExternal`\n- `DirectDebit`", "type": "string" - }, - "yPositionMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `yPosition` property is editable." } }, - "x-ds-definition-name": "commentThread", + "x-ds-definition-name": "downgradRequestBillingInfoResponse", "description": "", "x-ms-summary": "" }, - "company": { + "draw": { "type": "object", "properties": { + "allowSignerUpload": { + "description": "", + "type": "string" + }, + "anchorAllowWhiteSpaceInCharacters": { + "description": "", + "type": "string" + }, + "anchorAllowWhiteSpaceInCharactersMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "" + }, "anchorCaseSensitive": { - "description": "Reserved for DocuSign.\n", + "description": "This property controls how [anchor tabs][AnchorTabs] are placed. When **true**, the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false**.\n\nFor example, when set to **true**, if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When set to **false**, `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**.\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place", "type": "string" }, "anchorCaseSensitiveMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "description": "Metadata that indicates whether the `anchorCaseSensitive` property is editable." }, "anchorHorizontalAlignment": { - "description": "Reserved for DocuSign.\n\n", + "description": "This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are :\n\n- `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value.\n- `right`: Aligns the tab’s left side with the last character of the matching anchor word.\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place\n", "type": "string" }, "anchorHorizontalAlignmentMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "description": "Metadata that indicates whether the `anchorHorizontalAlignment` property is editable." }, "anchorIgnoreIfNotPresent": { "description": "When set to **true**, this tab is ignored if the `anchorString` is not found in the document.", @@ -26182,12 +36970,12 @@ "description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable." }, "anchorMatchWholeWord": { - "description": "Reserved for DocuSign.\n\n", + "description": "When set to **true**, the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false**.\n\nFor example, when set to **true**, if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When set to **false**, if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**.\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTab]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place\n", "type": "string" }, "anchorMatchWholeWordMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "description": "Metadata that indicates whether the `anchorMatchWholeWord` property is editable." }, "anchorString": { "description": "Specifies the string to find in the document and use as the basis for tab placement.", @@ -26206,7 +36994,7 @@ "description": "Reserved for DocuSign." }, "anchorUnits": { - "description": "Specifies the units of the X and Y offset. Units may be pixels, millimeters, centimeters, or inches.", + "description": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n", "type": "string" }, "anchorUnitsMetadata": { @@ -26214,7 +37002,7 @@ "description": "Metadata that indicates whether the `anchorUnits` property is editable." }, "anchorXOffset": { - "description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.", + "description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n", "type": "string" }, "anchorXOffsetMetadata": { @@ -26222,29 +37010,13 @@ "description": "Metadata that indicates whether the `anchorXOffset` property is editable." }, "anchorYOffset": { - "description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.", + "description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n", "type": "string" }, "anchorYOffsetMetadata": { "$ref": "#/definitions/propertyMetadata", "description": "Metadata that indicates whether the `anchorYOffset` property is editable." }, - "bold": { - "description": "When set to **true**, the information in the tab is bold.", - "type": "string" - }, - "boldMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `bold` property is editable." - }, - "concealValueOnDocument": { - "description": "When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender.\n\nWhen an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.", - "type": "string" - }, - "concealValueOnDocumentMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `concealValueOnDocument` property is editable." - }, "conditionalParentLabel": { "description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility.", "type": "string" @@ -26262,23 +37034,15 @@ "description": "Metadata that indicates whether the `conditionalParentValue` property is editable." }, "customTabId": { - "description": "The DocuSign-generated custom tab id for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.", + "description": "The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.", "type": "string" }, "customTabIdMetadata": { "$ref": "#/definitions/propertyMetadata", "description": "Metadata that indicates whether the `customTabId` property is editable." }, - "disableAutoSize": { - "description": "When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes.", - "type": "string" - }, - "disableAutoSizeMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `disableAutoSize` property is editable." - }, "documentId": { - "description": "Integer that identifies the document in the envelope.", + "description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.", "type": "string" }, "documentIdMetadata": { @@ -26289,30 +37053,6 @@ "$ref": "#/definitions/errorDetails", "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." }, - "font": { - "description": "The font to be used for the tab value. Supported fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n", - "type": "string" - }, - "fontColor": { - "description": "The font color to use for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n", - "type": "string" - }, - "fontColorMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `fontColor` property is editable." - }, - "fontMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `font` property is editable." - }, - "fontSize": { - "description": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72", - "type": "string" - }, - "fontSizeMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `fontSize` property is editable." - }, "formOrder": { "description": "An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block.", "type": "string" @@ -26345,18 +37085,6 @@ "$ref": "#/definitions/propertyMetadata", "description": "Metadata that indicates whether the `height` property is editable." }, - "italic": { - "description": "When set to **true**, the information in the tab is italic.", - "type": "string" - }, - "italicMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `italic` property is editable." - }, - "localePolicy": { - "$ref": "#/definitions/localePolicyTab", - "description": "Reserved for DocuSign." - }, "locked": { "description": "When set to **true**, the signer cannot change the data of the custom tab.", "type": "string" @@ -26365,36 +37093,16 @@ "$ref": "#/definitions/propertyMetadata", "description": "Metadata that indicates whether the `locked` property is editable." }, - "maxLength": { - "description": "An optional value that describes the maximum length of the property when the property is a string.", - "type": "string" - }, - "maxLengthMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `maxLength` property is editable." - }, "mergeField": { "$ref": "#/definitions/mergeField", "description": "Contains the information necessary to map the tab to a field in SalesForce." }, - "name": { - "description": "The name of the tab. For example, `Sign Here` or `Initial Here`.", - "type": "string" - }, - "nameMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `name` property is editable." - }, - "originalValue": { - "description": "The initial value of the tab when it was sent to the recipient. ", + "mergeFieldXml": { + "description": "", "type": "string" }, - "originalValueMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `originalValue` property is editable." - }, "pageNumber": { - "description": "The page number on which the tab is located.\nFor supplemental documents, this value must be `1`.", + "description": "Specifies the page number on which the tab is located.", "type": "string" }, "pageNumberMetadata": { @@ -26402,11 +37110,11 @@ "description": "Metadata that indicates whether the `pageNumber` property is editable." }, "recipientId": { - "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", + "description": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.", "type": "string" }, "recipientIdGuid": { - "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one.", + "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only.", "type": "string" }, "recipientIdGuidMetadata": { @@ -26425,8 +37133,20 @@ "$ref": "#/definitions/propertyMetadata", "description": "Metadata that indicates whether the `required` property is editable." }, + "shared": { + "description": "When set to **true**, this custom tab is shared.", + "type": "string" + }, + "sharedMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `shared` property is editable." + }, + "smartContractInformation": { + "$ref": "#/definitions/smartContractInformation", + "description": "" + }, "status": { - "description": "The status of the tab. Possible values are:\n\n- `active`: The tab is active, but the recipient has not yet interacted with it.\n- `signed`: The recipient signed the tab.\n- `declined`: The recipient declined the envelope.\n- `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`).\n", + "description": "Indicates the envelope status. Valid values are:\n\n* sent - The envelope is sent to the recipients. \n* created - The envelope is saved as a draft and can be modified and sent later.", "type": "string" }, "statusMetadata": { @@ -26452,10 +37172,6 @@ "$ref": "#/definitions/propertyMetadata", "description": "Metadata that indicates whether the `tabId` property is editable." }, - "tabLabel": { - "description": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n", - "type": "string" - }, "tabLabelMetadata": { "$ref": "#/definitions/propertyMetadata", "description": "Metadata that indicates whether the `tabLabel` property is editable." @@ -26500,22 +37216,10 @@ "$ref": "#/definitions/propertyMetadata", "description": "Metadata that indicates whether the `toolTip` property is editable." }, - "underline": { - "description": "When set to **true**, the information in the tab is underlined.", - "type": "string" - }, - "underlineMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `underline` property is editable." - }, - "value": { - "description": "Specifies the value of the tab. ", + "useBackgroundAsCanvas": { + "description": "", "type": "string" }, - "valueMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `value` property is editable." - }, "width": { "description": "The width of the tab in pixels.", "type": "string" @@ -26533,7 +37237,7 @@ "description": "Metadata that indicates whether the `xPosition` property is editable." }, "yPosition": { - "description": "This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.", + "description": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n", "type": "string" }, "yPositionMetadata": { @@ -26541,2011 +37245,2188 @@ "description": "Metadata that indicates whether the `yPosition` property is editable." } }, - "x-ds-definition-name": "company", - "description": "A tab that displays the recipient's company name.\n", - "x-ms-summary": "A tab that displays the recipient's company name.\n" - }, - "completeSignHashResponse": { - "type": "object", - "properties": { - "documents": { - "description": "Complex element contains the details on the documents in the envelope.", - "type": "array", - "items": { - "$ref": "#/definitions/signHashDocument" - } - }, - "redirectionUrl": { - "description": "", - "type": "string" - }, - "remainingSignatureRequests": { - "description": "", - "type": "string" - } - }, - "x-ds-definition-name": "completeSignHashResponse", + "x-ds-definition-name": "draw", "description": "", "x-ms-summary": "" }, - "completeSignRequest": { + "editor": { "type": "object", "properties": { - "certificate": { - "description": "When set to **false**, the envelope signing certificate is removed from the download.", + "accessCode": { + "description": "If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. \n\nMaximum Length: 50 characters and it must conform to the account's access code format setting.\n\nIf blank, but the signer `accessCode` property is set in the envelope, then that value is used.\n\nIf blank and the signer `accessCode` property is not set, then the access code is not required.", "type": "string" }, - "correlationId": { - "description": "", + "accessCodeMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `accessCode` property is editable. Read only." + }, + "addAccessCodeToEmail": { + "description": "Optional. When set to **true**, the access code will be added to the email sent to the recipient. This nullifies the security measure of `accessCode` on the recipient.", "type": "string" }, - "documentUpdateInfos": { - "description": "", + "additionalNotifications": { + "description": "An array of additional notification objects.", "type": "array", "items": { - "$ref": "#/definitions/documentUpdateInfo" + "$ref": "#/definitions/recipientAdditionalNotification" } }, - "maxSignatureLength": { + "allowSystemOverrideForLockedRecipient": { "description": "", "type": "string" }, - "signingLocation": { - "description": "Specifies the physical location where the signing takes place. It can have two enumeration values; `inPerson` and `online`. The default value is `online`.", + "clientUserId": { + "description": "Specifies whether the recipient is embedded or remote. \n\nIf the `clientUserId` property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing.\n\nNote: if the `clientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true**, an error is generated on sending. \n\nMaximum length: 100 characters. ", "type": "string" }, - "transactionId": { - "description": "Specifies the Transaction ID from the AppStore.", - "type": "string" - } - }, - "x-ds-definition-name": "completeSignRequest", - "description": "", - "x-ms-summary": "" - }, - "compositeTemplate": { - "type": "object", - "properties": { - "compositeTemplateId": { - "description": "The identify of this composite template. It is used as a reference when adding document object information. If used, the document's `content-disposition` must include the composite template ID to which the document should be added. If a composite template ID is not specified in the content-disposition, the document is applied based on the value of the `documentId` property only. If no document object is specified, the composite template inherits the first document.", + "completedCount": { + "description": "Indicates the number of times that the recipient has been through a signing completion for the envelope. If this number is greater than 0 for a signing group, only the user who previously completed may sign again. Read only.", "type": "string" }, - "document": { - "$ref": "#/definitions/document", - "description": "" - }, - "inlineTemplates": { - "description": " Zero or more inline templates and their position in the overlay. If supplied, they are overlaid into the envelope in the order of their Sequence value.", + "customFields": { + "description": "An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters.", "type": "array", "items": { - "$ref": "#/definitions/inlineTemplate" + "type": "string" } }, - "pdfMetaDataTemplateSequence": { - "description": "", + "declinedDateTime": { + "description": "The date and time the recipient declined the document. Read only.", "type": "string" }, - "serverTemplates": { - "description": "0 or more server-side templates and their position in the overlay. If supplied, they are overlaid into the envelope in the order of their Sequence value", - "type": "array", - "items": { - "$ref": "#/definitions/serverTemplate" - } - } - }, - "x-ds-definition-name": "compositeTemplate", - "description": "", - "x-ms-summary": "" - }, - "connectConfigResults": { - "type": "object", - "properties": { - "configurations": { - "description": "Array of Connect Configurations", - "type": "array", - "items": { - "$ref": "#/definitions/ConnectConfigurations" - } - }, - "totalRecords": { - "description": "The count of records in the log list.", - "type": "string" - } - }, - "x-ds-definition-name": "connectConfigResults", - "description": "", - "x-ms-summary": "" - }, - "connectCustomConfiguration": { - "type": "object", - "properties": { - "allowEnvelopePublish": { - "description": "When set to **true**, data is sent to the urlToPublishTo web address. This option can be set to false to stop sending data while maintaining the Connect configuration information.", + "declinedReason": { + "description": "The reason the recipient declined the document. Read only.", "type": "string" }, - "allowSalesforcePublish": { - "description": "", + "deliveredDateTime": { + "description": "The date and time that the envelope was delivered to the recipient. Read only.", "type": "string" }, - "allUsers": { - "description": "When set to **true**, the tracked envelope and recipient events for all users, including users that are added a later time, are sent through Connect.", + "deliveryMethod": { + "description": "Reserved for DocuSign.", "type": "string" }, - "configurationType": { - "description": "If merge fields are being used, specifies the type of the merge field. The only supported value is **salesforce**.", - "type": "string" + "deliveryMethodMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Reserved for DocuSign." }, - "connectId": { - "description": "The ID of the custom Connect configuration being accessed.", + "designatorId": { + "description": "", "type": "string" }, - "enableLog": { - "description": "This turns Connect logging on or off. When set to **true**, logging is turned on.", + "designatorIdGuid": { + "description": "", "type": "string" }, - "envelopeEvents": { - "description": "A list of envelope-level event statuses that will trigger Connect to send updates to the endpoint specified in the `url` property. \n\nTo receive notifications, you must include either an `envelopeEvents` node or a `recipientEvents` node. You do not need to specify both.", + "documentVisibility": { + "description": "A list of `documentVisibility` objects. Each object in the list specifies whether a document in the envelope is visible to this recipient. For the envelope to use this functionality, Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true**.", "type": "array", "items": { - "type": "string" + "$ref": "#/definitions/documentVisibility" } }, - "externalFolderId": { - "description": "", + "email": { + "description": "The recipient's email address. Notification of the document to sign is sent to this email address. \n\nMaximum length: 100 characters. ", "type": "string" }, - "externalFolderLabel": { - "description": "", - "type": "string" + "emailMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `email` property is editable. Read only." }, - "includeCertificateOfCompletion": { - "description": "When set to **true**, the Connect Service includes the Certificate of Completion with completed envelopes. ", - "type": "string" + "emailNotification": { + "$ref": "#/definitions/recipientEmailNotification", + "description": "An optional complex type that sets a specific email subject and body for this recipient's notification email. \n\n**Note**: You can set the `emailNotification` property separately for each recipient. If you set the value only for certain recipients, the other recipients will inherit the this value from the top-level `emailSubject` and `emailBlurb`. " }, - "includeCertSoapHeader": { - "description": "", + "embeddedRecipientStartURL": { + "description": "Specifies a sender-provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. \n\nIf set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation launched by a partner.\n\nIt is important to understand that in a typical embedded workflow, the authentication of an embedded recipient is the responsibility of the sending application. DocuSign expects that senders will follow their own processes for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process is initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process, bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient.\n\nIf the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: `envelopeId`, `recipientId`, `recipientName`, `recipientEmail`, and `customFields`. The `customFields` property must be set for the recipient or envelope. The merge fields are enclosed in double brackets. \n\n*Example*: \n\n`http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` ", "type": "string" }, - "includeDocumentFields": { - "description": "When set to **true**, the Document Fields associated with the envelope's documents are included in the notification messages. Document Fields are optional custom name-value pairs added to documents using the API. ", - "type": "string" + "errorDetails": { + "$ref": "#/definitions/errorDetails", + "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." }, - "includeDocuments": { - "description": "reserved", + "faxNumber": { + "description": "Reserved for DocuSign.", "type": "string" }, - "includeEnvelopeVoidReason": { - "description": "When set to **true**, if the envelope is voided, the Connect Service notification will include the void reason, as entered by the person that voided the envelope. ", - "type": "string" + "faxNumberMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Reserved for DocuSign." }, - "includeHMAC": { - "description": "", + "firstName": { + "description": "The recipient's first name. \n\nMaximum Length: 50 characters.", "type": "string" }, - "includeSenderAccountasCustomField": { - "description": "When set to **true**, Connect will include the sender account as Custom Field in the data.", - "type": "string" + "firstNameMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `firstame` property is editable. Read only." }, - "includeTimeZoneInformation": { - "description": "When set to **true**, Connect will include the envelope time zone information.", + "fullName": { + "description": "Reserved for DocuSign.", "type": "string" }, - "name": { - "description": "", - "type": "string" + "fullNameMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Reserved for DocuSign." }, - "password": { - "description": "The user's encrypted password hash.", + "idCheckConfigurationName": { + "description": "The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are:\n\n- `Phone Auth $`: The recipient must authenticate by using two-factor authentication (2FA). You provide the phone number to use for 2FA in the `phoneAuthentication` object.\n- `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object.\n- `ID Check $`: The recipient must answer detailed security questions. \n\n**Example**: Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node.", "type": "string" }, - "recipientEvents": { - "description": "An array of recipient event statuses that will trigger Connect to send notifications to your webhook listener at the url endpoint specified in the `url` property. \n\nTo receive notifications, you must include either an `envelopeEvents` node or a `recipientEvents` node. You do not need to specify both.", - "type": "array", - "items": { - "type": "string" - } + "idCheckConfigurationNameMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `idCheckConfigurationName` property is editable. Read only." }, - "requireMutualTls": { - "description": "If **true** [Mutual TLS](https://developers.docusign.com/esign-rest-api/guides/mutual-tls-intro) authentication is enabled.", - "type": "string" + "idCheckInformationInput": { + "$ref": "#/definitions/idCheckInformationInput", + "description": "An object that contains input information related to a recipient ID check." }, - "requiresAcknowledgement": { - "description": "#### When set to **true**, and SIM mode is activated:\n\nIf the HTTP Status response to a notification message is not in the range of 200-299,\nthen the message delivery failed, and the configuration is marked as down.\n\nThe message will be queued and retried once per day.\nWhile a Connect configuration is marked down, subsequent notifications will not be tried, they'll be immediately queued with reason \"Pending\".\nOnce a message succeeds, all queued messages for the configuration will be tried immediately, in order.\n\nThere is a maximum of ten retries. Alternately, you can use Republish Connect Information to manually republish the notification.\n\n#### When set to **true**, and SIM mode is not activated: \n\nIf the HTTP Status response to a notification message is not in the range of 200-299, then the message delivery failed, and the message is queued.\n\nThe message will be retried after at least a day the next time a subsequent message is successfully sent to this configuration (subscription). Subsequent notifications will be tried when they occur.\nThere is a maximum of ten retries. Alternately, you can use Republish Connect Information to manually republish the notification.", + "identityVerification": { + "$ref": "#/definitions/recipientIdentityVerification", + "description": "Specifies the ID Verification workflow applied on an envelope by workflow ID.
See the [list](https://developers.docusign.com/docs/esign-rest-api/reference/Accounts/IdentityVerifications/list) method in the [IdentityVerifications](https://developers.docusign.com/docs/esign-rest-api/reference/Accounts/IdentityVerifications) resource for more information on how to retrieve workflow IDs available for an account.
This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods.
Note that ID Verification and ID Check are two distinct methods. ID Verification checks recipients' identity by verifying their ID while ID Check relies on data available on public records (such as current and former address)." + }, + "inheritEmailNotificationConfiguration": { + "description": "When set to **true** and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account. ", "type": "string" }, - "salesforceAccessToken": { - "description": "The access token to use for Salesforce integration.", + "lastName": { + "description": "The recipient's last name.", "type": "string" }, - "salesforceApiVersion": { - "description": "The version of the Salesforce API that you are using.", + "lastNameMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `lastName` property is editable. Read only." + }, + "lockedRecipientPhoneAuthEditable": { + "description": "Reserved for DocuSign.", "type": "string" }, - "salesforceDocumentsAsContentFiles": { - "description": "", + "lockedRecipientSmsEditable": { + "description": "Reserved for DocuSign.", "type": "string" }, - "salesforceRefreshToken": { - "description": "", + "name": { + "description": "The full legal name of the recipient. Maximum Length: 100 characters.\n\n**Note**: You must always set a value for this property in requests, even if `firstName` and `lastName` are set.", "type": "string" }, - "senderOverride": { - "description": "", + "nameMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `name` property is editable. Read only." + }, + "note": { + "description": "A note sent to the recipient in the signing email.\nThis note is unique to this recipient.\nIn the user interface,\nit appears near the upper left corner\nof the document\non the signing screen.\n\nMaximum Length: 1000 characters.\n", "type": "string" }, - "senderSelectableItems": { - "description": "", + "noteMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `note` property is editable. Read only." + }, + "phoneAuthentication": { + "$ref": "#/definitions/recipientPhoneAuthentication", + "description": "When `idCheckConfigurationName` is set to `Phone Auth $`, you use this complex type to provide the recipient authentication method details. It contains the following elements:\n\n* `recipMayProvideNumber`: Boolean. When set to **true**, the recipient can use whatever phone number they choose.\n* `senderProvidedNumbers`: ArrayOfStrings. A list of phone numbers the recipient can use.\n* `recordVoicePrint`: Reserved for DocuSign.\n* `validateRecipProvidedNumber`: Reserved for DocuSign.\n\n" + }, + "recipientAttachments": { + "description": "Reserved for DocuSign.", "type": "array", "items": { - "type": "string" + "$ref": "#/definitions/recipientAttachment" } }, - "sfObjects": { - "description": "", + "recipientAuthenticationStatus": { + "$ref": "#/definitions/authenticationStatus", + "description": "Information about the recipient's authentication status. Read only." + }, + "recipientFeatureMetadata": { + "description": "Metadata about the features that are supported for the recipient type. Read only.", "type": "array", "items": { - "$ref": "#/definitions/connectSalesforceObject" + "$ref": "#/definitions/featureAvailableMetadata" } }, - "signMessageWithX509Certificate": { - "description": "When set to **true**, Mutual TLS will be enabled for notifications. Mutual TLS must be initiated by the listener (the customer's web server) during the TLS handshake protocol. ", + "recipientId": { + "description": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the document.", "type": "string" }, - "soapNamespace": { - "description": "The namespace of the SOAP interface.\n\nThe namespace value must be set if useSoapInterface is set to true.", + "recipientIdGuid": { + "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only.", "type": "string" }, - "urlToPublishTo": { - "description": "This is the web address and name of your listener or Retrieving Service endpoint. You need to include HTTPS:// in the web address.", + "recipientType": { + "description": "The recipient type, as specified by the following values:\n- `agent`: Agent recipients can add name and email information for recipients that appear after the agent in routing order.\n- `carbonCopy`: Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date, or add information to any of the documents. This type of recipient can be used in any routing order.\n- `certifiedDelivery`: Certified delivery recipients must receive the completed documents for the envelope to be completed. They don't need to sign, initial, date, or add information to any of the documents.\n- `editor`: Editors have the same management and access rights for the envelope as the sender. Editors can add name and email information, add or change the routing order, set authentication options, and can edit signature/initial tabs and data fields for the remaining recipients.\n- `inPersonSigner`: In-person recipients are DocuSign users who act as signing hosts in the same physical location as the signer.\n- `intermediaries`: Intermediary recipients can optionally add name and email information for recipients at the same or subsequent level in the routing order.\n- `seal`: Electronic seal recipients represent legal entities.\n- `signer`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope.\n- `witness`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope.", "type": "string" }, - "userIds": { - "description": "A comma separated list of userIds. This sets the users associated with the tracked envelope and recipient events. When a tracked event occurs for a set user, the a notification message is sent to your Connect listener. \n\n###### Note: If allUsers is set to `false` then you must provide a list of user ids.", - "type": "array", - "items": { - "type": "string" - } + "recipientTypeMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `recipientType` property is editable. Read only." }, - "userName": { - "description": "The name of the user.", + "requireIdLookup": { + "description": "When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. ", "type": "string" }, - "useSoapInterface": { - "description": "When set to **true**, the notifications are sent to your endpoint as SOAP requests. ", + "requireIdLookupMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `requireIdLookup` property is editable. Read only." + }, + "roleName": { + "description": "Optional element. Specifies the role name associated with the recipient.

This property is required when you are working with template recipients.", "type": "string" - } - }, - "x-ds-definition-name": "connectCustomConfiguration", - "description": "", - "x-ms-summary": "" - }, - "connectDebugLog": { - "type": "object", - "properties": { - "connectConfig": { - "description": "Name of the Connect configuration.", + }, + "routingOrder": { + "description": "Specifies the routing order of the recipient in the envelope. ", "type": "string" }, - "errorDetails": { - "$ref": "#/definitions/errorDetails", - "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." + "routingOrderMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `routingOrder` property is editable. Read only." }, - "eventDateTime": { - "description": "Date and time of the event.", + "sentDateTime": { + "description": "The UTC DateTime when the envelope was sent. Read only.", "type": "string" }, - "eventDescription": { - "description": "Description of the event.", + "signedDateTime": { + "description": "Reserved for DocuSign.", "type": "string" }, - "payload": { - "description": "Log output.", + "signingGroupId": { + "description": "When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once).", "type": "string" - } - }, - "x-ds-definition-name": "connectDebugLog", - "description": "", - "x-ms-summary": "" - }, - "connectFailureFilter": { - "type": "object", - "properties": { - "envelopeIds": { - "description": "", + }, + "signingGroupIdMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `signingGroupId` property is editable. Read only." + }, + "signingGroupName": { + "description": "Optional. The name of the signing group. \n\nMaximum Length: 100 characters. ", + "type": "string" + }, + "signingGroupUsers": { + "description": "A complex type that contains information about users in the signing group.", "type": "array", "items": { - "type": "string" + "$ref": "#/definitions/userInfo" } }, - "synchronous": { - "description": "", + "smsAuthentication": { + "$ref": "#/definitions/recipientSMSAuthentication", + "description": "When `idCheckConfigurationName` is set to `SMS Auth $`, you use this complex type to provide the recipient authentication method details. It contains the element `senderProvidedNumbers`, which is an array of phone numbers that the recipient can use for SMS text authentication. \n\n" + }, + "socialAuthentications": { + "description": "Deprecated.", + "type": "array", + "items": { + "$ref": "#/definitions/socialAuthentication" + } + }, + "status": { + "description": "The recipient's status. Read only. \n\nPossible values:\n\n- `autoresponded`: The recipient's email system auto-responded to the email from DocuSign. This status is used in the web console to inform senders about the bounced-back email. This recipient status is only used if **Send-on-behalf-of** is turned off for the account.\n- `completed`: The recipient has completed their actions (signing or other required actions if not a signer) for an envelope.\n- `created`: The recipient is in a draft state. This value is only associated with draft envelopes (envelopes that have a status of `created`).\n- `declined`: The recipient declined to sign the document(s) in the envelope.\n- `delivered`: The recipient has viewed the document(s) in an envelope through the DocuSign signing website. This is not an email delivery of the documents in an envelope.\n- `faxPending`: The recipient has finished signing and the system is waiting for a fax attachment from the recipient before completing their signing step.\n- `sent`: The recipient has been sent an email notification that it is their turn to sign an envelope.\n- `signed`: The recipient has completed (signed) all required tags in an envelope. This is a temporary state during processing, after which the recipient's status automatically switches to `completed`.\n", "type": "string" - } - }, - "x-ds-definition-name": "connectFailureFilter", - "description": "", - "x-ms-summary": "" - }, - "connectFailureResult": { - "type": "object", - "properties": { - "configId": { - "description": "Reserved for DocuSign.", + }, + "statusCode": { + "description": "The code associated with the recipient's status. Read only.", "type": "string" }, - "configUrl": { - "description": "Reserved for DocuSign.\n", + "suppressEmails": { + "description": "When set to **true**, email notifications are suppressed for the recipient, and they must access envelopes and documents from their DocuSign inbox.", "type": "string" }, - "envelopeId": { - "description": "The envelope ID of the envelope status that failed to post.", + "templateLocked": { + "description": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ", "type": "string" }, - "status": { - "description": "Connection status.", + "templateRequired": { + "description": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.", "type": "string" }, - "statusMessage": { - "description": "Connection status message.", + "totalTabCount": { + "description": "The total number of tabs in the documents. Read only.", + "type": "string" + }, + "userId": { + "description": "The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.\n", "type": "string" } }, - "x-ds-definition-name": "connectFailureResult", - "description": "", - "x-ms-summary": "" + "x-ds-definition-name": "editor", + "description": "A complex type defining the management and access rights of a recipient assigned as an editor on the envelope. Editors have the same management and access rights for the envelope as the sender. They can make changes to the envelope as if they were using the Correct feature. This recipient can add name and email information, add or change the routing order and set authentication options for the remaining recipients. Additionally, this recipient can edit signature/initial tabs and text tabs for the remaining recipients.", + "x-ms-summary": "A complex type defining the management and access rights of a recipient assigned as an editor on the envelope. Editors have the same management and access rights for the envelope as the sender. They can make changes to the envelope as if they were using the Correct feature. This recipient can add name and email information, add or change the routing order and set authentication options for the remaining recipients. Additionally, this recipient can edit signature/initial tabs and text tabs for the remaining recipients." }, - "connectFailureResults": { + "email": { "type": "object", "properties": { - "retryQueue": { + "anchorAllowWhiteSpaceInCharacters": { "description": "", - "type": "array", - "items": { - "$ref": "#/definitions/connectFailureResult" - } - } - }, - "x-ds-definition-name": "connectFailureResults", - "description": "", - "x-ms-summary": "" - }, - "connectLog": { - "type": "object", - "properties": { - "accountId": { - "description": "The external account number (int) or account ID GUID.", "type": "string" }, - "configUrl": { - "description": "Web address of the listener or retrieving service endpoint for Connect.", + "anchorAllowWhiteSpaceInCharactersMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "" + }, + "anchorCaseSensitive": { + "description": "This property controls how [anchor tabs][AnchorTabs] are placed. When **true**, the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false**.\n\nFor example, when set to **true**, if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When set to **false**, `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**.\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place", + "type": "string" + }, + "anchorCaseSensitiveMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorCaseSensitive` property is editable." + }, + "anchorHorizontalAlignment": { + "description": "This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are :\n\n- `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value.\n- `right`: Aligns the tab’s left side with the last character of the matching anchor word.\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place\n", + "type": "string" + }, + "anchorHorizontalAlignmentMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorHorizontalAlignment` property is editable." + }, + "anchorIgnoreIfNotPresent": { + "description": "When set to **true**, this tab is ignored if the `anchorString` is not found in the document.", "type": "string" }, - "connectDebugLog": { - "description": "A complex element containing information about the Connect configuration, error details, date/time, description and payload.\nThis information is included in the response only when the `additional_info` query is set to **true**.\nThis additional information is only available when retrieving general logs with [ConnectEvents:get](https://developers.docusign.com/esign-rest-api/reference/Connect/ConnectEvents/get); not when retrieving failure logs with [ConnectEvents:listFailures](https://developers.docusign.com/esign-rest-api/reference/Connect/ConnectEvents/listFailures).", - "type": "array", - "items": { - "$ref": "#/definitions/connectDebugLog" - } + "anchorIgnoreIfNotPresentMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable." }, - "connectId": { - "description": "Identifier for the Connect configuration that failed. If an account has multiple Connect configurations, this value is used to look up the Connect configuration for the failed post.", + "anchorMatchWholeWord": { + "description": "When set to **true**, the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false**.\n\nFor example, when set to **true**, if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When set to **false**, if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**.\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTab]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place\n", "type": "string" }, - "created": { - "description": "Date and time the Connect post was created.", + "anchorMatchWholeWordMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorMatchWholeWord` property is editable." + }, + "anchorString": { + "description": "Specifies the string to find in the document and use as the basis for tab placement.", "type": "string" }, - "email": { - "description": "Email address of the envelope sender.", + "anchorStringMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorString` property is editable." + }, + "anchorTabProcessorVersion": { + "description": "Reserved for DocuSign.", "type": "string" }, - "envelopeId": { - "description": "ID of the envelope that failed to post.", + "anchorTabProcessorVersionMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Reserved for DocuSign." + }, + "anchorUnits": { + "description": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n", "type": "string" }, - "error": { - "description": "Server error for the Connect post failure.", + "anchorUnitsMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorUnits` property is editable." + }, + "anchorXOffset": { + "description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n", "type": "string" }, - "failureId": { - "description": "ID of the Connect post failure.", + "anchorXOffsetMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorXOffset` property is editable." + }, + "anchorYOffset": { + "description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n", "type": "string" }, - "failureUri": { - "description": "URI for the Connect post failure.", + "anchorYOffsetMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorYOffset` property is editable." + }, + "bold": { + "description": "When set to **true**, the information in the tab is bold.", "type": "string" }, - "lastTry": { - "description": "Date and time of the last attempt to post.", + "boldMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `bold` property is editable." + }, + "concealValueOnDocument": { + "description": "When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender.\n\nWhen an envelope is completed the information is only available to the sender through the Form Data link in the DocuSign Console. The information on the downloaded document remains masked by asterisks.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.", "type": "string" }, - "logId": { - "description": "ID of the Connect log entry.", + "concealValueOnDocumentMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `concealValueOnDocument` property is editable." + }, + "conditionalParentLabel": { + "description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility.", "type": "string" }, - "logUri": { - "description": "URI for the Connect log entry.", + "conditionalParentLabelMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `conditionalParentLabel` property is editable." + }, + "conditionalParentValue": { + "description": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use \"on\" as the value to show that the parent tab is active.\n", "type": "string" }, - "retryCount": { - "description": "The number of times the Connect post has been retried.", + "conditionalParentValueMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `conditionalParentValue` property is editable." + }, + "customTabId": { + "description": "The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.", "type": "string" }, - "retryUri": { - "description": "URI that can be used to retry to publish the Connect post.", + "customTabIdMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `customTabId` property is editable." + }, + "disableAutoSize": { + "description": "When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes.", "type": "string" }, - "status": { - "description": "Envelope status for the Connect post:\n- `Any`\n- `Voided`\n- `Created`\n- `Deleted`\n- `Sent`\n- `Delivered`\n- `Signed`\n- `Completed`\n- `Declined`\n- `TimedOut`\n- `Template`\n- `Processing`", + "disableAutoSizeMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `disableAutoSize` property is editable." + }, + "documentId": { + "description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.", "type": "string" }, - "subject": { - "description": "The envelope subject.", + "documentIdMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `documentId` property is editable." + }, + "errorDetails": { + "$ref": "#/definitions/errorDetails", + "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." + }, + "font": { + "description": "The font to be used for the tab value. Supported fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n", "type": "string" }, - "userName": { - "description": "The name of the envelope sender.", + "fontColor": { + "description": "The font color to use for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n", "type": "string" - } - }, - "x-ds-definition-name": "connectLog", - "description": "", - "x-ms-summary": "" - }, - "connectLogs": { - "type": "object", - "properties": { - "failures": { - "description": "A list of Connect failure logs.", - "type": "array", - "items": { - "$ref": "#/definitions/connectLog" - } }, - "logs": { - "description": "A list of Connect general logs.", - "type": "array", - "items": { - "$ref": "#/definitions/connectLog" - } + "fontColorMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `fontColor` property is editable." }, - "totalRecords": { - "description": "The count of records in the log list.", - "type": "string" + "fontMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `font` property is editable." }, - "type": { - "description": "Type of user:\n- `type_owner`\n- `type_participant`", + "fontSize": { + "description": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72", "type": "string" - } - }, - "x-ds-definition-name": "connectLogs", - "description": "", - "x-ms-summary": "" - }, - "connectSalesforceField": { - "type": "object", - "properties": { - "dsAttribute": { - "description": "", + }, + "fontSizeMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `fontSize` property is editable." + }, + "formOrder": { + "description": "An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block.", "type": "string" }, - "dsLink": { - "description": "", + "formOrderMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `formOrder` property is editable." + }, + "formPageLabel": { + "description": "A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience.", "type": "string" }, - "dsNode": { - "description": "", + "formPageLabelMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `formPageLabel` property is editable." + }, + "formPageNumber": { + "description": "An integer specifying the order in which to present the guided form pages.", "type": "string" }, - "id": { - "description": "A unique ID for the Salesforce object.", + "formPageNumberMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `fromPageNumber` property is editable." + }, + "height": { + "description": "The height of the tab in pixels.", "type": "string" }, - "sfField": { - "description": "", + "heightMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `height` property is editable." + }, + "italic": { + "description": "When set to **true**, the information in the tab is italic.", "type": "string" }, - "sfFieldName": { - "description": "", + "italicMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `italic` property is editable." + }, + "localePolicy": { + "$ref": "#/definitions/localePolicyTab", + "description": "Reserved for DocuSign." + }, + "locked": { + "description": "When set to **true**, the signer cannot change the data of the custom tab.", "type": "string" }, - "sfFolder": { - "description": "", + "lockedMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `locked` property is editable." + }, + "maxLength": { + "description": "An optional value that describes the maximum length of the property when the property is a string.", "type": "string" }, - "sfLockedValue": { + "maxLengthMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `maxLength` property is editable." + }, + "mergeField": { + "$ref": "#/definitions/mergeField", + "description": "Contains the information necessary to map the tab to a field in SalesForce." + }, + "mergeFieldXml": { "description": "", "type": "string" - } - }, - "x-ds-definition-name": "connectSalesforceField", - "description": "", - "x-ms-summary": "" - }, - "connectSalesforceObject": { - "type": "object", - "properties": { - "active": { - "description": "", + }, + "name": { + "description": "The name of the tab. For example, `Sign Here` or `Initial Here`.", "type": "string" }, - "description": { - "description": "A sender-defined description of the line item.\n", + "nameMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `name` property is editable. Read only." + }, + "originalValue": { + "description": "The initial value of the tab when it was sent to the recipient. ", "type": "string" }, - "id": { - "description": "A unique ID for the Salesforce object.", + "originalValueMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `originalValue` property is editable." + }, + "pageNumber": { + "description": "The page number on which the tab is located.\nFor supplemental documents, this value must be `1`.", "type": "string" }, - "insert": { - "description": "", + "pageNumberMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `pageNumber` property is editable." + }, + "recipientId": { + "description": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.", "type": "string" }, - "onCompleteOnly": { - "description": "", + "recipientIdGuid": { + "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only.", "type": "string" }, - "selectFields": { - "description": "", - "type": "array", - "items": { - "$ref": "#/definitions/connectSalesforceField" - } + "recipientIdGuidMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `recipientIdGuid` property is editable." }, - "sfObject": { - "description": "", + "recipientIdMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `recipientId` property is editable." + }, + "requireAll": { + "description": "When set to **true** and shared is true, information must be entered in this field to complete the envelope. ", "type": "string" }, - "sfObjectName": { - "description": "The name of the Salesforce object.", + "requireAllMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `requireAll` property is editable." + }, + "required": { + "description": "When set to **true**, the signer is required to fill out this tab.", "type": "string" }, - "updateFields": { - "description": "", - "type": "array", - "items": { - "$ref": "#/definitions/connectSalesforceField" - } - } - }, - "x-ds-definition-name": "connectSalesforceObject", - "description": "", - "x-ms-summary": "" - }, - "connectUserObject": { - "type": "object", - "properties": { - "configurationtype": { - "description": "The type of custom Connect configuration being accessed.", + "requiredMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `required` property is editable." + }, + "requireInitialOnSharedChange": { + "description": "Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.", "type": "string" }, - "connectId": { - "description": "The ID of the custom Connect configuration being accessed.", + "requireInitialOnSharedChangeMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `requireInitialOnSharedChange` property is editable." + }, + "senderRequired": { + "description": "When set to **true**, the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope.", "type": "string" }, - "enabled": { - "description": "Boolean value that indicates whether the custom Connect configuration is enabled or not.", + "senderRequiredMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `senderRequired` property is editable." + }, + "shared": { + "description": "When set to **true**, this tab is shared.", "type": "string" }, - "hasAccess": { - "description": "", + "sharedMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `shared` property is editable." + }, + "smartContractInformation": { + "$ref": "#/definitions/smartContractInformation", + "description": "" + }, + "status": { + "description": "The status of the tab. Possible values are:\n\n- `active`: The tab is active, but the recipient has not yet interacted with it.\n- `signed`: The recipient signed the tab.\n- `declined`: The recipient declined the envelope.\n- `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`).\n", "type": "string" }, - "senderSearchableItems": { - "description": "", + "statusMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `status` property is editable." + }, + "tabGroupLabels": { + "description": "An array of tab group labels that uniquely identify tab groups. To assign a tab to a `tabGroup`, you assign the `TabGroupLabel` to the `Tab.TabGroupLabels` array.", "type": "array", "items": { "type": "string" } - } - }, - "x-ds-definition-name": "connectUserObject", - "description": "", - "x-ms-summary": "" - }, - "consoleViewRequest": { - "type": "object", - "properties": { - "envelopeId": { - "description": "The envelope ID of the envelope status that failed to post.", + }, + "tabGroupLabelsMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `tabGroupLabels` property is editable." + }, + "tabId": { + "description": "The unique identifier for the tab.", "type": "string" }, - "returnUrl": { - "description": "The URL to be redirected to after the console view session has ended.", + "tabIdMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `tabId` property is editable." + }, + "tabLabel": { + "description": "The label associated with the tab. This value may be an empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum Length: 500 characters.\n", "type": "string" - } - }, - "x-ds-definition-name": "consoleViewRequest", - "description": "", - "x-ms-summary": "" - }, - "consumerDisclosure": { - "type": "object", - "properties": { - "accountEsignId": { - "description": "A GUID identifying the account associated with the consumer disclosure", + }, + "tabLabelMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `tabLabel` property is editable." + }, + "tabOrder": { + "description": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.", "type": "string" }, - "allowCDWithdraw": { - "description": "Indicates whether the customer can withdraw their acceptance of the consumer disclosure.", + "tabOrderMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `tabOrder` property is editable." + }, + "tabType": { + "description": "Indicates the type of tab (for example, `signHere` or `initialHere`).", "type": "string" }, - "allowCDWithdrawMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `allowCDWithdraw` property is editable.\n" + "tabTypeMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `tabType` property is editable." }, - "changeEmail": { - "description": "", + "templateLocked": { + "description": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ", "type": "string" }, - "changeEmailOther": { - "description": "", + "templateLockedMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `templateLocked` property is editable." + }, + "templateRequired": { + "description": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.", "type": "string" }, - "companyName": { - "description": "The name of the user's company.", + "templateRequiredMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `templateRequired` property is editable." + }, + "tooltip": { + "description": "The text of a tooltip that appears when a user hovers over a form field or tab.", "type": "string" }, - "companyPhone": { - "description": "The phone number of the company associated with the consumer disclosure.", + "toolTipMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `toolTip` property is editable." + }, + "underline": { + "description": "When set to **true**, the information in the tab is underlined.", "type": "string" }, - "copyCostPerPage": { - "description": "", + "underlineMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `underline` property is editable." + }, + "validationMessage": { + "description": "The message displayed if the custom tab fails input validation (either custom of embedded).", "type": "string" }, - "copyFeeCollectionMethod": { - "description": "Specifies the fee collection method for cases in which the customer requires paper copies of the document.\n\nMaximum Length: 255 characters", + "validationMessageMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `validationMessage` property is editable." + }, + "validationPattern": { + "description": "A regular expression used to validate input for the tab.", "type": "string" }, - "copyRequestEmail": { - "description": "", + "validationPatternMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `validationPattern` property is editable." + }, + "value": { + "description": "Specifies the value of the tab. ", "type": "string" }, - "custom": { - "description": "", + "valueMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `value` property is editable." + }, + "width": { + "description": "The width of the tab in pixels.", "type": "string" }, - "enableEsign": { - "description": "", + "widthMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `width` property is editable." + }, + "xPosition": { + "description": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n", "type": "string" }, - "esignAgreement": { - "description": "The Electronic Record and Signature Disclosure text. The disclosure text includes the html formatting.", + "xPositionMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `xPosition` property is editable." + }, + "yPosition": { + "description": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n", "type": "string" }, - "esignText": { + "yPositionMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `yPosition` property is editable." + } + }, + "x-ds-definition-name": "email", + "description": "A tab that allows the recipient to enter an email address.\nThis is a one-line field that checks that a valid email\naddress is entered. It uses the same parameters as a Text\ntab, with the validation message and pattern set for email\ninformation.\n\nWhen getting information that includes\nthis tab type, the original value of the tab when the\nassociated envelope was sent is included in the response.\n", + "x-ms-summary": "A tab that allows the recipient to enter an email address.\nThis is a one-line field that checks that a valid email\naddress is entered. It uses the same parameters as a Text\ntab, with the validation message and pattern set for email\ninformation.\n\nWhen getting information that includes\nthis tab type, the original value of the tab when the\nassociated envelope was sent is included in the response.\n" + }, + "emailAddress": { + "type": "object", + "properties": { + "anchorAllowWhiteSpaceInCharacters": { "description": "", "type": "string" }, - "languageCode": { - "description": "", + "anchorAllowWhiteSpaceInCharactersMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "" + }, + "anchorCaseSensitive": { + "description": "This property controls how [anchor tabs][AnchorTabs] are placed. When **true**, the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false**.\n\nFor example, when set to **true**, if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When set to **false**, `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**.\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place", "type": "string" }, - "mustAgreeToEsign": { - "description": "", + "anchorCaseSensitiveMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorCaseSensitive` property is editable." + }, + "anchorHorizontalAlignment": { + "description": "This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are :\n\n- `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value.\n- `right`: Aligns the tab’s left side with the last character of the matching anchor word.\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place\n", "type": "string" }, - "pdfId": { - "description": "**Deprecated**\n\nThe `€œpdfId` property in the consumer_disclosure PUT request is deprecated. For security reasons going forward, any value provided in the request packet must be ignored. ", + "anchorHorizontalAlignmentMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorHorizontalAlignment` property is editable." + }, + "anchorIgnoreIfNotPresent": { + "description": "When set to **true**, this tab is ignored if the `anchorString` is not found in the document.", "type": "string" }, - "useBrand": { - "description": "", + "anchorIgnoreIfNotPresentMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable." + }, + "anchorMatchWholeWord": { + "description": "When set to **true**, the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false**.\n\nFor example, when set to **true**, if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When set to **false**, if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**.\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTab]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place\n", "type": "string" }, - "useConsumerDisclosureWithinAccount": { - "description": "Boolean that specifies whether recipients in the same account as the sender must agree to eSign an Electronic Record and Signature Disclosure Statement.", + "anchorMatchWholeWordMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorMatchWholeWord` property is editable." + }, + "anchorString": { + "description": "Specifies the string to find in the document and use as the basis for tab placement.", "type": "string" }, - "useConsumerDisclosureWithinAccountMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `useConsumerDisclosureWithinAccount` property is editable.\n" + "anchorStringMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorString` property is editable." }, - "withdrawAddressLine1": { - "description": "Contains the first address line of the postal address to which a customer can send a consent withdrawal notification.\n\nMaximum length: 100 characters. ", + "anchorTabProcessorVersion": { + "description": "Reserved for DocuSign.", "type": "string" }, - "withdrawAddressLine2": { - "description": "Contains the second address line of the postal address to which a customer can send a consent withdrawal notification.\n\nMaximum length: 100 characters. ", - "type": "string" + "anchorTabProcessorVersionMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Reserved for DocuSign." }, - "withdrawByEmail": { - "description": "Indicates whether the customer can withdraw consent by email.", + "anchorUnits": { + "description": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n", "type": "string" }, - "withdrawByMail": { - "description": "Indicates whether the customer can withdraw consent by postal mail.", - "type": "string" + "anchorUnitsMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorUnits` property is editable." }, - "withdrawByPhone": { - "description": "Indicates whether the customer can withdraw consent by phone.", + "anchorXOffset": { + "description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n", "type": "string" }, - "withdrawCity": { - "description": "Contains the city of the postal address to which a customer can send a consent withdrawal notification.\n\nMaximum length: 50 characters. ", - "type": "string" + "anchorXOffsetMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorXOffset` property is editable." }, - "withdrawConsequences": { - "description": "Indicates the consequences of withdrawing consent.", + "anchorYOffset": { + "description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n", "type": "string" }, - "withdrawEmail": { - "description": "Contains the email address to which a customer can send a consent withdrawal notification.\n\nMaximum length: 100 characters. ", - "type": "string" + "anchorYOffsetMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorYOffset` property is editable." }, - "withdrawOther": { - "description": "Indicates other information need to withdraw consent.\n\nMaximum length: 255 characters.", + "bold": { + "description": "When set to **true**, the information in the tab is bold.", "type": "string" }, - "withdrawPhone": { - "description": "Contains the phone number which a customer can call to register consent withdrawal notification.\n\nMaximum length: 20 characters. ", - "type": "string" + "boldMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `bold` property is editable." }, - "withdrawPostalCode": { - "description": "Contains the postal code of the postal address to which a customer can send a consent withdrawal notification.\n\nMaximum length: 20 characters. ", + "conditionalParentLabel": { + "description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility.", "type": "string" }, - "withdrawState": { - "description": "Contains the state of the postal address to which a customer can send a consent withdrawal notification.", - "type": "string" - } - }, - "x-ds-definition-name": "consumerDisclosure", - "description": "", - "x-ms-summary": "" - }, - "contact": { - "type": "object", - "properties": { - "cloudProvider": { - "description": "", - "type": "string" + "conditionalParentLabelMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `conditionalParentLabel` property is editable." }, - "cloudProviderContainerId": { - "description": "", + "conditionalParentValue": { + "description": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use \"on\" as the value to show that the parent tab is active.\n", "type": "string" }, - "contactId": { - "description": "The unique identifier of a person in the contacts address book.", + "conditionalParentValueMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `conditionalParentValue` property is editable." + }, + "customTabId": { + "description": "The DocuSign-generated custom tab id for the custom tab to be applied. This property can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.", "type": "string" }, - "contactPhoneNumbers": { - "description": "", - "type": "array", - "items": { - "$ref": "#/definitions/contactPhoneNumber" - } + "customTabIdMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `customTabId` property is editable." }, - "contactUri": { - "description": "", + "documentId": { + "description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.", "type": "string" }, - "emails": { - "description": "", - "type": "array", - "items": { - "type": "string" - } + "documentIdMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `documentId` property is editable." }, "errorDetails": { "$ref": "#/definitions/errorDetails", "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." }, - "isOwner": { - "description": "", - "type": "boolean" - }, - "name": { - "description": "", + "font": { + "description": "The font to be used for the tab value. Supported fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n", "type": "string" }, - "organization": { - "description": "", + "fontColor": { + "description": "The font color to use for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n", "type": "string" }, - "shared": { - "description": "When **true**, the tab is shared.", - "type": "string" + "fontColorMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `fontColor` property is editable." }, - "signingGroup": { - "description": "", - "type": "string" + "fontMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `font` property is editable." }, - "signingGroupName": { - "description": "The display name for the signing group. \n\nMaximum Length: 100 characters. ", + "fontSize": { + "description": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72", "type": "string" - } - }, - "x-ds-definition-name": "contact", - "description": "", - "x-ms-summary": "" - }, - "contactGetResponse": { - "type": "object", - "properties": { - "contacts": { - "description": "", - "type": "array", - "items": { - "$ref": "#/definitions/Contacts" - } }, - "endPosition": { - "description": "The last position in the result set. ", - "type": "string" + "fontSizeMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `fontSize` property is editable." }, - "nextUri": { - "description": "The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. ", + "formOrder": { + "description": "An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block.", "type": "string" }, - "previousUri": { - "description": "The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. ", - "type": "string" + "formOrderMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `formOrder` property is editable." }, - "resultSetSize": { - "description": "The number of results returned in this response. Because you can filter which entries are included in the response, this value is always less than or equal to `totalSetSize`.", + "formPageLabel": { + "description": "A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience.", "type": "string" }, - "startPosition": { - "description": "The starting position of the current result set.", - "type": "string" + "formPageLabelMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `formPageLabel` property is editable." }, - "totalSetSize": { - "description": "The total number of items in the search's result set. This value is always greater than or equal to the value of `resultSetSize`.", - "type": "string" - } - }, - "x-ds-definition-name": "contactGetResponse", - "description": "", - "x-ms-summary": "" - }, - "contactModRequest": { - "type": "object", - "properties": { - "contactList": { - "description": "", - "type": "array", - "items": { - "$ref": "#/definitions/Contacts" - } - } - }, - "x-ds-definition-name": "contactModRequest", - "description": "", - "x-ms-summary": "" - }, - "contactPhoneNumber": { - "type": "object", - "properties": { - "phoneNumber": { - "description": "", + "formPageNumber": { + "description": "An integer specifying the order in which to present the guided form pages.", "type": "string" }, - "phoneType": { - "description": "", - "type": "string" - } - }, - "x-ds-definition-name": "contactPhoneNumber", - "description": "", - "x-ms-summary": "" - }, - "contactUpdateResponse": { - "type": "object", - "properties": { - "contacts": { - "description": "", - "type": "array", - "items": { - "$ref": "#/definitions/Contacts" - } - } - }, - "x-ds-definition-name": "contactUpdateResponse", - "description": "", - "x-ms-summary": "" - }, - "correctViewRequest": { - "type": "object", - "properties": { - "returnUrl": { - "description": "The url used after correct/send view session has ended. DocuSign redirects to the url and includes an event parameter that can be used by your app. The event parameters returned are: \n\n* send (user corrected and sent the envelope)\n* save (user saved the envelope)\n* cancel (user canceled the transaction.)\n* error (there was an error when performing the correct or send)\n* sessionEnd (the session ended before the user completed a different action)\n\n###### Note: Include https:// in the URL or the redirect might not succeed on some browsers. ", + "formPageNumberMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `fromPageNumber` property is editable." + }, + "height": { + "description": "The height of the tab in pixels.", "type": "string" }, - "suppressNavigation": { - "description": "Specifies whether the window is displayed with or without dressing.", + "heightMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `height` property is editable." + }, + "italic": { + "description": "When set to **true**, the information in the tab is italic.", "type": "string" - } - }, - "x-ds-definition-name": "correctViewRequest", - "description": "", - "x-ms-summary": "" - }, - "country": { - "type": "object", - "properties": { - "isoCode": { + }, + "italicMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `italic` property is editable." + }, + "localePolicy": { + "$ref": "#/definitions/localePolicyTab", + "description": "Reserved for DocuSign." + }, + "mergeField": { + "$ref": "#/definitions/mergeField", + "description": "Contains the information necessary to map the tab to a field in SalesForce." + }, + "mergeFieldXml": { "description": "", "type": "string" }, "name": { - "description": "", + "description": "The name of the tab. For example, `Sign Here` or `Initial Here`.", "type": "string" }, - "provinces": { - "description": "", - "type": "array", - "items": { - "$ref": "#/definitions/province" - } + "nameMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `name` property is editable. Read only." }, - "provinceValidated": { - "description": "", - "type": "string" - } - }, - "x-ds-definition-name": "country", - "description": "", - "x-ms-summary": "" - }, - "credential": { - "type": "object", - "properties": { - "accessCode": { - "description": "If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. \n\nMaximum Length: 50 characters and it must conform to the account's access code format setting.\n\nIf blank, but the signer `accessCode` property is set in the envelope, then that value is used.\n\nIf blank and the signer `accessCode` property is not set, then the access code is not required.", + "pageNumber": { + "description": "The page number on which the tab is located.\nFor supplemental documents, this value must be `1`.\n", "type": "string" }, - "type": { - "description": "Type of user:\n- `type_owner`\n- `type_participant`", - "type": "string" + "pageNumberMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `pageNumber` property is editable." }, - "value": { - "description": "Specifies the value of the tab. ", + "recipientId": { + "description": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.", "type": "string" - } - }, - "x-ds-definition-name": "credential", - "description": "", - "x-ms-summary": "" - }, - "creditCardInformation": { - "type": "object", - "properties": { - "address": { - "$ref": "#/definitions/addressInformation", - "description": "A complex element containing the credit card billing address information." }, - "cardNumber": { - "description": "The credit card number.", + "recipientIdGuid": { + "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only.", "type": "string" }, - "cardType": { - "description": "The type of credit card. Valid values are: \n\n- `visa` \n- `mastercard` \n- `amex`", - "type": "string" + "recipientIdGuidMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `recipientIdGuid` property is editable." }, - "cvNumber": { - "description": "The 3 or 4-digit card verification value (CVV) number associated with the credit card. CVV numbers are also referred to as card security codes (CSCs).", - "type": "string" + "recipientIdMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `recipientId` property is editable." }, - "expirationMonth": { - "description": "The month that the credit card expires, expressed as a number from 1 to 12.", - "type": "string" + "smartContractInformation": { + "$ref": "#/definitions/smartContractInformation", + "description": "" }, - "expirationYear": { - "description": "The year in which the credit card expires, in 4-digit format.", + "status": { + "description": "The status of the tab. Possible values are:\n\n- `active`: The tab is active, but the recipient has not yet interacted with it.\n- `signed`: The recipient signed the tab.\n- `declined`: The recipient declined the envelope.\n- `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`).", "type": "string" }, - "nameOnCard": { - "description": "The exact name as it appears on the credit card.", - "type": "string" - } - }, - "x-ds-definition-name": "creditCardInformation", - "description": "This object contains information about a credit card that is associated with an account.", - "x-ms-summary": "This object contains information about a credit card that is associated with an account." - }, - "creditCardTypes": { - "type": "object", - "properties": { - "cardTypes": { - "description": "An array containing supported credit card types.", + "statusMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `status` property is editable." + }, + "tabGroupLabels": { + "description": "An array of tab group labels that uniquely identify tab groups. To assign a tab to a `tabGroup`, you assign the `TabGroupLabel` to the `Tab.TabGroupLabels` array.", "type": "array", "items": { "type": "string" } - } - }, - "x-ds-definition-name": "creditCardTypes", - "description": "", - "x-ms-summary": "" - }, - "currencyFeatureSetPrice": { - "type": "object", - "properties": { - "currencyCode": { - "description": "Reserved for DocuSign.", - "type": "string" }, - "currencySymbol": { - "description": "Reserved for DocuSign.", - "type": "string" + "tabGroupLabelsMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `tabGroupLabels` property is editable." }, - "envelopeFee": { - "description": "Reserved for DocuSign.", + "tabId": { + "description": "The unique identifier for the tab.", "type": "string" }, - "fixedFee": { - "description": "Reserved for DocuSign.", - "type": "string" + "tabIdMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `tabId` property is editable." }, - "seatFee": { - "description": "Reserved for DocuSign.", - "type": "string" - } - }, - "x-ds-definition-name": "currencyFeatureSetPrice", - "description": "Information about the price and currency associated with the feature set. Reserved for internal DocuSign use only.", - "x-ms-summary": "Information about the price and currency associated with the feature set. Reserved for internal DocuSign use only." - }, - "currencyPlanPrice": { - "type": "object", - "properties": { - "currencyCode": { - "description": "Specifies the ISO currency code for the account.", + "tabLabel": { + "description": "The label associated with the tab. This value may be an empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum Length: 500 characters.\n", "type": "string" }, - "currencySymbol": { - "description": "Specifies the currency symbol for the account.", + "tabLabelMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `tabLabel` property is editable." + }, + "tabOrder": { + "description": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.", "type": "string" }, - "perSeatPrice": { - "description": "", + "tabOrderMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `tabOrder` property is editable." + }, + "tabType": { + "description": "Indicates the type of tab (for example, `signHere` or `initialHere`).", "type": "string" }, - "supportedCardTypes": { - "$ref": "#/definitions/creditCardTypes", - "description": "A simple type enumeration of the language used. The supported languages, with the language value shown in parenthesis, are: Arabic (ar), Bahasa Indonesia (id), Bahasa Melayu (ms) Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro),Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi)." + "tabTypeMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `tabType` property is editable." }, - "supportIncidentFee": { - "description": "The support incident fee charged for each support incident.", + "templateLocked": { + "description": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ", "type": "string" }, - "supportPlanFee": { - "description": "The support plan fee charged for this plan.", + "templateLockedMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `templateLocked` property is editable." + }, + "templateRequired": { + "description": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.", "type": "string" - } - }, - "x-ds-definition-name": "currencyPlanPrice", - "description": "", - "x-ms-summary": "" - }, - "customField": { - "type": "object", - "properties": { - "customFieldType": { - "description": "", + }, + "templateRequiredMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `templateRequired` property is editable." + }, + "tooltip": { + "description": "The text of a tooltip that appears when a user hovers over a form field or tab.", "type": "string" }, - "errorDetails": { - "$ref": "#/definitions/errorDetails", - "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." + "toolTipMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `toolTip` property is editable." }, - "fieldId": { - "description": "An ID used to specify a custom field.", + "underline": { + "description": "When set to **true**, the information in the tab is underlined.", "type": "string" }, - "listItems": { - "description": "An array of strings that represent the items in a list.", - "type": "array", - "items": { - "type": "string" - } + "underlineMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `underline` property is editable." }, - "name": { - "description": "", + "value": { + "description": "Specifies the value of the tab. ", "type": "string" }, - "required": { - "description": "When set to **true**, the signer is required to fill out this tab.", + "valueMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `value` property is editable." + }, + "width": { + "description": "The width of the tab in pixels.", "type": "string" }, - "show": { - "description": "A boolean indicating if the value should be displayed. If this value is set to **true**, the custom field is displayed at the top of the certificate of completion. If this value is left blank/ or set to **false**, then it does not appear in the certificate of completion. ", + "widthMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `width` property is editable." + }, + "xPosition": { + "description": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n", "type": "string" }, - "value": { - "description": "Specifies the value of the tab. ", + "xPositionMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `xPosition` property is editable." + }, + "yPosition": { + "description": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n", "type": "string" - } - }, - "x-ds-definition-name": "customField", - "description": "", - "x-ms-summary": "" - }, - "customFields": { - "description": "", - "type": "object", - "properties": { - "listCustomFields": { - "description": "An array of list custom fields.", - "type": "array", - "items": { - "$ref": "#/definitions/listCustomField" - } }, - "textCustomFields": { - "description": "An array of text custom fields.", - "type": "array", - "items": { - "$ref": "#/definitions/textCustomField" - } + "yPositionMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `yPosition` property is editable." } }, - "x-ds-definition-name": "customFields", - "x-ms-summary": "" + "x-ds-definition-name": "emailAddress", + "description": "A tab that displays the recipient's email as entered in the\nrecipient information.\n", + "x-ms-summary": "A tab that displays the recipient's email as entered in the\nrecipient information.\n" }, - "customFieldsEnvelope": { + "emailSettings": { + "description": "A complex element that allows the sender to override some envelope email setting information. This can be used to override the Reply To email address and name associated with the envelope and to override the BCC email addresses to which an envelope is sent. \n\nWhen the emailSettings information is used for an envelope, it only applies to that envelope. \n\n**IMPORTANT**: The emailSettings information is not returned in the GET for envelope status. Use GET /email_settings to return information about the emailSettings. \n\nEmailSettings consists of: \n\n* replyEmailAddressOverride - The Reply To email used for the envelope. DocuSign will verify that a correct email format is used, but does not verify that the email is active. Maximum Length: 100 characters.\n* replyEmailNameOverride - The name associated with the Reply To email address. Maximum Length: 100 characters.\n* bccEmailAddresses - An array of up to five email addresses to which the envelope is sent to as a BCC email. Only users with canManageAccount setting set to true can use this option. \nDocuSign verifies that the email format is correct, but does not verify that the email is active. Using this overrides the BCC for Email Archive information setting for this envelope. Maximum Length: 100 characters.\n*Example*: if your account has BCC for Email Archive set up for the email address 'archive@mycompany.com' and you send an envelope using the BCC Email Override to send a BCC email to 'salesarchive@mycompany.com', then a copy of the envelope is only sent to the 'salesarchive@mycompany.com' email address.", "type": "object", "properties": { - "listCustomFields": { - "description": "An array of list custom fields.", + "bccEmailAddresses": { + "description": "An array containing the email address that should receive a copy of all email communications related to an envelope for archiving purposes. Maximum Length: 100 characters.\n\nWhile this property is an array, note that it takes only a single email address.\n\n**Note**: Only users with the `canManageAccount` setting set to **true** can use this option. \n\nDocuSign verifies that the email format is correct, but does not verify that the email address is active. You can use this for archiving purposes. However, using this property overrides the BCC for Email Archive information setting for this envelope. \n\n**Example**: if your account has BCC for Email Archive set up for the email address archive@mycompany.com and you send an envelope using the BCC Email Override to send a BCC email to salesarchive@mycompany.com, then a copy of the envelope is only sent to the salesarchive@mycompany.com email address.", "type": "array", "items": { - "$ref": "#/definitions/listCustomField" + "$ref": "#/definitions/bccEmailAddress" } }, - "textCustomFields": { - "description": "An array of text custom fields.", - "type": "array", - "items": { - "$ref": "#/definitions/textCustomField" - } + "replyEmailAddressOverride": { + "description": "The Reply To email address to use for email replies, instead of the one that is configured at the account level. DocuSign verifies that the email address is in a correct format, but does not verify that it is active. Maximum Length: 100 characters.", + "type": "string" + }, + "replyEmailNameOverride": { + "description": "The name to associate with the Reply To email address, instead of the name that is configured at the account level. Maximum Length: 100 characters.", + "type": "string" } }, - "x-ds-definition-name": "customFieldsEnvelope", - "description": "", - "x-ms-summary": "" + "x-ds-definition-name": "emailSettings", + "x-ms-summary": "A complex element that allows the sender to override some envelope email setting information. This can be used to override the Reply To email address and name associated with the envelope and to override the BCC email addresses to which an envelope is sent. \n\nWhen the emailSettings information is used for an envelope, it only applies to that envelope. \n\n**IMPORTANT**: The emailSettings information is not returned in the GET for envelope status. Use GET /email_settings to return information about the emailSettings. \n\nEmailSettings consists of: \n\n* replyEmailAddressOverride - The Reply To email used for the envelope. DocuSign will verify that a correct email format is used, but does not verify that the email is active. Maximum Length: 100 characters.\n* replyEmailNameOverride - The name associated with the Reply To email address. Maximum Length: 100 characters.\n* bccEmailAddresses - An array of up to five email addresses to which the envelope is sent to as a BCC email. Only users with canManageAccount setting set to true can use this option. \nDocuSign verifies that the email format is correct, but does not verify that the email is active. Using this overrides the BCC for Email Archive information setting for this envelope. Maximum Length: 100 characters.\n*Example*: if your account has BCC for Email Archive set up for the email address 'archive@mycompany.com' and you send an envelope using the BCC Email Override to send a BCC email to 'salesarchive@mycompany.com', then a copy of the envelope is only sent to the 'salesarchive@mycompany.com' email address." }, - "customSettingsInformation": { + "eNoteConfiguration": { "type": "object", "properties": { - "customSettings": { - "description": "The name/value pair information for the user custom setting.", - "type": "array", - "items": { - "$ref": "#/definitions/nameValue" - } + "apiKey": { + "description": "", + "type": "string" + }, + "connectConfigured": { + "description": "When **false**, the user must configure Connect and eOriginal for the integration to work.", + "type": "string" + }, + "eNoteConfigured": { + "description": "When **false**, the user must configure eNote for the feature to work.\n\n**Note**: In the account settings, `allowENoteEOriginal` must be set to **true** to make changes to the configuration.", + "type": "string" + }, + "organization": { + "description": "The name of the organization.", + "type": "string" + }, + "password": { + "description": "The user's encrypted password hash.", + "type": "string" + }, + "userName": { + "description": "The user's username.", + "type": "string" } }, - "x-ds-definition-name": "customSettingsInformation", - "description": "", - "x-ms-summary": "" + "x-ds-definition-name": "eNoteConfiguration", + "description": "This object contains information used to configure [eNote](https://www.docusign.com/products/enote) functionality. To use eNote, the Allow eNote for eOriginal account plan item must be on, and the Connect configuration for eOriginal must be set correctly.", + "x-ms-summary": "This object contains information used to configure [eNote](https://www.docusign.com/products/enote) functionality. To use eNote, the Allow eNote for eOriginal account plan item must be on, and the Connect configuration for eOriginal must be set correctly." }, - "date": { + "envelope": { "type": "object", "properties": { - "anchorCaseSensitive": { - "description": "Reserved for DocuSign.\n", + "accessControlListBase64": { + "description": "Reserved for DocuSign.", "type": "string" }, - "anchorCaseSensitiveMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "allowComments": { + "description": "When set to **true**, users can add comments to the documents in the envelope. For example, if a signer has a question about the text in the document, they can add a comment to the document.", + "type": "string" }, - "anchorHorizontalAlignment": { - "description": "Reserved for DocuSign.\n\n", + "allowMarkup": { + "description": "When set to **true**, the Document Markup feature is enabled.\n\n**Note**: To use this feature, Document Markup must be enabled at both the account and envelope levels. Only Admin users can change this setting for at the account level.", "type": "string" }, - "anchorHorizontalAlignmentMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "allowReassign": { + "description": "When **true**, the recipient can redirect an envelope to a more appropriate recipient.", + "type": "string" }, - "anchorIgnoreIfNotPresent": { - "description": "When set to **true**, this tab is ignored if the `anchorString` is not found in the document.", + "allowViewHistory": { + "description": "When set to **true**, recipients can view the history of the envelope.", "type": "string" }, - "anchorIgnoreIfNotPresentMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable." + "anySigner": { + "description": "Deprecated. This feature has been replaced by signing groups.", + "type": "string" }, - "anchorMatchWholeWord": { - "description": "Reserved for DocuSign.\n\n", + "asynchronous": { + "description": "When **true**, the envelope is queued for\nprocessing and the value of the `status` property\nis set to `Processing`. Additionally, GET status\ncalls return `Processing` until completed.\n\n\n**Note**: A `transactionId` is required for this\ncall to work correctly. When the envelope is\ncreated, the status is `Processing` and an\n`envelopeId` is not returned in the response. To\nget the `envelopeId`, use a GET envelope query by\nusing the\n[transactionId](https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/Envelopes/create/) or by checking the\nConnect notification.", "type": "string" }, - "anchorMatchWholeWordMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "attachmentsUri": { + "description": "Contains a URL for retrieving the attachments that are associated with the envelope.", + "type": "string" }, - "anchorString": { - "description": "Specifies the string to find in the document and use as the basis for tab placement.", + "authoritativeCopy": { + "description": "When **true**, marks all of the documents in the envelope as authoritative copies.\n\n**Note**: You can override this value for a specific document. For example, you can set the `authoritativeCopy` property to **true** at the envelope level, but turn it off for a single document by setting the `authoritativeCopy` property for the document to **false**.", "type": "string" }, - "anchorStringMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `anchorString` property is editable." + "authoritativeCopyDefault": { + "description": "The default `authoritativeCopy` setting for documents in this envelope that do not have `authoritativeCopy` set.\nIf this property is not set, each document defaults to the envelope's `authoritativeCopy`.", + "type": "string" }, - "anchorTabProcessorVersion": { - "description": "Reserved for DocuSign.", + "autoNavigation": { + "description": "When set to **true**, autonavigation is set for the recipient.\n", "type": "string" }, - "anchorTabProcessorVersionMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "brandId": { + "description": "The id of the brand.", + "type": "string" }, - "anchorUnits": { - "description": "Specifies the units of the X and Y offset. Units may be pixels, millimeters, centimeters, or inches.", + "brandLock": { + "description": "When **true**, the `brandId` for the envelope is locked and senders cannot change the brand used for the envelope.", "type": "string" }, - "anchorUnitsMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `anchorUnits` property is editable." + "certificateUri": { + "description": "The URI for retrieving certificate information.", + "type": "string" }, - "anchorXOffset": { - "description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.", + "completedDateTime": { + "description": "Specifies the date and time this item was completed.", "type": "string" }, - "anchorXOffsetMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `anchorXOffset` property is editable." + "copyRecipientData": { + "description": "", + "type": "string" }, - "anchorYOffset": { - "description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.", + "createdDateTime": { + "description": "The UTC DateTime when the item was created.", "type": "string" }, - "anchorYOffsetMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `anchorYOffset` property is editable." + "customFields": { + "$ref": "#/definitions/AccountCustomFields", + "description": "An optional array of strings that enables the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each `customField` string can be a maximum of 100 characters." }, - "bold": { - "description": "When set to **true**, the information in the tab is bold.", + "customFieldsUri": { + "description": "The URI for retrieving custom fields.", "type": "string" }, - "boldMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `bold` property is editable." - }, - "concealValueOnDocument": { - "description": "When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender.\n\nWhen an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.", + "declinedDateTime": { + "description": "The date and time the recipient declined the document. Read only.", "type": "string" }, - "concealValueOnDocumentMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `concealValueOnDocument` property is editable." + "deletedDateTime": { + "description": "Reserved for DocuSign.", + "type": "string" }, - "conditionalParentLabel": { - "description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility.", + "deliveredDateTime": { + "description": "The date and time that the envelope was delivered to the recipient. Read only.", "type": "string" }, - "conditionalParentLabelMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `conditionalParentLabel` property is editable." + "disableResponsiveDocument": { + "description": "When set to **true**, responsive documents are disabled for the envelope.", + "type": "string" }, - "conditionalParentValue": { - "description": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use \"on\" as the value to show that the parent tab is active.\n", + "documentsCombinedUri": { + "description": "The URI for retrieving all of the documents associated with the envelope as a single PDF file.", "type": "string" }, - "conditionalParentValueMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `conditionalParentValue` property is editable." + "documentsUri": { + "description": "The URI for retrieving all of the documents associated with the envelope as separate files.", + "type": "string" }, - "customTabId": { - "description": "The DocuSign-generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.", + "emailBlurb": { + "description": "This is the same as the email body. If specified it is included in email body for all envelope recipients.", "type": "string" }, - "customTabIdMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `customTabId` property is editable." + "emailSettings": { + "$ref": "#/definitions/emailSettings", + "description": "A complex type that contains email settings." }, - "disableAutoSize": { - "description": "When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes.", + "emailSubject": { + "description": "The subject line of the email message that is sent to all recipients.\n\nFor information about adding merge field information to the email subject, see [Template Email Subject Merge Fields](https://developers.docusign.com/docs/esign-rest-api/reference/Templates/Templates/create#template-email-subject-merge-fields).\n", "type": "string" }, - "disableAutoSizeMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `disableAutoSize` property is editable." + "enableWetSign": { + "description": "When set to **true**, the signer is allowed to print the document and sign it on paper.", + "type": "string" }, - "documentId": { - "description": "Integer that identifies the document in the envelope.", + "enforceSignerVisibility": { + "description": "When set to **true**, signers can only view the documents on which they have tabs. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all of the documents in an envelope, unless they are specifically excluded by using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded by using this setting when an envelope is sent.\n\n**Note**: To use this functionality, [Document Visibility][docviz] must be enabled for the account by making the account setting `allowDocumentVisibility` **true**.\n\n[docviz]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeDocumentVisibility/", "type": "string" }, - "documentIdMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `documentId` property is editable." + "envelopeAttachments": { + "description": "An array of attachment objects that provide information about the attachments that are associated with the envelope.", + "type": "array", + "items": { + "$ref": "#/definitions/attachment" + } }, - "errorDetails": { - "$ref": "#/definitions/errorDetails", - "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." + "envelopeDocuments": { + "description": "An array containing information about the documents that are included in the envelope.", + "type": "array", + "items": { + "$ref": "#/definitions/envelopeDocument" + } }, - "font": { - "description": "The font to be used for the tab value. Supported fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n", + "envelopeId": { + "description": "The envelope ID of the envelope status that failed to post.", "type": "string" }, - "fontColor": { - "description": "The font color to use for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n", + "envelopeIdStamping": { + "description": "When set to **true**, [Envelope ID Stamping](https://support.docusign.com/en/guides/ndse-user-guide-set-advanced-document-options) is enabled.\nAfter a document or attachment is stamped with an Envelope ID,\nthe ID is seen by all recipients\nand becomes a permanent part of the document\nand cannot be removed.", "type": "string" }, - "fontColorMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `fontColor` property is editable." + "envelopeLocation": { + "description": "Reserved for DocuSign.", + "type": "string" }, - "fontMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `font` property is editable." + "envelopeMetadata": { + "$ref": "#/definitions/envelopeMetadata", + "description": "Provides information about the features and services that are enabled for the envelope, including the Correct feature, the Advanced Correct feature, and DocuSign eNotary service." }, - "fontSize": { - "description": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72", + "envelopeUri": { + "description": "The URI for retrieving the envelope or envelopes.", "type": "string" }, - "fontSizeMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `fontSize` property is editable." + "expireAfter": { + "description": "An integer specifying the number of days that a sent envelope remains active before it expires. A negative number in a response indicates that the envelope has already expired.", + "type": "string" }, - "formOrder": { - "description": "An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block.", + "expireDateTime": { + "description": "The date and time the envelope is set to expire.", "type": "string" }, - "formOrderMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `formOrder` property is editable." + "expireEnabled": { + "description": "When set to **true**, the envelope expires (is no longer available for signing) after the specified number of days after it is sent (`sentDateTime`). Set `expireAfter` to set the number of days until an envelope expires. When **false**, the account default setting is used. If the account does not have an expiration setting, the DocuSign default value of 120 days is used.", + "type": "string" }, - "formPageLabel": { - "description": "A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience.", + "externalEnvelopeId": { + "description": "May contain an external identifier for the envelope.", "type": "string" }, - "formPageLabelMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `formPageLabel` property is editable." + "folders": { + "description": "A list of folder objects.", + "type": "array", + "items": { + "$ref": "#/definitions/folder" + } }, - "formPageNumber": { - "description": "An integer specifying the order in which to present the guided form pages.", + "hasComments": { + "description": "When set to **true**, indicates that users have added comments to the envelope.", "type": "string" }, - "formPageNumberMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `fromPageNumber` property is editable." + "hasFormDataChanged": { + "description": "When set to **true**, indicates that the data collected through form fields on a document has changed.", + "type": "string" }, - "height": { - "description": "The height of the tab in pixels.", + "hasWavFile": { + "description": "When set to **true**, indicates that a .wav file used for voice authentication is included in the envelope. ", "type": "string" }, - "heightMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `height` property is editable." + "holder": { + "description": "Reserved for DocuSign.", + "type": "string" }, - "italic": { - "description": "When set to **true**, the information in the tab is italic.", + "initialSentDateTime": { + "description": "The date and time the envelope was initially sent.", "type": "string" }, - "italicMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `italic` property is editable." + "is21CFRPart11": { + "description": "When **true**, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).", + "type": "string" }, - "localePolicy": { - "$ref": "#/definitions/localePolicyTab", - "description": "Reserved for DocuSign." + "isDynamicEnvelope": { + "description": "When set to **true**, indicates that the envelope is a dynamic envelope.", + "type": "string" }, - "locked": { - "description": "When set to **true**, the signer cannot change the data of the custom tab.", + "isSignatureProviderEnvelope": { + "description": "When set to **true**, indicates that the envelope is a signature-provided envelope.", "type": "string" }, - "lockedMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `locked` property is editable." + "lastModifiedDateTime": { + "description": "The date and time that the item was last modified.", + "type": "string" }, - "maxLength": { - "description": "An optional value that describes the maximum length of the property when the property is a string.", + "location": { + "description": "Reserved for DocuSign.", "type": "string" }, - "maxLengthMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `maxLength` property is editable." + "lockInformation": { + "$ref": "#/definitions/EnvelopeLocks", + "description": "Provides lock information about an envelope that a user has locked." }, - "mergeField": { - "$ref": "#/definitions/mergeField", - "description": "Contains the information necessary to map the tab to a field in SalesForce." + "messageLock": { + "description": "When set to **true**, prevents senders from changing the contents of `emailBlurb` and `emailSubject` properties for the envelope. \n\nAdditionally, this prevents users from making changes to the contents of `emailBlurb` and `emailSubject` properties when correcting envelopes. \n\nHowever, if the `messageLock` node is set to **true** and the `emailSubject` property is empty, senders and correctors are able to add a subject to the envelope.", + "type": "string" }, - "name": { - "description": "The name of the tab. For example, `Sign Here` or `Initial Here`.", + "notification": { + "$ref": "#/definitions/notification", + "description": "" + }, + "notificationUri": { + "description": "The URI for retrieving notifications.", "type": "string" }, - "nameMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `name` property is editable." + "powerForm": { + "$ref": "#/definitions/powerForm", + "description": "Information about any PowerForms that are included in the envelope." }, - "originalValue": { - "description": "The initial value of the tab when it was sent to the recipient. ", + "purgeCompletedDate": { + "description": "The date that a purge was completed.", "type": "string" }, - "originalValueMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `originalValue` property is editable." + "purgeRequestDate": { + "description": "The date that a purge was requested.", + "type": "string" }, - "pageNumber": { - "description": "The page number on which the tab is located.\nFor supplemental documents, this value must be `1`.", + "purgeState": { + "description": "Shows the current purge state for the envelope. The possible values are:\n\n* `unpurged`: There has been no successful request to purge documents.\n* `documents_queued`: The envelope documents have been added to the purge queue, but have not been purged.\n* `documents_dequeued`: The envelope documents have been taken out of the purge queue.\n* `documents_and_metadata_queued`: The envelope documents and metadata have been added to the purge queue, but have not yet been purged.\n* `documents_purged`: The envelope documents have been successfully purged.\n* `documents_and_metadata_purged`: The envelope documents and metadata have been successfully purged.\n\n", "type": "string" }, - "pageNumberMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `pageNumber` property is editable." + "recipients": { + "$ref": "#/definitions/EnvelopeRecipients", + "description": "An array of recipient objects that provides details about the recipients of the envelope." }, - "recipientId": { - "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", + "recipientsLock": { + "description": "When set to **true**, prevents senders from changing, correcting, or deleting the recipient information for the envelope.", "type": "string" }, - "recipientIdGuid": { - "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one.", + "recipientsUri": { + "description": "Contains a URI for an endpoint that you can use to retrieve the recipients.", "type": "string" }, - "recipientIdGuidMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `recipientIdGuid` property is editable." + "sender": { + "$ref": "#/definitions/userInfo", + "description": "Information about the sender of the envelope." }, - "recipientIdMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `recipientId` property is editable." + "sentDateTime": { + "description": "The UTC DateTime when the envelope was sent. Read only.", + "type": "string" }, - "requireAll": { - "description": "When set to **true** and shared is true, information must be entered in this field to complete the envelope. ", + "signerCanSignOnMobile": { + "description": "When set to **true**, recipients can sign on a mobile device.\n\n**Note**: Only Admin users can change this setting.\n", "type": "string" }, - "requireAllMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `requireAll` property is editable." + "signingLocation": { + "description": "Specifies the physical location where the signing takes place. It can have two enumeration values; `inPerson` and `online`. The default value is `online`.", + "type": "string" }, - "required": { - "description": "When set to **true**, the signer is required to fill out this tab.", + "status": { + "description": "Indicates the envelope status. Valid values are:\n\n* `completed`: The recipients have finished working with the envelope: the documents are signed and all required tabs are filled in.\n* `created`: The envelope is created as a draft. It can be modified and sent later.\n* `declined`: The envelope has been declined by the recipients.\n* `delivered`: The envelope has been delivered to the recipients.\n* `sent`: The envelope will be sent to the recipients after the envelope is created.\n* `signed`: The envelope has been signed by the recipients.\n* `voided`: The envelope is no longer valid and recipients cannot access or sign the envelope.\n", "type": "string" }, - "requiredMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `required` property is editable." + "statusChangedDateTime": { + "description": "The data and time that the status changed.", + "type": "string" }, - "requireInitialOnSharedChange": { - "description": "Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.", + "statusDateTime": { + "description": "The DateTime that the envelope changed status (i.e. was created or sent.)", "type": "string" }, - "requireInitialOnSharedChangeMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `requireInitialOnSharedChange` property is editable." + "templatesUri": { + "description": "The URI for retrieving the templates.", + "type": "string" }, - "senderRequired": { - "description": "When set to **true**, the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope.", + "transactionId": { + "description": "Specifies the Transaction ID from the AppStore.", "type": "string" }, - "senderRequiredMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `senderRequired` property is editable." + "useDisclosure": { + "description": "When set to **true**, the disclosure is shown to recipients in accordance with the account's Electronic Record and Signature Disclosure frequency setting. When set to **false**, the Electronic Record and Signature Disclosure is not shown to any envelope recipients. \n\nIf the `useDisclosure` property is not set, then the account's normal disclosure setting is used and the value of the `useDisclosure` property is not returned in responses when getting envelope information.", + "type": "string" }, - "shared": { - "description": "When set to **true**, this custom tab is shared.", + "voidedDateTime": { + "description": "The date and time the envelope or template was voided.", "type": "string" }, - "sharedMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `shared` property is editable." + "voidedReason": { + "description": "The reason the envelope or template was voided.", + "type": "string" }, - "status": { - "description": "The status of the tab. Possible values are:\n\n- `active`: The tab is active, but the recipient has not yet interacted with it.\n- `signed`: The recipient signed the tab.\n- `declined`: The recipient declined the envelope.\n- `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`).\n", + "workflow": { + "$ref": "#/definitions/workflow", + "description": "" + } + }, + "x-ds-definition-name": "envelope", + "description": "", + "x-ms-summary": "" + }, + "envelopeAttachment": { + "type": "object", + "properties": { + "accessControl": { + "description": "Valid values are `sender` and `senderAndAllRecipients`.", + "type": "string" + }, + "attachmentId": { + "description": "The unique identifier for the attachment.", + "type": "string" + }, + "attachmentType": { + "description": "Specifies the type of the attachment for the recipient. Possible values are:\n\n- `.htm`\n- `.xml`", + "type": "string" + }, + "errorDetails": { + "$ref": "#/definitions/errorDetails", + "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." + }, + "label": { + "description": "", + "type": "string" + }, + "name": { + "description": "", + "type": "string" + } + }, + "x-ds-definition-name": "envelopeAttachment", + "description": "", + "x-ms-summary": "" + }, + "envelopeAttachmentsRequest": { + "type": "object", + "properties": { + "attachments": { + "description": "An object that contains information about the attachment.", + "type": "array", + "items": { + "$ref": "#/definitions/attachment" + } + } + }, + "x-ds-definition-name": "envelopeAttachmentsRequest", + "description": "", + "x-ms-summary": "" + }, + "envelopeAttachmentsResult": { + "type": "object", + "properties": { + "attachments": { + "description": "An array of attachment objects that contain information about the attachments.", + "type": "array", + "items": { + "$ref": "#/definitions/envelopeAttachment" + } + } + }, + "x-ds-definition-name": "envelopeAttachmentsResult", + "description": "", + "x-ms-summary": "" + }, + "envelopeAuditEvent": { + "type": "object", + "properties": { + "eventFields": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/nameValue" + } + } + }, + "x-ds-definition-name": "envelopeAuditEvent", + "description": "", + "x-ms-summary": "" + }, + "envelopeAuditEventResponse": { + "type": "object", + "properties": { + "auditEvents": { + "description": "Reserved: TBD", + "type": "array", + "items": { + "$ref": "#/definitions/envelopeAuditEvent" + } + } + }, + "x-ds-definition-name": "envelopeAuditEventResponse", + "description": "", + "x-ms-summary": "" + }, + "envelopeDefinition": { + "type": "object", + "properties": { + "accessControlListBase64": { + "description": "Reserved for DocuSign.", "type": "string" }, - "statusMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `status` property is editable." + "accessibility": { + "description": "Sets the document reading zones for screen reader applications. This element can only be used if Document Accessibility is enabled for the account.\n\n**Note**: This information is currently generated from the DocuSign web console by setting the reading zones when creating a template, exporting the reading zone string information, and adding it here.", + "type": "string" }, - "tabGroupLabels": { - "description": "An array of tab group labels that uniquely identify tab groups. To assign a tab to a `tabGroup`, you assign the `TabGroupLabel` to the `Tab.TabGroupLabels` array.", - "type": "array", - "items": { - "type": "string" - } + "allowComments": { + "description": "When **true**, comments are allowed on the envelope.", + "type": "string" }, - "tabGroupLabelsMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `tabGroupLabels` property is editable." + "allowMarkup": { + "description": "When set to **true**, the Document Markup feature is enabled.\n\n**Note**: To use this feature, Document Markup must be enabled at both the account and envelope levels. Only Admin users can change this setting for at the account level.", + "type": "string" }, - "tabId": { - "description": "The unique identifier for the tab.", + "allowReassign": { + "description": "When **true**, the recipient can redirect an envelope to a more appropriate recipient.", "type": "string" }, - "tabIdMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `tabId` property is editable." + "allowRecipientRecursion": { + "description": "When set to **true**, this enables the Recursive Recipients feature and allows a recipient to appear more than once in the routing order.", + "type": "string" }, - "tabLabel": { - "description": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n", + "allowViewHistory": { + "description": "When **true**, users can view the history of the envelope.", "type": "string" }, - "tabLabelMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `tabLabel` property is editable." + "anySigner": { + "description": "Deprecated. This feature has been replaced by signing groups.", + "type": "string" }, - "tabOrder": { - "description": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.", + "asynchronous": { + "description": "When **true**, the envelope is queued for\nprocessing and the value of the `status` property\nis set to `Processing`. Additionally, GET status\ncalls return `Processing` until completed.\n\n\n**Note**: A `transactionId` is required for this\ncall to work correctly. When the envelope is\ncreated, the status is `Processing` and an\n`envelopeId` is not returned in the response. To\nget the `envelopeId`, use a GET envelope query by\nusing the\n[transactionId](https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/Envelopes/create/) or by checking the\nConnect notification.", "type": "string" }, - "tabOrderMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `tabOrder` property is editable." + "attachments": { + "description": "An array of attachment objects containing details about any envelope attachments.", + "type": "array", + "items": { + "$ref": "#/definitions/attachment" + } }, - "tabType": { - "description": "Indicates the type of tab (for example, `signHere` or `initialHere`).", + "attachmentsUri": { + "description": "The URI for retrieving the envelope attachments.", "type": "string" }, - "tabTypeMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `tabType` property is editable." - }, - "templateLocked": { - "description": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ", + "authoritativeCopy": { + "description": "When **true**, marks all of the documents in the envelope as authoritative copies.\n\n**Note**: You can override this value for a specific document. For example, you can set the `authoritativeCopy` property to **true** at the envelope level, but turn it off for a single document by setting the `authoritativeCopy` property for the document to **false**.", "type": "string" }, - "templateLockedMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `templateLocked` property is editable." + "authoritativeCopyDefault": { + "description": "The default `authoritativeCopy` setting for documents in this envelope that do not have `authoritativeCopy` set.\nIf this property is not set, each document defaults to the envelope's `authoritativeCopy`.", + "type": "string" }, - "templateRequired": { - "description": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.", + "autoNavigation": { + "description": "When set to **true**, autonavigation is set for the recipient.\n", "type": "string" }, - "templateRequiredMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `templateRequired` property is editable." + "brandId": { + "description": "The id of the brand, or text and formatting, to use for the envelope. To use brands, account branding must be enabled for the account.", + "type": "string" }, - "tooltip": { - "description": "The text of a tooltip that appears when a user hovers over a form field or tab.", + "brandLock": { + "description": "When **true**, the `brandId` for the envelope is locked and senders cannot change the brand used for the envelope.", "type": "string" }, - "toolTipMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `toolTip` property is editable." + "certificateUri": { + "description": "The URI for retrieving certificate information.", + "type": "string" }, - "underline": { - "description": "When set to **true**, the information in the tab is underlined.", + "completedDateTime": { + "description": "The date and time that the envelope was completed.", "type": "string" }, - "underlineMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `underline` property is editable." + "compositeTemplates": { + "description": "A complex type that can be added to create envelopes from a combination of DocuSign templates and PDF forms. The basic envelope remains the same, while the Composite Template adds new document and template overlays into the envelope. There can be any number of Composite Template structures in the envelope.", + "type": "array", + "items": { + "$ref": "#/definitions/compositeTemplate" + } }, - "validationMessage": { - "description": "The message displayed if the custom tab fails input validation (either custom of embedded).", + "copyRecipientData": { + "description": "", "type": "string" }, - "validationMessageMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `validationMessage` property is editable." - }, - "validationPattern": { - "description": "A regular expression used to validate input for the tab.", + "createdDateTime": { + "description": "The date and time that the envelope was created.", "type": "string" }, - "validationPatternMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `validationPattern` property is editable." + "customFields": { + "$ref": "#/definitions/AccountCustomFields", + "description": "An optional array of strings that enables the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each `customField` string can be a maximum of 100 characters." }, - "value": { - "description": "Specifies the value of the tab. ", + "customFieldsUri": { + "description": "The URI for retrieving custom fields.", "type": "string" }, - "valueMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `value` property is editable." + "declinedDateTime": { + "description": "The date and time that the recipient declined the envelope.", + "type": "string" }, - "width": { - "description": "The width of the tab in pixels.", + "deletedDateTime": { + "description": "The date and time that the envelope was deleted.", "type": "string" }, - "widthMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `width` property is editable." + "deliveredDateTime": { + "description": "The date and time that the envelope was delivered to the recipient. Read only.", + "type": "string" }, - "xPosition": { - "description": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n", + "disableResponsiveDocument": { + "description": "When set to **true**, the responsive document feature is turned off for the envelope.", "type": "string" }, - "xPositionMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `xPosition` property is editable." + "documents": { + "description": "A complex element that contains details about the documents associated with the envelope.", + "type": "array", + "items": { + "$ref": "#/definitions/document" + } }, - "yPosition": { - "description": "This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.", + "documentsCombinedUri": { + "description": "The URI for retrieving all of the documents associated with the envelope as a single PDF file.", "type": "string" }, - "yPositionMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `yPosition` property is editable." - } - }, - "x-ds-definition-name": "date", - "description": "A tab that allows the recipient to enter a date. Date tabs\nare one-line fields that allow date information to be\nentered in any format. The tooltip for this tab recommends\nentering the date as MM/DD/YYYY, but this is not enforced.\nThe format entered by the signer is retained. If you need a\nparticular date format enforced, DocuSign recommends using a\nText tab with a validation pattern and a validation message\nto enforce the format.\n", - "x-ms-summary": "A tab that allows the recipient to enter a date. Date tabs\nare one-line fields that allow date information to be\nentered in any format. The tooltip for this tab recommends\nentering the date as MM/DD/YYYY, but this is not enforced.\nThe format entered by the signer is retained. If you need a\nparticular date format enforced, DocuSign recommends using a\nText tab with a validation pattern and a validation message\nto enforce the format.\n" - }, - "dateSigned": { - "type": "object", - "properties": { - "anchorCaseSensitive": { - "description": "Reserved for DocuSign.\n", + "documentsUri": { + "description": "The URI for retrieving all of the documents associated with the envelope as separate files.", "type": "string" }, - "anchorCaseSensitiveMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." - }, - "anchorHorizontalAlignment": { - "description": "Reserved for DocuSign.\n\n", + "emailBlurb": { + "description": "This optional element holds the body of the email message that is sent to all envelope recipients. \n\nMaximum Length: 10000 characters.", "type": "string" }, - "anchorHorizontalAlignmentMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "emailSettings": { + "$ref": "#/definitions/emailSettings", + "description": "This optional complex element enables the sender to override some envelope email setting information. This can be used to override the Reply To email address and name associated with the envelope, as well as the BCC email addresses to which an envelope is sent. When the `emailSettings` information is used for an envelope, it only applies to that envelope.\n\n**Important Note**: The `emailSettings` information is not returned in the GET method for envelope status. Use GET /email_settings to return information about the emailSettings." }, - "anchorIgnoreIfNotPresent": { - "description": "When set to **true**, this tab is ignored if the `anchorString` is not found in the document.", + "emailSubject": { + "description": "The subject line of the email message that is sent to all recipients.\n\nFor information about adding merge field information to the email subject, see [Template Email Subject Merge Fields](https://developers.docusign.com/docs/esign-rest-api/reference/Templates/Templates/create#template-email-subject-merge-fields).\n", "type": "string" }, - "anchorIgnoreIfNotPresentMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable." + "enableWetSign": { + "description": "When set to **true**, the signer is allowed to print the document and sign it on paper.", + "type": "string" }, - "anchorMatchWholeWord": { - "description": "Reserved for DocuSign.\n\n", + "enforceSignerVisibility": { + "description": "When set to **true**, signers can only view the documents on which they have tabs. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all of the documents in an envelope, unless they are specifically excluded by using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded by using this setting when an envelope is sent.\n\n**Note**: To use this functionality, [Document Visibility][docviz] must be enabled for the account by making the account setting `allowDocumentVisibility` **true**.\n\n[docviz]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeDocumentVisibility/", "type": "string" }, - "anchorMatchWholeWordMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "envelopeAttachments": { + "description": "An array of attachment objects that provide information about the attachments that are associated with the envelope.", + "type": "array", + "items": { + "$ref": "#/definitions/attachment" + } }, - "anchorString": { - "description": "Specifies the string to find in the document and use as the basis for tab placement.", + "envelopeDocuments": { + "description": "An array containing information about the documents that are included in the envelope.", + "type": "array", + "items": { + "$ref": "#/definitions/envelopeDocument" + } + }, + "envelopeId": { + "description": "The envelope ID of the envelope status that failed to post.", "type": "string" }, - "anchorStringMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `anchorString` property is editable." + "envelopeIdStamping": { + "description": "When set to **true**, [Envelope ID Stamping](https://support.docusign.com/en/guides/ndse-user-guide-set-advanced-document-options) is enabled.\nAfter a document or attachment is stamped with an Envelope ID,\nthe ID is seen by all recipients\nand becomes a permanent part of the document\nand cannot be removed.", + "type": "string" }, - "anchorTabProcessorVersion": { + "envelopeLocation": { "description": "Reserved for DocuSign.", "type": "string" }, - "anchorTabProcessorVersionMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "envelopeMetadata": { + "$ref": "#/definitions/envelopeMetadata", + "description": "Metadata about the features that are enabled for the envelope." }, - "anchorUnits": { - "description": "Specifies the units of the X and Y offset. Units may be pixels, millimeters, centimeters, or inches.", + "envelopeUri": { + "description": "The URI for retrieving the envelope or envelopes.", "type": "string" }, - "anchorUnitsMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `anchorUnits` property is editable." + "eventNotification": { + "$ref": "#/definitions/eventNotification", + "description": "" }, - "anchorXOffset": { - "description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.", + "expireAfter": { + "description": "An integer specifying the number of days that a sent envelope remains active before it expires. A negative number in a response indicates that the envelope has already expired.", "type": "string" }, - "anchorXOffsetMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `anchorXOffset` property is editable." - }, - "anchorYOffset": { - "description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.", + "expireDateTime": { + "description": "The date and time the envelope is set to expire.", "type": "string" }, - "anchorYOffsetMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `anchorYOffset` property is editable." + "expireEnabled": { + "description": "When set to **true**, the envelope expires (is no longer available for signing) after the specified number of days after it is sent (`sentDateTime`). Set `expireAfter` to set the number of days until an envelope expires. When **false**, the account default setting is used. If the account does not have an expiration setting, the DocuSign default value of 120 days is used.", + "type": "string" }, - "bold": { - "description": "When set to **true**, the information in the tab is bold.", + "externalEnvelopeId": { + "description": "May contain an external identifier for the envelope.", "type": "string" }, - "boldMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `bold` property is editable." + "folders": { + "description": "An array of folders that the envelope belongs to.", + "type": "array", + "items": { + "$ref": "#/definitions/folder" + } }, - "conditionalParentLabel": { - "description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility.", + "hasComments": { + "description": "When set to **true**, indicates that users have added comments to the envelope.", "type": "string" }, - "conditionalParentLabelMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `conditionalParentLabel` property is editable." + "hasFormDataChanged": { + "description": "When set to **true**, indicates that the form data associated with the envelope has changed since it was sent. If **false**, this property does not appear in the response.", + "type": "string" }, - "conditionalParentValue": { - "description": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use \"on\" as the value to show that the parent tab is active.\n", + "hasWavFile": { + "description": "When set to **true**, indicates that a wave file (voice recording) is part of the envelope.", "type": "string" }, - "conditionalParentValueMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `conditionalParentValue` property is editable." + "holder": { + "description": "Reserved for DocuSign.", + "type": "string" }, - "customTabId": { - "description": "The DocuSign-generated custom tab id for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.", + "initialSentDateTime": { + "description": "The date and time that the envelope was first sent.", "type": "string" }, - "customTabIdMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `customTabId` property is editable." + "is21CFRPart11": { + "description": "When **true**, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).", + "type": "string" }, - "documentId": { - "description": "Integer that identifies the document in the envelope.", + "isDynamicEnvelope": { + "description": "When set to **true**, indicates that the envelope is a dynamic envelope.", "type": "string" }, - "documentIdMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `documentId` property is editable." + "isSignatureProviderEnvelope": { + "description": "When set to **true**, indicates that the envelope is a signature-provided envelope.", + "type": "string" }, - "errorDetails": { - "$ref": "#/definitions/errorDetails", - "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." + "lastModifiedDateTime": { + "description": "The date and time that the item was last modified.", + "type": "string" }, - "font": { - "description": "The font to be used for the tab value. Supported fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n", + "location": { + "description": "Reserved for DocuSign.", "type": "string" }, - "fontColor": { - "description": "The font color to use for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n", + "lockInformation": { + "$ref": "#/definitions/EnvelopeLocks", + "description": "Provides lock information about an envelope that a user has locked." + }, + "messageLock": { + "description": "When set to **true**, prevents senders from changing the contents of `emailBlurb` and `emailSubject` properties for the envelope. \n\nAdditionally, this prevents users from making changes to the contents of `emailBlurb` and `emailSubject` properties when correcting envelopes. \n\nHowever, if the `messageLock` node is set to **true** and the `emailSubject` property is empty, senders and correctors are able to add a subject to the envelope.", "type": "string" }, - "fontColorMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `fontColor` property is editable." + "notification": { + "$ref": "#/definitions/notification", + "description": "An optional complex element that specifies the notification options for the envelope." }, - "fontMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `font` property is editable." + "notificationUri": { + "description": "The URI for retrieving notifications.", + "type": "string" }, - "fontSize": { - "description": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72", + "password": { + "description": "The user's encrypted password hash.", "type": "string" }, - "fontSizeMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `fontSize` property is editable." + "powerForm": { + "$ref": "#/definitions/powerForm", + "description": "Information about any PowerForms that are included in the envelope." }, - "formOrder": { - "description": "An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block.", + "purgeCompletedDate": { + "description": "The date that a purge was completed.", "type": "string" }, - "formOrderMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `formOrder` property is editable." + "purgeRequestDate": { + "description": "The date that a purge was requested.", + "type": "string" }, - "formPageLabel": { - "description": "A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience.", + "purgeState": { + "description": "Initiates a purge request. Valid values are:\n* `documents_queued`: Places envelope documents in the purge queue.\n* `documents_and_metadata_queued`: Places envelope documents and metadata in the purge queue.\n", "type": "string" }, - "formPageLabelMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `formPageLabel` property is editable." + "recipients": { + "$ref": "#/definitions/EnvelopeRecipients", + "description": "Specifies the envelope recipients." }, - "formPageNumber": { - "description": "An integer specifying the order in which to present the guided form pages.", + "recipientsLock": { + "description": "When set to **true**, prevents senders from changing, correcting, or deleting the recipient information for the envelope.", "type": "string" }, - "formPageNumberMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `fromPageNumber` property is editable." - }, - "height": { - "description": "The height of the tab in pixels.", + "recipientsUri": { + "description": "Contains a URI for an endpoint that you can use to retrieve the recipients.", "type": "string" }, - "heightMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `height` property is editable." + "sender": { + "$ref": "#/definitions/userInfo", + "description": "Information about the sender of the envelope." }, - "italic": { - "description": "When set to **true**, the information in the tab is italic.", + "sentDateTime": { + "description": "The UTC DateTime when the envelope was sent. Read only.", "type": "string" }, - "italicMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `italic` property is editable." + "signerCanSignOnMobile": { + "description": "When set to **true**, recipients can sign on a mobile device.\n\n**Note**: Only Admin users can change this setting.\n", + "type": "string" }, - "localePolicy": { - "$ref": "#/definitions/localePolicyTab", - "description": "Reserved for DocuSign." + "signingLocation": { + "description": "Specifies the physical location where the signing takes place. It can have two enumeration values; `inPerson` and `online`. The default value is `online`.", + "type": "string" }, - "mergeField": { - "$ref": "#/definitions/mergeField", - "description": "Contains the information necessary to map the tab to a field in SalesForce." + "status": { + "description": "Indicates the envelope status. Valid values when creating an envelope are: \n\n* `created`: The envelope is created as a draft. It can be modified and sent later.\n* `sent`: The envelope will be sent to the recipients after the envelope is created.\n\nYou can query these additional statuses once the recipients have interacted with the envelope.\n\n* `completed`: The recipients have finished working with the envelope: the documents are signed and all required tabs are filled in.\n* `declined`: The envelope has been declined by the recipients.\n* `delivered`: The envelope has been delivered to the recipients.\n* `signed`: The envelope has been signed by the recipients.\n* `voided`: The envelope is no longer valid and recipients cannot access or sign the envelope.\n", + "type": "string" }, - "name": { - "description": "The name of the tab. For example, `Sign Here` or `Initial Here`.", + "statusChangedDateTime": { + "description": "The data and time that the status changed.", "type": "string" }, - "nameMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `name` property is editable." + "statusDateTime": { + "description": "The DateTime that the envelope changed status (i.e. was created or sent.)", + "type": "string" }, - "pageNumber": { - "description": "The page number on which the tab is located.\nFor supplemental documents, this value must be `1`.", + "templateId": { + "description": "The id of the template. If a value is not provided, DocuSign generates a value. ", "type": "string" }, - "pageNumberMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `pageNumber` property is editable." + "templateRoles": { + "description": "This object specifies the template recipients. Each `roleName` in the template must have a recipient assigned to it. This object is comprised of the following elements:\n\n* `email`: The recipient's email address.\n* `name`: The recipient's name.\n* `roleName`: The template roleName associated with the recipient.\n* `clientUserId`: An optional property that specifies whether the recipient is embedded or remote. If the `clientUserId` is not null, then the recipient is embedded. Note that if a `clientUserId` is used and the account settings `signerMustHaveAccount` or `signerMustLoginToSign` are **true**, an error is generated on sending.\n* `defaultRecipient`: Optional, When set to **true**, this recipient is the default recipient and any tabs generated by the `transformPdfFields` option are mapped to this recipient.\n* `routingOrder`: This specifies the routing order of the recipient in the envelope.\n* `accessCode`: This optional element specifies the access code a recipient has to enter to validate the identity. Maximum Length: 50 characters.\n* `inPersonSignerName`: Optional. If the template role is an in-person signer, this is the full legal name of the signer. Maximum Length: 100 characters.\n* `emailNotification`: This is an optional complex element that has a role-specific `emailSubject`, `emailBody`, and `language`. It follows the same format as the `emailNotification` property for recipients.\n* `tabs`: This property enables the tab values to be specified for matching to tabs in the template.\n", + "type": "array", + "items": { + "$ref": "#/definitions/templateRole" + } }, - "recipientId": { - "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", + "templatesUri": { + "description": "The URI for retrieving any templates associated with the envelope.", "type": "string" }, - "recipientIdGuid": { - "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one.", + "transactionId": { + "description": " Used to identify an envelope. The id is a sender-generated value and is valid in the DocuSign system for 7 days. We recommend that you use a transaction ID for offline signing to ensure that an envelope is not sent multiple times. You can use the `transactionId` property to determine an envelope's status (i.e. was it created or not) in cases where the Internet connection was lost before the envelope status was returned.", "type": "string" }, - "recipientIdGuidMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `recipientIdGuid` property is editable." - }, - "recipientIdMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `recipientId` property is editable." + "useDisclosure": { + "description": "When set to **true**, the disclosure is shown to recipients in accordance with the account's Electronic Record and Signature Disclosure frequency setting. When set to **false**, the Electronic Record and Signature Disclosure is not shown to any envelope recipients. \n\nIf the `useDisclosure` property is not set, then the account's normal disclosure setting is used and the value of the `useDisclosure` property is not returned in responses when getting envelope information.", + "type": "string" }, - "status": { - "description": "The status of the tab. Possible values are:\n\n- `active`: The tab is active, but the recipient has not yet interacted with it.\n- `signed`: The recipient signed the tab.\n- `declined`: The recipient declined the envelope.\n- `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`).", + "voidedDateTime": { + "description": "The date and time the envelope or template was voided.", "type": "string" }, - "statusMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `status` property is editable." + "voidedReason": { + "description": "The reason the envelope or template was voided.", + "type": "string" }, - "tabGroupLabels": { - "description": "An array of tab group labels that uniquely identify tab groups. To assign a tab to a `tabGroup`, you assign the `TabGroupLabel` to the `Tab.TabGroupLabels` array.", + "workflow": { + "$ref": "#/definitions/workflow", + "description": "Describes the workflow for this envelope." + } + }, + "x-ds-definition-name": "envelopeDefinition", + "description": "Envelope object definition.", + "x-ms-summary": "Envelope object definition." + }, + "envelopeDocument": { + "type": "object", + "properties": { + "addedRecipientIds": { + "description": "If recipients were added by converting form fields into tabs, their ids appear here. Read only.", "type": "array", "items": { "type": "string" } }, - "tabGroupLabelsMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `tabGroupLabels` property is editable." + "attachmentTabId": { + "description": "If this document is an attachment to another document in the envelope, this is the id of the attachment tab it is associated with on the other document.", + "type": "string" }, - "tabId": { - "description": "The unique identifier for the tab.", + "authoritativeCopy": { + "description": "When **true**, marks all of the documents in the envelope as authoritative copies.\n\n**Note**: You can override this value for a specific document. For example, you can set the `authoritativeCopy` property to **true** at the envelope level, but turn it off for a single document by setting the `authoritativeCopy` property for the document to **false**.", "type": "string" }, - "tabIdMetadata": { + "authoritativeCopyMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `tabId` property is editable." + "description": "Metadata that indicates if the sender can edit the `authoritativeCopy` property. Not applicable for template documents." }, - "tabLabel": { - "description": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n", - "type": "string" + "availableDocumentTypes": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/signatureType" + } }, - "tabLabelMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `tabLabel` property is editable." + "containsPdfFormFields": { + "description": "When **true**, the document has editable form fields that are made available through a PDF format.", + "type": "string" }, - "tabOrder": { - "description": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.", + "display": { + "description": "This string sets the display and behavior properties of\nthe document during signing. The possible values are:\n\n* `modal`
\n The document is shown as a supplement action strip\n and can be viewed, downloaded, or printed in a modal window.\n This is the recommended value for supplemental documents. \n\n* `download`
\n The document is shown as a supplement action strip\n and can be viewed, downloaded, or printed in a new browser window. \n\n* `inline`
\n The document is shown in the normal signing window.\n This value is not used with supplemental documents,\n but is the default value for all other documents.\n", "type": "string" }, - "tabOrderMetadata": { + "displayMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `tabOrder` property is editable." + "description": "Metadata that indicates if the sender can edit the `display` property. Not applicable for template documents." }, - "tabType": { - "description": "Indicates the type of tab (for example, `signHere` or `initialHere`).", - "type": "string" + "documentFields": { + "description": "An object containing information about the custom fields on the document.", + "type": "array", + "items": { + "$ref": "#/definitions/nameValue" + } }, - "tabTypeMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `tabType` property is editable." + "documentId": { + "description": "The id of the document that the tab is placed on. This value must refer to the id of an existing document.", + "type": "string" }, - "templateLocked": { - "description": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ", + "documentIdGuid": { + "description": "The GUID of the document.", "type": "string" }, - "templateLockedMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `templateLocked` property is editable." + "errorDetails": { + "$ref": "#/definitions/errorDetails", + "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." }, - "templateRequired": { - "description": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.", + "includeInDownload": { + "description": "When set to **true**,\nthe document is included in the combined document download (`documentsCombinedUri`). \nThe default value is **true**.\n", "type": "string" }, - "templateRequiredMetadata": { + "includeInDownloadMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `templateRequired` property is editable." + "description": "Metadata that indicates if the sender can edit the `includeInDowload` property. Not applicable for template documents." }, - "tooltip": { - "description": "The text of a tooltip that appears when a user hovers over a form field or tab.", + "name": { + "description": "The document's file name. \n\nExample: `Q1-Report.docx`", "type": "string" }, - "toolTipMetadata": { + "nameMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `toolTip` property is editable." + "description": "Metadata that indicates if the sender can edit the `name` property. Not applicable for template documents." }, - "underline": { - "description": "When set to **true**, the information in the tab is underlined.", + "order": { + "description": "(Optional) The order in which to sort the results.\n\nValid values are: \n\n\n* `asc`: Ascending order.\n* `desc`: Descending order. ", "type": "string" }, - "underlineMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `underline` property is editable." + "pages": { + "description": "An array of page objects that contain information about the pages in the document.", + "type": "array", + "items": { + "$ref": "#/definitions/page" + } }, - "value": { - "description": "Specifies the value of the tab. ", + "signerMustAcknowledge": { + "description": "Sets how the signer interacts with the supplemental document.\nThe possible values are: \n\n*\t`no_interaction`
\n No recipient action is required. \n\n*\t`view`
\n The recipient is required to view the document. \n\n*\t`accept`
\n The recipient is required to accept the document by selecting accept during signing, but is not required to view the document. \n\n*\t`view_accept`
\n The recipient is required to view and accept the document. \n\n", "type": "string" }, - "valueMetadata": { + "signerMustAcknowledgeMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `value` property is editable." + "description": "Metadata that indicates if the sender can edit the `signerMustAcknowledge` property. Not applicable for template documents." }, - "width": { - "description": "The width of the tab in pixels.", + "sizeBytes": { + "description": "", "type": "string" }, - "widthMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `width` property is editable." + "templateLocked": { + "description": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ", + "type": "string" }, - "xPosition": { - "description": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n", + "templateRequired": { + "description": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.", "type": "string" }, - "xPositionMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `xPosition` property is editable." + "type": { + "description": "", + "type": "string" }, - "yPosition": { - "description": "This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.", + "uri": { + "description": "The URI for retrieving the document.", "type": "string" + } + }, + "x-ds-definition-name": "envelopeDocument", + "description": "This object contains details about the envelope document.", + "x-ms-summary": "This object contains details about the envelope document." + }, + "envelopeDocumentsResult": { + "type": "object", + "properties": { + "envelopeDocuments": { + "description": "An array containing information about the documents that are included in the envelope.", + "type": "array", + "items": { + "$ref": "#/definitions/envelopeDocument" + } }, - "yPositionMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `yPosition` property is editable." + "envelopeId": { + "description": "The envelope ID of the envelope status that failed to post.", + "type": "string" } }, - "x-ds-definition-name": "dateSigned", - "description": "A tab that displays the date that the recipient signed the\ndocument.\n", - "x-ms-summary": "A tab that displays the date that the recipient signed the\ndocument.\n" + "x-ds-definition-name": "envelopeDocumentsResult", + "description": "", + "x-ms-summary": "" }, - "dateStampProperties": { + "envelopeEvent": { "type": "object", "properties": { - "dateAreaHeight": { - "description": "The height of the rectangle.", + "envelopeEventStatusCode": { + "description": "An envelope status for which your webhook should be called. Values: Draft, Sent, Delivered, Completed, Declined, or Voided.", "type": "string" }, - "dateAreaWidth": { - "description": "The width of the rectangle.", + "includeDocuments": { + "description": "When set to **true**, the PDF documents are included in the message along with the updated XML. ", + "type": "string" + } + }, + "x-ds-definition-name": "envelopeEvent", + "description": "For which envelope events should your webhook be called?", + "x-ms-summary": "For which envelope events should your webhook be called?" + }, + "envelopeFormData": { + "type": "object", + "properties": { + "emailSubject": { + "description": "The subject line of the email message that is sent to all recipients.\n\nFor information about adding merge field information to the email subject, see [Template Email Subject Merge Fields](https://developers.docusign.com/docs/esign-rest-api/reference/Templates/Templates/create#template-email-subject-merge-fields).\n", "type": "string" }, - "dateAreaX": { - "description": "The X axis position of the top-left corner.", + "envelopeId": { + "description": "The envelope ID of the envelope status that failed to post.", "type": "string" }, - "dateAreaY": { - "description": "The Y axis position of the top-left corner.", + "formData": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/formDataItem" + } + }, + "prefillFormData": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/formDataItem" + } + }, + "recipientFormData": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/recipientFormData" + } + }, + "sentDateTime": { + "description": "The UTC DateTime when the envelope was sent. Read only.", + "type": "string" + }, + "status": { + "description": "Indicates the envelope status. Valid values are:\n\n* sent - The envelope is sent to the recipients. \n* created - The envelope is saved as a draft and can be modified and sent later.", "type": "string" } }, - "x-ds-definition-name": "dateStampProperties", - "description": "Specifies the area in which a date stamp is placed. This parameter uses pixel positioning to draw a rectangle at the center of the stamp area. The stamp is superimposed on top of this central area.\n\nThis property contains the following information about the central rectangle:\n\n- `DateAreaX`: The X axis position of the top-left corner.\n- `DateAreaY`: The Y axis position of the top-left corner.\n- `DateAreaWidth`: The width of the rectangle.\n- `DateAreaHeight`: The height of the rectangle.", - "x-ms-summary": "Specifies the area in which a date stamp is placed. This parameter uses pixel positioning to draw a rectangle at the center of the stamp area. The stamp is superimposed on top of this central area.\n\nThis property contains the following information about the central rectangle:\n\n- `DateAreaX`: The X axis position of the top-left corner.\n- `DateAreaY`: The Y axis position of the top-left corner.\n- `DateAreaWidth`: The width of the rectangle.\n- `DateAreaHeight`: The height of the rectangle." + "x-ds-definition-name": "envelopeFormData", + "description": "", + "x-ms-summary": "" }, - "decline": { + "envelopeId": { "type": "object", "properties": { + "anchorAllowWhiteSpaceInCharacters": { + "description": "", + "type": "string" + }, + "anchorAllowWhiteSpaceInCharactersMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "" + }, "anchorCaseSensitive": { - "description": "Reserved for DocuSign.\n", + "description": "This property controls how [anchor tabs][AnchorTabs] are placed. When **true**, the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false**.\n\nFor example, when set to **true**, if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When set to **false**, `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**.\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place", "type": "string" }, "anchorCaseSensitiveMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "description": "Metadata that indicates whether the `anchorCaseSensitive` property is editable." }, "anchorHorizontalAlignment": { - "description": "Reserved for DocuSign.\n\n", + "description": "This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are :\n\n- `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value.\n- `right`: Aligns the tab’s left side with the last character of the matching anchor word.\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place\n", "type": "string" }, "anchorHorizontalAlignmentMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "description": "Metadata that indicates whether the `anchorHorizontalAlignment` property is editable." }, "anchorIgnoreIfNotPresent": { "description": "When set to **true**, this tab is ignored if the `anchorString` is not found in the document.", @@ -28556,12 +39437,12 @@ "description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable." }, "anchorMatchWholeWord": { - "description": "Reserved for DocuSign.\n\n", + "description": "When set to **true**, the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false**.\n\nFor example, when set to **true**, if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When set to **false**, if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**.\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTab]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place\n", "type": "string" }, "anchorMatchWholeWordMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "description": "Metadata that indicates whether the `anchorMatchWholeWord` property is editable." }, "anchorString": { "description": "Specifies the string to find in the document and use as the basis for tab placement.", @@ -28580,7 +39461,7 @@ "description": "Reserved for DocuSign." }, "anchorUnits": { - "description": "Specifies the units of the X and Y offset. Units may be pixels, millimeters, centimeters, or inches.", + "description": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n", "type": "string" }, "anchorUnitsMetadata": { @@ -28588,7 +39469,7 @@ "description": "Metadata that indicates whether the `anchorUnits` property is editable." }, "anchorXOffset": { - "description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.", + "description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n", "type": "string" }, "anchorXOffsetMetadata": { @@ -28596,7 +39477,7 @@ "description": "Metadata that indicates whether the `anchorXOffset` property is editable." }, "anchorYOffset": { - "description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.", + "description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n", "type": "string" }, "anchorYOffsetMetadata": { @@ -28611,14 +39492,6 @@ "$ref": "#/definitions/propertyMetadata", "description": "Metadata that indicates whether the `bold` property is editable." }, - "buttonText": { - "description": " Specifies the decline text displayed in the tab.", - "type": "string" - }, - "buttonTextMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `buttonText` property is editable." - }, "conditionalParentLabel": { "description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility.", "type": "string" @@ -28636,23 +39509,15 @@ "description": "Metadata that indicates whether the `conditionalParentValue` property is editable." }, "customTabId": { - "description": "The DocuSign-generated custom tab id for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.", + "description": "The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.", "type": "string" }, "customTabIdMetadata": { "$ref": "#/definitions/propertyMetadata", "description": "Metadata that indicates whether the `customTabId` property is editable." }, - "declineReason": { - "description": "The reason the recipient declined the document.", - "type": "string" - }, - "declineReasonMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `declineReason` property is editable." - }, "documentId": { - "description": "Integer that identifies the document in the envelope.", + "description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.", "type": "string" }, "documentIdMetadata": { @@ -28735,6 +39600,18 @@ "$ref": "#/definitions/mergeField", "description": "Contains the information necessary to map the tab to a field in SalesForce." }, + "mergeFieldXml": { + "description": "", + "type": "string" + }, + "name": { + "description": "The name of the tab. For example, `Sign Here` or `Initial Here`.", + "type": "string" + }, + "nameMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `name` property is editable. Read only." + }, "pageNumber": { "description": "The page number on which the tab is located.\nFor supplemental documents, this value must be `1`.", "type": "string" @@ -28744,11 +39621,11 @@ "description": "Metadata that indicates whether the `pageNumber` property is editable." }, "recipientId": { - "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", + "description": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.", "type": "string" }, "recipientIdGuid": { - "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one.", + "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only.", "type": "string" }, "recipientIdGuidMetadata": { @@ -28759,6 +39636,10 @@ "$ref": "#/definitions/propertyMetadata", "description": "Metadata that indicates whether the `recipientId` property is editable." }, + "smartContractInformation": { + "$ref": "#/definitions/smartContractInformation", + "description": "" + }, "status": { "description": "The status of the tab. Possible values are:\n\n- `active`: The tab is active, but the recipient has not yet interacted with it.\n- `signed`: The recipient signed the tab.\n- `declined`: The recipient declined the envelope.\n- `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`).", "type": "string" @@ -28787,7 +39668,7 @@ "description": "Metadata that indicates whether the `tabId` property is editable." }, "tabLabel": { - "description": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n", + "description": "The label associated with the tab. This value may be an empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum Length: 500 characters.\n", "type": "string" }, "tabLabelMetadata": { @@ -28859,7 +39740,7 @@ "description": "Metadata that indicates whether the `xPosition` property is editable." }, "yPosition": { - "description": "This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.", + "description": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n", "type": "string" }, "yPositionMetadata": { @@ -28867,927 +39748,1404 @@ "description": "Metadata that indicates whether the `yPosition` property is editable." } }, - "x-ds-definition-name": "decline", - "description": "A tab that allows the recipient the option of declining an\nenvelope. If the recipient clicks the tab during the signing\nprocess, the envelope is voided.\n", - "x-ms-summary": "A tab that allows the recipient the option of declining an\nenvelope. If the recipient clicks the tab during the signing\nprocess, the envelope is voided.\n" + "x-ds-definition-name": "envelopeId", + "description": "A tab that displays the envelope ID. Recipients cannot enter\nor change the information in this tab.\n", + "x-ms-summary": "A tab that displays the envelope ID. Recipients cannot enter\nor change the information in this tab.\n" }, - "diagnosticsSettingsInformation": { + "envelopeIdsRequest": { "type": "object", "properties": { - "apiRequestLogging": { - "description": " When set to **true**, enables API request logging for the user. ", + "envelopeIds": { + "description": "A comma-separated list of envelope IDs to include in the results.", + "type": "array", + "items": { + "type": "string" + } + }, + "transactionIds": { + "description": "A comma-separated list of transaction IDs to include in the results. Note that transaction IDs are valid for seven days.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ds-definition-name": "envelopeIdsRequest", + "description": "Lists of envelope and transaction IDs to use in the results.", + "x-ms-summary": "Lists of envelope and transaction IDs to use in the results." + }, + "envelopeMetadata": { + "type": "object", + "properties": { + "allowAdvancedCorrect": { + "description": "Specifies if the Advanced Correct feature is enabled for the envelope. This feature enables you to correct the details of in process envelopes that you sent or are shared with you. It offers more functionality than the Correct feature.", "type": "string" }, - "apiRequestLogMaxEntries": { - "description": "Specifies the maximum number of API requests to log.", + "allowCorrect": { + "description": "Specifies if the Correct feature is enabled for the envelope. This feature enables you to correct the details of in process envelopes that you sent or are shared with you, including the recipient, envelope, and document information.", "type": "string" }, - "apiRequestLogRemainingEntries": { - "description": "Indicates the remaining number of API requests that can be logged.", + "enableSignWithNotary": { + "description": "Specifies if DocuSign eNotary service is enabled for the envelope.", "type": "string" } }, - "x-ds-definition-name": "diagnosticsSettingsInformation", + "x-ds-definition-name": "envelopeMetadata", "description": "", "x-ms-summary": "" }, - "directDebitProcessorInformation": { + "envelopeNotificationRequest": { "type": "object", "properties": { - "bankBranchCode": { + "expirations": { + "$ref": "#/definitions/expirations", + "description": "A complex element that specifies the expiration settings for the envelope." + }, + "reminders": { + "$ref": "#/definitions/reminders", + "description": "A complex element that specifies reminder settings for the envelope" + }, + "useAccountDefaults": { + "description": "When set to **true**, the account default notification settings are used for the envelope, overriding the reminders and expirations settings. When set to **false**, the reminders and expirations settings specified in this request are used.", + "type": "string" + } + }, + "x-ds-definition-name": "envelopeNotificationRequest", + "description": "A complex element that specifies the notification settings for the envelope.", + "x-ms-summary": "A complex element that specifies the notification settings for the envelope." + }, + "envelopePurgeConfiguration": { + "type": "object", + "properties": { + "purgeEnvelopes": { + "description": "When set to **true**, purging is enabled.", + "type": "string" + }, + "redactPII": { + "description": "When set to **true**, the system also redacts personally identifiable information (PII).\n\n**Note**: To redact PII, you must also set the property `removeTabsAndEnvelopeAttachments` to **true**.", + "type": "string" + }, + "removeTabsAndEnvelopeAttachments": { + "description": "When set to **true**, the system also purges the tabs and attachments associated with the envelopes. ", + "type": "string" + }, + "retentionDays": { + "description": "The number of days to retain envelope documents before purging them. This value must be a number between `0` and `999`.", + "type": "string" + } + }, + "x-ds-definition-name": "envelopePurgeConfiguration", + "description": "Contains information about the current envelope purge configuration for an account, which enables account administrators to purge documents from completed and voided envelopes after a set number of days (`retentionDays`). ", + "x-ms-summary": "Contains information about the current envelope purge configuration for an account, which enables account administrators to purge documents from completed and voided envelopes after a set number of days (`retentionDays`). " + }, + "envelopesInformation": { + "type": "object", + "properties": { + "continuationToken": { + "description": "A token returned by an earlier API call that you can use with a new call to resume a search query at the point where it left off. This token system enhances the performance of the API.", + "type": "string" + }, + "endPosition": { + "description": "The last index position in the result set. ", + "type": "string" + }, + "envelopes": { + "description": "Set of envelope information", + "type": "array", + "items": { + "$ref": "#/definitions/envelope" + } + }, + "envelopeTransactionStatuses": { + "description": "Array of envelope statuses and transaction IDs in the result set.", + "type": "array", + "items": { + "$ref": "#/definitions/envelopeTransactionStatus" + } + }, + "folders": { + "description": "A list of folder objects.", + "type": "array", + "items": { + "$ref": "#/definitions/folder" + } + }, + "lastQueriedDateTime": { + "description": "The last time that a query was performed.", + "type": "string" + }, + "resultSetSize": { + "description": "The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`.", + "type": "string" + }, + "startPosition": { + "description": "The starting index position of the current result set.", + "type": "string" + }, + "totalSetSize": { + "description": "The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`.", + "type": "string" + } + }, + "x-ds-definition-name": "envelopesInformation", + "description": "Result set for the Envelopes: listStatusChanges method", + "x-ms-summary": "Result set for the Envelopes: listStatusChanges method" + }, + "envelopeSummary": { + "type": "object", + "properties": { + "bulkEnvelopeStatus": { + "$ref": "#/definitions/bulkEnvelopeStatus", + "description": "An object that describes the status of the bulk send envelopes." + }, + "envelopeId": { + "description": "The envelope ID of the envelope status that failed to post.", + "type": "string" + }, + "errorDetails": { + "$ref": "#/definitions/errorDetails", + "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." + }, + "status": { + "description": "Indicates the envelope status. Valid values are: \n\n* `completed`: The recipients have finished working with the envelope: the documents are signed and all required tabs are filled in.\n* `created`: The envelope is created as a draft. It can be modified and sent later.\n* `declined`: The envelope has been declined by the recipients.\n* `delivered`: The envelope has been delivered to the recipients.\n* `sent`: The envelope will be sent to the recipients after the envelope is created.\n* `signed`: The envelope has been signed by the recipients.\n* `voided`: The envelope is no longer valid and recipients cannot access or sign the envelope.\n", + "type": "string" + }, + "statusDateTime": { + "description": "The DateTime that the envelope changed status (i.e. was created or sent.)", + "type": "string" + }, + "uri": { + "description": "A URI containing the user ID.", + "type": "string" + } + }, + "x-ds-definition-name": "envelopeSummary", + "description": " This object describes an envelope.", + "x-ms-summary": " This object describes an envelope." + }, + "envelopeTemplate": { + "type": "object", + "properties": { + "accessControlListBase64": { + "description": "Reserved for DocuSign.", + "type": "string" + }, + "allowComments": { + "description": "When set to **true**, users can add comments to the documents in the envelope. For example, if a signer has a question about the text in the document, they can add a comment to the document.", + "type": "string" + }, + "allowMarkup": { + "description": "When set to **true**, the Document Markup feature is enabled.\n\n**Note**: To use this feature, Document Markup must be enabled at both the account and envelope levels. Only Admin users can change this setting for at the account level.", + "type": "string" + }, + "allowReassign": { + "description": "When **true**, the recipient can redirect an envelope to a more appropriate recipient.", + "type": "string" + }, + "allowViewHistory": { + "description": "When set to **true**, recipients can view the history of the envelope.", + "type": "string" + }, + "anySigner": { + "description": "Deprecated. This feature has been replaced by signing groups.", + "type": "string" + }, + "asynchronous": { + "description": "When **true**, the envelope is queued for\nprocessing and the value of the `status` property\nis set to `Processing`. Additionally, GET status\ncalls return `Processing` until completed.\n\n\n**Note**: A `transactionId` is required for this\ncall to work correctly. When the envelope is\ncreated, the status is `Processing` and an\n`envelopeId` is not returned in the response. To\nget the `envelopeId`, use a GET envelope query by\nusing the\n[transactionId](https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/Envelopes/create/) or by checking the\nConnect notification.", + "type": "string" + }, + "attachmentsUri": { + "description": "Contains a URL for retrieving the attachments that are associated with the envelope.", + "type": "string" + }, + "authoritativeCopy": { + "description": "When **true**, marks all of the documents in the envelope as authoritative copies.\n\n**Note**: You can override this value for a specific document. For example, you can set the `authoritativeCopy` property to **true** at the envelope level, but turn it off for a single document by setting the `authoritativeCopy` property for the document to **false**.", + "type": "string" + }, + "authoritativeCopyDefault": { + "description": "The default `authoritativeCopy` setting for documents in this envelope that do not have `authoritativeCopy` set.\nIf this property is not set, each document defaults to the envelope's `authoritativeCopy`.", + "type": "string" + }, + "autoMatch": { + "description": "By default, templates that have been used within\nthe last 60 days are included in auto-matching.\n\nBy explicitly setting `autoMatch`,\nyou can permanently include or exclude the template\nin auto matching.\n\nWhen **true** the template is included in auto-matching\nregardless of when it was last used.\n\nWhen **false** the template is never included in auto-matching.", + "type": "string" + }, + "autoMatchSpecifiedByUser": { + "description": "If **true**, the template has been explicitly included in or excluded from auto-matching. The default is false.\nThis is a read-only property.", + "type": "string" + }, + "autoNavigation": { + "description": "When set to **true**, autonavigation is set for the recipient.\n", + "type": "string" + }, + "brandId": { + "description": "The id of the brand.", + "type": "string" + }, + "brandLock": { + "description": "When **true**, the `brandId` for the envelope is locked and senders cannot change the brand used for the envelope.", + "type": "string" + }, + "certificateUri": { + "description": "The URI for retrieving certificate information.", + "type": "string" + }, + "completedDateTime": { + "description": "Specifies the date and time this item was completed.", + "type": "string" + }, + "copyRecipientData": { + "description": "", + "type": "string" + }, + "created": { + "description": "The UTC DateTime when the workspace user authorization was created.", + "type": "string" + }, + "createdDateTime": { + "description": "The UTC DateTime when the item was created.", + "type": "string" + }, + "customFields": { + "$ref": "#/definitions/AccountCustomFields", + "description": "An optional array of strings that enables the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each `customField` string can be a maximum of 100 characters." + }, + "customFieldsUri": { + "description": "The URI for retrieving custom fields.", + "type": "string" + }, + "declinedDateTime": { + "description": "The date and time the recipient declined the document. Read only.", + "type": "string" + }, + "deletedDateTime": { + "description": "Reserved for DocuSign.", + "type": "string" + }, + "deliveredDateTime": { + "description": "The date and time that the envelope was delivered to the recipient. Read only.", + "type": "string" + }, + "description": { + "description": "A sender-defined description of the line item.\n", + "type": "string" + }, + "disableResponsiveDocument": { + "description": "When set to **true**, responsive documents are disabled for the envelope.", + "type": "string" + }, + "documents": { + "description": "A complex element that contains details about the documents associated with the envelope.", + "type": "array", + "items": { + "$ref": "#/definitions/document" + } + }, + "documentsCombinedUri": { + "description": "The URI for retrieving all of the documents associated with the envelope as a single PDF file.", + "type": "string" + }, + "documentsUri": { + "description": "The URI for retrieving all of the documents associated with the envelope as separate files.", + "type": "string" + }, + "emailBlurb": { + "description": "This is the same as the email body. If the sender enters an email blurb, it is included in the email body for all envelope recipients.", + "type": "string" + }, + "emailSettings": { + "$ref": "#/definitions/emailSettings", + "description": "A complex type that contains email settings." + }, + "emailSubject": { + "description": "The subject line of the email message that is sent to all recipients.\n\nFor information about adding merge field information to the email subject, see [Template Email Subject Merge Fields](https://developers.docusign.com/docs/esign-rest-api/reference/Templates/Templates/create#template-email-subject-merge-fields).\n", + "type": "string" + }, + "enableWetSign": { + "description": "When set to **true**, the signer is allowed to print the document and sign it on paper.", + "type": "string" + }, + "enforceSignerVisibility": { + "description": "When set to **true**, signers can only view the documents on which they have tabs. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all of the documents in an envelope, unless they are specifically excluded by using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded by using this setting when an envelope is sent.\n\n**Note**: To use this functionality, [Document Visibility][docviz] must be enabled for the account by making the account setting `allowDocumentVisibility` **true**.\n\n[docviz]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeDocumentVisibility/", + "type": "string" + }, + "envelopeAttachments": { + "description": "An array of attachment objects that provide information about the attachments that are associated with the envelope.", + "type": "array", + "items": { + "$ref": "#/definitions/attachment" + } + }, + "envelopeDocuments": { + "description": "An array containing information about the documents that are included in the envelope.", + "type": "array", + "items": { + "$ref": "#/definitions/envelopeDocument" + } + }, + "envelopeId": { + "description": "The envelope ID of the envelope status that failed to post.", + "type": "string" + }, + "envelopeIdStamping": { + "description": "When set to **true**, [Envelope ID Stamping](https://support.docusign.com/en/guides/ndse-user-guide-set-advanced-document-options) is enabled.\nAfter a document or attachment is stamped with an Envelope ID,\nthe ID is seen by all recipients\nand becomes a permanent part of the document\nand cannot be removed.", + "type": "string" + }, + "envelopeLocation": { + "description": "Reserved for DocuSign.", + "type": "string" + }, + "envelopeMetadata": { + "$ref": "#/definitions/envelopeMetadata", + "description": "Provides information about the features and services that are enabled for the envelope, including the Correct feature, the Advanced Correct feature, and DocuSign eNotary service." + }, + "envelopeUri": { + "description": "The URI for retrieving the envelope or envelopes.", + "type": "string" + }, + "expireAfter": { + "description": "An integer specifying the number of days that a sent envelope remains active before it expires. A negative number in a response indicates that the envelope has already expired.", + "type": "string" + }, + "expireDateTime": { + "description": "The date and time the envelope is set to expire.", + "type": "string" + }, + "expireEnabled": { + "description": "When set to **true**, the envelope expires (is no longer available for signing) after the specified number of days after it is sent (`sentDateTime`). Set `expireAfter` to set the number of days until an envelope expires. When **false**, the account default setting is used. If the account does not have an expiration setting, the DocuSign default value of 120 days is used.", + "type": "string" + }, + "externalEnvelopeId": { + "description": "May contain an external identifier for the envelope.", + "type": "string" + }, + "favoritedByMe": { + "description": "", + "type": "string" + }, + "folderId": { + "description": "The id of the folder.", + "type": "string" + }, + "folderIds": { + "description": "", + "type": "array", + "items": { + "type": "string" + } + }, + "folderName": { "description": "", "type": "string" }, - "bankCheckDigit": { - "description": "", + "folders": { + "description": "A list of folder objects.", + "type": "array", + "items": { + "$ref": "#/definitions/folder" + } + }, + "hasComments": { + "description": "When set to **true**, indicates that users have added comments to the envelope.", + "type": "string" + }, + "hasFormDataChanged": { + "description": "When set to **true**, indicates that the data collected through form fields on a document has changed.", + "type": "string" + }, + "hasWavFile": { + "description": "When set to **true**, indicates that a .wav file used for voice authentication is included in the envelope. ", "type": "string" }, - "bankCode": { - "description": "", + "holder": { + "description": "Reserved for DocuSign.", "type": "string" }, - "bankName": { - "description": "", + "initialSentDateTime": { + "description": "The date and time the envelope was initially sent.", "type": "string" }, - "bankTransferAccountName": { - "description": "", + "is21CFRPart11": { + "description": "When **true**, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).", "type": "string" }, - "bankTransferAccountNumber": { - "description": "", + "isDynamicEnvelope": { + "description": "When set to **true**, indicates that the envelope is a dynamic envelope.", "type": "string" }, - "bankTransferType": { - "description": "", + "isSignatureProviderEnvelope": { + "description": "When set to **true**, indicates that the envelope is a signature-provided envelope.", "type": "string" }, - "country": { - "description": "Specifies the country associated with the address.", + "lastModified": { + "description": "The UTC date and time that the comment was last updated.\n\n**Note**: This can only be done by the creator.", "type": "string" }, - "email": { - "description": "Filters returned user records by the specified email address.", - "type": "string" + "lastModifiedBy": { + "$ref": "#/definitions/userInfo", + "description": "" }, - "firstName": { - "description": "The user's first name. \nMaximum Length: 50 characters.", + "lastModifiedDateTime": { + "description": "The date and time that the item was last modified.", "type": "string" }, - "iBAN": { + "lastUsed": { "description": "", "type": "string" }, - "lastName": { - "description": "", + "location": { + "description": "Reserved for DocuSign.", "type": "string" - } - }, - "x-ds-definition-name": "directDebitProcessorInformation", - "description": "", - "x-ms-summary": "" - }, - "dobInformationInput": { - "description": "", - "type": "object", - "properties": { - "dateOfBirth": { - "description": "Specifies the recipient's date, month, and year of birth.", + }, + "lockInformation": { + "$ref": "#/definitions/EnvelopeLocks", + "description": "Provides lock information about an envelope that a user has locked." + }, + "messageLock": { + "description": "When set to **true**, prevents senders from changing the contents of `emailBlurb` and `emailSubject` properties for the envelope. \n\nAdditionally, this prevents users from making changes to the contents of `emailBlurb` and `emailSubject` properties when correcting envelopes. \n\nHowever, if the `messageLock` node is set to **true** and the `emailSubject` property is empty, senders and correctors are able to add a subject to the envelope.", "type": "string" }, - "displayLevelCode": { - "description": "Specifies the display level for the recipient. Valid values are:\n* `ReadOnly`\n* `Editable`\n* `DoNotDisplay`", + "name": { + "description": "", "type": "string" }, - "receiveInResponse": { - "description": "A Boolean value that specifies whether the information must be returned in the response.", + "newPassword": { + "description": "The user's new password.", "type": "string" - } - }, - "x-ds-definition-name": "dobInformationInput", - "x-ms-summary": "" - }, - "document": { - "type": "object", - "properties": { - "applyAnchorTabs": { - "description": "Reserved for DocuSign", + }, + "notification": { + "$ref": "#/definitions/notification", + "description": "" + }, + "notificationUri": { + "description": "The URI for retrieving notifications.", "type": "string" }, - "display": { - "description": "This string sets the display and behavior properties of\nthe document during signing. The possible values are:\n\n* `modal`
\n The document is shown as a supplement action strip\n and can be viewed, downloaded, or printed in a modal window.\n This is the recommended value for supplemental documents. \n\n* `download`
\n The document is shown as a supplement action strip\n and can be viewed, downloaded, or printed in a new browser window. \n\n* `inline`
\n The document is shown in the normal signing window.\n This value is not used with supplemental documents,\n but is the default value for all other documents.\n", + "owner": { + "$ref": "#/definitions/userInfo", + "description": "" + }, + "pageCount": { + "description": "An integer value specifying the number of document pages in the template. ", "type": "string" }, - "documentBase64": { - "description": "The document's bytes. This field can be used to include a base64 version of the document bytes within an envelope definition instead of sending the document using a multi-part HTTP request. The maximum document size is smaller if this field is used due to the overhead of the base64 encoding.", + "password": { + "description": "The user's encrypted password hash.", "type": "string" }, - "documentFields": { + "passwordProtected": { "description": "", + "type": "string" + }, + "powerForm": { + "$ref": "#/definitions/powerForm", + "description": "Information about any PowerForms that are included in the envelope." + }, + "powerForms": { + "description": "An array of PowerForm objects.", "type": "array", "items": { - "$ref": "#/definitions/nameValue" + "$ref": "#/definitions/powerForm" } }, - "documentGroup": { - "description": "The type of group the document belongs to (`certificate` or `content`).", + "purgeCompletedDate": { + "description": "The date that a purge was completed.", "type": "string" }, - "documentId": { - "description": "Specifies the document ID of this document. This value is used by tabs to determine which document they appear in.", + "purgeRequestDate": { + "description": "The date that a purge was requested.", "type": "string" }, - "encryptedWithKeyManager": { - "description": "When set to **true**, the document is been already encrypted by the sender for use with the DocuSign Key Manager Security Appliance.\n ", + "purgeState": { + "description": "Shows the current purge state for the envelope. The possible values are:\n\n* `unpurged`: There has been no successful request to purge documents.\n* `documents_queued`: The envelope documents have been added to the purge queue, but have not been purged.\n* `documents_dequeued`: The envelope documents have been taken out of the purge queue.\n* `documents_and_metadata_queued`: The envelope documents and metadata have been added to the purge queue, but have not yet been purged.\n* `documents_purged`: The envelope documents have been successfully purged.\n* `documents_and_metadata_purged`: The envelope documents and metadata have been successfully purged.\n\n", "type": "string" }, - "fileExtension": { - "description": "The file extension type of the document. Non-PDF documents are converted to PDF.\n\nIf the document is not a PDF, `fileExtension` is required.\n\nIf you try to upload a non-PDF document without a `fileExtension`, you will receive an \"unable to load document\" error message. \n ", - "type": "string" + "recipients": { + "$ref": "#/definitions/EnvelopeRecipients", + "description": "An array of recipient objects that provides details about the recipients of the envelope." }, - "fileFormatHint": { - "description": "", + "recipientsLock": { + "description": "When set to **true**, prevents senders from changing, correcting, or deleting the recipient information for the envelope.", "type": "string" }, - "htmlDefinition": { - "$ref": "#/definitions/documentHtmlDefinition", - "description": "" - }, - "includeInDownload": { - "description": "When set to **true**,\nthe document is included in the combined document download. \nThe default value is **true**.\n", + "recipientsUri": { + "description": "Contains a URI for an endpoint that you can use to retrieve the recipients.", "type": "string" }, - "matchBoxes": { - "description": "Matchboxes define areas in a document for document matching when you are creating envelopes. They are only used when you upload and edit a template. \n\nA matchbox consists of 5 elements:\n\n* pageNumber - The document page number on which the matchbox will appear. \n* xPosition - The x position of the matchbox on a page. \n* yPosition - The y position of the matchbox on a page.\n* width - The width of the matchbox. \n* height - The height of the matchbox. \n", - "type": "array", - "items": { - "$ref": "#/definitions/matchBox" - } + "sender": { + "$ref": "#/definitions/userInfo", + "description": "Information about the sender of the envelope." }, - "name": { - "description": "The name of the document.", + "sentDateTime": { + "description": "The UTC DateTime when the envelope was sent. Read only.", "type": "string" }, - "order": { - "description": "(Optional) The order in which to sort the results.\n\nValid values are: \n\n\n* `asc`: Ascending order.\n* `desc`: Descending order. ", + "shared": { + "description": "When set to **true**, this custom tab is shared.", "type": "string" }, - "pageCount": { - "description": "An integer value specifying the number of document pages in the template. ", + "signerCanSignOnMobile": { + "description": "When set to **true**, recipients can sign on a mobile device.\n\n**Note**: Only Admin users can change this setting.\n", "type": "string" }, - "pages": { - "description": "An array of page objects.", + "signingLocation": { + "description": "Specifies the physical location where the signing takes place. It can have two enumeration values; `inPerson` and `online`. The default value is `online`.", "type": "string" }, - "pageSizes": { - "description": "", - "type": "array", - "items": { - "$ref": "#/definitions/pageSize" - } + "status": { + "description": "Indicates the envelope status. Valid values are:\n\n* `completed`: The recipients have finished working with the envelope: the documents are signed and all required tabs are filled in.\n* `created`: The envelope is created as a draft. It can be modified and sent later.\n* `declined`: The envelope has been declined by the recipients.\n* `delivered`: The envelope has been delivered to the recipients.\n* `sent`: The envelope will be sent to the recipients after the envelope is created.\n* `signed`: The envelope has been signed by the recipients.\n* `voided`: The envelope is no longer valid and recipients cannot access or sign the envelope.\n", + "type": "string" }, - "password": { - "description": "The user's encrypted password hash.", + "statusChangedDateTime": { + "description": "The data and time that the status changed.", "type": "string" }, - "pdfFormFieldOption": { - "description": "", + "statusDateTime": { + "description": "The DateTime that the envelope changed status (i.e. was created or sent.)", "type": "string" }, - "remoteUrl": { - "description": "The file id from the cloud storage service where the document is located. This information is returned using [CloudStorage::listFolders](https://developers.docusign.com/esign-rest-api/reference/CloudStorage/CloudStorage/listFolders) or [CloudStorage::list](https://developers.docusign.com/esign-rest-api/reference/CloudStorage/CloudStorage/list).\n", + "templateId": { + "description": "The unique identifier of the template. If this is not provided, DocuSign will generate a value. ", "type": "string" }, - "signerMustAcknowledge": { - "description": "Sets how the signer interacts with the supplemental document.\nThe possible values are: \n\n*\t`no_interaction`
\n No recipient action is required. \n\n*\t`view`
\n The recipient is required to view the document. \n\n*\t`accept`
\n The recipient is required to accept the document by selecting accept during signing, but is not required to view the document. \n\n*\t`view_accept`
\n The recipient is required to view and accept the document. \n\n", + "templatesUri": { + "description": "The URI for retrieving the templates.", "type": "string" }, - "tabs": { - "$ref": "#/definitions/EnvelopeRecipientTabs", - "description": "A list of `signHere` tabs, which can be used to add a visual representation for an electronic seal in a document." + "transactionId": { + "description": "Specifies the Transaction ID from the AppStore.", + "type": "string" }, - "templateLocked": { - "description": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ", + "uri": { + "description": "A URI containing the user ID.", "type": "string" }, - "templateRequired": { - "description": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.", + "useDisclosure": { + "description": "When set to **true**, the disclosure is shown to recipients in accordance with the account's Electronic Record and Signature Disclosure frequency setting. When set to **false**, the Electronic Record and Signature Disclosure is not shown to any envelope recipients. \n\nIf the `useDisclosure` property is not set, then the account's normal disclosure setting is used and the value of the `useDisclosure` property is not returned in responses when getting envelope information.", "type": "string" }, - "transformPdfFields": { - "description": "When set to **true**, PDF form field data is transformed into document tab values when the PDF form field name matches the DocuSign custom tab tabLabel. The resulting PDF form data is also returned in the PDF meta data when requesting the document PDF.\n", + "voidedDateTime": { + "description": "The date and time the envelope or template was voided.", "type": "string" }, - "uri": { - "description": "URI containing the user ID.", + "voidedReason": { + "description": "The reason the envelope or template was voided.", "type": "string" + }, + "workflow": { + "$ref": "#/definitions/workflow", + "description": "" } }, - "x-ds-definition-name": "document", - "description": "A document object.", - "x-ms-summary": "A document object." - }, - "documentFieldsInformation": { - "type": "object", - "properties": { - "documentFields": { - "description": "", - "type": "array", - "items": { - "$ref": "#/definitions/nameValue" - } - } - }, - "x-ds-definition-name": "documentFieldsInformation", + "x-ds-definition-name": "envelopeTemplate", "description": "", "x-ms-summary": "" }, - "documentHtmlCollapsibleDisplaySettings": { + "envelopeTemplateResults": { "type": "object", "properties": { - "arrowClosed": { - "description": "", + "endPosition": { + "description": "The last index position in the result set. ", "type": "string" }, - "arrowColor": { - "description": "", - "type": "string" + "envelopeTemplates": { + "description": "The list of requested templates.", + "type": "array", + "items": { + "$ref": "#/definitions/envelopeTemplate" + } }, - "arrowLocation": { - "description": "", - "type": "string" + "folders": { + "description": "A list of folder objects.", + "type": "array", + "items": { + "$ref": "#/definitions/folder" + } }, - "arrowOpen": { - "description": "", + "nextUri": { + "description": "The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. ", "type": "string" }, - "arrowSize": { - "description": "", + "previousUri": { + "description": "The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. ", "type": "string" }, - "arrowStyle": { - "description": "", + "resultSetSize": { + "description": "The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`.", "type": "string" }, - "containerStyle": { - "description": "", + "startPosition": { + "description": "The starting index position of the current result set.", "type": "string" }, - "labelStyle": { - "description": "", + "totalSetSize": { + "description": "The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`.", + "type": "string" + } + }, + "x-ds-definition-name": "envelopeTemplateResults", + "description": "Information about templates.", + "x-ms-summary": "Information about templates." + }, + "envelopeTransactionStatus": { + "type": "object", + "properties": { + "envelopeId": { + "description": "The envelope ID of the envelope status that failed to post.", "type": "string" }, - "onlyArrowIsClickable": { - "description": "", - "type": "boolean" + "errorDetails": { + "$ref": "#/definitions/errorDetails", + "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." }, - "outerLabelAndArrowStyle": { - "description": "", + "status": { + "description": "Indicates the envelope status. Valid values are:\n\n* `completed`: The recipients have finished working with the envelope: the documents are signed and all required tabs are filled in.\n* `created`: The envelope is created as a draft. It can be modified and sent later.\n* `declined`: The envelope has been declined by the recipients.\n* `delivered`: The envelope has been delivered to the recipients.\n* `sent`: The envelope will be sent to the recipients after the envelope is created.\n* `signed`: The envelope has been signed by the recipients.\n* `voided`: The envelope is no longer valid and recipients cannot access or sign the envelope.\n", + "type": "string" + }, + "transactionId": { + "description": " Used to identify an envelope. The id is a sender-generated value and is valid in the DocuSign system for 7 days. It is recommended that a transaction ID is used for offline signing to ensure that an envelope is not sent multiple times. The `transactionId` property can be used determine an envelope's status (i.e. was it created or not) in cases where the internet connection was lost before the envelope status was returned.", "type": "string" } }, - "x-ds-definition-name": "documentHtmlCollapsibleDisplaySettings", + "x-ds-definition-name": "envelopeTransactionStatus", "description": "", "x-ms-summary": "" }, - "documentHtmlDefinition": { + "envelopeTransferRule": { "type": "object", "properties": { - "displayAnchorPrefix": { - "description": "", + "carbonCopyOriginalOwner": { + "description": "When set to **true**, the original owner is added as a carbon copy recipient after envelope transfer. The default value is **false**.", "type": "string" }, - "displayAnchors": { - "description": "", - "type": "array", - "items": { - "$ref": "#/definitions/documentHtmlDisplayAnchor" - } + "enabled": { + "description": "When set to **true**, the envelope transfer rule is active.", + "type": "string" }, - "displayOrder": { - "description": "The position on the page where the display section appears.", + "envelopeTransferRuleId": { + "description": "The id of the envelope transfer rule. The system generates this id when the rule is first created.", "type": "string" }, - "displayPageNumber": { - "description": "The number of the page on which the display section appears.", + "eventType": { + "description": "The type of envelope event that triggers the transfer. Valid values are:\n\n- `sent`\n- `before sent` \n- `completed`", "type": "string" }, - "documentGuid": { - "description": "", + "fromGroup": { + "$ref": "#/definitions/group", + "description": "Information about the group that triggers the transfer." + }, + "fromUser": { + "$ref": "#/definitions/userInformation", + "description": "Information about the user who triggers the transfer." + }, + "modifiedDate": { + "description": "The UTC DateTime when the envelope transfer rule was last modified. This property is read only.", "type": "string" }, - "documentId": { - "description": "Integer that identifies the document in the envelope.", + "modifiedUser": { + "$ref": "#/definitions/userInformation", + "description": "Information about the user who last modified the envelope transfer rule." + }, + "toFolder": { + "$ref": "#/definitions/folder", + "description": "Information about the destination folder to which the envelope is transferred." + }, + "toUser": { + "$ref": "#/definitions/userInformation", + "description": "Information about the user to which the envelope is transferred." + } + }, + "x-ds-definition-name": "envelopeTransferRule", + "description": "This object contains details about an envelope transfer rule.", + "x-ms-summary": "This object contains details about an envelope transfer rule." + }, + "envelopeTransferRuleInformation": { + "type": "object", + "properties": { + "endPosition": { + "description": "The last index position in the result set. ", "type": "string" }, - "headerLabel": { - "description": "", + "envelopeTransferRules": { + "description": "Contains information about a specific envelope transfer rule.", + "type": "array", + "items": { + "$ref": "#/definitions/envelopeTransferRule" + } + }, + "nextUri": { + "description": "The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. ", "type": "string" }, - "maxScreenWidth": { - "description": "", + "previousUri": { + "description": "The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. ", "type": "string" }, - "removeEmptyTags": { - "description": "", + "resultSetSize": { + "description": "The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`.", "type": "string" }, - "showMobileOptimizedToggle": { - "description": "", + "startPosition": { + "description": "The starting index position of the current result set.", "type": "string" }, - "source": { - "description": "", + "totalSetSize": { + "description": "The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`.", "type": "string" } }, - "x-ds-definition-name": "documentHtmlDefinition", + "x-ds-definition-name": "envelopeTransferRuleInformation", "description": "", "x-ms-summary": "" }, - "documentHtmlDefinitionOriginal": { + "envelopeTransferRuleRequest": { "type": "object", "properties": { - "documentId": { - "description": "Integer that identifies the document in the envelope.", + "carbonCopyOriginalOwner": { + "description": "When set to **true**, the original owner is added as a carbon copy recipient after envelope transfer. The default value is **false**.", "type": "string" }, - "documentIdGuid": { - "description": "The Guid of the document.", + "enabled": { + "description": "When set to **true**, the envelope transfer rule is active.", "type": "string" }, - "htmlDefinition": { - "$ref": "#/definitions/documentHtmlDefinition", - "description": "" + "envelopeTransferRuleId": { + "description": "The id of the envelope transfer rule. The system generates this id when the rule is first created.", + "type": "string" + }, + "eventType": { + "description": "The type of envelope event that triggers the transfer. Valid values are:\n\n- `sent`\n- `before sent` \n- `completed`", + "type": "string" + }, + "fromGroups": { + "description": "Information about the group that triggers the transfer.", + "type": "array", + "items": { + "$ref": "#/definitions/group" + } + }, + "fromUsers": { + "description": "Information about the user who triggers the transfer.", + "type": "array", + "items": { + "$ref": "#/definitions/userInformation" + } + }, + "modifiedDate": { + "description": "The UTC DateTime when the envelope transfer rule was last modified. This property is read only.", + "type": "string" + }, + "modifiedUser": { + "$ref": "#/definitions/userInformation", + "description": "Information about the user who last modified the envelope transfer rule." + }, + "toFolder": { + "$ref": "#/definitions/folder", + "description": "Information about the destination folder to which the envelope is transferred." + }, + "toUser": { + "$ref": "#/definitions/userInformation", + "description": "Information about the user to which the envelope is transferred." } }, - "x-ds-definition-name": "documentHtmlDefinitionOriginal", - "description": "", - "x-ms-summary": "" + "x-ds-definition-name": "envelopeTransferRuleRequest", + "description": "This object contains details about the envelope transfer rule that you want to create.", + "x-ms-summary": "This object contains details about the envelope transfer rule that you want to create." }, - "documentHtmlDefinitionOriginals": { + "envelopeUpdateSummary": { "type": "object", "properties": { - "htmlDefinitions": { + "bulkEnvelopeStatus": { + "$ref": "#/definitions/bulkEnvelopeStatus", + "description": "An object that describes the status of the bulk send envelopes." + }, + "envelopeId": { + "description": "The envelope ID of the envelope status that failed to post.", + "type": "string" + }, + "errorDetails": { + "$ref": "#/definitions/errorDetails", + "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." + }, + "listCustomFieldUpdateResults": { "description": "", "type": "array", "items": { - "$ref": "#/definitions/documentHtmlDefinitionOriginal" + "$ref": "#/definitions/listCustomField" } - } - }, - "x-ds-definition-name": "documentHtmlDefinitionOriginals", - "description": "", - "x-ms-summary": "" - }, - "documentHtmlDefinitions": { - "type": "object", - "properties": { - "htmlDefinitions": { + }, + "lockInformation": { + "$ref": "#/definitions/EnvelopeLocks", + "description": "Provides lock information about an envelope that a user has locked." + }, + "purgeState": { + "description": "Shows the current purge state for the envelope. The possible values are:\n\n* `unpurged`: There has been no successful request to purge documents.\n* `documents_queued`: The envelope documents have been added to the purge queue, but have not been purged.\n* `documents_dequeued`: The envelope documents have been taken out of the purge queue.\n* `documents_and_metadata_queued`: The envelope documents and metadata have been added to the purge queue, but have not yet been purged.\n* `documents_purged`: The envelope documents have been successfully purged.\n* `documents_and_metadata_purged`: The envelope documents and metadata have been successfully purged.\n\n", + "type": "string" + }, + "recipientUpdateResults": { + "description": "An array of `recipientUpdateResults` objects that contain details about the recipients.", + "type": "array", + "items": { + "$ref": "#/definitions/recipientUpdateResponse" + } + }, + "tabUpdateResults": { + "$ref": "#/definitions/EnvelopeRecipientTabs", + "description": "" + }, + "textCustomFieldUpdateResults": { "description": "", "type": "array", "items": { - "type": "string" + "$ref": "#/definitions/textCustomField" } } }, - "x-ds-definition-name": "documentHtmlDefinitions", + "x-ds-definition-name": "envelopeUpdateSummary", "description": "", "x-ms-summary": "" }, - "documentHtmlDisplayAnchor": { + "errorDetails": { + "description": "This object describes errors that occur. It is only valid for responses and ignored in requests.", "type": "object", "properties": { - "caseSensitive": { - "description": "", - "type": "boolean" - }, - "displaySettings": { - "$ref": "#/definitions/documentHtmlDisplaySettings", - "description": "This object defines how the HTML section inside the `startAnchor` and `endAnchor` displays." - }, - "endAnchor": { - "description": "Specifies the end of the area in the HTML where the display settings will be applied. If you do not specify an end anchor, the end of the document will be used by default.\n\n**Note**: A start anchor, an end anchor, or both are required.", + "errorCode": { + "description": "The code associated with the error condition.", "type": "string" }, - "removeEndAnchor": { - "description": "When **true**, removes the end anchor string for the Smart Section from the HTML, preventing it from displaying.", - "type": "boolean" - }, - "removeStartAnchor": { - "description": "When **true**, removes the start anchor string for the Smart Section from the HTML, preventing it from displaying.", - "type": "boolean" - }, - "startAnchor": { - "description": "Specifies the beginning of the area in the HTML where the display settings will be applied. If you do not specify a start anchor, the beginning of the document will be used by default.\n\n**Note**: A start anchor, an end anchor, or both are required.", + "message": { + "description": "A brief message describing the error condition.", "type": "string" } }, - "x-ds-definition-name": "documentHtmlDisplayAnchor", - "description": "", - "x-ms-summary": "" + "x-ds-definition-name": "errorDetails", + "x-ms-summary": "This object describes errors that occur. It is only valid for responses and ignored in requests." }, - "documentHtmlDisplaySettings": { + "eventNotification": { + "description": "Use this object to configure a [DocuSign Connect webhook](https://developers.docusign.com/platform/webhooks/connect/).", "type": "object", "properties": { - "cellStyle": { - "description": "Specifies the valid CSS-formatted styles to use on responsive table cells. Only valid in display sections of `responsive_table` or `responsive_table_single_column` types.", - "type": "string" + "envelopeEvents": { + "description": "A list of envelope-level event statuses that will trigger Connect to send updates to the endpoint specified in the `url` property. \n\nTo receive notifications, you must include either an `envelopeEvents` node or a `recipientEvents` node. You do not need to specify both.", + "type": "array", + "items": { + "$ref": "#/definitions/envelopeEvent" + } }, - "collapsibleSettings": { - "$ref": "#/definitions/documentHtmlCollapsibleDisplaySettings", - "description": "This object defines the appearance and function of a collapsible section or item." + "eventData": { + "$ref": "#/definitions/connectEventData", + "description": "Allows you to specify the format of the information the Connect webhooks returns. For more information, see [Connect webhooks with JSON notifications](https://www.docusign.com/blog/developers/connect-webhooks-json-notifications)" }, - "display": { - "description": "This string sets the display and behavior properties of\nthe document during signing. The possible values are:\n\n* `modal`
\n The document is shown as a supplement action strip\n and can be viewed, downloaded, or printed in a modal window.\n This is the recommended value for supplemental documents. \n\n* `download`
\n The document is shown as a supplement action strip\n and can be viewed, downloaded, or printed in a new browser window. \n\n* `inline`
\n The document is shown in the normal signing window.\n This value is not used with supplemental documents,\n but is the default value for all other documents.\n", + "includeCertificateOfCompletion": { + "description": "When set to **true**, the Connect Service includes the Certificate of Completion with completed envelopes. ", "type": "string" }, - "displayLabel": { - "description": "The label for the display section.", + "includeCertificateWithSoap": { + "description": "When set to **true**, the Connect service will digitally sign the XML data. The signature will be included in the XML message.", "type": "string" }, - "displayOrder": { - "format": "int32", - "description": "The position on the page where the display section appears.", - "type": "integer" - }, - "displayPageNumber": { - "format": "int32", - "description": "The number of the page on which the display section appears.", - "type": "integer" + "includeDocumentFields": { + "description": "When set to **true**, the Document Fields associated with the envelope's documents are included in the notification messages. Document Fields are optional custom name-value pairs added to documents using the API. ", + "type": "string" }, - "hideLabelWhenOpened": { - "description": "When **true**, the `displayLabel` is hidden when the display section is expanded and the display section is no longer collapsible. This property is valid only when the value of the `display` property is `collapsed`.", - "type": "boolean" + "includeDocuments": { + "description": "When set to **true**, the XML webhook messages will include the envelope's PDF documents. Including the PDF documents will greatly increase the size of the notification messages. Ensure that your listener can handle incoming messages that are 25MB or larger. ", + "type": "string" }, - "inlineOuterStyle": { - "description": "Specifies the valid CSS-formatted styles to use on inline display sections. This property is valid only when the value of the `display` property is `inline`.", + "includeEnvelopeVoidReason": { + "description": "When set to **true**, this tells the Connect Service to include the void reason, as entered by the person that voided the envelope, in the message. ", + "type": "string" + }, + "includeHMAC": { + "description": "When set to **true**, HMAC headers will be included with the webhook notifications.\n\n**Note**: [HMAC must enabled](https://developers.docusign.com/platform/webhooks/connect/hmac/) at the account level with [one or more HMAC secrets](https://developers.docusign.com/platform/webhooks/connect/setting-up-hmac/).", "type": "string" }, - "labelWhenOpened": { - "description": "The label for the display section when it is expanded from a collapsed state. This label displays only on the first opening and is only valid with the value of the `display` property is `collapsed`.", + "includeSenderAccountAsCustomField": { + "description": "When set to **true**, Connect will include the sender account as Custom Field in the data.", "type": "string" }, - "scrollToTopWhenOpened": { - "description": "When **true** and the section is expanded, the position of the section close is scrolled to the top of the screen. This property is only valid when the value of the `display` property is `collapsed`.", - "type": "boolean" + "includeTimeZone": { + "description": "When set to **true**, the envelope's time zone information is included in the webhook messages. ", + "type": "string" }, - "tableStyle": { - "description": "Specifies the valid CSS-formatted styles to use on responsive tables. This property is valid only when the value of the `display` property is `responsive_table` or `responsive_table_single_column`.", + "loggingEnabled": { + "description": "When set to **true**, the webhook messages are logged. They can be viewed on the DocuSign Administration Web Tool in the Connect section. Logged messages can also be downloaded via the [ConnectEvents resource](https://developers.docusign.com/docs/esign-rest-api/reference/connect/connectevents/).", "type": "string" - } - }, - "x-ds-definition-name": "documentHtmlDisplaySettings", - "description": "", - "x-ms-summary": "" - }, - "documentSecurityStore": { - "type": "object", - "properties": { - "certificates": { - "description": "", - "type": "array", - "items": { - "type": "string" - } }, - "crls": { - "description": "", + "recipientEvents": { + "description": "A list of recipient event statuses that will trigger Connect to send updates to the endpoint specified in the url property.\n\nTo receive notifications, you must include either an `envelopeEvents` node or a `recipientEvents` node. You do not need to specify both.", "type": "array", "items": { - "type": "string" + "$ref": "#/definitions/recipientEvent" } }, - "ocsps": { - "description": "", - "type": "array", - "items": { - "type": "string" - } - } - }, - "x-ds-definition-name": "documentSecurityStore", - "description": "", - "x-ms-summary": "" - }, - "documentTemplate": { - "type": "object", - "properties": { - "documentEndPage": { - "description": "", + "requireAcknowledgment": { + "description": "When set to **true**, the DocuSign Connect service checks that the message was received and retries on failures. ", "type": "string" }, - "documentId": { - "description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.", + "signMessageWithX509Cert": { + "description": "When set to **true**, Mutual TLS will be enabled for notifications. Mutual TLS must be initiated by the listener (the customer's web server) during the TLS handshake protocol. ", "type": "string" }, - "documentStartPage": { - "description": "", + "soapNameSpace": { + "description": "The namespace of the SOAP interface.\n\nThe namespace value must be set if useSoapInterface is set to true.", "type": "string" }, - "errorDetails": { - "$ref": "#/definitions/errorDetails", - "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." + "url": { + "description": "The endpoint to which webhook notification messages are sent via an HTTPS POST request. The url must start with https. The customer's web server must use an SSL/TLS certificate whose CA is in the Microsoft list of trusted CAs. Self-signed certificates are not ok. Free certificates from Let's Encrypt can be used.", + "type": "string" }, - "templateId": { - "description": "The unique identifier of the template. If this is not provided, DocuSign generates an error and the call fails.", + "useSoapInterface": { + "description": "When set to **true**, this tells the Connect service that the user's endpoint has implemented a SOAP interface. ", "type": "string" } }, - "x-ds-definition-name": "documentTemplate", - "description": "", - "x-ms-summary": "" + "x-ds-definition-name": "eventNotification", + "x-ms-summary": "Use this object to configure a [DocuSign Connect webhook](https://developers.docusign.com/platform/webhooks/connect/)." }, - "documentTemplateList": { + "eventResult": { "type": "object", "properties": { - "documentTemplates": { - "description": "", - "type": "array", - "items": { - "$ref": "#/definitions/documentTemplate" - } + "eventTimestamp": { + "description": "Date/time of the event.", + "type": "string" + }, + "failureDescription": { + "description": "Reason for failure, if the event failed.", + "type": "string" + }, + "status": { + "description": "Event status.", + "type": "string" + }, + "vendorFailureStatusCode": { + "description": "Failure status code, if the event failed.", + "type": "string" } }, - "x-ds-definition-name": "documentTemplateList", - "description": "", - "x-ms-summary": "" + "x-ds-definition-name": "eventResult", + "description": "Information about the result of an event.", + "x-ms-summary": "Information about the result of an event." }, - "documentUpdateInfo": { + "expirations": { + "description": "A complex element that specifies the expiration settings for the envelope.", "type": "object", "properties": { - "data": { - "description": "A Base64-encoded representation of the attachment that is used to upload and download the file. File attachments may be up to 50 MB in size.", - "type": "string" - }, - "documentId": { - "description": "Integer that identifies the document in the envelope.", + "expireAfter": { + "description": "An integer that sets the number of days the envelope is active.", "type": "string" }, - "documentSecurityStore": { - "$ref": "#/definitions/documentSecurityStore", - "description": "" - }, - "name": { - "description": "", + "expireEnabled": { + "description": "When set to **true**, the envelope expires (is no longer available for signing) in the set number of days. If false, the account default setting is used. If the account does not have an expiration setting, the DocuSign default value of 120 days is used.", "type": "string" }, - "returnFormat": { - "description": "", + "expireWarn": { + "description": "An integer that specifying the number of days before the envelope expires that an expiration warning email is sent to the recipient. If set to 0 (zero), no warning email is sent.", "type": "string" - }, - "signatureDataInfos": { - "description": "", - "type": "array", - "items": { - "$ref": "#/definitions/signatureDataInfo" - } - }, - "timeStampField": { - "$ref": "#/definitions/timeStampField", - "description": "" } }, - "x-ds-definition-name": "documentUpdateInfo", - "description": "", - "x-ms-summary": "" + "x-ds-definition-name": "expirations", + "x-ms-summary": "A complex element that specifies the expiration settings for the envelope." }, - "documentVisibility": { + "externalClaim": { "type": "object", "properties": { - "documentId": { - "description": "Integer that identifies the document in the envelope.", + "acquiredTime": { + "description": "Reserved for DocuSign.", "type": "string" }, - "errorDetails": { - "$ref": "#/definitions/errorDetails", - "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." - }, - "recipientId": { - "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", + "claimName": { + "description": "Reserved for DocuSign.", "type": "string" }, - "rights": { - "description": "Indicates whether the document is editable:\n\n- `editable`\n- `read_only`", + "provider": { + "description": "Reserved for DocuSign.", "type": "string" }, - "visible": { - "description": "When **true**, the document is visible to the recipient.", + "value": { + "description": "Reserved for DocuSign.", "type": "string" } }, - "x-ds-definition-name": "documentVisibility", - "description": "This object configures a recipient's read/write access to a document.", - "x-ms-summary": "This object configures a recipient's read/write access to a document." + "x-ds-definition-name": "externalClaim", + "description": " Claims about the user from an external provider. This object is reserved for DocuSign internal use.", + "x-ms-summary": " Claims about the user from an external provider. This object is reserved for DocuSign internal use." }, - "documentVisibilityList": { + "externalDocServiceErrorDetails": { "type": "object", "properties": { - "documentVisibility": { - "description": "An array of `documentVisibility` objects that specifies which documents are visible to which recipients.", - "type": "array", - "items": { - "$ref": "#/definitions/documentVisibility" - } + "authenticationUrl": { + "description": "Reserved: TBD", + "type": "string" + }, + "errorCode": { + "description": "A code associated with the error condition.", + "type": "string" + }, + "message": { + "description": "", + "type": "string" } }, - "x-ds-definition-name": "documentVisibilityList", - "description": "A list of `documentVisibility` objects that specify whether documents are visible to recipients.", - "x-ms-summary": "A list of `documentVisibility` objects that specify whether documents are visible to recipients." + "x-ds-definition-name": "externalDocServiceErrorDetails", + "description": "", + "x-ms-summary": "" }, - "editor": { + "externalDocumentSources": { "type": "object", "properties": { - "accessCode": { - "description": "If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. \n\nMaximum Length: 50 characters and it must conform to the account's access code format setting.\n\nIf blank, but the signer `accessCode` property is set in the envelope, then that value is used.\n\nIf blank and the signer `accessCode` property is not set, then the access code is not required.", + "boxnetEnabled": { + "description": "The account is enabled to allow external documents to be attached from BoxNet.", "type": "string" }, - "accessCodeMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the `accessCode` property." + "boxnetMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata indicating whether the `boxnetEnabled` property is editable." }, - "addAccessCodeToEmail": { - "description": "This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient.", + "dropboxEnabled": { + "description": "The account is enabled to allow external documents to be attached from DropBox.", "type": "string" }, - "clientUserId": { - "description": "Specifies whether the recipient is embedded or remote. \n\nIf the `clientUserId` property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing.\n\nNote: if the `clientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true**, an error is generated on sending. \n\nMaximum length: 100 characters. ", - "type": "string" + "dropboxMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata indicating whether the `dropboxEnabled` property is editable." }, - "completedCount": { - "description": "Indicates the number of times that the recipient has been through a signing completion for the envelope.\n\nIf this number is greater than 0 for a signing group, only the user who previously completed may sign again.", + "googleDriveEnabled": { + "description": "The account is enabled to allow external documents to be attached from Google Drive.", "type": "string" }, - "customFields": { - "description": "An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters.", - "type": "array", - "items": { - "type": "string" - } + "googleDriveMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata indicating whether the `googleDriveEnabled` property is editable." }, - "declinedDateTime": { - "description": "The date and time the recipient declined the document.", + "oneDriveEnabled": { + "description": "The account is enabled to allow external documents to be attached from OneDrive.", "type": "string" }, - "declinedReason": { - "description": "The reason the recipient declined the document.", + "oneDriveMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata indicating whether the `oneDriveEnabled` property is editable." + }, + "salesforceEnabled": { + "description": "The account is enabled to allow external documents to be attached from Salesforce.", "type": "string" }, - "deliveredDateTime": { - "description": "The date and time that the envelope was delivered to the recipient.", + "salesforceMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata indicating whether the `salesforceEnabled` property is editable." + } + }, + "x-ds-definition-name": "externalDocumentSources", + "description": "A complex object specifying the external document sources.", + "x-ms-summary": "A complex object specifying the external document sources." + }, + "externalFile": { + "type": "object", + "properties": { + "date": { + "description": "The UTC date and time that the file or folder was last modified.", "type": "string" }, - "deliveryMethod": { - "description": "Reserved for DocuSign.", + "id": { + "description": "The storage provider's id for the file or folder.", "type": "string" }, - "deliveryMethodMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `deliveryMethod` property is editable.\n" + "img": { + "description": "The file extension for a file.\n\n**Note**: If the item is a folder, this value is null.", + "type": "string" }, - "documentVisibility": { - "description": "A list of documentVisibility objects, which define a recipient's read/write access to a document.", - "type": "array", - "items": { - "$ref": "#/definitions/documentVisibility" - } + "name": { + "description": "The full name of a file.", + "type": "string" }, - "email": { - "description": "Email id of the recipient. Notification of the document to sign is sent to this email id. \n\nMaximum length: 100 characters. ", + "size": { + "description": "The size of the file. The file size limit varies based on the cloud storage provider.", "type": "string" }, - "emailMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the email id of the recipient." + "supported": { + "description": "When set to **true**, DocuSign supports the file type for upload.", + "type": "string" }, - "emailNotification": { - "$ref": "#/definitions/recipientEmailNotification", - "description": "An optional complex type that sets a specific email subject and body for this recipient's notification email. \n\n**Note**: If you use this field to set a specific email notification for one recipient, you must also set the email notification for the other recipients. Using this field for one or more recipients negates the Envelope `Subject` and `EmailBlurb` property settings. " + "type": { + "description": "The type of cloud storage item. Valid values are:\n\n- `file`\n- `folder`", + "type": "string" }, - "embeddedRecipientStartURL": { - "description": "Specifies a sender-provided valid URL string for redirecting an embedded recipient. When this option is used, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the recipient clicks the document link in the email, the recipient is redirected through DocuSign to the specified URL to complete the required actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. \n\nIf set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation launched by a partner.\n\nIt is important to understand that in a typical embedded workflow, the authentication of an embedded recipient is the responsibility of the sending application. DocuSign expects that senders will follow their own processes for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process is initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process, bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient.\n\nIf the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: `envelopeId`, `recipientId`, `recipientName`, `recipientEmail`, and `customFields`. The `customFields` property must be set for the recipient or envelope. The merge fields are enclosed in double brackets. \n\n*Example*: \n\n`http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` ", + "uri": { + "description": "The URI for the file or folder.", + "type": "string" + } + }, + "x-ds-definition-name": "externalFile", + "description": "This object contains information about a file or folder in cloud storage.", + "x-ms-summary": "This object contains information about a file or folder in cloud storage." + }, + "externalFolder": { + "type": "object", + "properties": { + "endPosition": { + "description": "The last index position in the result set. ", "type": "string" }, "errorDetails": { - "$ref": "#/definitions/errorDetails", + "$ref": "#/definitions/externalDocServiceErrorDetails", "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." }, - "faxNumber": { - "description": "Reserved for DocuSign.", - "type": "string" - }, - "faxNumberMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `faxNumber` property is editable.\n" - }, - "firstName": { - "description": "The recipient's first name. \n\nMaximum Length: 50 characters.", + "id": { + "description": "A unique ID for the Salesforce object.", "type": "string" }, - "firstNameMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the recipient's first name." + "items": { + "description": "If the tab is a list, this represents the values that are possible for the tab.", + "type": "array", + "items": { + "$ref": "#/definitions/externalFile" + } }, - "fullName": { - "description": "Reserved for DocuSign.", + "name": { + "description": "", "type": "string" }, - "fullNameMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." - }, - "idCheckConfigurationName": { - "description": "The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting.\n\n**Example**: Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node.", + "nextUri": { + "description": "The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. ", "type": "string" }, - "idCheckConfigurationNameMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the `idCheckConfigurationName` property." - }, - "idCheckInformationInput": { - "$ref": "#/definitions/idCheckInformationInput", - "description": "An object that contains input information related to a recipient ID check." - }, - "inheritEmailNotificationConfiguration": { - "description": "When set to **true** and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account. ", + "previousUri": { + "description": "The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. ", "type": "string" }, - "lastName": { - "description": "The recipient's last name.", + "resultSetSize": { + "description": "The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`.", "type": "string" }, - "lastNameMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the recipient's last name." - }, - "lockedRecipientPhoneAuthEditable": { - "description": "Reserved for DocuSign.", + "startPosition": { + "description": "The starting index position of the current result set.", "type": "string" }, - "lockedRecipientSmsEditable": { - "description": "Reserved for DocuSign.", + "totalSetSize": { + "description": "The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`.", "type": "string" + } + }, + "x-ds-definition-name": "externalFolder", + "description": "", + "x-ms-summary": "" + }, + "favoriteTemplatesContentItem": { + "type": "object", + "properties": { + "errorDetails": { + "$ref": "#/definitions/errorDetails", + "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." }, - "name": { - "description": "The full legal name of the recipient. Maximum Length: 100 characters.", + "favoritedDate": { + "description": "", "type": "string" }, - "nameMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the full legal name of the recipient." - }, - "note": { - "description": "A note sent to the recipient in the signing email.\nThis note is unique to this recipient.\nIn the user interface,\nit appears near the upper left corner\nof the document\non the signing screen.\n\nMaximum Length: 1000 characters.\n", + "templateId": { + "description": "The unique identifier of the template. If this is not provided, DocuSign will generate a value. ", "type": "string" + } + }, + "x-ds-definition-name": "favoriteTemplatesContentItem", + "description": "", + "x-ms-summary": "" + }, + "favoriteTemplatesInfo": { + "type": "object", + "properties": { + "errorDetails": { + "$ref": "#/definitions/errorDetails", + "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." }, - "noteMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the note sent to the recipient in the signing email." - }, - "phoneAuthentication": { - "$ref": "#/definitions/recipientPhoneAuthentication", - "description": "A complex type that contains the following elements:\n\n* `recipMayProvideNumber` - Boolean. When set to **true**, the recipient can use whatever phone number they choose.\n* `senderProvidedNumbers` - ArrayOfString. A list of phone numbers the recipient can use.\n* `recordVoicePrint` - Reserved.\n* `validateRecipProvidedNumber` - Reserved." - }, - "recipientAttachments": { - "description": "Reserved for DocuSign.", + "favoriteTemplates": { + "description": "", "type": "array", "items": { - "$ref": "#/definitions/recipientAttachment" + "$ref": "#/definitions/favoriteTemplatesContentItem" } }, - "recipientAuthenticationStatus": { - "$ref": "#/definitions/authenticationStatus", - "description": "Information about the recipient's authentication status." + "templatesUpdatedCount": { + "format": "int32", + "description": "", + "type": "integer" + } + }, + "x-ds-definition-name": "favoriteTemplatesInfo", + "description": "", + "x-ms-summary": "" + }, + "featureAvailableMetadata": { + "type": "object", + "properties": { + "availabilty": { + "description": "", + "type": "string" }, - "recipientFeatureMetadata": { - "description": "Metadata about the features that are supported for the recipient type.", + "featureName": { + "description": "", + "type": "string" + } + }, + "x-ds-definition-name": "featureAvailableMetadata", + "description": "", + "x-ms-summary": "" + }, + "featureSet": { + "type": "object", + "properties": { + "currencyFeatureSetPrices": { + "description": "Reserved for DocuSign.", "type": "array", "items": { - "$ref": "#/definitions/featureAvailableMetadata" + "$ref": "#/definitions/currencyFeatureSetPrice" } }, - "recipientId": { - "description": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.", + "envelopeFee": { + "description": "Reserved for DocuSign.", "type": "string" }, - "recipientIdGuid": { - "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one.", + "featureSetId": { + "description": "Reserved for DocuSign.", "type": "string" }, - "recipientType": { - "description": "The recipient type, as specified by the following values:\n- `agents`: Agent recipients can add name and email information for recipients that appear after the agent in routing order.\n- `carbonCopies`: Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date, or add information to any of the documents. This type of recipient can be used in any routing order.\n- `certifiedDeliveries`: Certified delivery recipients must receive the completed documents for the envelope to be completed. They don't need to sign, initial, date, or add information to any of the documents.\n- `editors`: Editors have the same management and access rights for the envelope as the sender. Editors can add name and email information, add or change the routing order, set authentication options, and can edit signature/initial tabs and data fields for the remaining recipients.\n- `inPersonSigners`: In-person recipients are DocuSign users who act as signing hosts in the same physical location as the signer.\n- `intermediaries`: Intermediary recipients can optionally add name and email information for recipients at the same or subsequent level in the routing order.\n- `seals`: Electronic seal recipients represent legal entities.\n- `signers`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope.\n- `witnesses`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope.", + "fixedFee": { + "description": "Reserved for DocuSign.", "type": "string" }, - "recipientTypeMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the recipient type." - }, - "requireIdLookup": { - "description": "When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. ", + "is21CFRPart11": { + "description": "Reserved for DocuSign.", "type": "string" }, - "requireIdLookupMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `requireIdLookup` property is editable.\n" - }, - "roleName": { - "description": "Optional element. Specifies the role name associated with the recipient.

This is required when working with template recipients.", + "isActive": { + "description": "Reserved for DocuSign.", "type": "string" }, - "routingOrder": { - "description": "Specifies the routing order of the recipient in the envelope. ", + "isEnabled": { + "description": "When set to **true**, the feature set is actively enabled as part of the plan.", "type": "string" }, - "routingOrderMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the routing order for the recipient." - }, - "sentDateTime": { - "description": "The date and time the envelope was sent.", + "name": { + "description": "Reserved for DocuSign.", "type": "string" }, - "signedDateTime": { + "seatFee": { "description": "Reserved for DocuSign.", "type": "string" - }, - "signingGroupId": { - "description": "The id of the signing group of which the recipient is a member, if applicable.", + } + }, + "x-ds-definition-name": "featureSet", + "description": "This object provides details about a feature set, or add-on product that is associated with an account. It is reserved for DocuSign internal use only.", + "x-ms-summary": "This object provides details about a feature set, or add-on product that is associated with an account. It is reserved for DocuSign internal use only." + }, + "fileType": { + "type": "object", + "properties": { + "fileExtension": { + "description": "", "type": "string" }, - "signingGroupIdMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the signing group id." - }, - "signingGroupName": { - "description": "The display name for the signing group. \n\nMaximum Length: 100 characters. ", + "mimeType": { + "description": "The mime-type of a file type listed in a fileTypes collection.", "type": "string" - }, - "signingGroupUsers": { - "description": "A complex type that contains information about users in the signing group.", + } + }, + "x-ds-definition-name": "fileType", + "description": "", + "x-ms-summary": "" + }, + "fileTypeList": { + "type": "object", + "properties": { + "fileTypes": { + "description": "A collection of file types.", "type": "array", "items": { - "$ref": "#/definitions/userInfo" + "$ref": "#/definitions/fileType" } + } + }, + "x-ds-definition-name": "fileTypeList", + "description": "", + "x-ms-summary": "" + }, + "filter": { + "type": "object", + "properties": { + "actionRequired": { + "description": "When set to **true**, the current user needs to take action on the item.", + "type": "string" }, - "smsAuthentication": { - "$ref": "#/definitions/recipientSMSAuthentication", - "description": "Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication. \n" + "expires": { + "description": "The number of days a sent envelope remains active before it expires.", + "type": "string" }, - "socialAuthentications": { - "description": " Lists the social ID type that can be used for recipient authentication.", - "type": "array", - "items": { - "$ref": "#/definitions/socialAuthentication" - } + "folderIds": { + "description": "Filters for any combination of folder ids and folder types. The possible folder types are:\n\n- `awaiting_my_signature`\n- `completed`\n- `draft`\n- `drafts`\n- `expiring_soon`\n- `inbox`\n- `out_for_signature`\n- `recyclebin`\n- `sentitems`\n- `waiting_for_others`", + "type": "string" }, - "status": { - "description": "Recipient status.\n\n", + "fromDateTime": { + "description": "The UTC DateTime of the beginning of a date range. If no value is provided, the default search is the previous 30 days.", "type": "string" }, - "statusCode": { - "description": "Reserved for DocuSign.", + "isTemplate": { + "description": "When set to **true**, the item is a template.", "type": "string" }, - "templateLocked": { - "description": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ", + "order": { + "description": "(Optional) The order in which to sort the results.\n\nValid values are: \n\n\n* `asc`: Ascending order.\n* `desc`: Descending order. ", "type": "string" }, - "templateRequired": { - "description": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.", + "orderBy": { + "description": "The field used to sort the results.\n\nExample: `Created`", "type": "string" }, - "totalTabCount": { - "description": "The total number of tabs in the documents.", + "searchTarget": { + "description": "Reserved for DocuSign.", "type": "string" }, - "userId": { - "description": "The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.\n", + "searchText": { + "description": "A free text search field for searching across the items in a folder. The search looks for the text that you enter in the recipient names and emails, envelope custom fields, sender name, and subject.", + "type": "string" + }, + "status": { + "description": "The status of the envelope. By default, all statuses are returned.\n\nFor details, see [Envelope Status Code Descriptions](https://developers.docusign.com/esign-rest-api/guides/status-and-error-codes#envelope-status-code-descriptions).", + "type": "string" + }, + "toDateTime": { + "description": "The UTC DateTime of the end of a date range. If no value is provided, the default search is to the current date.", "type": "string" } }, - "x-ds-definition-name": "editor", - "description": "A complex type defining the management and access rights of a recipient assigned as an editor on the document.", - "x-ms-summary": "A complex type defining the management and access rights of a recipient assigned as an editor on the document." + "x-ds-definition-name": "filter", + "description": "Use this object to create a filtered view of the items in a folder.", + "x-ms-summary": "Use this object to create a filtered view of the items in a folder." }, - "email": { + "firstName": { "type": "object", "properties": { + "anchorAllowWhiteSpaceInCharacters": { + "description": "", + "type": "string" + }, + "anchorAllowWhiteSpaceInCharactersMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "" + }, "anchorCaseSensitive": { - "description": "Reserved for DocuSign.\n", + "description": "This property controls how [anchor tabs][AnchorTabs] are placed. When **true**, the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false**.\n\nFor example, when set to **true**, if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When set to **false**, `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**.\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place", "type": "string" }, "anchorCaseSensitiveMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "description": "Metadata that indicates whether the `anchorCaseSensitive` property is editable." }, "anchorHorizontalAlignment": { - "description": "Reserved for DocuSign.\n\n", + "description": "This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are :\n\n- `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value.\n- `right`: Aligns the tab’s left side with the last character of the matching anchor word.\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place\n", "type": "string" }, "anchorHorizontalAlignmentMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "description": "Metadata that indicates whether the `anchorHorizontalAlignment` property is editable." }, "anchorIgnoreIfNotPresent": { "description": "When set to **true**, this tab is ignored if the `anchorString` is not found in the document.", @@ -29798,12 +41156,12 @@ "description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable." }, "anchorMatchWholeWord": { - "description": "Reserved for DocuSign.\n\n", + "description": "When set to **true**, the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false**.\n\nFor example, when set to **true**, if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When set to **false**, if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**.\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTab]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place\n", "type": "string" }, "anchorMatchWholeWordMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "description": "Metadata that indicates whether the `anchorMatchWholeWord` property is editable." }, "anchorString": { "description": "Specifies the string to find in the document and use as the basis for tab placement.", @@ -29822,7 +41180,7 @@ "description": "Reserved for DocuSign." }, "anchorUnits": { - "description": "Specifies the units of the X and Y offset. Units may be pixels, millimeters, centimeters, or inches.", + "description": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n", "type": "string" }, "anchorUnitsMetadata": { @@ -29830,7 +41188,7 @@ "description": "Metadata that indicates whether the `anchorUnits` property is editable." }, "anchorXOffset": { - "description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.", + "description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n", "type": "string" }, "anchorXOffsetMetadata": { @@ -29838,7 +41196,7 @@ "description": "Metadata that indicates whether the `anchorXOffset` property is editable." }, "anchorYOffset": { - "description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.", + "description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n", "type": "string" }, "anchorYOffsetMetadata": { @@ -29853,14 +41211,6 @@ "$ref": "#/definitions/propertyMetadata", "description": "Metadata that indicates whether the `bold` property is editable." }, - "concealValueOnDocument": { - "description": "When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender.\n\nWhen an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.", - "type": "string" - }, - "concealValueOnDocumentMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `concealValueOnDocument` property is editable." - }, "conditionalParentLabel": { "description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility.", "type": "string" @@ -29878,23 +41228,15 @@ "description": "Metadata that indicates whether the `conditionalParentValue` property is editable." }, "customTabId": { - "description": "The DocuSign-generated custom tab id for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.", + "description": "The DocuSign-generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.", "type": "string" }, "customTabIdMetadata": { "$ref": "#/definitions/propertyMetadata", "description": "Metadata that indicates whether the `customTabId` property is editable." }, - "disableAutoSize": { - "description": "When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes.", - "type": "string" - }, - "disableAutoSizeMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `disableAutoSize` property is editable." - }, "documentId": { - "description": "Integer that identifies the document in the envelope.", + "description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.", "type": "string" }, "documentIdMetadata": { @@ -29973,44 +41315,24 @@ "$ref": "#/definitions/localePolicyTab", "description": "Reserved for DocuSign." }, - "locked": { - "description": "When set to **true**, the signer cannot change the data of the custom tab.", - "type": "string" - }, - "lockedMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `locked` property is editable." - }, - "maxLength": { - "description": "An optional value that describes the maximum length of the property when the property is a string.", - "type": "string" - }, - "maxLengthMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `maxLength` property is editable." - }, "mergeField": { "$ref": "#/definitions/mergeField", "description": "Contains the information necessary to map the tab to a field in SalesForce." }, + "mergeFieldXml": { + "description": "", + "type": "string" + }, "name": { "description": "The name of the tab. For example, `Sign Here` or `Initial Here`.", "type": "string" }, "nameMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `name` property is editable." - }, - "originalValue": { - "description": "The initial value of the tab when it was sent to the recipient. ", - "type": "string" - }, - "originalValueMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `originalValue` property is editable." + "description": "Metadata that indicates whether the `name` property is editable. Read only." }, "pageNumber": { - "description": "The page number on which the tab is located.\nFor supplemental documents, this value must be `1`.", + "description": "The page number on which the tab is located. For supplemental documents, this value must be `1`.\n", "type": "string" }, "pageNumberMetadata": { @@ -30018,11 +41340,11 @@ "description": "Metadata that indicates whether the `pageNumber` property is editable." }, "recipientId": { - "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", + "description": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.", "type": "string" }, "recipientIdGuid": { - "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one.", + "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only.", "type": "string" }, "recipientIdGuidMetadata": { @@ -30033,48 +41355,12 @@ "$ref": "#/definitions/propertyMetadata", "description": "Metadata that indicates whether the `recipientId` property is editable." }, - "requireAll": { - "description": "When set to **true** and shared is true, information must be entered in this field to complete the envelope. ", - "type": "string" - }, - "requireAllMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `requireAll` property is editable." - }, - "required": { - "description": "When set to **true**, the signer is required to fill out this tab.", - "type": "string" - }, - "requiredMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `required` property is editable." - }, - "requireInitialOnSharedChange": { - "description": "Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.", - "type": "string" - }, - "requireInitialOnSharedChangeMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `requireInitialOnSharedChange` property is editable." - }, - "senderRequired": { - "description": "When set to **true**, the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope.", - "type": "string" - }, - "senderRequiredMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `senderRequired` property is editable." - }, - "shared": { - "description": "When set to **true**, this tab is shared.", - "type": "string" - }, - "sharedMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `shared` property is editable." + "smartContractInformation": { + "$ref": "#/definitions/smartContractInformation", + "description": "" }, "status": { - "description": "The status of the tab. Possible values are:\n\n- `active`: The tab is active, but the recipient has not yet interacted with it.\n- `signed`: The recipient signed the tab.\n- `declined`: The recipient declined the envelope.\n- `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`).\n", + "description": "The status of the tab. Possible values are:\n\n- `active`: The tab is active, but the recipient has not yet interacted with it.\n- `signed`: The recipient signed the tab.\n- `declined`: The recipient declined the envelope.\n- `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`).", "type": "string" }, "statusMetadata": { @@ -30101,7 +41387,7 @@ "description": "Metadata that indicates whether the `tabId` property is editable." }, "tabLabel": { - "description": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n", + "description": "The label associated with the tab. This value may be an empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum Length: 500 characters.\n", "type": "string" }, "tabLabelMetadata": { @@ -30156,22 +41442,6 @@ "$ref": "#/definitions/propertyMetadata", "description": "Metadata that indicates whether the `underline` property is editable." }, - "validationMessage": { - "description": "The message displayed if the custom tab fails input validation (either custom of embedded).", - "type": "string" - }, - "validationMessageMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `validationMessage` property is editable." - }, - "validationPattern": { - "description": "A regular expression used to validate input for the tab.", - "type": "string" - }, - "validationPatternMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `validationPattern` property is editable." - }, "value": { "description": "Specifies the value of the tab. ", "type": "string" @@ -30188,45 +41458,498 @@ "$ref": "#/definitions/propertyMetadata", "description": "Metadata that indicates whether the `width` property is editable." }, - "xPosition": { - "description": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n", + "xPosition": { + "description": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n", + "type": "string" + }, + "xPositionMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `xPosition` property is editable." + }, + "yPosition": { + "description": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n", + "type": "string" + }, + "yPositionMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `yPosition` property is editable." + } + }, + "x-ds-definition-name": "firstName", + "description": "A tab that displays the recipient's first name. This tab\ntakes the recipient's name as entered in the recipient\ninformation, splits it into sections based on spaces and\nuses the first section as the first name.\n", + "x-ms-summary": "A tab that displays the recipient's first name. This tab\ntakes the recipient's name as entered in the recipient\ninformation, splits it into sections based on spaces and\nuses the first section as the first name.\n" + }, + "folder": { + "type": "object", + "properties": { + "errorDetails": { + "$ref": "#/definitions/errorDetails", + "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." + }, + "filter": { + "$ref": "#/definitions/filter", + "description": "An object used to present a filtered view of the items in a folder." + }, + "folderId": { + "description": "The id of the folder.", + "type": "string" + }, + "folderItems": { + "description": "A list of envelopes and templates that the folder contains.", + "type": "array", + "items": { + "$ref": "#/definitions/folderItem_v2" + } + }, + "folders": { + "description": "A collection of folder objects returned in a response.", + "type": "array", + "items": { + "$ref": "#/definitions/folder" + } + }, + "hasAccess": { + "description": "When set to **true**, the current user has access to the folder.", + "type": "string" + }, + "hasSubFolders": { + "description": "When set to **true**, the folder has subfolders.", + "type": "string" + }, + "itemCount": { + "description": "The number of items in the folder.", + "type": "string" + }, + "name": { + "description": "The name of the folder.", + "type": "string" + }, + "owner": { + "$ref": "#/definitions/userInfo", + "description": "Information about the user who owns the folder." + }, + "parentFolderId": { + "description": "The id of the parent folder, or the special value `root` for the root folder.", + "type": "string" + }, + "parentFolderUri": { + "description": "The URI of the parent folder.", + "type": "string" + }, + "subFolderCount": { + "description": "The number of subfolders.", + "type": "string" + }, + "type": { + "description": "The type of folder. Possible values include:\n\n- `draft`\n- `inbox`\n- `normal` (a system-generated folder)\n- `recyclebin`\n- `sentitems`\n- `custom` (a custom folder created by a user)", + "type": "string" + }, + "uri": { + "description": "The URI for the folder.", + "type": "string" + } + }, + "x-ds-definition-name": "folder", + "description": "This object contains details about a folder.", + "x-ms-summary": "This object contains details about a folder." + }, + "folderItem_v2": { + "type": "object", + "properties": { + "completedDateTime": { + "description": "If the item is an envelope, this is the UTC DateTime when the envelope was completed.", + "type": "string" + }, + "createdDateTime": { + "description": "The UTC DateTime when the item was created.", + "type": "string" + }, + "envelopeId": { + "description": "If the item is an envelope, this is the id of the envelope.", + "type": "string" + }, + "envelopeUri": { + "description": "If the item is an envelope, this is the URI for retrieving it.", + "type": "string" + }, + "expireDateTime": { + "description": "The date and time the envelope is set to expire.", + "type": "string" + }, + "folderId": { + "description": "The id of the folder.", + "type": "string" + }, + "folderUri": { + "description": "If the item is a subfolder, this is the URI for retrieving it.", + "type": "string" + }, + "is21CFRPart11": { + "description": "When **true**, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).", + "type": "string" + }, + "ownerName": { + "description": "The name of the user who owns the folder.", + "type": "string" + }, + "recipients": { + "$ref": "#/definitions/EnvelopeRecipients", + "description": "An array of recipient objects that provides details about the recipients of the envelope." + }, + "recipientsUri": { + "description": "Contains a URI for an endpoint that you can use to retrieve the recipients.", + "type": "string" + }, + "senderCompany": { + "description": "The name of the sender's company.", + "type": "string" + }, + "senderEmail": { + "description": "The sender's email address.", + "type": "string" + }, + "senderName": { + "description": "The sender's name.", + "type": "string" + }, + "senderUserId": { + "description": "The sender's id.", + "type": "string" + }, + "sentDateTime": { + "description": "The UTC DateTime when the envelope was sent. Read only.", + "type": "string" + }, + "status": { + "description": "Indicates the envelope status. Valid values are:\n\n* sent - The envelope is sent to the recipients. \n* created - The envelope is saved as a draft and can be modified and sent later.", + "type": "string" + }, + "subject": { + "description": "The subject of the envelope.", + "type": "string" + }, + "templateId": { + "description": "The unique identifier of the template. If this is not provided, DocuSign will generate a value. ", + "type": "string" + }, + "templateUri": { + "description": "The URI for retrieving the template.", + "type": "string" + } + }, + "x-ds-definition-name": "folderItem_v2", + "description": "Information about folder item results.", + "x-ms-summary": "Information about folder item results." + }, + "folderItemResponse": { + "type": "object", + "properties": { + "endPosition": { + "description": "The last index position in the result set. ", + "type": "string" + }, + "folderItems": { + "description": "A list of the envelopes in the specified folder or folders. ", + "type": "array", + "items": { + "$ref": "#/definitions/folderItem_v2" + } + }, + "nextUri": { + "description": "The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. ", + "type": "string" + }, + "previousUri": { + "description": "The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. ", + "type": "string" + }, + "resultSetSize": { + "description": "The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`.", + "type": "string" + }, + "startPosition": { + "description": "The starting index position of the current result set.", + "type": "string" + }, + "totalRows": { + "description": "The total number of items in the result.", + "type": "string" + } + }, + "x-ds-definition-name": "folderItemResponse", + "description": "Results from a folder item request.", + "x-ms-summary": "Results from a folder item request." + }, + "folderItemsResponse": { + "type": "object", + "properties": { + "endPosition": { + "description": "The last index position in the result set. ", + "type": "string" + }, + "envelopes": { + "description": "An array containing PowerForm data.", + "type": "array", + "items": { + "$ref": "#/definitions/envelopeSummary" + } + }, + "folders": { + "description": "A list of folder objects.", + "type": "array", + "items": { + "$ref": "#/definitions/folder" + } + }, + "nextUri": { + "description": "The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. ", + "type": "string" + }, + "previousUri": { + "description": "The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. ", + "type": "string" + }, + "resultSetSize": { + "description": "The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`.", + "type": "string" + }, + "startPosition": { + "description": "The starting index position of the current result set.", + "type": "string" + }, + "totalSetSize": { + "description": "The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`.", + "type": "string" + } + }, + "x-ds-definition-name": "folderItemsResponse", + "description": "", + "x-ms-summary": "" + }, + "folderSharedItem": { + "type": "object", + "properties": { + "errorDetails": { + "$ref": "#/definitions/errorDetails", + "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." + }, + "folderId": { + "description": "The id of the folder.", + "type": "string" + }, + "name": { + "description": "The name of the folder.", + "type": "string" + }, + "owner": { + "$ref": "#/definitions/userInfo", + "description": "Information about the user who owns the folder." + }, + "parentFolderId": { + "description": "The id of the parent folder.", + "type": "string" + }, + "parentFolderUri": { + "description": "The URI for the parent folder.", + "type": "string" + }, + "shared": { + "description": "Indicates how the folder is shared. Valid values are:\n\n- `not_shared`\n- `shared_to`", + "type": "string" + }, + "sharedGroups": { + "description": "A list of groups that share the folder.", + "type": "array", + "items": { + "$ref": "#/definitions/memberGroupSharedItem" + } + }, + "sharedUsers": { + "description": "A list of users that share the folder.", + "type": "array", + "items": { + "$ref": "#/definitions/userSharedItem" + } + }, + "uri": { + "description": "A URI containing the user ID.", + "type": "string" + }, + "user": { + "$ref": "#/definitions/userInfo", + "description": "Information about the user associated with the folder." + } + }, + "x-ds-definition-name": "folderSharedItem", + "description": "", + "x-ms-summary": "" + }, + "foldersRequest": { + "type": "object", + "properties": { + "envelopeIds": { + "description": "A comma-separated list of envelope IDs.", + "type": "array", + "items": { + "type": "string" + } + }, + "folders": { + "description": "A list of folder objects.", + "type": "array", + "items": { + "$ref": "#/definitions/folder" + } + }, + "fromFolderId": { + "description": " The id of the folder that the envelope is being moved from.", + "type": "string" + } + }, + "x-ds-definition-name": "foldersRequest", + "description": "Information for a folder request.", + "x-ms-summary": "Information for a folder request." + }, + "foldersResponse": { + "type": "object", + "properties": { + "endPosition": { + "description": "The last index position in the result set. ", + "type": "string" + }, + "envelopes": { + "description": "An array containing PowerForm data.", + "type": "array", + "items": { + "$ref": "#/definitions/envelopeSummary" + } + }, + "folders": { + "description": "A list of folder objects.", + "type": "array", + "items": { + "$ref": "#/definitions/folder" + } + }, + "nextUri": { + "description": "The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. ", + "type": "string" + }, + "previousUri": { + "description": "The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. ", + "type": "string" + }, + "resultSetSize": { + "description": "The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`.", + "type": "string" + }, + "startPosition": { + "description": "The starting index position of the current result set.", + "type": "string" + }, + "totalSetSize": { + "description": "The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`.", + "type": "string" + } + }, + "x-ds-definition-name": "foldersResponse", + "description": "", + "x-ms-summary": "" + }, + "forgottenPasswordInformation": { + "description": "A complex element that has up to four Question/Answer pairs for forgotten password information.", + "type": "object", + "properties": { + "forgottenPasswordAnswer1": { + "description": "The answer to the first forgotten password challenge question.", + "type": "string" + }, + "forgottenPasswordAnswer2": { + "description": "The answer to the second forgotten password challenge question.", + "type": "string" + }, + "forgottenPasswordAnswer3": { + "description": "The answer to the third forgotten password challenge question.", + "type": "string" + }, + "forgottenPasswordAnswer4": { + "description": "The answer to the fourth forgotten password challenge question.", + "type": "string" + }, + "forgottenPasswordQuestion1": { + "description": "The first challenge question presented to a user who has forgotten their password.", + "type": "string" + }, + "forgottenPasswordQuestion2": { + "description": "The second challenge question presented to a user who has forgotten their password.", + "type": "string" + }, + "forgottenPasswordQuestion3": { + "description": "The third challenge question presented to a user who has forgotten their password.", + "type": "string" + }, + "forgottenPasswordQuestion4": { + "description": "The fourth challenge question presented to a user who has forgotten their password.", + "type": "string" + } + }, + "x-ds-definition-name": "forgottenPasswordInformation", + "x-ms-summary": "A complex element that has up to four Question/Answer pairs for forgotten password information." + }, + "formDataItem": { + "type": "object", + "properties": { + "errorDetails": { + "$ref": "#/definitions/errorDetails", + "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." + }, + "listSelectedValue": { + "description": "The selected value in a list.", "type": "string" }, - "xPositionMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `xPosition` property is editable." + "name": { + "description": "The name of the form field.", + "type": "string" }, - "yPosition": { - "description": "This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.", + "originalValue": { + "description": "The initial value associated with the form field.", "type": "string" }, - "yPositionMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `yPosition` property is editable." + "value": { + "description": "The current value associated with the form field.", + "type": "string" } }, - "x-ds-definition-name": "email", - "description": "A tab that allows the recipient to enter an email address.\nThis is a one-line field that checks that a valid email\naddress is entered. It uses the same parameters as a Text\ntab, with the validation message and pattern set for email\ninformation.\n\nWhen getting information that includes\nthis tab type, the original value of the tab when the\nassociated envelope was sent is included in the response.\n", - "x-ms-summary": "A tab that allows the recipient to enter an email address.\nThis is a one-line field that checks that a valid email\naddress is entered. It uses the same parameters as a Text\ntab, with the validation message and pattern set for email\ninformation.\n\nWhen getting information that includes\nthis tab type, the original value of the tab when the\nassociated envelope was sent is included in the response.\n" + "x-ds-definition-name": "formDataItem", + "description": "", + "x-ms-summary": "" }, - "emailAddress": { + "formulaTab": { "type": "object", "properties": { + "anchorAllowWhiteSpaceInCharacters": { + "description": "", + "type": "string" + }, + "anchorAllowWhiteSpaceInCharactersMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "" + }, "anchorCaseSensitive": { - "description": "Reserved for DocuSign.\n", + "description": "This property controls how [anchor tabs][AnchorTabs] are placed. When **true**, the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false**.\n\nFor example, when set to **true**, if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When set to **false**, `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**.\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place", "type": "string" }, "anchorCaseSensitiveMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "description": "Metadata that indicates whether the `anchorCaseSensitive` property is editable." }, "anchorHorizontalAlignment": { - "description": "Reserved for DocuSign.\n\n", + "description": "This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are :\n\n- `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value.\n- `right`: Aligns the tab’s left side with the last character of the matching anchor word.\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place\n", "type": "string" }, "anchorHorizontalAlignmentMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "description": "Metadata that indicates whether the `anchorHorizontalAlignment` property is editable." }, "anchorIgnoreIfNotPresent": { "description": "When set to **true**, this tab is ignored if the `anchorString` is not found in the document.", @@ -30237,12 +41960,12 @@ "description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable." }, "anchorMatchWholeWord": { - "description": "Reserved for DocuSign.\n\n", + "description": "When set to **true**, the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false**.\n\nFor example, when set to **true**, if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When set to **false**, if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**.\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTab]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place\n", "type": "string" }, "anchorMatchWholeWordMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "description": "Metadata that indicates whether the `anchorMatchWholeWord` property is editable." }, "anchorString": { "description": "Specifies the string to find in the document and use as the basis for tab placement.", @@ -30261,7 +41984,7 @@ "description": "Reserved for DocuSign." }, "anchorUnits": { - "description": "Specifies the units of the X and Y offset. Units may be pixels, millimeters, centimeters, or inches.", + "description": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n", "type": "string" }, "anchorUnitsMetadata": { @@ -30269,7 +41992,7 @@ "description": "Metadata that indicates whether the `anchorUnits` property is editable." }, "anchorXOffset": { - "description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.", + "description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n", "type": "string" }, "anchorXOffsetMetadata": { @@ -30277,7 +42000,7 @@ "description": "Metadata that indicates whether the `anchorXOffset` property is editable." }, "anchorYOffset": { - "description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.", + "description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n", "type": "string" }, "anchorYOffsetMetadata": { @@ -30292,6 +42015,14 @@ "$ref": "#/definitions/propertyMetadata", "description": "Metadata that indicates whether the `bold` property is editable." }, + "concealValueOnDocument": { + "description": "When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender.\n\nWhen an envelope is completed the information is only available to the sender through the Form Data link in the DocuSign Console. The information on the downloaded document remains masked by asterisks.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.", + "type": "string" + }, + "concealValueOnDocumentMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `concealValueOnDocument` property is editable." + }, "conditionalParentLabel": { "description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility.", "type": "string" @@ -30309,15 +42040,23 @@ "description": "Metadata that indicates whether the `conditionalParentValue` property is editable." }, "customTabId": { - "description": "The DocuSign-generated custom tab id for the custom tab to be applied. This property can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.", + "description": "The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.", "type": "string" }, "customTabIdMetadata": { "$ref": "#/definitions/propertyMetadata", "description": "Metadata that indicates whether the `customTabId` property is editable." }, + "disableAutoSize": { + "description": "When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes.", + "type": "string" + }, + "disableAutoSizeMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `disableAutoSize` property is editable." + }, "documentId": { - "description": "Integer that identifies the document in the envelope.", + "description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.", "type": "string" }, "documentIdMetadata": { @@ -30376,6 +42115,14 @@ "$ref": "#/definitions/propertyMetadata", "description": "Metadata that indicates whether the `fromPageNumber` property is editable." }, + "formula": { + "description": "Contains the formula\nfor calculating the value of\nthis tab.\n\nUse a tab's `tabLabel`,\nenclosed in brackets,\nto refer to it.\n\nFor example,\nyou want to present the total cost\nof two items, tax included.\n\nThe cost of each item is stored\nin number tabs labeled Item1 and Item2.\nThe tax rate is in a number tab\nlabeled TaxRate.\n\nThe formula string for this property\nwould be:\n`([Item1] + [Item2]) * (1 + [TaxRate])`\n\nSee [Calculated Fields][calculatedfields]\nin the DocuSign Support Center\nto learn more about formulas.\n\nMaximum Length: 2000 characters\n\n[calculatedfields]: https://support.docusign.com/en/guides/ndse-user-guide-calculated-fields\n", + "type": "string" + }, + "formulaMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata indicating if the sender can edit the `formula` property." + }, "height": { "description": "The height of the tab in pixels.", "type": "string" @@ -30384,6 +42131,18 @@ "$ref": "#/definitions/propertyMetadata", "description": "Metadata that indicates whether the `height` property is editable." }, + "hidden": { + "description": "If this is a regular formula (no `paymentDetails` property is present):\n\n* **true**: The tab is hidden.\n* **false**: The tab is shown.\n\nIf the formula is payment item (a `paymentDetails` property is present):\n\n* **true**: The tab is displayed as a payment.\n* **false**: The tab is displayed as a regular formula.\n", + "type": "string" + }, + "hiddenMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `hidden` property is editable." + }, + "isPaymentAmountMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Reserved for DocuSign." + }, "italic": { "description": "When set to **true**, the information in the tab is italic.", "type": "string" @@ -30396,32 +42155,64 @@ "$ref": "#/definitions/localePolicyTab", "description": "Reserved for DocuSign." }, + "locked": { + "description": "When set to **true**, the signer cannot change the data of the custom tab.", + "type": "string" + }, + "lockedMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `locked` property is editable." + }, + "maxLength": { + "description": "An optional value that describes the maximum length of the property when the property is a string.", + "type": "string" + }, + "maxLengthMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `maxLength` property is editable." + }, "mergeField": { "$ref": "#/definitions/mergeField", "description": "Contains the information necessary to map the tab to a field in SalesForce." }, + "mergeFieldXml": { + "description": "", + "type": "string" + }, "name": { "description": "The name of the tab. For example, `Sign Here` or `Initial Here`.", "type": "string" }, "nameMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `name` property is editable." + "description": "Metadata that indicates whether the `name` property is editable. Read only." + }, + "originalValue": { + "description": "The initial value of the tab when it was sent to the recipient. ", + "type": "string" + }, + "originalValueMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `originalValue` property is editable." }, "pageNumber": { - "description": "The page number on which the tab is located.\nFor supplemental documents, this value must be `1`.\n", + "description": "The page number on which the tab is located. For supplemental documents, this value must be `1`.\n", "type": "string" }, "pageNumberMetadata": { "$ref": "#/definitions/propertyMetadata", "description": "Metadata that indicates whether the `pageNumber` property is editable." }, + "paymentDetails": { + "$ref": "#/definitions/paymentDetails", + "description": "This property indicates \nthat this formula tab \nis a payment item. \nSee [Requesting Payments Along with Signatures][paymentguide] \nin the DocuSign Support Center \nto learn more about payments. \n\n[paymentguide]: https://support.docusign.com/en/guides/requesting-payments-along-with-signatures\n" + }, "recipientId": { - "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", + "description": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.", "type": "string" }, "recipientIdGuid": { - "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one.", + "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only.", "type": "string" }, "recipientIdGuidMetadata": { @@ -30432,6 +42223,58 @@ "$ref": "#/definitions/propertyMetadata", "description": "Metadata that indicates whether the `recipientId` property is editable." }, + "requireAll": { + "description": "When set to **true** and shared is true, information must be entered in this field to complete the envelope. ", + "type": "string" + }, + "requireAllMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `requireAll` property is editable." + }, + "required": { + "description": "When set to **true**, the signer is required to fill out this tab.", + "type": "string" + }, + "requiredMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `required` property is editable." + }, + "requireInitialOnSharedChange": { + "description": "Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.", + "type": "string" + }, + "requireInitialOnSharedChangeMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `requireInitialOnSharedChange` property is editable." + }, + "roundDecimalPlaces": { + "description": "The number of decimal places to round to.", + "type": "string" + }, + "roundDecimalPlacesMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `roundDecimalPlaces` property is editable." + }, + "senderRequired": { + "description": "When set to **true**, the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope.", + "type": "string" + }, + "senderRequiredMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `senderRequired` property is editable." + }, + "shared": { + "description": "When set to **true**, this custom tab is shared.", + "type": "string" + }, + "sharedMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `shared` property is editable." + }, + "smartContractInformation": { + "$ref": "#/definitions/smartContractInformation", + "description": "" + }, "status": { "description": "The status of the tab. Possible values are:\n\n- `active`: The tab is active, but the recipient has not yet interacted with it.\n- `signed`: The recipient signed the tab.\n- `declined`: The recipient declined the envelope.\n- `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`).", "type": "string" @@ -30460,7 +42303,7 @@ "description": "Metadata that indicates whether the `tabId` property is editable." }, "tabLabel": { - "description": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n", + "description": "The label associated with the tab. This value may be an empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum Length: 500 characters.\n", "type": "string" }, "tabLabelMetadata": { @@ -30500,1093 +42343,616 @@ "description": "Metadata that indicates whether the `templateRequired` property is editable." }, "tooltip": { - "description": "The text of a tooltip that appears when a user hovers over a form field or tab.", - "type": "string" - }, - "toolTipMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `toolTip` property is editable." - }, - "underline": { - "description": "When set to **true**, the information in the tab is underlined.", - "type": "string" - }, - "underlineMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `underline` property is editable." - }, - "value": { - "description": "Specifies the value of the tab. ", - "type": "string" - }, - "valueMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `value` property is editable." - }, - "width": { - "description": "The width of the tab in pixels.", - "type": "string" - }, - "widthMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `width` property is editable." - }, - "xPosition": { - "description": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n", - "type": "string" - }, - "xPositionMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `xPosition` property is editable." - }, - "yPosition": { - "description": "This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.", - "type": "string" - }, - "yPositionMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `yPosition` property is editable." - } - }, - "x-ds-definition-name": "emailAddress", - "description": "A tab that displays the recipient's email as entered in the\nrecipient information.\n", - "x-ms-summary": "A tab that displays the recipient's email as entered in the\nrecipient information.\n" - }, - "emailSettings": { - "description": "", - "type": "object", - "properties": { - "bccEmailAddresses": { - "description": "An array of up to five email addresses that receive a copy of all email communications for an envelope. Maximum Length: 100 characters.\n\n**Note**: Only users with the `canManageAccount` setting set to **true** can use this option. \n\nDocuSign verifies that the email format is correct, but does not verify that the email address is active. You can use this for archiving purposes. However, using this property overrides the BCC for Email Archive information setting for this envelope. \n\n**Example**: if your account has BCC for Email Archive set up for the email address archive@mycompany.com and you send an envelope using the BCC Email Override to send a BCC email to salesarchive@mycompany.com, then a copy of the envelope is only sent to the salesarchive@mycompany.com email address.", - "type": "array", - "items": { - "$ref": "#/definitions/bccEmailAddress" - } - }, - "replyEmailAddressOverride": { - "description": "The Reply To email address to use for email replies, instead of the one that is configured at the account level. DocuSign verifies that the email address is in a correct format, but does not verify that it is active. Maximum Length: 100 characters.", - "type": "string" - }, - "replyEmailNameOverride": { - "description": "The name to associate with the Reply To email address, instead of the name that is configured at the account level. Maximum Length: 100 characters.", - "type": "string" - } - }, - "x-ds-definition-name": "emailSettings", - "x-ms-summary": "" - }, - "eNoteConfiguration": { - "type": "object", - "properties": { - "connectConfigured": { - "description": "", - "type": "string" - }, - "eNoteConfigured": { - "description": "", - "type": "string" - }, - "organization": { - "description": "", - "type": "string" - }, - "password": { - "description": "The user's encrypted password hash.", - "type": "string" - }, - "userName": { - "description": "The name of the user.", - "type": "string" - } - }, - "x-ds-definition-name": "eNoteConfiguration", - "description": "", - "x-ms-summary": "" - }, - "envelope": { - "type": "object", - "properties": { - "accessControlListBase64": { - "description": "Reserved for DocuSign.", - "type": "string" - }, - "allowComments": { - "description": "When set to **true**, users can add comments to the documents in the envelope. For example, if a signer has a question about the text in the document, they can add a comment to the document.", - "type": "string" - }, - "allowMarkup": { - "description": "When **true**, Document Markup is enabled for envelope. The account must have Document Markup enabled to use this.", - "type": "string" - }, - "allowReassign": { - "description": "When **true**, the recipient can redirect an envelope to a more appropriate recipient.", - "type": "string" - }, - "allowViewHistory": { - "description": "When set to **true**, recipients can view the history of the envelope.", - "type": "string" - }, - "anySigner": { - "description": "Deprecated. This feature has been replaced by signing groups.", - "type": "string" - }, - "asynchronous": { - "description": "When **true**, the envelope is queued for processing and the value of the `status` property is set to 'Processing'. Additionally, get status calls return 'Processing' until completed. \n\n\n**Note**: A `transactionId` is required for this call to work correctly. When the envelope is created, the status is 'Processing' and an `envelopeId` is not returned in the response. To get the `envelopeId`, use a GET envelope query using the [transactionId](https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/create/#envelopeDefinition) or by checking the Connect notification.", - "type": "string" - }, - "attachmentsUri": { - "description": "Contains a URL for retrieving the attachments that are associated with the envelope.", - "type": "string" - }, - "authoritativeCopy": { - "description": "Specifies whether all documents in this envelope are authoritative copies.\nA document can set its own `authoritativeCopy` property to override this value. For example you can set the `authoritativeCopy` on an envelope level to true but can turn it off for a specific document. ", - "type": "string" - }, - "authoritativeCopyDefault": { - "description": "The default `authoritativeCopy` setting for documents in this envelope that do not have `authoritativeCopy` set.\nIf this property is not set, each document defaults to the envelope's `authoritativeCopy`.", - "type": "string" - }, - "autoNavigation": { - "description": "When **true**, auto navigation is set for the recipient.\n", - "type": "string" - }, - "brandId": { - "description": "The id of the brand.", - "type": "string" - }, - "brandLock": { - "description": "Indicates if the brandId for the envelope is locked.", - "type": "string" - }, - "certificateUri": { - "description": "Contains a URI that you can use to retrieve certificate information.", - "type": "string" - }, - "completedDateTime": { - "description": "Specifies the date and time this item was completed.", - "type": "string" - }, - "createdDateTime": { - "description": "The date and time the item was created.", - "type": "string" - }, - "customFields": { - "$ref": "#/definitions/AccountCustomFields", - "description": "An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters." - }, - "customFieldsUri": { - "description": "Contains a URI for an endpoint to retrieve the custom fields.", - "type": "string" - }, - "declinedDateTime": { - "description": "The date and time the recipient declined the document.", - "type": "string" - }, - "deletedDateTime": { - "description": "Specifies the data and time the item was deleted.", - "type": "string" - }, - "deliveredDateTime": { - "description": "The date and time that the envelope was delivered to the recipient.", - "type": "string" - }, - "disableResponsiveDocument": { - "description": "When set to **true**, responsive documents are disabled for the envelope.", - "type": "string" - }, - "documentsCombinedUri": { - "description": "Contains a URL that you can use to retrieve all of the documents associated with the envelope combined into a single PDF file.", - "type": "string" - }, - "documentsUri": { - "description": "Contains a URI for an endpoint that you can use to retrieve the documents.", - "type": "string" - }, - "emailBlurb": { - "description": "This is the same as the email body. If the sender enters an email blurb, it is included in the email body for all envelope recipients.", - "type": "string" - }, - "emailSettings": { - "$ref": "#/definitions/EnvelopeEmailSettings", - "description": "A complex type that contains email settings." - }, - "emailSubject": { - "description": "The subject line of the email message that is sent to all recipients.\n\nFor information about adding merge field information to the email subject, see [Template Email Subject Merge Fields](https://developers.docusign.com/esign-rest-api/reference/Templates/Templates/create#template-email-subject-merge-fields).\n", - "type": "string" - }, - "enableWetSign": { - "description": "When set to **true**, the signer is allowed to print the document and sign it on paper.", - "type": "string" - }, - "enforceSignerVisibility": { - "description": "When set to **true**, signers can only view the documents on which they have tabs. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all of the documents in an envelope, unless they are specifically excluded by using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded by using this setting when an envelope is sent.\n\n**Note**: To use this functionality, [Document Visibility][docviz] must be enabled for the account by making the account setting `allowDocumentVisibility` **true**.\n\n[docviz]: /esign/restapi/Envelopes/EnvelopeDocumentVisibility", - "type": "string" - }, - "envelopeAttachments": { - "description": "An array of attachment objects that provide information about the attachments that are associated with the envelope.", - "type": "array", - "items": { - "$ref": "#/definitions/attachment" - } - }, - "envelopeDocuments": { - "description": "An array containing information about the documents that are included in the envelope.", - "type": "array", - "items": { - "$ref": "#/definitions/envelopeDocument" - } - }, - "envelopeId": { - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", - "type": "string" - }, - "envelopeIdStamping": { - "description": "When set to **true**, [Envelope ID Stamping](https://support.docusign.com/en/guides/ndse-user-guide-set-advanced-document-options) is enabled.\nOnce a document or attachment is stamped with an Envelope ID,\nthe ID is seen by all recipients\nand becomes a permanent part of the document\nand cannot be removed.", - "type": "string" - }, - "envelopeLocation": { - "description": "Reserved for DocuSign.", - "type": "string" - }, - "envelopeMetadata": { - "$ref": "#/definitions/envelopeMetadata", - "description": "Provides information about the features and services that are enabled for the envelope, including the Correct feature, the Advanced Correct feature, and DocuSign eNotary service." - }, - "envelopeUri": { - "description": "URI that you can use to retrieve the bulk envelopes.", - "type": "string" - }, - "expireAfter": { - "description": "An integer specifying the number of days that a sent envelope remains active before it expires. A negative number in a response indicates that the envelope has already expired.", - "type": "string" - }, - "expireDateTime": { - "description": "The date and time the envelope is set to expire.", - "type": "string" - }, - "expireEnabled": { - "description": "When set to **true**, the envelope expires (is no longer available for signing) after the specified number of days after it is sent (`sentDateTime`). Set `expireAfter` to set the number of days until an envelope expires. When **false**, the account default setting is used. If the account does not have an expiration setting, the DocuSign default value of 120 days is used.", - "type": "string" - }, - "externalEnvelopeId": { - "description": "May contain an external identifier for the envelope.", - "type": "string" - }, - "folders": { - "description": "A collection of folder objects returned in a response.", - "type": "array", - "items": { - "$ref": "#/definitions/folder" - } - }, - "hasComments": { - "description": "When set to **true**, indicates that users have added comments to the envelope.", - "type": "string" - }, - "hasFormDataChanged": { - "description": "When set to **true**, indicates that the data collected through form fields on a document has changed.", - "type": "string" - }, - "hasWavFile": { - "description": "When set to **true**, indicates that a .wav file used for voice authentication is included in the envelope. ", - "type": "string" - }, - "holder": { - "description": "Reserved for DocuSign.", - "type": "string" - }, - "initialSentDateTime": { - "description": "The date and time the envelope was initially sent.", - "type": "string" - }, - "is21CFRPart11": { - "description": "When **true**, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).", - "type": "string" - }, - "isDynamicEnvelope": { - "description": "When set to **true**, indicates that the envelope is a dynamic envelope.", - "type": "string" - }, - "isSignatureProviderEnvelope": { - "description": "When set to **true**, indicates that the envelope is a signature-provided envelope.", - "type": "string" - }, - "lastModifiedDateTime": { - "description": "The date and time the item was last modified.", - "type": "string" - }, - "location": { - "description": "Reserved for DocuSign.", - "type": "string" - }, - "lockInformation": { - "$ref": "#/definitions/EnvelopeLocks", - "description": "Provides lock information about an envelope that a user has locked." - }, - "messageLock": { - "description": "When set to **true**, prevents senders from changing the contents of `emailBlurb` and `emailSubject` properties for the envelope. \n\nAdditionally, this prevents users from making changes to the contents of `emailBlurb` and `emailSubject` properties when correcting envelopes. \n\nHowever, if the `messageLock` node is set to **true** and the `emailSubject` property is empty, senders and correctors are able to add a subject to the envelope.", - "type": "string" - }, - "notification": { - "$ref": "#/definitions/notification", - "description": "" - }, - "notificationUri": { - "description": "Contains a URI for an endpoint that you can use to retrieve the notifications.", - "type": "string" - }, - "powerForm": { - "$ref": "#/definitions/PowerForms", - "description": "Contains information about any PowerForms that are included in the envelope." - }, - "purgeCompletedDate": { - "description": "The date that a purge was completed.", - "type": "string" - }, - "purgeRequestDate": { - "description": "The date that a purge was requested.", - "type": "string" - }, - "purgeState": { - "description": "Shows the current purge state for the envelope. The possible values are:\n\n* `unpurged`: There has been no successful request to purge documents.\n* `documents_queued`: The envelope documents have been added to the purge queue, but have not been purged.\n* `documents_dequeued`: The envelope documents have been taken out of the purge queue.\n* `documents_and_metadata_queued`: The envelope documents and metadata have been added to the purge queue, but have not yet been purged.\n* `documents_purged`: The envelope documents have been successfully purged.\n* `documents_and_metadata_purged`: The envelope documents and metadata have been successfully purged.\n\n", - "type": "string" - }, - "recipients": { - "$ref": "#/definitions/EnvelopeRecipients", - "description": "An array of recipient objects that provides details about the recipients of the envelope." - }, - "recipientsLock": { - "description": "When set to **true**, prevents senders from changing, correcting, or deleting the recipient information for the envelope.", - "type": "string" - }, - "recipientsUri": { - "description": "Contains a URI for an endpoint that you can use to retrieve the recipients.", - "type": "string" - }, - "sender": { - "$ref": "#/definitions/userInfo", - "description": "Information about the sender of the envelope." - }, - "sentDateTime": { - "description": "The date and time the envelope was sent.", - "type": "string" - }, - "signerCanSignOnMobile": { - "description": "When set to **true**, the recipient can sign on a mobile device.", - "type": "string" - }, - "signingLocation": { - "description": "Specifies the physical location where the signing takes place. It can have two enumeration values; `inPerson` and `online`. The default value is `online`.", + "description": "The text of a tooltip that appears when a user hovers over a form field or tab.", "type": "string" }, - "status": { - "description": "The status of the item.", - "type": "string" + "toolTipMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `toolTip` property is editable." }, - "statusChangedDateTime": { - "description": "The data and time the status changed.", + "underline": { + "description": "When set to **true**, the information in the tab is underlined.", "type": "string" }, - "statusDateTime": { - "description": "The DateTime that the envelope changed status (i.e. was created or sent.)", - "type": "string" + "underlineMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `underline` property is editable." }, - "templatesUri": { - "description": "Contains a URI for an endpoint that you can use to retrieve the templates.", + "validationMessage": { + "description": "The message displayed if the custom tab fails input validation (either custom of embedded).", "type": "string" }, - "transactionId": { - "description": "Specifies the Transaction ID from the AppStore.", - "type": "string" + "validationMessageMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `validationMessage` property is editable." }, - "useDisclosure": { - "description": "When set to **true**, the disclosure is shown to recipients in accordance with the account's Electronic Record and Signature Disclosure frequency setting. When set to **false**, the Electronic Record and Signature Disclosure is not shown to any envelope recipients. \n\nIf the `useDisclosure` property is not set, then the account's normal disclosure setting is used and the value of the `useDisclosure` property is not returned in responses when getting envelope information.", + "validationPattern": { + "description": "A regular expression used to validate input for the tab.", "type": "string" }, - "voidedDateTime": { - "description": "The date and time the envelope or template was voided.", - "type": "string" + "validationPatternMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `validationPattern` property is editable." }, - "voidedReason": { - "description": "The reason the envelope or template was voided.", - "type": "string" - } - }, - "x-ds-definition-name": "envelope", - "description": "", - "x-ms-summary": "" - }, - "envelopeAttachment": { - "type": "object", - "properties": { - "accessControl": { - "description": "Valid values are `sender` and `senderAndAllRecipients`.", + "value": { + "description": "Specifies the value of the tab. ", "type": "string" }, - "attachmentId": { - "description": "The unique identifier for the attachment.", - "type": "string" + "valueMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `value` property is editable." }, - "attachmentType": { - "description": "Specifies the type of the attachment for the recipient. Possible values are:\n\n- `.htm`\n- `.xml`", + "width": { + "description": "The width of the tab in pixels.", "type": "string" }, - "errorDetails": { - "$ref": "#/definitions/errorDetails", - "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." + "widthMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `width` property is editable." }, - "label": { - "description": "", + "xPosition": { + "description": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (+35, -2)\n", "type": "string" }, - "name": { - "description": "", + "xPositionMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `xPosition` property is editable." + }, + "yPosition": { + "description": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (+35, -2)\n", "type": "string" + }, + "yPositionMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `yPosition` property is editable." } }, - "x-ds-definition-name": "envelopeAttachment", - "description": "", - "x-ms-summary": "" - }, - "envelopeAttachmentsRequest": { - "type": "object", - "properties": { - "attachments": { - "description": "An object that contains information about the attachment.", - "type": "array", - "items": { - "$ref": "#/definitions/attachment" - } - } - }, - "x-ds-definition-name": "envelopeAttachmentsRequest", - "description": "", - "x-ms-summary": "" - }, - "envelopeAttachmentsResult": { - "type": "object", - "properties": { - "attachments": { - "description": "An array of attachment objects that contain information about the attachments.", - "type": "array", - "items": { - "$ref": "#/definitions/EnvelopeAttachments" - } - } - }, - "x-ds-definition-name": "envelopeAttachmentsResult", - "description": "", - "x-ms-summary": "" + "x-ds-definition-name": "formulaTab", + "description": "The value of a formula tab is calculated\nfrom the values of other\nnumber or date tabs in the document.\nWhen the recipient completes the underlying fields,\nthe formula tab calculates and displays the result.\n\nThe `formula` property of the tab\ncontains the references\nto the underlying tabs.\nSee [Calculated Fields][calculatedfields]\nin the DocuSign Support Center\nto learn more about formulas.\n\nIf a formula tab contains\na `paymentDetails` property,\nthe tab is considered a payment item.\nSee [Requesting Payments Along with Signatures][paymentguide]\nin the DocuSign Support Center\nto learn more about payments.\n\n[calculatedfields]: https://support.docusign.com/en/guides/ndse-user-guide-calculated-fields\n[paymentguide]: https://support.docusign.com/en/guides/requesting-payments-along-with-signatures\n", + "x-ms-summary": "The value of a formula tab is calculated\nfrom the values of other\nnumber or date tabs in the document.\nWhen the recipient completes the underlying fields,\nthe formula tab calculates and displays the result.\n\nThe `formula` property of the tab\ncontains the references\nto the underlying tabs.\nSee [Calculated Fields][calculatedfields]\nin the DocuSign Support Center\nto learn more about formulas.\n\nIf a formula tab contains\na `paymentDetails` property,\nthe tab is considered a payment item.\nSee [Requesting Payments Along with Signatures][paymentguide]\nin the DocuSign Support Center\nto learn more about payments.\n\n[calculatedfields]: https://support.docusign.com/en/guides/ndse-user-guide-calculated-fields\n[paymentguide]: https://support.docusign.com/en/guides/requesting-payments-along-with-signatures\n" }, - "envelopeAuditEvent": { + "fullName": { "type": "object", "properties": { - "eventFields": { + "anchorAllowWhiteSpaceInCharacters": { "description": "", - "type": "array", - "items": { - "$ref": "#/definitions/nameValue" - } - } - }, - "x-ds-definition-name": "envelopeAuditEvent", - "description": "", - "x-ms-summary": "" - }, - "envelopeAuditEventResponse": { - "type": "object", - "properties": { - "auditEvents": { - "description": "Reserved: TBD", - "type": "array", - "items": { - "$ref": "#/definitions/envelopeAuditEvent" - } - } - }, - "x-ds-definition-name": "envelopeAuditEventResponse", - "description": "", - "x-ms-summary": "" - }, - "envelopeDefinition": { - "type": "object", - "properties": { - "accessControlListBase64": { - "description": "Reserved for DocuSign.", "type": "string" }, - "accessibility": { - "description": "Sets the document reading zones for screen reader applications. This element can only be used if Document Accessibility is enabled for the account. \n\n###### Note: This information is currently generated from the DocuSign web console by setting the reading zones when creating a template, exporting the reading zone string information, and adding it here.", - "type": "string" + "anchorAllowWhiteSpaceInCharactersMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "" }, - "allowComments": { - "description": "When **true**, indicates that comments are allowed on the envelope.", + "anchorCaseSensitive": { + "description": "This property controls how [anchor tabs][AnchorTabs] are placed. When **true**, the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false**.\n\nFor example, when set to **true**, if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When set to **false**, `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**.\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place", "type": "string" }, - "allowMarkup": { - "description": "When **true**, Document Markup is enabled for envelope. The account must have Document Markup enabled to use this.", - "type": "string" + "anchorCaseSensitiveMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorCaseSensitive` property is editable." }, - "allowReassign": { - "description": "When **true**, the recipient can redirect an envelope to a more appropriate recipient.", + "anchorHorizontalAlignment": { + "description": "This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are :\n\n- `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value.\n- `right`: Aligns the tab’s left side with the last character of the matching anchor word.\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place\n", "type": "string" }, - "allowRecipientRecursion": { - "description": "When set to **true**, this enables the Recursive Recipients feature and allows a recipient to appear more than once in the routing order.", - "type": "string" + "anchorHorizontalAlignmentMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorHorizontalAlignment` property is editable." }, - "allowViewHistory": { - "description": "Specifies if users can view the history of the envelope.", + "anchorIgnoreIfNotPresent": { + "description": "When set to **true**, this tab is ignored if the `anchorString` is not found in the document.", "type": "string" }, - "anySigner": { - "description": "Deprecated. This feature has been replaced by signing groups.", - "type": "string" + "anchorIgnoreIfNotPresentMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable." }, - "asynchronous": { - "description": "When **true**, the envelope is queued for processing and the value of the `status` property is set to 'Processing'. Additionally, get status calls return 'Processing' until completed. \n\n\n**Note**: A `transactionId` is required for this call to work correctly. When the envelope is created, the status is 'Processing' and an `envelopeId` is not returned in the response. To get the `envelopeId`, use a GET envelope query using the [transactionId](https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/create/#envelopeDefinition) or by checking the Connect notification.", + "anchorMatchWholeWord": { + "description": "When set to **true**, the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false**.\n\nFor example, when set to **true**, if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When set to **false**, if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**.\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTab]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place\n", "type": "string" }, - "attachments": { - "description": "", - "type": "array", - "items": { - "$ref": "#/definitions/attachment" - } - }, - "attachmentsUri": { - "description": "The URI for retrieving information about the attachments associated with the envelope.", - "type": "string" + "anchorMatchWholeWordMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorMatchWholeWord` property is editable." }, - "authoritativeCopy": { - "description": "Specifies whether all documents in this envelope are authoritative copies.\nA document can set its own `authoritativeCopy` property to override this value. For example you can set the `authoritativeCopy` on an envelope level to true but can turn it off for a specific document. ", + "anchorString": { + "description": "Specifies the string to find in the document and use as the basis for tab placement.", "type": "string" }, - "authoritativeCopyDefault": { - "description": "The default `authoritativeCopy` setting for documents in this envelope that do not have `authoritativeCopy` set.\nIf this property is not set, each document defaults to the envelope's `authoritativeCopy`.", - "type": "string" + "anchorStringMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorString` property is editable." }, - "autoNavigation": { - "description": "When **true**, auto navigation is set for the recipient.\n", + "anchorTabProcessorVersion": { + "description": "Reserved for DocuSign.", "type": "string" }, - "brandId": { - "description": "This sets the brand profile format used for the envelope. The value in the string is the brandId associated with the profile. Account branding must be enabled for the account to use this option.", - "type": "string" + "anchorTabProcessorVersionMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Reserved for DocuSign." }, - "brandLock": { - "description": "Indicates if the brandId for the envelope is locked.", + "anchorUnits": { + "description": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n", "type": "string" }, - "certificateUri": { - "description": "Contains a URI that you can use to retrieve certificate information.", - "type": "string" + "anchorUnitsMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorUnits` property is editable." }, - "completedDateTime": { - "description": "Specifies the date and time this item was completed.", + "anchorXOffset": { + "description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n", "type": "string" }, - "compositeTemplates": { - "description": "A complex type that can be added to create envelopes from a combination of DocuSign templates and PDF forms. The basic envelope remains the same, while the Composite Template adds new document and template overlays into the envelope. There can be any number of Composite Template structures in the envelope.", - "type": "array", - "items": { - "$ref": "#/definitions/compositeTemplate" - } + "anchorXOffsetMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorXOffset` property is editable." }, - "createdDateTime": { - "description": "The date and time the item was created.", + "anchorYOffset": { + "description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n", "type": "string" }, - "customFields": { - "$ref": "#/definitions/AccountCustomFields", - "description": "An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters." + "anchorYOffsetMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorYOffset` property is editable." }, - "customFieldsUri": { - "description": "Contains a URI for an endpoint to retrieve the custom fields.", + "bold": { + "description": "When set to **true**, the information in the tab is bold.", "type": "string" }, - "declinedDateTime": { - "description": "The date and time the recipient declined the document.", - "type": "string" + "boldMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `bold` property is editable." }, - "deletedDateTime": { - "description": "Specifies the data and time the item was deleted.", + "conditionalParentLabel": { + "description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility.", "type": "string" }, - "deliveredDateTime": { - "description": "The date and time that the envelope was delivered to the recipient.", - "type": "string" + "conditionalParentLabelMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `conditionalParentLabel` property is editable." }, - "disableResponsiveDocument": { - "description": "When **true**, indicates that the responsive document feature has been turned off for the envelope.", + "conditionalParentValue": { + "description": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use \"on\" as the value to show that the parent tab is active.\n", "type": "string" }, - "documents": { - "description": "Complex element contains the details on the documents in the envelope.", - "type": "array", - "items": { - "$ref": "#/definitions/document" - } + "conditionalParentValueMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `conditionalParentValue` property is editable." }, - "documentsCombinedUri": { - "description": "Contains a URL that you can use to retrieve all of the documents associated with the envelope combined into a single PDF file.", + "customTabId": { + "description": "The DocuSign-generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.", "type": "string" }, - "documentsUri": { - "description": "Contains a URI for an endpoint that you can use to retrieve the documents.", - "type": "string" + "customTabIdMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `customTabId` property is editable." }, - "emailBlurb": { - "description": "Optional element. This is the same as the email body. If specified it is included in email body for all envelope recipients. This can be a maximum of 10000 characters", + "documentId": { + "description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.", "type": "string" }, - "emailSettings": { - "$ref": "#/definitions/EnvelopeEmailSettings", - "description": "This optional complex element allows sender to override some envelope email setting information. This can be used to override the Reply To email address and name associated with the envelope and to override the BCC email addresses to which an envelope is sent. When the emailSettings information is used for an envelope, it only applies to that envelope. \n###### Important Note: The emailSettings information is not returned in the GET for envelope status. Use GET /email_settings to return information about the emailSettings." + "documentIdMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `documentId` property is editable." }, - "emailSubject": { - "description": "The subject line of the email message that is sent to all recipients.\n\nFor information about adding merge field information to the email subject, see [Template Email Subject Merge Fields](https://developers.docusign.com/esign-rest-api/reference/Templates/Templates/create#template-email-subject-merge-fields).\n", - "type": "string" + "errorDetails": { + "$ref": "#/definitions/errorDetails", + "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." }, - "enableWetSign": { - "description": "When set to **true**, the signer is allowed to print the document and sign it on paper.", + "font": { + "description": "The font to be used for the tab value. Supported fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n", "type": "string" }, - "enforceSignerVisibility": { - "description": "When set to **true**, signers can only view the documents on which they have tabs. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all of the documents in an envelope, unless they are specifically excluded by using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded by using this setting when an envelope is sent.\n\n**Note**: To use this functionality, [Document Visibility][docviz] must be enabled for the account by making the account setting `allowDocumentVisibility` **true**.\n\n[docviz]: /esign/restapi/Envelopes/EnvelopeDocumentVisibility", + "fontColor": { + "description": "The font color to use for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n", "type": "string" }, - "envelopeAttachments": { - "description": "An array of attachment objects that provide information about the attachments that are associated with the envelope.", - "type": "array", - "items": { - "$ref": "#/definitions/attachment" - } + "fontColorMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `fontColor` property is editable." }, - "envelopeDocuments": { - "description": "An array containing information about the documents that are included in the envelope.", - "type": "array", - "items": { - "$ref": "#/definitions/envelopeDocument" - } + "fontMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `font` property is editable." }, - "envelopeId": { - "description": "The envelope ID of the envelope status that failed to post.", + "fontSize": { + "description": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72", "type": "string" }, - "envelopeIdStamping": { - "description": "When set to **true**, [Envelope ID Stamping](https://support.docusign.com/en/guides/ndse-user-guide-set-advanced-document-options) is enabled.\nOnce a document or attachment is stamped with an Envelope ID,\nthe ID is seen by all recipients\nand becomes a permanent part of the document\nand cannot be removed.", - "type": "string" + "fontSizeMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `fontSize` property is editable." }, - "envelopeLocation": { - "description": "Reserved for DocuSign.", + "formOrder": { + "description": "An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block.", "type": "string" }, - "envelopeMetadata": { - "$ref": "#/definitions/envelopeMetadata", - "description": "Metadata about the features that are enabled for the envelope." + "formOrderMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `formOrder` property is editable." }, - "envelopeUri": { - "description": "URI that you can use to retrieve the bulk envelopes.", + "formPageLabel": { + "description": "A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience.", "type": "string" }, - "eventNotification": { - "$ref": "#/definitions/eventNotification", - "description": "This optional object is used to register a webhook that will receive status changes for this envelope." - }, - "eventNotifications": { - "description": "An array of event notification objects.", - "type": "array", - "items": { - "$ref": "#/definitions/eventNotification" - } + "formPageLabelMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `formPageLabel` property is editable." }, - "expireAfter": { - "description": "An integer specifying the number of days that a sent envelope remains active before it expires. A negative number in a response indicates that the envelope has already expired.", + "formPageNumber": { + "description": "An integer specifying the order in which to present the guided form pages.", "type": "string" }, - "expireDateTime": { - "description": "The date and time the envelope is set to expire.", - "type": "string" + "formPageNumberMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `fromPageNumber` property is editable." }, - "expireEnabled": { - "description": "When set to **true**, the envelope expires (is no longer available for signing) after the specified number of days after it is sent (`sentDateTime`). Set `expireAfter` to set the number of days until an envelope expires. When **false**, the account default setting is used. If the account does not have an expiration setting, the DocuSign default value of 120 days is used.", + "height": { + "description": "The height of the tab in pixels.", "type": "string" }, - "externalEnvelopeId": { - "description": "May contain an external identifier for the envelope.", + "heightMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `height` property is editable." + }, + "italic": { + "description": "When set to **true**, the information in the tab is italic.", "type": "string" }, - "folders": { - "description": "An array of the folders in which the envelope is included.", - "type": "array", - "items": { - "$ref": "#/definitions/folder" - } + "italicMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `italic` property is editable." }, - "hasComments": { - "description": "When set to **true**, indicates that users have added comments to the envelope.", - "type": "string" + "localePolicy": { + "$ref": "#/definitions/localePolicyTab", + "description": "Reserved for DocuSign." }, - "hasFormDataChanged": { - "description": "When set to **true**, indicates that the form data associated with the envelope has changed since it was sent. If **false**, this property does not appear in the response.", - "type": "string" + "mergeField": { + "$ref": "#/definitions/mergeField", + "description": "Contains the information necessary to map the tab to a field in SalesForce." }, - "hasWavFile": { - "description": "When **true**, indicates that a wave file (voice recording) is part of the envelope.", + "mergeFieldXml": { + "description": "", "type": "string" }, - "holder": { - "description": "Reserved for DocuSign.", + "name": { + "description": "The name of the tab. For example, `Sign Here` or `Initial Here`.", "type": "string" }, - "initialSentDateTime": { - "description": "The date and time that the envelope was initially sent.", - "type": "string" + "nameMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `name` property is editable. Read only." }, - "is21CFRPart11": { - "description": "When **true**, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).", + "pageNumber": { + "description": "The page number on which the tab is located. For supplemental documents, this value must be `1`.\n", "type": "string" }, - "isDynamicEnvelope": { - "description": "When set to **true**, indicates that the envelope is a dynamic envelope.", - "type": "string" + "pageNumberMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `pageNumber` property is editable." }, - "isSignatureProviderEnvelope": { - "description": "When set to **true**, indicates that the envelope is a signature-provided envelope.", + "recipientId": { + "description": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.", "type": "string" }, - "lastModifiedDateTime": { - "description": "The date and time the item was last modified.", + "recipientIdGuid": { + "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only.", "type": "string" }, - "location": { - "description": "Reserved for DocuSign.", - "type": "string" + "recipientIdGuidMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `recipientIdGuid` property is editable." }, - "lockInformation": { - "$ref": "#/definitions/EnvelopeLocks", - "description": "Provides lock information about an envelope that a user has locked." + "recipientIdMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `recipientId` property is editable." }, - "messageLock": { - "description": "When set to **true**, prevents senders from changing the contents of `emailBlurb` and `emailSubject` properties for the envelope. \n\nAdditionally, this prevents users from making changes to the contents of `emailBlurb` and `emailSubject` properties when correcting envelopes. \n\nHowever, if the `messageLock` node is set to **true** and the `emailSubject` property is empty, senders and correctors are able to add a subject to the envelope.", + "smartContractInformation": { + "$ref": "#/definitions/smartContractInformation", + "description": "" + }, + "status": { + "description": "The status of the tab. Possible values are:\n\n- `active`: The tab is active, but the recipient has not yet interacted with it.\n- `signed`: The recipient signed the tab.\n- `declined`: The recipient declined the envelope.\n- `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`).", "type": "string" }, - "notification": { - "$ref": "#/definitions/notification", - "description": "An optional complex element that specifies the notification options for the envelope." + "statusMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `status` property is editable." }, - "notificationUri": { - "description": "Contains a URI for an endpoint that you can use to retrieve the notifications.", - "type": "string" + "tabGroupLabels": { + "description": "An array of tab group labels that uniquely identify tab groups. To assign a tab to a `tabGroup`, you assign the `TabGroupLabel` to the `Tab.TabGroupLabels` array.", + "type": "array", + "items": { + "type": "string" + } }, - "password": { - "description": "The user's encrypted password hash.", + "tabGroupLabelsMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `tabGroupLabels` property is editable." + }, + "tabId": { + "description": "The unique identifier for the tab.", "type": "string" }, - "powerForm": { - "$ref": "#/definitions/PowerForms", - "description": "Contains information about any PowerForms that are included in the envelope." + "tabIdMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `tabId` property is editable." }, - "purgeCompletedDate": { - "description": "The date that a purge was completed.", + "tabLabel": { + "description": "The label associated with the tab. This value may be an empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum Length: 500 characters.\n", "type": "string" }, - "purgeRequestDate": { - "description": "The date that a purge was requested.", - "type": "string" + "tabLabelMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `tabLabel` property is editable." }, - "purgeState": { - "description": "Initiates a purge request. Valid values are:\n* documents_queued - Places envelope documents in the purge queue.\n* documents_and_metadata_queued - Places envelope documents and metadata in the purge queue.\n", + "tabOrder": { + "description": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.", "type": "string" }, - "recipients": { - "$ref": "#/definitions/EnvelopeRecipients", - "description": "Specifies the envelope recipients." + "tabOrderMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `tabOrder` property is editable." }, - "recipientsLock": { - "description": "When set to **true**, prevents senders from changing, correcting, or deleting the recipient information for the envelope.", + "tabType": { + "description": "Indicates the type of tab (for example, `signHere` or `initialHere`).", "type": "string" }, - "recipientsUri": { - "description": "Contains a URI for an endpoint that you can use to retrieve the recipients.", + "tabTypeMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `tabType` property is editable." + }, + "templateLocked": { + "description": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ", "type": "string" }, - "sender": { - "$ref": "#/definitions/userInfo", - "description": "Information about the sender of the envelope." + "templateLockedMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `templateLocked` property is editable." }, - "sentDateTime": { - "description": "The date and time the envelope was sent.", + "templateRequired": { + "description": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.", "type": "string" }, - "signerCanSignOnMobile": { - "description": "When set to **true**, the recipient can sign on a mobile device.", - "type": "string" + "templateRequiredMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `templateRequired` property is editable." }, - "signingLocation": { - "description": "Specifies the physical location where the signing takes place. It can have two enumeration values; `inPerson` and `online`. The default value is `online`.", + "tooltip": { + "description": "The text of a tooltip that appears when a user hovers over a form field or tab.", "type": "string" }, - "status": { - "description": "Indicates the envelope status. Valid values are:\n\n* sent - The envelope is sent to the recipients. \n* created - The envelope is saved as a draft and can be modified and sent later.", - "type": "string" + "toolTipMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `toolTip` property is editable." }, - "statusChangedDateTime": { - "description": "The data and time the status changed.", + "underline": { + "description": "When set to **true**, the information in the tab is underlined.", "type": "string" }, - "statusDateTime": { - "description": "The DateTime that the envelope changed status (i.e. was created or sent.)", + "underlineMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `underline` property is editable." + }, + "value": { + "description": "Specifies the value of the tab. ", "type": "string" }, - "templateId": { - "description": "The unique identifier of the template. If this is not provided, DocuSign will generate a value. ", + "valueMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `value` property is editable." + }, + "width": { + "description": "The width of the tab in pixels.", "type": "string" }, - "templateRoles": { - "description": "Specifies the template recipients. Each roleName in the template must have a recipient assigned to it. This is made up by the following elements:\n\n* email - The recipient's email address.\n* name - The recipient's name.\n* roleName - The template roleName associated with the recipient.\n* clientUserId - Optional, this sets if the signer is This specifies if the recipient is embedded or remote. If the clientUserId is not null then the recipient is embedded. Note that if a ClientUserId is used and the account settings SignerMustHaveAccount or SignerMustLoginToSign are true, an error is generated on sending.\n* defaultRecipient - Optional, When set to **true**, this recipient is the default recipient and any tabs generated by the transformPdfFields option are mapped to this recipient.\n* routingOrder - This specifies the routing order of the recipient in the envelope.\n* accessCode - This optional element specifies the access code a recipient has to enter to validate the identity. This can be a maximum of 50 characters.\n* inPersonSignerName - Optional, if the template role is an in person signer, this is the full legal name of the signer. This can be a maximum of 100 characters.\n* emailNotification - This is an optional complex element that has a role-specific emailSubject, emailBody, and language. It follows the same format as the emailNotification node for Recipients.\n* tabs - This allows the tab values to be specified for matching to tabs in the template.\n", - "type": "array", - "items": { - "$ref": "#/definitions/templateRole" - } + "widthMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `width` property is editable." }, - "templatesUri": { - "description": "Contains a URI for an endpoint that you can use to retrieve the templates.", + "xPosition": { + "description": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n", "type": "string" }, - "transactionId": { - "description": " Used to identify an envelope. The id is a sender-generated value and is valid in the DocuSign system for 7 days. It is recommended that a transaction ID is used for offline signing to ensure that an envelope is not sent multiple times. The `transactionId` property can be used determine an envelope's status (i.e. was it created or not) in cases where the internet connection was lost before the envelope status was returned.", + "xPositionMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `xPosition` property is editable." + }, + "yPosition": { + "description": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n", "type": "string" }, - "useDisclosure": { - "description": "When set to **true**, the disclosure is shown to recipients in accordance with the account's Electronic Record and Signature Disclosure frequency setting. When set to **false**, the Electronic Record and Signature Disclosure is not shown to any envelope recipients. \n\nIf the `useDisclosure` property is not set, then the account's normal disclosure setting is used and the value of the `useDisclosure` property is not returned in responses when getting envelope information.", + "yPositionMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `yPosition` property is editable." + } + }, + "x-ds-definition-name": "fullName", + "description": "A tab that displays the recipient's full name.\n", + "x-ms-summary": "A tab that displays the recipient's full name.\n" + }, + "graphicsContext": { + "type": "object", + "properties": { + "fillColor": { + "description": "The fill color to use for the overlay. Colors are typically specified by their RGB hex values, but you can also use a [friendly CSS color name](https://developer.mozilla.org/en-US/docs/Web/CSS/color_value).", "type": "string" }, - "voidedDateTime": { - "description": "The date and time the envelope or template was voided.", + "lineColor": { + "description": "The line color to use for the overlay. Colors are typically specified by their RGB hex values, but you can also use a [friendly CSS color name](https://developer.mozilla.org/en-US/docs/Web/CSS/color_value).", "type": "string" }, - "voidedReason": { - "description": "The reason the envelope or template was voided.", + "lineWeight": { + "description": "The line weight or thickness to use for the overlay.", "type": "string" } }, - "x-ds-definition-name": "envelopeDefinition", - "description": "Envelope object definition.", - "x-ms-summary": "Envelope object definition." + "x-ds-definition-name": "graphicsContext", + "description": "", + "x-ms-summary": "" }, - "envelopeDocument": { + "group": { "type": "object", "properties": { - "addedRecipientIds": { - "description": "If recipients were added by converting form fields into tabs, their ids will appear here. Read only.", - "type": "array", - "items": { - "type": "string" - } + "errorDetails": { + "$ref": "#/definitions/errorDetails", + "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." }, - "attachmentTabId": { - "description": "If this document is an attachment to another document in the envelope, this is the id of the attachment tab it is associated with on the other document.", + "groupId": { + "description": "The DocuSign group ID for the group.", "type": "string" }, - "authoritativeCopy": { - "description": "Specifies whether all documents in this envelope are authoritative copies.\nA document can set its own `authoritativeCopy` property to override this value. For example you can set the `authoritativeCopy` on an envelope level to true but can turn it off for a specific document. ", + "groupName": { + "description": "The name of the group.", "type": "string" }, - "authoritativeCopyMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the `authoritativeCopy` property. Not applicable for template documents." - }, - "availableDocumentTypes": { - "description": "", - "type": "array", - "items": { - "$ref": "#/definitions/signatureType" - } - }, - "containsPdfFormFields": { - "description": "When **true**, the document has editable form fields that are made available through a PDF format.", + "groupType": { + "description": "The group type.", "type": "string" }, - "display": { - "description": "This string sets the display and behavior properties of\nthe document during signing. The possible values are:\n\n* `modal`
\n The document is shown as a supplement action strip\n and can be viewed, downloaded, or printed in a modal window.\n This is the recommended value for supplemental documents. \n\n* `download`
\n The document is shown as a supplement action strip\n and can be viewed, downloaded, or printed in a new browser window. \n\n* `inline`
\n The document is shown in the normal signing window.\n This value is not used with supplemental documents,\n but is the default value for all other documents.\n", + "permissionProfileId": { + "description": "The ID of the permission profile associated with the group. Possible values include:\n\n- `2301416` (for the `DocuSign Viewer` profile)\n- `2301415` (for the `DocuSign Sender` profile)\n- `2301414` (for the `Account Administrator` profile)", "type": "string" }, - "displayMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the `display` property. Not applicable for template documents." - }, - "documentFields": { - "description": "The custom fields on the document.", + "users": { + "description": "A list of the users in the group.", "type": "array", "items": { - "$ref": "#/definitions/nameValue" + "$ref": "#/definitions/userInfo" } }, - "documentGroup": { - "description": "The type of group the document belongs to (`certificate` or `content`).", - "type": "string" - }, - "documentId": { - "description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.", - "type": "string" - }, - "documentIdGuid": { - "description": "The Guid of the document.", - "type": "string" - }, - "errorDetails": { - "$ref": "#/definitions/errorDetails", - "description": "If an error occurs, this property describes the error." - }, - "includeInDownload": { - "description": "When set to **true**,\nthe document is included in the combined document download. \nThe default value is **true**.\n", - "type": "string" - }, - "includeInDownloadMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the `includeInDowload` property. Not applicable for template documents." - }, - "name": { - "description": "The name of the document.", + "usersCount": { + "description": "The total number of users in the group.", "type": "string" - }, - "nameMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the `name` property. Not applicable for template documents." - }, - "order": { - "description": "(Optional) The order in which to sort the results.\n\nValid values are: \n\n\n* `asc`: Ascending order.\n* `desc`: Descending order. ", + } + }, + "x-ds-definition-name": "group", + "description": "This object contains information about a group.", + "x-ms-summary": "This object contains information about a group." + }, + "groupInformation": { + "type": "object", + "properties": { + "endPosition": { + "description": "The last index position in the result set. ", "type": "string" }, - "pages": { - "description": "An array of page objects that contain information about the pages in a document.", + "groups": { + "description": "A collection group objects containing information about the groups.", "type": "array", "items": { - "$ref": "#/definitions/page" + "$ref": "#/definitions/group" } }, - "signerMustAcknowledge": { - "description": "Sets how the signer interacts with the supplemental document.\nThe possible values are: \n\n*\t`no_interaction`
\n No recipient action is required. \n\n*\t`view`
\n The recipient is required to view the document. \n\n*\t`accept`
\n The recipient is required to accept the document by selecting accept during signing, but is not required to view the document. \n\n*\t`view_accept`
\n The recipient is required to view and accept the document. \n\n", + "nextUri": { + "description": "The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. ", "type": "string" }, - "signerMustAcknowledgeMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the `signerMustAcknowledge` property. Not applicable for template documents." - }, - "templateLocked": { - "description": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ", + "previousUri": { + "description": "The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. ", "type": "string" }, - "templateRequired": { - "description": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.", + "resultSetSize": { + "description": "The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`.", "type": "string" }, - "type": { - "description": "Type of user:\n- `type_owner`\n- `type_participant`", + "startPosition": { + "description": "The starting index position of the current result set.", "type": "string" }, - "uri": { - "description": "URI containing the user ID.", + "totalSetSize": { + "description": "The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`.", "type": "string" } }, - "x-ds-definition-name": "envelopeDocument", + "x-ds-definition-name": "groupInformation", "description": "", "x-ms-summary": "" }, - "envelopeDocumentsResult": { + "idCheckConfiguration": { "type": "object", "properties": { - "envelopeDocuments": { - "description": "An array containing information about the documents that are included in the envelope.", + "authSteps": { + "description": "A list of ID check security steps, each specifying an authorization type.", "type": "array", "items": { - "$ref": "#/definitions/envelopeDocument" + "$ref": "#/definitions/idCheckSecurityStep" } }, - "envelopeId": { - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", + "isDefault": { + "description": "Boolean that specifies whether the signature is the default signature for the user.", + "type": "string" + }, + "name": { + "description": "The name of the signature.", "type": "string" } }, - "x-ds-definition-name": "envelopeDocumentsResult", - "description": "", - "x-ms-summary": "" + "x-ds-definition-name": "idCheckConfiguration", + "description": "A complex object specifying ID check configuration.", + "x-ms-summary": "A complex object specifying ID check configuration." }, - "envelopeEvent": { + "idCheckInformationInput": { + "description": "A complex element that contains input information related to a recipient ID check.", "type": "object", "properties": { - "envelopeEventStatusCode": { - "description": "An envelope status for which your webhook should be called. Values: Draft, Sent, Delivered, Completed, Declined, or Voided.", - "type": "string" + "addressInformationInput": { + "$ref": "#/definitions/addressInformationInput", + "description": "An object that specifies recipient address information and how it is displayed." }, - "includeDocuments": { - "description": "reserved", - "type": "string" + "dobInformationInput": { + "$ref": "#/definitions/dobInformationInput", + "description": "An object that specifies recipient date of birth information and how it is displayed." + }, + "ssn4InformationInput": { + "$ref": "#/definitions/ssn4InformationInput", + "description": "An object that specifies the last four digits of the recipient's Social Security Number (SSN)." + }, + "ssn9InformationInput": { + "$ref": "#/definitions/ssn9InformationInput", + "description": "An object that specifies the recipient's Social Security Number (SSN) information. Note that ssn9 information cannot be returned in a response." } }, - "x-ds-definition-name": "envelopeEvent", - "description": "For which envelope events should your webhook be called?", - "x-ms-summary": "For which envelope events should your webhook be called?" + "x-ds-definition-name": "idCheckInformationInput", + "x-ms-summary": "A complex element that contains input information related to a recipient ID check." }, - "envelopeFormData": { + "idCheckSecurityStep": { "type": "object", "properties": { - "emailSubject": { - "description": "The subject line of the email message that is sent to all recipients.\n\nFor information about adding merge field information to the email subject, see [Template Email Subject Merge Fields](https://developers.docusign.com/esign-rest-api/reference/Templates/Templates/create#template-email-subject-merge-fields).\n", - "type": "string" - }, - "envelopeId": { - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", - "type": "string" - }, - "formData": { - "description": "", - "type": "array", - "items": { - "$ref": "#/definitions/formDataItem" - } - }, - "recipientFormData": { - "description": "", - "type": "array", - "items": { - "$ref": "#/definitions/recipientFormData" - } - }, - "sentDateTime": { - "description": "The date and time the envelope was sent.", - "type": "string" - }, - "status": { - "description": "The status of the item.", + "authType": { + "description": "Type of authorization used for the security check.", "type": "string" } }, - "x-ds-definition-name": "envelopeFormData", + "x-ds-definition-name": "idCheckSecurityStep", "description": "", "x-ms-summary": "" }, - "envelopeId": { + "initialHere": { "type": "object", "properties": { + "anchorAllowWhiteSpaceInCharacters": { + "description": "", + "type": "string" + }, + "anchorAllowWhiteSpaceInCharactersMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "" + }, "anchorCaseSensitive": { - "description": "Reserved for DocuSign.\n", + "description": "This property controls how [anchor tabs][AnchorTabs] are placed. When **true**, the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false**.\n\nFor example, when set to **true**, if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When set to **false**, `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**.\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place", "type": "string" }, "anchorCaseSensitiveMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "description": "Metadata that indicates whether the `anchorCaseSensitive` property is editable." }, "anchorHorizontalAlignment": { - "description": "Reserved for DocuSign.\n\n", + "description": "This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are :\n\n- `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value.\n- `right`: Aligns the tab’s left side with the last character of the matching anchor word.\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place\n", "type": "string" }, "anchorHorizontalAlignmentMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "description": "Metadata that indicates whether the `anchorHorizontalAlignment` property is editable." }, "anchorIgnoreIfNotPresent": { "description": "When set to **true**, this tab is ignored if the `anchorString` is not found in the document.", @@ -31597,12 +42963,12 @@ "description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable." }, "anchorMatchWholeWord": { - "description": "Reserved for DocuSign.\n\n", + "description": "When set to **true**, the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false**.\n\nFor example, when set to **true**, if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When set to **false**, if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**.\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTab]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place\n", "type": "string" }, "anchorMatchWholeWordMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "description": "Metadata that indicates whether the `anchorMatchWholeWord` property is editable." }, "anchorString": { "description": "Specifies the string to find in the document and use as the basis for tab placement.", @@ -31621,7 +42987,7 @@ "description": "Reserved for DocuSign." }, "anchorUnits": { - "description": "Specifies the units of the X and Y offset. Units may be pixels, millimeters, centimeters, or inches.", + "description": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n", "type": "string" }, "anchorUnitsMetadata": { @@ -31629,7 +42995,7 @@ "description": "Metadata that indicates whether the `anchorUnits` property is editable." }, "anchorXOffset": { - "description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.", + "description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n", "type": "string" }, "anchorXOffsetMetadata": { @@ -31637,21 +43003,13 @@ "description": "Metadata that indicates whether the `anchorXOffset` property is editable." }, "anchorYOffset": { - "description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.", + "description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n", "type": "string" }, "anchorYOffsetMetadata": { "$ref": "#/definitions/propertyMetadata", "description": "Metadata that indicates whether the `anchorYOffset` property is editable." }, - "bold": { - "description": "When set to **true**, the information in the tab is bold.", - "type": "string" - }, - "boldMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `bold` property is editable." - }, "conditionalParentLabel": { "description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility.", "type": "string" @@ -31669,7 +43027,7 @@ "description": "Metadata that indicates whether the `conditionalParentValue` property is editable." }, "customTabId": { - "description": "The DocuSign-generated custom tab id for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.", + "description": "The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.", "type": "string" }, "customTabIdMetadata": { @@ -31677,7 +43035,7 @@ "description": "Metadata that indicates whether the `customTabId` property is editable." }, "documentId": { - "description": "Integer that identifies the document in the envelope.", + "description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.", "type": "string" }, "documentIdMetadata": { @@ -31688,30 +43046,6 @@ "$ref": "#/definitions/errorDetails", "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." }, - "font": { - "description": "The font to be used for the tab value. Supported fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n", - "type": "string" - }, - "fontColor": { - "description": "The font color to use for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n", - "type": "string" - }, - "fontColorMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `fontColor` property is editable." - }, - "fontMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `font` property is editable." - }, - "fontSize": { - "description": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72", - "type": "string" - }, - "fontSizeMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `fontSize` property is editable." - }, "formOrder": { "description": "An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block.", "type": "string" @@ -31744,32 +43078,32 @@ "$ref": "#/definitions/propertyMetadata", "description": "Metadata that indicates whether the `height` property is editable." }, - "italic": { - "description": "When set to **true**, the information in the tab is italic.", - "type": "string" - }, - "italicMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `italic` property is editable." - }, - "localePolicy": { - "$ref": "#/definitions/localePolicyTab", - "description": "Reserved for DocuSign." - }, "mergeField": { "$ref": "#/definitions/mergeField", "description": "Contains the information necessary to map the tab to a field in SalesForce." }, + "mergeFieldXml": { + "description": "", + "type": "string" + }, "name": { "description": "The name of the tab. For example, `Sign Here` or `Initial Here`.", "type": "string" }, "nameMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `name` property is editable." + "description": "Metadata that indicates whether the `name` property is editable. Read only." + }, + "optional": { + "description": "When set to **true**, the recipient does not need to complete this tab to complete the signing process.", + "type": "string" + }, + "optionalMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `optional` property is editable." }, "pageNumber": { - "description": "The page number on which the tab is located.\nFor supplemental documents, this value must be `1`.", + "description": "The page number on which the tab is located. For supplemental documents, this value must be `1`.", "type": "string" }, "pageNumberMetadata": { @@ -31777,11 +43111,11 @@ "description": "Metadata that indicates whether the `pageNumber` property is editable." }, "recipientId": { - "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", + "description": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.", "type": "string" }, "recipientIdGuid": { - "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one.", + "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only.", "type": "string" }, "recipientIdGuidMetadata": { @@ -31792,6 +43126,18 @@ "$ref": "#/definitions/propertyMetadata", "description": "Metadata that indicates whether the `recipientId` property is editable." }, + "scaleValue": { + "description": " Sets the size for the InitialHere tab. It can be value from 0.5 to 1.0, where 1.0 represents full size and 0.5 is 50% size.", + "type": "string" + }, + "scaleValueMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `scaleValue` property is editable." + }, + "smartContractInformation": { + "$ref": "#/definitions/smartContractInformation", + "description": "" + }, "status": { "description": "The status of the tab. Possible values are:\n\n- `active`: The tab is active, but the recipient has not yet interacted with it.\n- `signed`: The recipient signed the tab.\n- `declined`: The recipient declined the envelope.\n- `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`).", "type": "string" @@ -31820,7 +43166,7 @@ "description": "Metadata that indicates whether the `tabId` property is editable." }, "tabLabel": { - "description": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n", + "description": "The label associated with the tab. This value may be an empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum Length: 500 characters.\n", "type": "string" }, "tabLabelMetadata": { @@ -31867,14 +43213,6 @@ "$ref": "#/definitions/propertyMetadata", "description": "Metadata that indicates whether the `toolTip` property is editable." }, - "underline": { - "description": "When set to **true**, the information in the tab is underlined.", - "type": "string" - }, - "underlineMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `underline` property is editable." - }, "width": { "description": "The width of the tab in pixels.", "type": "string" @@ -31884,7 +43222,7 @@ "description": "Metadata that indicates whether the `width` property is editable." }, "xPosition": { - "description": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n", + "description": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (+2, -7)\n", "type": "string" }, "xPositionMetadata": { @@ -31892,7 +43230,7 @@ "description": "Metadata that indicates whether the `xPosition` property is editable." }, "yPosition": { - "description": "This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.", + "description": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (+2, -7)\n", "type": "string" }, "yPositionMetadata": { @@ -31900,619 +43238,447 @@ "description": "Metadata that indicates whether the `yPosition` property is editable." } }, - "x-ds-definition-name": "envelopeId", - "description": "A tab that displays the envelope ID. Recipients cannot enter\nor change the information in this tab.\n", - "x-ms-summary": "A tab that displays the envelope ID. Recipients cannot enter\nor change the information in this tab.\n" - }, - "envelopeIdsRequest": { - "type": "object", - "properties": { - "envelopeIds": { - "description": "A comma-separated list of envelope IDs to include in the results.", - "type": "array", - "items": { - "type": "string" - } - }, - "transactionIds": { - "description": "A comma-separated list of transaction IDs to include in the results. Note that transaction IDs are valid for seven days.", - "type": "array", - "items": { - "type": "string" - } - } - }, - "x-ds-definition-name": "envelopeIdsRequest", - "description": "Lists of envelope and transaction IDs to use in the results.", - "x-ms-summary": "Lists of envelope and transaction IDs to use in the results." - }, - "envelopeMetadata": { - "type": "object", - "properties": { - "allowAdvancedCorrect": { - "description": "Specifies if the Advanced Correct feature is enabled for the envelope. This feature enables you to correct the details of in process envelopes that you sent or are shared with you. It offers more functionality than the Correct feature.", - "type": "string" - }, - "allowCorrect": { - "description": "Specifies if the Correct feature is enabled for the envelope. This feature enables you to correct the details of in process envelopes that you sent or are shared with you, including the recipient, envelope, and document information.", - "type": "string" - }, - "enableSignWithNotary": { - "description": "Specifies if DocuSign eNotary service is enabled for the envelope.", - "type": "string" - } - }, - "x-ds-definition-name": "envelopeMetadata", - "description": "", - "x-ms-summary": "" - }, - "envelopeNotificationRequest": { - "type": "object", - "properties": { - "expirations": { - "$ref": "#/definitions/expirations", - "description": "A complex element that specifies the expiration settings for the envelope." - }, - "reminders": { - "$ref": "#/definitions/reminders", - "description": "A complex element that specifies reminder settings for the envelope" - }, - "useAccountDefaults": { - "description": "When set to **true**, the account default notification settings are used for the envelope, overriding the reminders and expirations settings. When set to **false**, the reminders and expirations settings specified in this request are used.", - "type": "string" - } - }, - "x-ds-definition-name": "envelopeNotificationRequest", - "description": "A complex element that specifies the notification settings for the envelope.", - "x-ms-summary": "A complex element that specifies the notification settings for the envelope." - }, - "envelopePurgeConfiguration": { - "type": "object", - "properties": { - "purgeEnvelopes": { - "description": "", - "type": "string" - }, - "redactPII": { - "description": "", - "type": "string" - }, - "removeTabsAndEnvelopeAttachments": { - "description": "", - "type": "string" - }, - "retentionDays": { - "description": "", - "type": "string" - } - }, - "x-ds-definition-name": "envelopePurgeConfiguration", - "description": "", - "x-ms-summary": "" + "x-ds-definition-name": "initialHere", + "description": "A tab that allows the recipient to initial the document. May\nbe optional.\n", + "x-ms-summary": "A tab that allows the recipient to initial the document. May\nbe optional.\n" }, - "envelopesInformation": { + "inlineTemplate": { "type": "object", "properties": { - "continuationToken": { - "description": "A token returned by an earlier API call that you can use with a new call to resume a search query at the point where it left off. This token system enhances the performance of the API.", - "type": "string" - }, - "endPosition": { - "description": "The last position in the result set. ", - "type": "string" - }, - "envelopes": { - "description": "Set of envelope information", - "type": "array", - "items": { - "$ref": "#/definitions/Envelopes" - } - }, - "envelopeTransactionStatuses": { - "description": "Array of envelope statuses and transaction IDs in the result set.", - "type": "array", - "items": { - "$ref": "#/definitions/envelopeTransactionStatus" - } + "customFields": { + "$ref": "#/definitions/AccountCustomFields", + "description": "An optional array of strings that enables the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each `customField` string can be a maximum of 100 characters." }, - "folders": { - "description": "A collection of folder objects returned in a response.", + "documents": { + "description": "A complex element that contains details about the documents associated with the envelope.", "type": "array", "items": { - "$ref": "#/definitions/folder" + "$ref": "#/definitions/document" } }, - "lastQueriedDateTime": { - "description": "The last time that a query was performed.", - "type": "string" - }, - "nextUri": { - "description": "The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. ", - "type": "string" - }, - "previousUri": { - "description": "The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. ", - "type": "string" - }, - "resultSetSize": { - "description": "The number of results returned in this response. Because you can filter which entries are included in the response, this value is always less than or equal to `totalSetSize`.", - "type": "string" - }, - "startPosition": { - "description": "The starting position of the current result set.", - "type": "string" - }, - "totalSetSize": { - "description": "The total number of items in the search's result set. This value is always greater than or equal to the value of `resultSetSize`.", - "type": "string" - } - }, - "x-ds-definition-name": "envelopesInformation", - "description": "Result set for the Envelopes: listStatusChanges method", - "x-ms-summary": "Result set for the Envelopes: listStatusChanges method" - }, - "envelopeSummary": { - "type": "object", - "properties": { - "bulkEnvelopeStatus": { - "$ref": "#/definitions/bulkEnvelopeStatus", - "description": "" - }, - "envelopeId": { - "description": "The envelope ID of the envelope status that failed to post.", - "type": "string" - }, - "errorDetails": { - "$ref": "#/definitions/errorDetails", - "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." - }, - "status": { - "description": "Indicates the envelope status. Valid values are: \n\n* completed - The envelope has been completed and all tags have been signed.\n* created - The envelope is created as a draft. It can be modified and sent later.\n* declined - The envelope has been declined by the recipients.\n* delivered - The envelope has been delivered to the recipients.\n* sent - The envelope is sent to the recipients.\n* signed - The envelope has been signed by the recipients.\n* voided - The envelope is no longer valid and recipients cannot access or sign the envelope.\n", - "type": "string" + "envelope": { + "$ref": "#/definitions/envelope", + "description": "A container used to send documents to recipients. The envelope carries information about the sender and timestamps to indicate the progress of the delivery procedure. It can contain collections of Documents, Tabs and Recipients." }, - "statusDateTime": { - "description": "The DateTime that the envelope changed status (i.e. was created or sent.)", - "type": "string" + "recipients": { + "$ref": "#/definitions/EnvelopeRecipients", + "description": "An array of recipient objects that provides details about the recipients of the envelope." }, - "uri": { - "description": "URI containing the user ID.", + "sequence": { + "description": "Specifies the order in which templates are overlaid.", "type": "string" } }, - "x-ds-definition-name": "envelopeSummary", + "x-ds-definition-name": "inlineTemplate", "description": "", "x-ms-summary": "" }, - "envelopeTemplate": { + "inPersonSigner": { "type": "object", "properties": { - "accessControlListBase64": { - "description": "Reserved for DocuSign.", - "type": "string" - }, - "allowComments": { - "description": "When set to **true**, users can add comments to the documents in the envelope. For example, if a signer has a question about the text in the document, they can add a comment to the document.", + "accessCode": { + "description": "If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. \n\nMaximum Length: 50 characters and it must conform to the account's access code format setting.\n\nIf blank, but the signer `accessCode` property is set in the envelope, then that value is used.\n\nIf blank and the signer `accessCode` property is not set, then the access code is not required.", "type": "string" }, - "allowMarkup": { - "description": "When **true**, Document Markup is enabled for envelope. The account must have Document Markup enabled to use this.", - "type": "string" + "accessCodeMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `accessCode` property is editable. Read only." }, - "allowReassign": { - "description": "When **true**, the recipient can redirect an envelope to a more appropriate recipient.", + "addAccessCodeToEmail": { + "description": "Optional. When set to **true**, the access code will be added to the email sent to the recipient. This nullifies the security measure of `accessCode` on the recipient.", "type": "string" }, - "allowViewHistory": { - "description": "When set to **true**, recipients can view the history of the envelope.", + "allowSystemOverrideForLockedRecipient": { + "description": "", "type": "string" }, - "anySigner": { - "description": "Deprecated. This feature has been replaced by signing groups.", + "autoNavigation": { + "description": "When set to **true**, autonavigation is set for the recipient.\n", "type": "string" }, - "asynchronous": { - "description": "When **true**, the envelope is queued for processing and the value of the `status` property is set to 'Processing'. Additionally, get status calls return 'Processing' until completed. \n\n\n**Note**: A `transactionId` is required for this call to work correctly. When the envelope is created, the status is 'Processing' and an `envelopeId` is not returned in the response. To get the `envelopeId`, use a GET envelope query using the [transactionId](https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/create/#envelopeDefinition) or by checking the Connect notification.", + "canSignOffline": { + "description": "When set to **true**, specifies that the signer can perform the signing ceremony offline.", "type": "string" }, - "attachmentsUri": { - "description": "Contains a URL for retrieving the attachments that are associated with the envelope.", + "clientUserId": { + "description": "Specifies whether the recipient is embedded or remote. \n\nIf the `clientUserId` property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing.\n\nNote: if the `clientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true**, an error is generated on sending. \n\nMaximum length: 100 characters. ", "type": "string" }, - "authoritativeCopy": { - "description": "Specifies whether all documents in this envelope are authoritative copies.\nA document can set its own `authoritativeCopy` property to override this value. For example you can set the `authoritativeCopy` on an envelope level to true but can turn it off for a specific document. ", + "completedCount": { + "description": "Indicates the number of times that the recipient has been through a signing completion. \n\nIf this number is greater than `0` for a signing group, only the user who previously completed may sign again.", "type": "string" }, - "authoritativeCopyDefault": { - "description": "The default `authoritativeCopy` setting for documents in this envelope that do not have `authoritativeCopy` set.\nIf this property is not set, each document defaults to the envelope's `authoritativeCopy`.", + "creationReason": { + "description": "The reason why the recipient was created (for example, `sender`). Read only.", "type": "string" }, - "autoMatch": { - "description": "By default, templates that have been used within\nthe last 60 days are included in auto-matching.\n\nBy explicitly setting `autoMatch`,\nyou can permanently include or exclude the template\nin auto matching.\n\nWhen **true** the template is included in auto-matching\nregardless of when it was last used.\n\nWhen **false** the template is never included in auto-matching.", - "type": "string" + "customFields": { + "description": "An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters.", + "type": "array", + "items": { + "type": "string" + } }, - "autoMatchSpecifiedByUser": { - "description": "If **true**, the template has been explicitly included in or excluded from auto-matching. The default is false.\nThis is a read-only property.", + "declinedDateTime": { + "description": "The date and time the recipient declined the document. Read only.", "type": "string" }, - "autoNavigation": { - "description": "When **true**, auto navigation is set for the recipient.\n", + "declinedReason": { + "description": "The reason the recipient declined the document. Read only.", "type": "string" }, - "brandId": { - "description": "The id of the brand.", + "defaultRecipient": { + "description": "When set to **true**,\nthis is the default recipient for the envelope.\nThis option is used when creating an envelope from a template.\n", "type": "string" }, - "brandLock": { - "description": "Indicates if the brandId for the envelope is locked.", + "deliveredDateTime": { + "description": "The date and time that the envelope was delivered to the recipient. Read only.", "type": "string" }, - "certificateUri": { - "description": "Contains a URI that you can use to retrieve certificate information.", + "deliveryMethod": { + "description": "Reserved for DocuSign.", "type": "string" }, - "completedDateTime": { - "description": "Specifies the date and time this item was completed.", - "type": "string" + "deliveryMethodMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Reserved for DocuSign." }, - "created": { - "description": "The UTC DateTime when the workspace user authorization was created.", + "designatorId": { + "description": "", "type": "string" }, - "createdDateTime": { - "description": "The date and time the item was created.", + "designatorIdGuid": { + "description": "", "type": "string" }, - "customFields": { - "$ref": "#/definitions/AccountCustomFields", - "description": "An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters." - }, - "customFieldsUri": { - "description": "Contains a URI for an endpoint to retrieve the custom fields.", - "type": "string" + "documentVisibility": { + "description": "A list of `documentVisibility` objects. Each object in the list specifies whether a document in the envelope is visible to this recipient. For the envelope to use this functionality, Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true**.", + "type": "array", + "items": { + "$ref": "#/definitions/documentVisibility" + } }, - "declinedDateTime": { - "description": "The date and time the recipient declined the document.", + "email": { + "description": "The signer's email address in an eNotary flow.\n\nUse only when `inPersonSigningType` is `notary`.\nFor regular in-person-signer flow, use `signerEmail` instead.\n", "type": "string" }, - "deletedDateTime": { - "description": "Specifies the data and time the item was deleted.", - "type": "string" + "emailMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `email` property is editable. Read only." }, - "deliveredDateTime": { - "description": "The date and time that the envelope was delivered to the recipient.", - "type": "string" + "emailNotification": { + "$ref": "#/definitions/recipientEmailNotification", + "description": "An optional complex type that sets a specific email subject and body for this recipient's notification email. \n\n**Note**: You can set the `emailNotification` property separately for each recipient. If you set the value only for certain recipients, the other recipients will inherit the this value from the top-level `emailSubject` and `emailBlurb`. " }, - "description": { - "description": "A sender-defined description of the line item.\n", + "embeddedRecipientStartURL": { + "description": "Specifies a sender-provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. \n\nIf set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation launched by a partner.\n\nIt is important to understand that in a typical embedded workflow, the authentication of an embedded recipient is the responsibility of the sending application. DocuSign expects that senders will follow their own processes for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process is initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process, bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient.\n\nIf the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: `envelopeId`, `recipientId`, `recipientName`, `recipientEmail`, and `customFields`. The `customFields` property must be set for the recipient or envelope. The merge fields are enclosed in double brackets. \n\n*Example*: \n\n`http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` ", "type": "string" }, - "disableResponsiveDocument": { - "description": "When set to **true**, responsive documents are disabled for the envelope.", - "type": "string" + "errorDetails": { + "$ref": "#/definitions/errorDetails", + "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." }, - "documents": { - "description": "Complex element contains the details on the documents in the envelope.", + "excludedDocuments": { + "description": "Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true** for the envelope to use this.\n\nWhen enforce signer visibility is enabled, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent.", "type": "array", "items": { - "$ref": "#/definitions/document" + "type": "string" } }, - "documentsCombinedUri": { - "description": "Contains a URL that you can use to retrieve all of the documents associated with the envelope combined into a single PDF file.", + "faxNumber": { + "description": "Reserved for DocuSign.", "type": "string" }, - "documentsUri": { - "description": "Contains a URI for an endpoint that you can use to retrieve the documents.", - "type": "string" + "faxNumberMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Reserved for DocuSign." }, - "emailBlurb": { - "description": "This is the same as the email body. If the sender enters an email blurb, it is included in the email body for all envelope recipients.", + "hostEmail": { + "description": "The email address of the signing host.\nThis is the DocuSign user that is hosting the in-person signing session.\n\nRequired when `inPersonSigningType` is `inPersonSigner`.\nFor eNotary flow, use `email` instead.\n\nMaximum Length: 100 characters.\n", "type": "string" }, - "emailSettings": { - "$ref": "#/definitions/EnvelopeEmailSettings", - "description": "A complex type that contains email settings." + "hostEmailMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `hostEmail` property is editable." }, - "emailSubject": { - "description": "The subject line of the email message that is sent to all recipients.\n\nFor information about adding merge field information to the email subject, see [Template Email Subject Merge Fields](https://developers.docusign.com/esign-rest-api/reference/Templates/Templates/create#template-email-subject-merge-fields).\n", + "hostName": { + "description": "The name of the signing host.\nThis is the DocuSign user that is hosting the in-person signing session.\n\nRequired when `inPersonSigningType` is `inPersonSigner`.\nFor eNotary flow, use `name` instead.\n\nMaximum Length: 100 characters.\n", "type": "string" }, - "enableWetSign": { - "description": "When set to **true**, the signer is allowed to print the document and sign it on paper.", - "type": "string" + "hostNameMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `hostName` property is editable." }, - "enforceSignerVisibility": { - "description": "When set to **true**, signers can only view the documents on which they have tabs. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all of the documents in an envelope, unless they are specifically excluded by using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded by using this setting when an envelope is sent.\n\n**Note**: To use this functionality, [Document Visibility][docviz] must be enabled for the account by making the account setting `allowDocumentVisibility` **true**.\n\n[docviz]: /esign/restapi/Envelopes/EnvelopeDocumentVisibility", + "idCheckConfigurationName": { + "description": "The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are:\n\n- `Phone Auth $`: The recipient must authenticate by using two-factor authentication (2FA). You provide the phone number to use for 2FA in the `phoneAuthentication` object.\n- `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object.\n- `ID Check $`: The recipient must answer detailed security questions. \n\n**Example**: Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node.", "type": "string" }, - "envelopeAttachments": { - "description": "An array of attachment objects that provide information about the attachments that are associated with the envelope.", - "type": "array", - "items": { - "$ref": "#/definitions/attachment" - } + "idCheckConfigurationNameMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `idCheckConfigurationName` property is editable. Read only." }, - "envelopeDocuments": { - "description": "An array containing information about the documents that are included in the envelope.", - "type": "array", - "items": { - "$ref": "#/definitions/envelopeDocument" - } + "idCheckInformationInput": { + "$ref": "#/definitions/idCheckInformationInput", + "description": "An object that contains input information related to a recipient ID check." }, - "envelopeId": { - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", - "type": "string" + "identityVerification": { + "$ref": "#/definitions/recipientIdentityVerification", + "description": "Specifies the ID Verification workflow applied on an envelope by workflow ID.
See the [list](https://developers.docusign.com/docs/esign-rest-api/reference/Accounts/IdentityVerifications/list) method in the [IdentityVerifications](https://developers.docusign.com/docs/esign-rest-api/reference/Accounts/IdentityVerifications) resource for more information on how to retrieve workflow IDs available for an account.
This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods.
Note that ID Verification and ID Check are two distinct methods. ID Verification checks recipients' identity by verifying their ID while ID Check relies on data available on public records (such as current and former address)." }, - "envelopeIdStamping": { - "description": "When set to **true**, [Envelope ID Stamping](https://support.docusign.com/en/guides/ndse-user-guide-set-advanced-document-options) is enabled.\nOnce a document or attachment is stamped with an Envelope ID,\nthe ID is seen by all recipients\nand becomes a permanent part of the document\nand cannot be removed.", + "inheritEmailNotificationConfiguration": { + "description": "When set to **true** and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account. ", "type": "string" }, - "envelopeLocation": { - "description": "Reserved for DocuSign.", + "inPersonSigningType": { + "description": "Specifies whether the envelope uses the eNotary feature.\nValid values:\n\n* `inPersonSigner`: The envelope uses the normal in-person signing flow.\n* `notary`: The envelope uses the eNotary in-person signing flow.\n", "type": "string" }, - "envelopeMetadata": { - "$ref": "#/definitions/envelopeMetadata", - "description": "Provides information about the features and services that are enabled for the envelope, including the Correct feature, the Advanced Correct feature, and DocuSign eNotary service." + "inPersonSigningTypeMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `inPersonSigningType` property is editable." }, - "envelopeUri": { - "description": "URI that you can use to retrieve the bulk envelopes.", + "lockedRecipientPhoneAuthEditable": { + "description": "Reserved for DocuSign.", "type": "string" }, - "expireAfter": { - "description": "An integer specifying the number of days that a sent envelope remains active before it expires. A negative number in a response indicates that the envelope has already expired.", + "lockedRecipientSmsEditable": { + "description": "Reserved for DocuSign.", "type": "string" }, - "expireDateTime": { - "description": "The date and time the envelope is set to expire.", + "name": { + "description": "The signer's full legal name in an eNotary flow.\n\nRequired when `inPersonSigningType` is `notary`.\nFor a regular in-person-signer flow, use `signerName` instead.\n\nMaximum Length: 100 characters.\n", "type": "string" }, - "expireEnabled": { - "description": "When set to **true**, the envelope expires (is no longer available for signing) after the specified number of days after it is sent (`sentDateTime`). Set `expireAfter` to set the number of days until an envelope expires. When **false**, the account default setting is used. If the account does not have an expiration setting, the DocuSign default value of 120 days is used.", - "type": "string" + "nameMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `name` property is editable. Read only." }, - "externalEnvelopeId": { - "description": "May contain an external identifier for the envelope.", + "notaryHost": { + "$ref": "#/definitions/notaryHost", + "description": "Information about the notary host. The following information is required when using the eNotary in-person signing flow:\n\n- `name`: The name of the notary.\n- `email`: The email address of the notary.\n- `recipientId`: A unique ID number for the notary signing host." + }, + "notaryId": { + "description": "", "type": "string" }, - "folderId": { - "description": "Unique identifier for the folder.", + "note": { + "description": "A note sent to the in-person signer in the signing email.\nThis note is visible only to this recipient.\n\nMaximum Length: 1000 characters.\n", "type": "string" }, - "folderIds": { - "description": "", + "noteMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `note` property is editable. Read only." + }, + "phoneAuthentication": { + "$ref": "#/definitions/recipientPhoneAuthentication", + "description": "When `idCheckConfigurationName` is set to `Phone Auth $`, you use this complex type to provide the recipient authentication method details. It contains the following elements:\n\n* `recipMayProvideNumber`: Boolean. When set to **true**, the recipient can use whatever phone number they choose.\n* `senderProvidedNumbers`: ArrayOfStrings. A list of phone numbers the recipient can use.\n* `recordVoicePrint`: Reserved for DocuSign.\n* `validateRecipProvidedNumber`: Reserved for DocuSign.\n\n" + }, + "recipientAttachments": { + "description": "Reserved for DocuSign.", "type": "array", "items": { - "type": "string" + "$ref": "#/definitions/recipientAttachment" } }, - "folderName": { - "description": "", - "type": "string" + "recipientAuthenticationStatus": { + "$ref": "#/definitions/authenticationStatus", + "description": "Information about the recipient's authentication status. Read only." }, - "folders": { - "description": "A collection of folder objects returned in a response.", + "recipientFeatureMetadata": { + "description": "Metadata about the features that are supported for the recipient type. Read only.", "type": "array", "items": { - "$ref": "#/definitions/folder" + "$ref": "#/definitions/featureAvailableMetadata" } }, - "hasComments": { - "description": "When set to **true**, indicates that users have added comments to the envelope.", + "recipientId": { + "description": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the document.", "type": "string" }, - "hasFormDataChanged": { - "description": "When set to **true**, indicates that the data collected through form fields on a document has changed.", + "recipientIdGuid": { + "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only.", "type": "string" }, - "hasWavFile": { - "description": "When set to **true**, indicates that a .wav file used for voice authentication is included in the envelope. ", - "type": "string" + "recipientSignatureProviders": { + "description": "The default signature provider is the DocuSign Electronic signature system. This parameter is used to specify one or more Standards Based Signature (digital signature) providers for the signer to use. [More information.](https://developers.docusign.com/esign-rest-api/guides/standards-based-signatures)", + "type": "array", + "items": { + "$ref": "#/definitions/recipientSignatureProvider" + } }, - "holder": { - "description": "Reserved for DocuSign.", + "recipientSuppliesTabs": { + "description": "When set to **true**, specifies that the recipient creates the tabs.", "type": "string" }, - "initialSentDateTime": { - "description": "The date and time the envelope was initially sent.", + "recipientType": { + "description": "The recipient type, as specified by the following values:\n- `agent`: Agent recipients can add name and email information for recipients that appear after the agent in routing order.\n- `carbonCopy`: Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date, or add information to any of the documents. This type of recipient can be used in any routing order.\n- `certifiedDelivery`: Certified delivery recipients must receive the completed documents for the envelope to be completed. They don't need to sign, initial, date, or add information to any of the documents.\n- `editor`: Editors have the same management and access rights for the envelope as the sender. Editors can add name and email information, add or change the routing order, set authentication options, and can edit signature/initial tabs and data fields for the remaining recipients.\n- `inPersonSigner`: In-person recipients are DocuSign users who act as signing hosts in the same physical location as the signer.\n- `intermediaries`: Intermediary recipients can optionally add name and email information for recipients at the same or subsequent level in the routing order.\n- `seal`: Electronic seal recipients represent legal entities.\n- `signer`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope.\n- `witness`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope.", "type": "string" }, - "is21CFRPart11": { - "description": "When **true**, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).", - "type": "string" + "recipientTypeMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `recipientType` property is editable. Read only." }, - "isDynamicEnvelope": { - "description": "When set to **true**, indicates that the envelope is a dynamic envelope.", + "requireIdLookup": { + "description": "When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. ", "type": "string" }, - "isSignatureProviderEnvelope": { - "description": "When set to **true**, indicates that the envelope is a signature-provided envelope.", - "type": "string" + "requireIdLookupMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `requireIdLookup` property is editable. Read only." }, - "lastModified": { - "description": "Utc date and time the comment was last updated (can only be done by creator.)", + "requireSignerCertificate": { + "description": "By default, DocuSign signers create electronic signatures. This field can be used to require the signer to use a SAFE-BioPharma digital certificate for signing.\n\nThis parameter should only be used to select a SAFE-BioPharma certificate. New integrations should use the `recipientSignatureProviders` parameter for other types of digital certificates. \n\nSet this parameter to `safe` to use a SAFE-BioPharma certificate.\n\nThe signer must be enrolled in the SAFE program to sign with a SAFE certificate.", "type": "string" }, - "lastModifiedBy": { - "$ref": "#/definitions/userInfo", - "description": "" - }, - "lastModifiedDateTime": { - "description": "The date and time the item was last modified.", + "requireSignOnPaper": { + "description": "When set to **true**, the signer must print, sign, and upload or fax the signed documents to DocuSign.", "type": "string" }, - "lastUsed": { - "description": "", + "requireUploadSignature": { + "description": "When set to **true**, the signer is required to upload a new signature, even if they have a pre-adopted signature in their personal DocuSign account.", "type": "string" }, - "location": { - "description": "Reserved for DocuSign.", + "roleName": { + "description": "Optional element. Specifies the role name associated with the recipient.

This property is required when you are working with template recipients.", "type": "string" }, - "lockInformation": { - "$ref": "#/definitions/EnvelopeLocks", - "description": "Provides lock information about an envelope that a user has locked." - }, - "messageLock": { - "description": "When set to **true**, prevents senders from changing the contents of `emailBlurb` and `emailSubject` properties for the envelope. \n\nAdditionally, this prevents users from making changes to the contents of `emailBlurb` and `emailSubject` properties when correcting envelopes. \n\nHowever, if the `messageLock` node is set to **true** and the `emailSubject` property is empty, senders and correctors are able to add a subject to the envelope.", + "routingOrder": { + "description": "Specifies the routing order of the recipient in the envelope. ", "type": "string" }, - "name": { - "description": "", - "type": "string" + "routingOrderMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `routingOrder` property is editable. Read only." }, - "newPassword": { - "description": "The user's new password.", + "sentDateTime": { + "description": "The UTC DateTime when the envelope was sent. Read only.", "type": "string" }, - "notification": { - "$ref": "#/definitions/notification", - "description": "" + "signatureInfo": { + "$ref": "#/definitions/recipientSignatureInformation", + "description": "Allows the sender to pre-specify the signature name, signature initials and signature font used in the signature stamp for the recipient.\n\nUsed only with recipient types In Person Signers and Signers." }, - "notificationUri": { - "description": "Contains a URI for an endpoint that you can use to retrieve the notifications.", + "signedDateTime": { + "description": "Reserved for DocuSign.", "type": "string" }, - "owner": { - "$ref": "#/definitions/userInfo", - "description": "" - }, - "pageCount": { - "description": "An integer value specifying the number of document pages in the template. ", + "signerEmail": { + "description": "The in-person signer's email address.\n\nRequired when `inPersonSigningType` is `inPersonSigner`.\nFor eNotary flow, use `email` instead.\n\nMaximum Length: 100 characters.\n\n", "type": "string" }, - "password": { - "description": "The user's encrypted password hash.", - "type": "string" + "signerEmailMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates if the sender can edit the in-person signer's email address." }, - "passwordProtected": { - "description": "", + "signerFirstName": { + "description": "The signer's first name.", "type": "string" }, - "powerForm": { - "$ref": "#/definitions/PowerForms", - "description": "Contains information about any PowerForms that are included in the envelope." - }, - "powerForms": { - "description": "An array of PowerForm objects.", - "type": "array", - "items": { - "$ref": "#/definitions/PowerForms" - } + "signerFirstNameMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates if the `signerFirstName` property is editable." }, - "purgeCompletedDate": { - "description": "The date that a purge was completed.", + "signerLastName": { + "description": "The signer's last name.", "type": "string" }, - "purgeRequestDate": { - "description": "The date that a purge was requested.", - "type": "string" + "signerLastNameMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `signerLastName` property is editable." }, - "purgeState": { - "description": "Shows the current purge state for the envelope. The possible values are:\n\n* `unpurged`: There has been no successful request to purge documents.\n* `documents_queued`: The envelope documents have been added to the purge queue, but have not been purged.\n* `documents_dequeued`: The envelope documents have been taken out of the purge queue.\n* `documents_and_metadata_queued`: The envelope documents and metadata have been added to the purge queue, but have not yet been purged.\n* `documents_purged`: The envelope documents have been successfully purged.\n* `documents_and_metadata_purged`: The envelope documents and metadata have been successfully purged.\n\n", + "signerName": { + "description": "Required. The full legal name of a signer for the envelope. \n\nMaximum Length: 100 characters.\n\n\n", "type": "string" }, - "recipients": { - "$ref": "#/definitions/EnvelopeRecipients", - "description": "An array of recipient objects that provides details about the recipients of the envelope." - }, - "recipientsLock": { - "description": "When set to **true**, prevents senders from changing, correcting, or deleting the recipient information for the envelope.", - "type": "string" + "signerNameMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `signerName` property is editable." }, - "recipientsUri": { - "description": "Contains a URI for an endpoint that you can use to retrieve the recipients.", + "signInEachLocation": { + "description": "When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab (instead of adopting a signature/initial style or only drawing a signature/initial once).", "type": "string" }, - "sender": { - "$ref": "#/definitions/userInfo", - "description": "Information about the sender of the envelope." - }, - "sentDateTime": { - "description": "The date and time the envelope was sent.", - "type": "string" + "signInEachLocationMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `signInEachLocation` property is editable. Read only." }, - "shared": { - "description": "When **true**, the tab is shared.", + "signingGroupId": { + "description": "Not applicable. You cannot use a signing group for an in-person signer.", "type": "string" }, - "sharedWithMe": { - "description": "", - "type": "string" + "signingGroupIdMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Not applicable." }, - "signerCanSignOnMobile": { - "description": "When set to **true**, the recipient can sign on a mobile device.", + "signingGroupName": { + "description": "Not applicable.", "type": "string" }, - "signingLocation": { - "description": "Specifies the physical location where the signing takes place. It can have two enumeration values; `inPerson` and `online`. The default value is `online`.", - "type": "string" + "signingGroupUsers": { + "description": "Not applicable.", + "type": "array", + "items": { + "$ref": "#/definitions/userInfo" + } }, - "status": { - "description": "The status of the item.", - "type": "string" + "smsAuthentication": { + "$ref": "#/definitions/recipientSMSAuthentication", + "description": "When `idCheckConfigurationName` is set to `SMS Auth $`, you use this complex type to provide the recipient authentication method details. It contains the element `senderProvidedNumbers`, which is an array of phone numbers that the recipient can use for SMS text authentication. \n\n" }, - "statusChangedDateTime": { - "description": "The data and time the status changed.", - "type": "string" + "socialAuthentications": { + "description": "Deprecated.", + "type": "array", + "items": { + "$ref": "#/definitions/socialAuthentication" + } }, - "statusDateTime": { - "description": "The DateTime that the envelope changed status (i.e. was created or sent.)", + "status": { + "description": "The recipient's status. Read only. \n\nPossible values:\n\n- `autoresponded`: The recipient's email system auto-responded to the email from DocuSign. This status is used in the web console to inform senders about the bounced-back email. This recipient status is only used if **Send-on-behalf-of** is turned off for the account.\n- `completed`: The recipient has completed their actions (signing or other required actions if not a signer) for an envelope.\n- `created`: The recipient is in a draft state. This value is only associated with draft envelopes (envelopes that have a status of `created`).\n- `declined`: The recipient declined to sign the document(s) in the envelope.\n- `delivered`: The recipient has viewed the document(s) in an envelope through the DocuSign signing website. This is not an email delivery of the documents in an envelope.\n- `faxPending`: The recipient has finished signing and the system is waiting for a fax attachment from the recipient before completing their signing step.\n- `sent`: The recipient has been sent an email notification that it is their turn to sign an envelope.\n- `signed`: The recipient has completed (signed) all required tags in an envelope. This is a temporary state during processing, after which the recipient's status automatically switches to `completed`.", "type": "string" }, - "templateId": { - "description": "The ID of the template.", + "statusCode": { + "description": "The code associated with the recipient's status. Read only.", "type": "string" }, - "templatesUri": { - "description": "Contains a URI for an endpoint that you can use to retrieve the templates.", + "suppressEmails": { + "description": "When set to **true**, email notifications are suppressed for the recipient, and they must access envelopes and documents from their DocuSign inbox.", "type": "string" }, - "transactionId": { - "description": "Specifies the Transaction ID from the AppStore.", - "type": "string" + "tabs": { + "$ref": "#/definitions/EnvelopeRecipientTabs", + "description": "A list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients." }, - "uri": { - "description": "URI containing the user ID.", + "templateLocked": { + "description": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ", "type": "string" }, - "useDisclosure": { - "description": "When set to **true**, the disclosure is shown to recipients in accordance with the account's Electronic Record and Signature Disclosure frequency setting. When set to **false**, the Electronic Record and Signature Disclosure is not shown to any envelope recipients. \n\nIf the `useDisclosure` property is not set, then the account's normal disclosure setting is used and the value of the `useDisclosure` property is not returned in responses when getting envelope information.", + "templateRequired": { + "description": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.", "type": "string" }, - "voidedDateTime": { - "description": "The date and time the envelope or template was voided.", + "totalTabCount": { + "description": "The total number of tabs in the documents. Read only.", "type": "string" }, - "voidedReason": { - "description": "The reason the envelope or template was voided.", + "userId": { + "description": "The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.\n", "type": "string" } }, - "x-ds-definition-name": "envelopeTemplate", - "description": "", - "x-ms-summary": "" + "x-ds-definition-name": "inPersonSigner", + "description": "Contains information about an in-person recipient. This is a DocuSign user,\nacting as a Signing Host,\nwho is in the same physical location as the signer.\nTo learn about the fields used\nfor the eNotary feature,\nsee the [EnvelopeRecipients resource][resource].\n\n[resource]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipients#in-person-signer-recipient\n", + "x-ms-summary": "Contains information about an in-person recipient. This is a DocuSign user,\nacting as a Signing Host,\nwho is in the same physical location as the signer.\nTo learn about the fields used\nfor the eNotary feature,\nsee the [EnvelopeRecipients resource][resource].\n\n[resource]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipients#in-person-signer-recipient\n" }, - "envelopeTemplateResults": { + "integratedUserInfoList": { "type": "object", "properties": { - "endPosition": { - "description": "The last position in the result set. ", + "allUsersSelected": { + "description": "", "type": "string" }, - "envelopeTemplates": { - "description": "The list of requested templates.", - "type": "array", - "items": { - "$ref": "#/definitions/Templates" - } - }, - "folders": { - "description": "A collection of folder objects returned in a response.", - "type": "array", - "items": { - "$ref": "#/definitions/folder" - } + "endPosition": { + "description": "The last index position in the result set. ", + "type": "string" }, "nextUri": { "description": "The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. ", @@ -32523,721 +43689,770 @@ "type": "string" }, "resultSetSize": { - "description": "The number of results returned in this response. Because you can filter which entries are included in the response, this value is always less than or equal to `totalSetSize`.", + "description": "The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`.", "type": "string" }, "startPosition": { - "description": "The starting position of the current result set.", + "description": "The starting index position of the current result set.", "type": "string" }, "totalSetSize": { - "description": "The total number of items in the search's result set. This value is always greater than or equal to the value of `resultSetSize`.", - "type": "string" - } - }, - "x-ds-definition-name": "envelopeTemplateResults", - "description": "Information about templates.", - "x-ms-summary": "Information about templates." - }, - "envelopeTransactionStatus": { - "type": "object", - "properties": { - "envelopeId": { - "description": "The envelope ID of the envelope status that failed to post.", - "type": "string" - }, - "errorDetails": { - "$ref": "#/definitions/errorDetails", - "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." - }, - "status": { - "description": "Indicates the envelope status. Valid values are:\n\n* sent - The envelope is sent to the recipients. \n* created - The envelope is saved as a draft and can be modified and sent later.", + "description": "The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`.", "type": "string" }, - "transactionId": { - "description": " Used to identify an envelope. The id is a sender-generated value and is valid in the DocuSign system for 7 days. It is recommended that a transaction ID is used for offline signing to ensure that an envelope is not sent multiple times. The `transactionId` property can be used determine an envelope's status (i.e. was it created or not) in cases where the internet connection was lost before the envelope status was returned.", - "type": "string" + "users": { + "description": "User management information.", + "type": "array", + "items": { + "$ref": "#/definitions/userInfo" + } } }, - "x-ds-definition-name": "envelopeTransactionStatus", + "x-ds-definition-name": "integratedUserInfoList", "description": "", "x-ms-summary": "" }, - "envelopeTransferRule": { + "intermediary": { "type": "object", "properties": { - "carbonCopyOriginalOwner": { - "description": "", + "accessCode": { + "description": "If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. \n\nMaximum Length: 50 characters and it must conform to the account's access code format setting.\n\nIf blank, but the signer `accessCode` property is set in the envelope, then that value is used.\n\nIf blank and the signer `accessCode` property is not set, then the access code is not required.", "type": "string" }, - "enabled": { - "description": "", - "type": "string" + "accessCodeMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `accessCode` property is editable. Read only." }, - "envelopeTransferRuleId": { - "description": "", + "addAccessCodeToEmail": { + "description": "Optional. When set to **true**, the access code will be added to the email sent to the recipient. This nullifies the security measure of `accessCode` on the recipient.", "type": "string" }, - "eventType": { + "additionalNotifications": { + "description": "An array of additional notification objects.", + "type": "array", + "items": { + "$ref": "#/definitions/recipientAdditionalNotification" + } + }, + "allowSystemOverrideForLockedRecipient": { "description": "", "type": "string" }, - "fromGroup": { - "$ref": "#/definitions/group", - "description": "" - }, - "fromUser": { - "$ref": "#/definitions/Users", - "description": "" - }, - "modifiedDate": { - "description": "Most recent date on which this user record was modified.", + "clientUserId": { + "description": "Specifies whether the recipient is embedded or remote. \n\nIf the `clientUserId` property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing.\n\nNote: if the `clientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true**, an error is generated on sending. \n\nMaximum length: 100 characters. ", "type": "string" }, - "modifiedUser": { - "$ref": "#/definitions/Users", - "description": "" - }, - "toFolder": { - "$ref": "#/definitions/folder", - "description": "" - }, - "toUser": { - "$ref": "#/definitions/Users", - "description": "" - } - }, - "x-ds-definition-name": "envelopeTransferRule", - "description": "", - "x-ms-summary": "" - }, - "envelopeTransferRuleInformation": { - "type": "object", - "properties": { - "endPosition": { - "description": "The last position in the result set. ", + "completedCount": { + "description": "Indicates the number of times that the recipient has been through a signing completion for the envelope. If this number is greater than 0 for a signing group, only the user who previously completed may sign again. Read only.", "type": "string" }, - "envelopeTransferRules": { - "description": "", + "customFields": { + "description": "An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters.", "type": "array", "items": { - "$ref": "#/definitions/envelopeTransferRule" - } - }, - "nextUri": { - "description": "The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. ", - "type": "string" + "type": "string" + } }, - "previousUri": { - "description": "The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. ", + "declinedDateTime": { + "description": "The date and time the recipient declined the document. Read only.", "type": "string" }, - "resultSetSize": { - "description": "The number of results returned in this response. Because you can filter which entries are included in the response, this value is always less than or equal to `totalSetSize`.", + "declinedReason": { + "description": "The reason the recipient declined the document. Read only.", "type": "string" }, - "startPosition": { - "description": "The starting position of the current result set.", + "deliveredDateTime": { + "description": "The date and time that the envelope was delivered to the recipient. Read only.", "type": "string" }, - "totalSetSize": { - "description": "The total number of items in the search's result set. This value is always greater than or equal to the value of `resultSetSize`.", - "type": "string" - } - }, - "x-ds-definition-name": "envelopeTransferRuleInformation", - "description": "", - "x-ms-summary": "" - }, - "envelopeTransferRuleRequest": { - "type": "object", - "properties": { - "carbonCopyOriginalOwner": { - "description": "", + "deliveryMethod": { + "description": "Reserved for DocuSign.", "type": "string" }, - "enabled": { - "description": "", - "type": "string" + "deliveryMethodMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Reserved for DocuSign." }, - "envelopeTransferRuleId": { + "designatorId": { "description": "", "type": "string" }, - "eventType": { + "designatorIdGuid": { "description": "", "type": "string" }, - "fromGroups": { - "description": "", - "type": "array", - "items": { - "$ref": "#/definitions/group" - } - }, - "fromUsers": { - "description": "", + "documentVisibility": { + "description": "A list of `documentVisibility` objects. Each object in the list specifies whether a document in the envelope is visible to this recipient. For the envelope to use this functionality, Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true**.", "type": "array", "items": { - "$ref": "#/definitions/Users" + "$ref": "#/definitions/documentVisibility" } }, - "modifiedDate": { - "description": "Most recent date on which this user record was modified.", + "email": { + "description": "The recipient's email address. Notification of the document to sign is sent to this email address. \n\nMaximum length: 100 characters. ", "type": "string" }, - "modifiedUser": { - "$ref": "#/definitions/Users", - "description": "" - }, - "toFolder": { - "$ref": "#/definitions/folder", - "description": "" + "emailMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `email` property is editable. Read only." }, - "toUser": { - "$ref": "#/definitions/Users", - "description": "" - } - }, - "x-ds-definition-name": "envelopeTransferRuleRequest", - "description": "", - "x-ms-summary": "" - }, - "envelopeUpdateSummary": { - "type": "object", - "properties": { - "bulkEnvelopeStatus": { - "$ref": "#/definitions/bulkEnvelopeStatus", - "description": "" + "emailNotification": { + "$ref": "#/definitions/recipientEmailNotification", + "description": "An optional complex type that sets a specific email subject and body for this recipient's notification email. \n\n**Note**: You can set the `emailNotification` property separately for each recipient. If you set the value only for certain recipients, the other recipients will inherit the this value from the top-level `emailSubject` and `emailBlurb`. " }, - "envelopeId": { - "description": "The envelope ID of the envelope status that failed to post.", + "embeddedRecipientStartURL": { + "description": "Specifies a sender-provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. \n\nIf set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation launched by a partner.\n\nIt is important to understand that in a typical embedded workflow, the authentication of an embedded recipient is the responsibility of the sending application. DocuSign expects that senders will follow their own processes for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process is initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process, bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient.\n\nIf the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: `envelopeId`, `recipientId`, `recipientName`, `recipientEmail`, and `customFields`. The `customFields` property must be set for the recipient or envelope. The merge fields are enclosed in double brackets. \n\n*Example*: \n\n`http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` ", "type": "string" }, "errorDetails": { "$ref": "#/definitions/errorDetails", "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." }, - "listCustomFieldUpdateResults": { - "description": "", + "excludedDocuments": { + "description": "Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true** for the envelope to use this.\n\nWhen enforce signer visibility is enabled, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent.", "type": "array", "items": { - "$ref": "#/definitions/listCustomField" + "type": "string" } }, - "lockInformation": { - "$ref": "#/definitions/EnvelopeLocks", - "description": "Provides lock information about an envelope that a user has locked." + "faxNumber": { + "description": "Reserved for DocuSign.", + "type": "string" }, - "purgeState": { - "description": "Shows the current purge state for the envelope. The possible values are:\n\n* `unpurged`: There has been no successful request to purge documents.\n* `documents_queued`: The envelope documents have been added to the purge queue, but have not been purged.\n* `documents_dequeued`: The envelope documents have been taken out of the purge queue.\n* `documents_and_metadata_queued`: The envelope documents and metadata have been added to the purge queue, but have not yet been purged.\n* `documents_purged`: The envelope documents have been successfully purged.\n* `documents_and_metadata_purged`: The envelope documents and metadata have been successfully purged.\n\n", + "faxNumberMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Reserved for DocuSign." + }, + "firstName": { + "description": "The recipient's first name. Maximum Length: 50 characters.", "type": "string" }, - "recipientUpdateResults": { - "description": "An array of `recipientUpdateResults` objects that contain details about the recipients.", + "firstNameMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `firstame` property is editable. Read only." + }, + "fullName": { + "description": "Reserved for DocuSign.", + "type": "string" + }, + "fullNameMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Reserved for DocuSign." + }, + "idCheckConfigurationName": { + "description": "The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are:\n\n- `Phone Auth $`: The recipient must authenticate by using two-factor authentication (2FA). You provide the phone number to use for 2FA in the `phoneAuthentication` object.\n- `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object.\n- `ID Check $`: The recipient must answer detailed security questions. \n\n**Example**: Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node.", + "type": "string" + }, + "idCheckConfigurationNameMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `idCheckConfigurationName` property is editable. Read only." + }, + "idCheckInformationInput": { + "$ref": "#/definitions/idCheckInformationInput", + "description": "An object that contains input information related to a recipient ID check." + }, + "identityVerification": { + "$ref": "#/definitions/recipientIdentityVerification", + "description": "Specifies the ID Verification workflow applied on an envelope by workflow ID.
See the [list](https://developers.docusign.com/docs/esign-rest-api/reference/Accounts/IdentityVerifications/list) method in the [IdentityVerifications](https://developers.docusign.com/docs/esign-rest-api/reference/Accounts/IdentityVerifications) resource for more information on how to retrieve workflow IDs available for an account.
This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods.
Note that ID Verification and ID Check are two distinct methods. ID Verification checks recipients' identity by verifying their ID while ID Check relies on data available on public records (such as current and former address)." + }, + "inheritEmailNotificationConfiguration": { + "description": "When set to **true** and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account. ", + "type": "string" + }, + "lastName": { + "description": "The recipient's last name.", + "type": "string" + }, + "lastNameMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `lastName` property is editable. Read only." + }, + "lockedRecipientPhoneAuthEditable": { + "description": "Reserved for DocuSign.", + "type": "string" + }, + "lockedRecipientSmsEditable": { + "description": "Reserved for DocuSign.", + "type": "string" + }, + "name": { + "description": "The full legal name of the recipient. Maximum Length: 100 characters.\n\n**Note**: You must always set a value for this property in requests, even if `firstName` and `lastName` are set.", + "type": "string" + }, + "nameMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `name` property is editable. Read only." + }, + "note": { + "description": "A note sent to the recipient in the signing email.\nThis note is unique to this recipient.\nIn the user interface,\nit appears near the upper left corner\nof the document\non the signing screen.\n\nMaximum Length: 1000 characters.\n", + "type": "string" + }, + "noteMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `note` property is editable. Read only." + }, + "phoneAuthentication": { + "$ref": "#/definitions/recipientPhoneAuthentication", + "description": "When `idCheckConfigurationName` is set to `Phone Auth $`, you use this complex type to provide the recipient authentication method details. It contains the following elements:\n\n* `recipMayProvideNumber`: Boolean. When set to **true**, the recipient can use whatever phone number they choose.\n* `senderProvidedNumbers`: ArrayOfStrings. A list of phone numbers the recipient can use.\n* `recordVoicePrint`: Reserved for DocuSign.\n* `validateRecipProvidedNumber`: Reserved for DocuSign.\n\n" + }, + "recipientAttachments": { + "description": "Reserved for DocuSign.", "type": "array", "items": { - "$ref": "#/definitions/recipientUpdateResponse" + "$ref": "#/definitions/recipientAttachment" } }, - "tabUpdateResults": { - "$ref": "#/definitions/EnvelopeRecipientTabs", - "description": "" + "recipientAuthenticationStatus": { + "$ref": "#/definitions/authenticationStatus", + "description": "Information about the recipient's authentication status. Read only." }, - "textCustomFieldUpdateResults": { - "description": "", + "recipientFeatureMetadata": { + "description": "Metadata about the features that are supported for the recipient type. Read only.", "type": "array", "items": { - "$ref": "#/definitions/textCustomField" + "$ref": "#/definitions/featureAvailableMetadata" } - } - }, - "x-ds-definition-name": "envelopeUpdateSummary", - "description": "", - "x-ms-summary": "" - }, - "errorDetails": { - "description": "This object describes errors that occur. It is only valid for responses and ignored in requests.", - "type": "object", - "properties": { - "errorCode": { - "description": "The code associated with the error condition.", + }, + "recipientId": { + "description": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the document.", "type": "string" }, - "message": { - "description": "A brief message describing the error condition.", + "recipientIdGuid": { + "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only.", "type": "string" - } - }, - "x-ds-definition-name": "errorDetails", - "x-ms-summary": "This object describes errors that occur. It is only valid for responses and ignored in requests." - }, - "eventNotification": { - "description": "Register a Connect webhook for a specific envelope", - "type": "object", - "properties": { - "envelopeEvents": { - "description": "A list of envelope-level event statuses that will trigger Connect to send updates to the endpoint specified in the `url` property. \n\nTo receive notifications, you must include either an `envelopeEvents` node or a `recipientEvents` node. You do not need to specify both.", - "type": "array", - "items": { - "$ref": "#/definitions/envelopeEvent" - } }, - "includeCertificateOfCompletion": { - "description": "When set to **true**, the Connect Service includes the Certificate of Completion with completed envelopes. ", + "recipientType": { + "description": "The recipient type, as specified by the following values:\n- `agent`: Agent recipients can add name and email information for recipients that appear after the agent in routing order.\n- `carbonCopy`: Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date, or add information to any of the documents. This type of recipient can be used in any routing order.\n- `certifiedDelivery`: Certified delivery recipients must receive the completed documents for the envelope to be completed. They don't need to sign, initial, date, or add information to any of the documents.\n- `editor`: Editors have the same management and access rights for the envelope as the sender. Editors can add name and email information, add or change the routing order, set authentication options, and can edit signature/initial tabs and data fields for the remaining recipients.\n- `inPersonSigner`: In-person recipients are DocuSign users who act as signing hosts in the same physical location as the signer.\n- `intermediaries`: Intermediary recipients can optionally add name and email information for recipients at the same or subsequent level in the routing order.\n- `seal`: Electronic seal recipients represent legal entities.\n- `signer`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope.\n- `witness`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope.", "type": "string" }, - "includeCertificateWithSoap": { - "description": "When set to **true**, the Connect service will digitally sign the XML data. The signature will be included in the XML message.", + "recipientTypeMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `recipientType` property is editable. Read only." + }, + "requireIdLookup": { + "description": "When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. ", "type": "string" }, - "includeDocumentFields": { - "description": "When set to **true**, the Document Fields associated with the envelope's documents are included in the notification messages. Document Fields are optional custom name-value pairs added to documents using the API. ", + "requireIdLookupMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `requireIdLookup` property is editable. Read only." + }, + "roleName": { + "description": "Optional element. Specifies the role name associated with the recipient.

This property is required when you are working with template recipients.", "type": "string" }, - "includeDocuments": { - "description": "When set to **true**, the XML webhook messages will include the envelope's PDF documents. Including the PDF documents will greatly increase the size of the notification messages. Ensure that your listener can handle incoming messages that are 25MB or larger. ", + "routingOrder": { + "description": "Specifies the routing order of the recipient in the envelope. ", "type": "string" }, - "includeEnvelopeVoidReason": { - "description": "When set to **true**, if the envelope is voided, the Connect Service notification will include the void reason, as entered by the person that voided the envelope. ", + "routingOrderMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `routingOrder` property is editable. Read only." + }, + "sentDateTime": { + "description": "The UTC DateTime when the envelope was sent. Read only.", "type": "string" }, - "includeSenderAccountAsCustomField": { - "description": "When set to **true**, Connect will include the sender account as Custom Field in the data.", + "signedDateTime": { + "description": "Reserved for DocuSign.", "type": "string" }, - "includeTimeZone": { - "description": "When set to **true**, the envelope's time zone information is included in the webhook messages. ", + "signingGroupId": { + "description": "When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once).", "type": "string" }, - "loggingEnabled": { - "description": "When set to **true**, the webhook messages are logged. They can be viewed on the DocuSign Administration Web Tool in the Connect section. Logged messages can also be downloaded via the [ConnectEvents resource](https://developers.docusign.com/esign-rest-api/reference/Connect/ConnectEvents).", + "signingGroupIdMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `signingGroupId` property is editable. Read only." + }, + "signingGroupName": { + "description": "Optional. The name of the signing group. \n\nMaximum Length: 100 characters. ", "type": "string" }, - "recipientEvents": { - "description": "An array of recipient event statuses that will trigger Connect to send notifications to your webhook listener at the url endpoint specified in the `url` property. \n\nTo receive notifications, you must include either an `envelopeEvents` node or a `recipientEvents` node. You do not need to specify both.", + "signingGroupUsers": { + "description": "A complex type that contains information about users in the signing group.", "type": "array", "items": { - "$ref": "#/definitions/recipientEvent" + "$ref": "#/definitions/userInfo" } }, - "requireAcknowledgment": { - "description": "When set to **true**, the DocuSign Connect service checks that the message was received and retries on failures. ", + "smsAuthentication": { + "$ref": "#/definitions/recipientSMSAuthentication", + "description": "When `idCheckConfigurationName` is set to `SMS Auth $`, you use this complex type to provide the recipient authentication method details. It contains the element `senderProvidedNumbers`, which is an array of phone numbers that the recipient can use for SMS text authentication. \n\n" + }, + "socialAuthentications": { + "description": "Deprecated.", + "type": "array", + "items": { + "$ref": "#/definitions/socialAuthentication" + } + }, + "status": { + "description": "The recipient's status. Read only. \n\nPossible values:\n\n- `autoresponded`: The recipient’s email system auto-responded to the email from DocuSign. This status is used in the web console to inform senders about the bounced-back email. This recipient status is only used if **Send-on-behalf-of** is turned off for the account.\n- `completed`: The recipient has completed their actions (signing or other required actions if not a signer) for an envelope.\n- `created`: The recipient is in a draft state. This value is only associated with draft envelopes (envelopes that have a status of `created`).\n- `declined`: The recipient declined to sign the document(s) in the envelope.\n- `delivered`: The recipient has viewed the document(s) in an envelope through the DocuSign signing website. This is not an email delivery of the documents in an envelope.\n- `faxPending`: The recipient has finished signing and the system is waiting for a fax attachment from the recipient before completing their signing step.\n- `sent`: The recipient has been sent an email notification that it is their turn to sign an envelope.\n- `signed`: The recipient has completed (signed) all required tags in an envelope. This is a temporary state during processing, after which the recipient's status automatically switches to `completed`.\n", "type": "string" }, - "signMessageWithX509Cert": { - "description": "When set to **true**, Mutual TLS will be enabled for notifications. Mutual TLS must be initiated by the listener (the customer's web server) during the TLS handshake protocol. ", + "statusCode": { + "description": "The code associated with the recipient's status. Read only.", "type": "string" }, - "soapNameSpace": { - "description": "The namespace of the SOAP interface.\n\nThe namespace value must be set if useSoapInterface is set to true.", + "suppressEmails": { + "description": "When set to **true**, email notifications are suppressed for the recipient, and they must access envelopes and documents from their DocuSign inbox.", "type": "string" }, - "url": { - "description": "The endpoint to which webhook notification messages are sent via an HTTPS POST request. The url must start with https. The customer's web server must use an SSL/TLS certificate whose CA is in the Microsoft list of trusted CAs. Self-signed certificates are not ok. Free certificates from Let's Encrypt can be used.", + "templateLocked": { + "description": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ", "type": "string" }, - "useSoapInterface": { - "description": "When set to **true**, the notifications are sent to your endpoint as SOAP requests. ", + "templateRequired": { + "description": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.", + "type": "string" + }, + "totalTabCount": { + "description": "The total number of tabs in the documents. Read only.", + "type": "string" + }, + "userId": { + "description": "The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.\n", "type": "string" } }, - "x-ds-definition-name": "eventNotification", - "x-ms-summary": "Register a Connect webhook for a specific envelope" + "x-ds-definition-name": "intermediary", + "description": "Contains information about an intermediary recipient. An intermediary is a recipient who can, but is not required to, add name and email information for recipients at the same or subsequent level in the routing order, unless subsequent agents, editors or intermediaries are added.", + "x-ms-summary": "Contains information about an intermediary recipient. An intermediary is a recipient who can, but is not required to, add name and email information for recipients at the same or subsequent level in the routing order, unless subsequent agents, editors or intermediaries are added." }, - "eventResult": { + "jurisdiction": { "type": "object", "properties": { - "eventTimestamp": { - "description": "Date/time of the event.", + "allowSystemCreatedSeal": { + "description": "If **true**, the seal can be generated by the platform.", "type": "string" }, - "failureDescription": { - "description": "Reason for failure, if the event failed.", + "allowUserUploadedSeal": { + "description": "If **true**, the seal can be uploaded by the user.", "type": "string" }, - "status": { - "description": "Event status.", + "commissionIdInSeal": { + "description": "If **true**, the notary's `comissionId` appears in the seal.", "type": "string" }, - "vendorFailureStatusCode": { - "description": "Failure status code, if the event failed.", + "county": { + "description": "The county of the jurisdiction.", "type": "string" - } - }, - "x-ds-definition-name": "eventResult", - "description": "Information about the result of an event.", - "x-ms-summary": "Information about the result of an event." - }, - "expirations": { - "description": "A complex element that specifies the expiration settings for the envelope.", - "type": "object", - "properties": { - "expireAfter": { - "description": "An integer specifying the number of days that a sent envelope remains active before it expires. A negative number in a response indicates that the envelope has already expired.", + }, + "countyInSeal": { + "description": "If **true**, the county name appears in the seal.", "type": "string" }, - "expireEnabled": { - "description": "When set to **true**, the envelope expires (is no longer available for signing) after the specified number of days after it is sent (`sentDateTime`). Set `expireAfter` to set the number of days until an envelope expires. When **false**, the account default setting is used. If the account does not have an expiration setting, the DocuSign default value of 120 days is used.", + "enabled": { + "description": "If **true**, this jurisdiction is enabled.", "type": "string" }, - "expireWarn": { - "description": "An integer that specifying the number of days before the envelope expires that an expiration warning email is sent to the recipient. If set to 0 (zero), no warning email is sent.", + "jurisdictionId": { + "description": "The ID of the jurisdiction.\nThe following jurisdictions\nare supported:\n\n- `5 - California`\n- `6 - Colorado`\n- `9 - Florida`\n- `10 - Georgia`\n- `12 - Idaho`\n- `13 - Illinois`\n- `14 - Indiana`\n- `15 - Iowa`\n- `17 - Kentucky`\n- `23 - Minnesota`\n- `25 - Missouri`\n- `30 - New Jersey`\n- `32 - New York`\n- `33 - North Carolina`\n- `35 - Ohio`\n- `37 - Oregon`\n- `38 - Pennsylvania`\n- `40 - South Carolina`\n- `43 - Texas`\n- `44 - Utah`\n- `47 - Washington`\n- `48 - West Virginia`\n- `49 - Wisconsin`\n- `62 - Florida Commissioner of Deeds`\n", + "type": "string" + }, + "name": { + "description": "The name of the jurisdiction. Typically the state name.", + "type": "string" + }, + "notaryPublicInSeal": { + "description": "If **true**, the name of the notary appears in the seal.", + "type": "string" + }, + "stateNameInSeal": { + "description": "If **true**, the name of the state appears in the seal.", "type": "string" } }, - "x-ds-definition-name": "expirations", - "x-ms-summary": "A complex element that specifies the expiration settings for the envelope." + "x-ds-definition-name": "jurisdiction", + "description": "Describes the jurisdiction of a notary.\nThis is read-only object.", + "x-ms-summary": "Describes the jurisdiction of a notary.\nThis is read-only object." }, - "externalClaim": { + "lastName": { "type": "object", "properties": { - "acquiredTime": { + "anchorAllowWhiteSpaceInCharacters": { "description": "", "type": "string" }, - "claimName": { - "description": "", + "anchorAllowWhiteSpaceInCharactersMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "" + }, + "anchorCaseSensitive": { + "description": "This property controls how [anchor tabs][AnchorTabs] are placed. When **true**, the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false**.\n\nFor example, when set to **true**, if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When set to **false**, `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**.\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place", "type": "string" }, - "provider": { - "description": "The social account provider (Facebook, Yahoo, etc.)", + "anchorCaseSensitiveMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorCaseSensitive` property is editable." + }, + "anchorHorizontalAlignment": { + "description": "This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are :\n\n- `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value.\n- `right`: Aligns the tab’s left side with the last character of the matching anchor word.\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place\n", "type": "string" }, - "value": { - "description": "Specifies the value of the tab. ", + "anchorHorizontalAlignmentMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorHorizontalAlignment` property is editable." + }, + "anchorIgnoreIfNotPresent": { + "description": "When set to **true**, this tab is ignored if the `anchorString` is not found in the document.", "type": "string" - } - }, - "x-ds-definition-name": "externalClaim", - "description": "", - "x-ms-summary": "" - }, - "externalDocServiceErrorDetails": { - "type": "object", - "properties": { - "authenticationUrl": { - "description": "Reserved: TBD", + }, + "anchorIgnoreIfNotPresentMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable." + }, + "anchorMatchWholeWord": { + "description": "When set to **true**, the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false**.\n\nFor example, when set to **true**, if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When set to **false**, if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**.\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTab]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place\n", "type": "string" }, - "errorCode": { - "description": "A code associated with the error condition.", + "anchorMatchWholeWordMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorMatchWholeWord` property is editable." + }, + "anchorString": { + "description": "Specifies the string to find in the document and use as the basis for tab placement.", "type": "string" }, - "message": { - "description": "", + "anchorStringMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorString` property is editable." + }, + "anchorTabProcessorVersion": { + "description": "Reserved for DocuSign.", "type": "string" - } - }, - "x-ds-definition-name": "externalDocServiceErrorDetails", - "description": "", - "x-ms-summary": "" - }, - "externalDocumentSources": { - "type": "object", - "properties": { - "boxnetEnabled": { - "description": "The account is enabled to allow external documents to be attached from BoxNet.", + }, + "anchorTabProcessorVersionMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Reserved for DocuSign." + }, + "anchorUnits": { + "description": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n", "type": "string" }, - "boxnetMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata indicating whether the `boxnetEnabled` property is editable." + "anchorUnitsMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorUnits` property is editable." }, - "dropboxEnabled": { - "description": "The account is enabled to allow external documents to be attached from DropBox.", + "anchorXOffset": { + "description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n", "type": "string" }, - "dropboxMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata indicating whether the `dropboxEnabled` property is editable." + "anchorXOffsetMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorXOffset` property is editable." }, - "googleDriveEnabled": { - "description": "The account is enabled to allow external documents to be attached from Google Drive.", + "anchorYOffset": { + "description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n", "type": "string" }, - "googleDriveMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata indicating whether the `googleDriveEnabled` property is editable." + "anchorYOffsetMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorYOffset` property is editable." }, - "oneDriveEnabled": { - "description": "The account is enabled to allow external documents to be attached from OneDrive.", + "bold": { + "description": "When set to **true**, the information in the tab is bold.", "type": "string" }, - "oneDriveMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata indicating whether the `oneDriveEnabled` property is editable." + "boldMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `bold` property is editable." }, - "salesforceEnabled": { - "description": "The account is enabled to allow external documents to be attached from Salesforce.", + "conditionalParentLabel": { + "description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility.", "type": "string" }, - "salesforceMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata indicating whether the `salesforceEnabled` property is editable." - } - }, - "x-ds-definition-name": "externalDocumentSources", - "description": "A complex object specifying the external document sources.", - "x-ms-summary": "A complex object specifying the external document sources." - }, - "externalFile": { - "type": "object", - "properties": { - "date": { - "description": "", + "conditionalParentLabelMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `conditionalParentLabel` property is editable." + }, + "conditionalParentValue": { + "description": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use \"on\" as the value to show that the parent tab is active.\n", "type": "string" }, - "id": { - "description": "A unique ID for the Salesforce object.", + "conditionalParentValueMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `conditionalParentValue` property is editable." + }, + "customTabId": { + "description": "The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.", + "type": "string" + }, + "customTabIdMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `customTabId` property is editable." + }, + "documentId": { + "description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.", + "type": "string" + }, + "documentIdMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `documentId` property is editable." + }, + "errorDetails": { + "$ref": "#/definitions/errorDetails", + "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." + }, + "font": { + "description": "The font to be used for the tab value. Supported fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n", + "type": "string" + }, + "fontColor": { + "description": "The font color to use for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n", + "type": "string" + }, + "fontColorMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `fontColor` property is editable." + }, + "fontMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `font` property is editable." + }, + "fontSize": { + "description": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72", + "type": "string" + }, + "fontSizeMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `fontSize` property is editable." + }, + "formOrder": { + "description": "An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block.", + "type": "string" + }, + "formOrderMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `formOrder` property is editable." + }, + "formPageLabel": { + "description": "A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience.", "type": "string" }, - "img": { - "description": "", - "type": "string" + "formPageLabelMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `formPageLabel` property is editable." }, - "name": { - "description": "", + "formPageNumber": { + "description": "An integer specifying the order in which to present the guided form pages.", "type": "string" }, - "size": { - "description": "Reserved: TBD", - "type": "string" + "formPageNumberMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `fromPageNumber` property is editable." }, - "supported": { - "description": "", + "height": { + "description": "The height of the tab in pixels.", "type": "string" }, - "type": { - "description": "Type of user:\n- `type_owner`\n- `type_participant`", - "type": "string" + "heightMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `height` property is editable." }, - "uri": { - "description": "URI containing the user ID.", - "type": "string" - } - }, - "x-ds-definition-name": "externalFile", - "description": "", - "x-ms-summary": "" - }, - "externalFolder": { - "type": "object", - "properties": { - "endPosition": { - "description": "The last position in the result set. ", + "italic": { + "description": "When set to **true**, the information in the tab is italic.", "type": "string" }, - "errorDetails": { - "$ref": "#/definitions/externalDocServiceErrorDetails", - "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." + "italicMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `italic` property is editable." }, - "id": { - "description": "A unique ID for the Salesforce object.", - "type": "string" + "localePolicy": { + "$ref": "#/definitions/localePolicyTab", + "description": "Reserved for DocuSign." }, - "items": { - "description": "", - "type": "array", - "items": { - "$ref": "#/definitions/externalFile" - } + "mergeField": { + "$ref": "#/definitions/mergeField", + "description": "Contains the information necessary to map the tab to a field in SalesForce." }, - "name": { + "mergeFieldXml": { "description": "", "type": "string" }, - "nextUri": { - "description": "The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. ", + "name": { + "description": "The name of the tab. For example, `Sign Here` or `Initial Here`.", "type": "string" }, - "previousUri": { - "description": "The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. ", - "type": "string" + "nameMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `name` property is editable. Read only." }, - "resultSetSize": { - "description": "The number of results returned in this response. Because you can filter which entries are included in the response, this value is always less than or equal to `totalSetSize`.", + "pageNumber": { + "description": "The page number on which the tab is located. For supplemental documents, this value must be `1`.\n", "type": "string" }, - "startPosition": { - "description": "The starting position of the current result set.", - "type": "string" + "pageNumberMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `pageNumber` property is editable." }, - "totalSetSize": { - "description": "The total number of items in the search's result set. This value is always greater than or equal to the value of `resultSetSize`.", + "recipientId": { + "description": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.", "type": "string" - } - }, - "x-ds-definition-name": "externalFolder", - "description": "", - "x-ms-summary": "" - }, - "featureAvailableMetadata": { - "type": "object", - "properties": { - "availabilty": { - "description": "", + }, + "recipientIdGuid": { + "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only.", "type": "string" }, - "featureName": { - "description": "", + "recipientIdGuidMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `recipientIdGuid` property is editable." + }, + "recipientIdMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `recipientId` property is editable." + }, + "smartContractInformation": { + "$ref": "#/definitions/smartContractInformation", + "description": "" + }, + "status": { + "description": "The status of the tab. Possible values are:\n\n- `active`: The tab is active, but the recipient has not yet interacted with it.\n- `signed`: The recipient signed the tab.\n- `declined`: The recipient declined the envelope.\n- `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`).", "type": "string" - } - }, - "x-ds-definition-name": "featureAvailableMetadata", - "description": "", - "x-ms-summary": "" - }, - "featureSet": { - "type": "object", - "properties": { - "currencyFeatureSetPrices": { - "description": "Reserved for DocuSign.", + }, + "statusMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `status` property is editable." + }, + "tabGroupLabels": { + "description": "An array of tab group labels that uniquely identify tab groups. To assign a tab to a `tabGroup`, you assign the `TabGroupLabel` to the `Tab.TabGroupLabels` array.", "type": "array", "items": { - "$ref": "#/definitions/currencyFeatureSetPrice" + "type": "string" } }, - "envelopeFee": { - "description": "Reserved for DocuSign.", - "type": "string" + "tabGroupLabelsMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `tabGroupLabels` property is editable." }, - "featureSetId": { - "description": "Reserved for DocuSign.", + "tabId": { + "description": "The unique identifier for the tab.", "type": "string" }, - "fixedFee": { - "description": "Reserved for DocuSign.", - "type": "string" + "tabIdMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `tabId` property is editable." }, - "is21CFRPart11": { - "description": "Reserved for DocuSign.", + "tabLabel": { + "description": "The label associated with the tab. This value may be an empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum Length: 500 characters.\n", "type": "string" }, - "isActive": { - "description": "Reserved for DocuSign.", - "type": "string" + "tabLabelMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `tabLabel` property is editable." }, - "isEnabled": { - "description": "Reserved for DocuSign.", + "tabOrder": { + "description": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.", "type": "string" }, - "name": { - "description": "Reserved for DocuSign.", - "type": "string" + "tabOrderMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `tabOrder` property is editable." }, - "seatFee": { - "description": "Reserved for DocuSign.", - "type": "string" - } - }, - "x-ds-definition-name": "featureSet", - "description": "This object provides details about a feature set, or add-on product that is associated with an account. It is reserved for DocuSign internal use only.", - "x-ms-summary": "This object provides details about a feature set, or add-on product that is associated with an account. It is reserved for DocuSign internal use only." - }, - "fileType": { - "type": "object", - "properties": { - "fileExtension": { - "description": "", + "tabType": { + "description": "Indicates the type of tab (for example, `signHere` or `initialHere`).", "type": "string" }, - "mimeType": { - "description": "The mime-type of a file type listed in a fileTypes collection.", - "type": "string" - } - }, - "x-ds-definition-name": "fileType", - "description": "", - "x-ms-summary": "" - }, - "fileTypeList": { - "type": "object", - "properties": { - "fileTypes": { - "description": "A collection of file types.", - "type": "array", - "items": { - "$ref": "#/definitions/fileType" - } - } - }, - "x-ds-definition-name": "fileTypeList", - "description": "", - "x-ms-summary": "" - }, - "filter": { - "type": "object", - "properties": { - "actionRequired": { - "description": "Action required.", - "type": "string" + "tabTypeMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `tabType` property is editable." }, - "expires": { - "description": "", + "templateLocked": { + "description": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ", "type": "string" }, - "folderIds": { - "description": "", - "type": "string" + "templateLockedMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `templateLocked` property is editable." }, - "fromDateTime": { - "description": "", + "templateRequired": { + "description": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.", "type": "string" }, - "isTemplate": { - "description": "", - "type": "string" + "templateRequiredMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `templateRequired` property is editable." }, - "order": { - "description": "(Optional) The order in which to sort the results.\n\nValid values are: \n\n\n* `asc`: Ascending order.\n* `desc`: Descending order. ", + "tooltip": { + "description": "The text of a tooltip that appears when a user hovers over a form field or tab.", "type": "string" }, - "orderBy": { - "description": "", + "toolTipMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `toolTip` property is editable." + }, + "underline": { + "description": "When set to **true**, the information in the tab is underlined.", "type": "string" }, - "searchTarget": { - "description": "", + "underlineMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `underline` property is editable." + }, + "value": { + "description": "Specifies the value of the tab. ", "type": "string" }, - "searchText": { - "description": "", + "valueMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `value` property is editable." + }, + "width": { + "description": "The width of the tab in pixels.", "type": "string" }, - "status": { - "description": "Filter status.", + "widthMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `width` property is editable." + }, + "xPosition": { + "description": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n", "type": "string" }, - "toDateTime": { - "description": "Latest date to filter.", + "xPositionMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `xPosition` property is editable." + }, + "yPosition": { + "description": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n", "type": "string" + }, + "yPositionMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `yPosition` property is editable." } }, - "x-ds-definition-name": "filter", - "description": "", - "x-ms-summary": "" + "x-ds-definition-name": "lastName", + "description": "A tab that displays the recipient's last name. This tab\ntakes the recipient's name as entered in the recipient\ninformation, splits it into sections based on spaces and\nuses the last section as the last name.\n", + "x-ms-summary": "A tab that displays the recipient's last name. This tab\ntakes the recipient's name as entered in the recipient\ninformation, splits it into sections based on spaces and\nuses the last section as the last name.\n" }, - "firstName": { + "list": { "type": "object", "properties": { + "anchorAllowWhiteSpaceInCharacters": { + "description": "", + "type": "string" + }, + "anchorAllowWhiteSpaceInCharactersMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "" + }, "anchorCaseSensitive": { - "description": "Reserved for DocuSign.\n", + "description": "This property controls how [anchor tabs][AnchorTabs] are placed. When **true**, the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false**.\n\nFor example, when set to **true**, if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When set to **false**, `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**.\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place", "type": "string" }, "anchorCaseSensitiveMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "description": "Metadata that indicates whether the `anchorCaseSensitive` property is editable." }, "anchorHorizontalAlignment": { - "description": "Reserved for DocuSign.\n\n", + "description": "This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are :\n\n- `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value.\n- `right`: Aligns the tab’s left side with the last character of the matching anchor word.\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place\n", "type": "string" }, "anchorHorizontalAlignmentMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "description": "Metadata that indicates whether the `anchorHorizontalAlignment` property is editable." }, "anchorIgnoreIfNotPresent": { "description": "When set to **true**, this tab is ignored if the `anchorString` is not found in the document.", @@ -33248,12 +44463,12 @@ "description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable." }, "anchorMatchWholeWord": { - "description": "Reserved for DocuSign.\n\n", + "description": "When set to **true**, the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false**.\n\nFor example, when set to **true**, if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When set to **false**, if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**.\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTab]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place\n", "type": "string" }, "anchorMatchWholeWordMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "description": "Metadata that indicates whether the `anchorMatchWholeWord` property is editable." }, "anchorString": { "description": "Specifies the string to find in the document and use as the basis for tab placement.", @@ -33272,7 +44487,7 @@ "description": "Reserved for DocuSign." }, "anchorUnits": { - "description": "Specifies the units of the X and Y offset. Units may be pixels, millimeters, centimeters, or inches.", + "description": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n", "type": "string" }, "anchorUnitsMetadata": { @@ -33280,7 +44495,7 @@ "description": "Metadata that indicates whether the `anchorUnits` property is editable." }, "anchorXOffset": { - "description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.", + "description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n", "type": "string" }, "anchorXOffsetMetadata": { @@ -33288,7 +44503,7 @@ "description": "Metadata that indicates whether the `anchorXOffset` property is editable." }, "anchorYOffset": { - "description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.", + "description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n", "type": "string" }, "anchorYOffsetMetadata": { @@ -33328,7 +44543,7 @@ "description": "Metadata that indicates whether the `customTabId` property is editable." }, "documentId": { - "description": "Integer that identifies the document in the envelope.", + "description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.", "type": "string" }, "documentIdMetadata": { @@ -33403,22 +44618,41 @@ "$ref": "#/definitions/propertyMetadata", "description": "Metadata that indicates whether the `italic` property is editable." }, + "listItems": { + "description": "The list of values that can be selected by senders. The list values are separated by semi-colons. Example: [one;two;three;four]\n\nMaximum Length of listItems: 2048 characters.\nMaximum Length of items in the list: 100 characters. \n", + "type": "array", + "items": { + "$ref": "#/definitions/listItem" + } + }, + "listSelectedValue": { + "description": "The value in the list that is selected by default.", + "type": "string" + }, + "listSelectedValueMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `listSelectedValue` property is editable." + }, "localePolicy": { "$ref": "#/definitions/localePolicyTab", "description": "Reserved for DocuSign." }, + "locked": { + "description": "When set to **true**, the signer cannot change the data of the custom tab.", + "type": "string" + }, + "lockedMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `locked` property is editable." + }, "mergeField": { "$ref": "#/definitions/mergeField", "description": "Contains the information necessary to map the tab to a field in SalesForce." }, - "name": { - "description": "The name of the tab. For example, `Sign Here` or `Initial Here`.", + "mergeFieldXml": { + "description": "", "type": "string" }, - "nameMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `name` property is editable." - }, "pageNumber": { "description": "The page number on which the tab is located. For supplemental documents, this value must be `1`.\n", "type": "string" @@ -33428,11 +44662,11 @@ "description": "Metadata that indicates whether the `pageNumber` property is editable." }, "recipientId": { - "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", + "description": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.", "type": "string" }, "recipientIdGuid": { - "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one.", + "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only.", "type": "string" }, "recipientIdGuidMetadata": { @@ -33443,6 +44677,50 @@ "$ref": "#/definitions/propertyMetadata", "description": "Metadata that indicates whether the `recipientId` property is editable." }, + "requireAll": { + "description": "When set to **true** and shared is true, information must be entered in this field to complete the envelope. ", + "type": "string" + }, + "requireAllMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `requireAll` property is editable." + }, + "required": { + "description": "When set to **true**, the signer is required to fill out this tab.", + "type": "string" + }, + "requiredMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `required` property is editable." + }, + "requireInitialOnSharedChange": { + "description": "Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.", + "type": "string" + }, + "requireInitialOnSharedChangeMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `requireInitialOnSharedChange` property is editable." + }, + "senderRequired": { + "description": "When set to **true**, the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope.", + "type": "string" + }, + "senderRequiredMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `senderRequired` property is editable." + }, + "shared": { + "description": "When set to **true**, this custom tab is shared.", + "type": "string" + }, + "sharedMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `shared` property is editable." + }, + "smartContractInformation": { + "$ref": "#/definitions/smartContractInformation", + "description": "" + }, "status": { "description": "The status of the tab. Possible values are:\n\n- `active`: The tab is active, but the recipient has not yet interacted with it.\n- `signed`: The recipient signed the tab.\n- `declined`: The recipient declined the envelope.\n- `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`).", "type": "string" @@ -33471,7 +44749,7 @@ "description": "Metadata that indicates whether the `tabId` property is editable." }, "tabLabel": { - "description": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n", + "description": "The label associated with the tab. This value may be an empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum Length: 500 characters.\n", "type": "string" }, "tabLabelMetadata": { @@ -33527,7 +44805,7 @@ "description": "Metadata that indicates whether the `underline` property is editable." }, "value": { - "description": "Specifies the value of the tab. ", + "description": "The value to use when the item is selected.", "type": "string" }, "valueMetadata": { @@ -33543,7 +44821,7 @@ "description": "Metadata that indicates whether the `width` property is editable." }, "xPosition": { - "description": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n", + "description": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n", "type": "string" }, "xPositionMetadata": { @@ -33551,7 +44829,7 @@ "description": "Metadata that indicates whether the `xPosition` property is editable." }, "yPosition": { - "description": "This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.", + "description": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n", "type": "string" }, "yPositionMetadata": { @@ -33559,948 +44837,901 @@ "description": "Metadata that indicates whether the `yPosition` property is editable." } }, - "x-ds-definition-name": "firstName", - "description": "A tab that displays the recipient's first name. This tab\ntakes the recipient's name as entered in the recipient\ninformation, splits it into sections based on spaces and\nuses the first section as the first name.\n", - "x-ms-summary": "A tab that displays the recipient's first name. This tab\ntakes the recipient's name as entered in the recipient\ninformation, splits it into sections based on spaces and\nuses the first section as the first name.\n" + "x-ds-definition-name": "list", + "description": "This tab offers a list of options to choose from.\nThe `listItems`\nproperty contains a list of\n[`listItem`](https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/)\nobjects to specify the selectable options.\n", + "x-ms-summary": "This tab offers a list of options to choose from.\nThe `listItems`\nproperty contains a list of\n[`listItem`](https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/)\nobjects to specify the selectable options.\n" }, - "folder": { + "listCustomField": { "type": "object", "properties": { + "configurationType": { + "description": "If you are using merge fields, this property specifies the type of the merge field. The only supported value is `salesforce`.", + "type": "string" + }, "errorDetails": { "$ref": "#/definitions/errorDetails", "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." }, - "filter": { - "$ref": "#/definitions/filter", - "description": "" - }, - "folderId": { - "description": "Unique identifier for the folder.", + "fieldId": { + "description": "The id of the custom field.", "type": "string" }, - "folderItems": { - "description": "A list of the envelopes in the specified folder or folders. ", + "listItems": { + "description": "An array of strings that represents the options in a list.\n\nMaximum length: 2048 characters, but each individual option string can only be a maximum of 100 characters.", "type": "array", "items": { - "$ref": "#/definitions/folderItem_v2" + "type": "string" } }, - "folders": { - "description": "A collection of folder objects returned in a response.", - "type": "array", - "items": { - "$ref": "#/definitions/folder" - } + "name": { + "description": "The name of the custom field.", + "type": "string" }, - "hasAccess": { + "required": { + "description": "When set to **true**, senders are required to select an option from the list before they can send the envelope.", + "type": "string" + }, + "show": { + "description": "When set to **true**, the field displays in the **Envelope Custom Fields** section when a user creates or sends an envelope.", + "type": "string" + }, + "value": { + "description": "The value of the custom field. This is the value that the user who creates or sends the envelope selects from the list.", + "type": "string" + } + }, + "x-ds-definition-name": "listCustomField", + "description": "This object represents a list custom field from which envelope creators and senders can select custom data.", + "x-ms-summary": "This object represents a list custom field from which envelope creators and senders can select custom data." + }, + "listItem": { + "type": "object", + "properties": { + "selected": { + "description": "When set to **true**, indicates that this item is the default selection shown to a signer. \n\nOnly one selection can be set as the default.", + "type": "string" + }, + "selectedMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `selected` property is editable." + }, + "text": { + "description": "Specifies the text that is shown in the dropdown list. ", + "type": "string" + }, + "textMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "" + }, + "value": { + "description": "Specifies the value that is used when the list item is selected.", + "type": "string" + }, + "valueMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `value` property is editable." + } + }, + "x-ds-definition-name": "listItem", + "description": "One of the selectable items\nin the `listItems` property\nof a [`list`](https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/) tab.", + "x-ms-summary": "One of the selectable items\nin the `listItems` property\nof a [`list`](https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/) tab." + }, + "localePolicy": { + "type": "object", + "properties": { + "addressFormat": { "description": "", "type": "string" }, - "hasSubFolders": { + "addressFormatMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "" + }, + "allowRegion": { "description": "", "type": "string" }, - "itemCount": { + "calendarType": { "description": "", "type": "string" }, - "name": { + "calendarTypeMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "" + }, + "cultureName": { "description": "", "type": "string" }, - "owner": { - "$ref": "#/definitions/userInfo", + "cultureNameMetadata": { + "$ref": "#/definitions/settingsMetadata", "description": "" }, - "parentFolderId": { + "currencyCode": { + "description": "The currency code for the account, based on the [ISO 4217 currency code](https://www.iso.org/iso-4217-currency-codes.html).", + "type": "string" + }, + "currencyCodeMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `currencyCode` property is editable." + }, + "currencyNegativeFormat": { "description": "", "type": "string" }, - "parentFolderUri": { + "currencyNegativeFormatMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "" + }, + "currencyPositiveFormat": { "description": "", "type": "string" }, - "subFolderCount": { + "currencyPositiveFormatMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "" + }, + "customDateFormat": { "description": "", "type": "string" }, - "type": { - "description": "Type of user:\n- `type_owner`\n- `type_participant`", + "customSignDateFormat": { + "description": "", "type": "string" }, - "uri": { - "description": "URI containing the user ID.", + "customSignTimeFormat": { + "description": "", "type": "string" - } - }, - "x-ds-definition-name": "folder", - "description": "", - "x-ms-summary": "" - }, - "folderItem_v2": { - "type": "object", - "properties": { - "completedDateTime": { - "description": "Specifies the date and time this item was completed.", + }, + "customTimeFormat": { + "description": "", + "type": "string" + }, + "dateFormat": { + "description": "", "type": "string" }, - "createdDateTime": { - "description": "The date and time the item was created.", + "dateFormatMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "" + }, + "effectiveAddressFormat": { + "description": "", "type": "string" }, - "envelopeId": { - "description": "The envelope ID of the envelope status that failed to post.", + "effectiveCalendarType": { + "description": "", "type": "string" }, - "envelopeUri": { - "description": "URI that you can use to retrieve the bulk envelopes.", + "effectiveCurrencyCode": { + "description": "", "type": "string" }, - "expireDateTime": { - "description": "The date and time the envelope is set to expire.", + "effectiveCurrencyNegativeFormat": { + "description": "", "type": "string" }, - "folderId": { - "description": "Unique identifier for the folder.", + "effectiveCurrencyPositiveFormat": { + "description": "", "type": "string" }, - "folderUri": { + "effectiveCustomDateFormat": { "description": "", "type": "string" }, - "is21CFRPart11": { - "description": "When **true**, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).", + "effectiveCustomTimeFormat": { + "description": "", "type": "string" }, - "ownerName": { + "effectiveDateFormat": { "description": "", "type": "string" }, - "recipients": { - "$ref": "#/definitions/EnvelopeRecipients", - "description": "An array of recipient objects that provides details about the recipients of the envelope." + "effectiveInitialFormat": { + "description": "", + "type": "string" }, - "recipientsUri": { - "description": "Contains a URI for an endpoint that you can use to retrieve the recipients.", + "effectiveNameFormat": { + "description": "", "type": "string" }, - "senderCompany": { + "effectiveTimeFormat": { "description": "", "type": "string" }, - "senderEmail": { + "effectiveTimeZone": { "description": "", "type": "string" }, - "senderName": { + "initialFormat": { "description": "", "type": "string" }, - "senderUserId": { + "initialFormatMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "" + }, + "nameFormat": { "description": "", "type": "string" }, - "sentDateTime": { - "description": "The date and time the envelope was sent.", + "nameFormatMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "" + }, + "signDateFormat": { + "description": "The format for the signature date. Valid values are:\n\n- `d/M/yyyy`\n- `dd-MM-yy`\n- `dd-MMM-yy`\n- `dd-MM-yyyy`\n- `dd.MM.yyyy`\n- `dd-MMM-yyyy`\n- `dd MMMM yyyy`\n- `M/d/yyyy`\n- `MM-dd-yyyy`\n- `MM/dd/yyyy`\n- `MM/dd/yy`\n- `MMM-dd-yyyy`\n- `MMM d, yyyy`\n- `MMMM d, yyyy`\n- `yyyy-MM-dd`\n- `yyyy-MMM-dd`\n- `yyyy/MM/dd`\n- `yyyy MMMM d`\n\n**Note**: Only Admin users can change this setting.\n", "type": "string" }, - "status": { - "description": "The status of the item.", + "signDateFormatMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `signDateFormat` property is editable.\n" + }, + "signTimeFormat": { + "description": "The format for the signature time. Valid values are:\n\n- `none`\n- `HH:mm`\n- `h:mm`\n- `HH:mm:ss`\n- `h:mm:ss`\n", "type": "string" }, - "subject": { + "signTimeFormatMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `signTimeFormat` property is editable.\n" + }, + "timeFormat": { "description": "", "type": "string" }, - "templateId": { - "description": "The ID of the template.", - "type": "string" + "timeFormatMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "" }, - "templateUri": { + "timeZone": { "description": "", "type": "string" + }, + "timeZoneMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "" } }, - "x-ds-definition-name": "folderItem_v2", - "description": "Information about folder item results.", - "x-ms-summary": "Information about folder item results." + "x-ds-definition-name": "localePolicy", + "description": "", + "x-ms-summary": "" }, - "folderItemResponse": { + "localePolicyTab": { "type": "object", "properties": { - "endPosition": { - "description": "The last position in the result set. ", + "addressFormat": { + "description": "", "type": "string" }, - "folderItems": { - "description": "A list of the envelopes in the specified folder or folders. ", - "type": "array", - "items": { - "$ref": "#/definitions/folderItem_v2" - } - }, - "nextUri": { - "description": "The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. ", + "calendarType": { + "description": "", "type": "string" }, - "previousUri": { - "description": "The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. ", + "cultureName": { + "description": "", "type": "string" }, - "resultSetSize": { - "description": "The number of results returned in this response. Because you can filter which entries are included in the response, this value is always less than or equal to `totalSetSize`.", + "currencyCode": { + "description": "The currency code for the account, based on the [ISO 4217 currency code](https://www.iso.org/iso-4217-currency-codes.html).", "type": "string" }, - "startPosition": { - "description": "The starting position of the current result set.", + "currencyNegativeFormat": { + "description": "", "type": "string" }, - "totalRows": { - "description": "The total number of items in the result.", - "type": "string" - } - }, - "x-ds-definition-name": "folderItemResponse", - "description": "Results from a folder item request.", - "x-ms-summary": "Results from a folder item request." - }, - "folderItemsResponse": { - "type": "object", - "properties": { - "endPosition": { - "description": "The last position in the result set. ", + "currencyPositiveFormat": { + "description": "", "type": "string" }, - "envelopes": { - "description": "An array containing PowerForm data.", - "type": "array", - "items": { - "$ref": "#/definitions/envelopeSummary" - } + "customDateFormat": { + "description": "", + "type": "string" }, - "folders": { - "description": "A collection of folder objects returned in a response.", - "type": "array", - "items": { - "$ref": "#/definitions/folder" - } + "customTimeFormat": { + "description": "", + "type": "string" }, - "nextUri": { - "description": "The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. ", + "dateFormat": { + "description": "", "type": "string" }, - "previousUri": { - "description": "The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. ", + "initialFormat": { + "description": "", "type": "string" }, - "resultSetSize": { - "description": "The number of results returned in this response. Because you can filter which entries are included in the response, this value is always less than or equal to `totalSetSize`.", + "nameFormat": { + "description": "", "type": "string" }, - "startPosition": { - "description": "The starting position of the current result set.", + "timeFormat": { + "description": "", "type": "string" }, - "totalSetSize": { - "description": "The total number of items in the search's result set. This value is always greater than or equal to the value of `resultSetSize`.", + "timeZone": { + "description": "", "type": "string" } }, - "x-ds-definition-name": "folderItemsResponse", + "x-ds-definition-name": "localePolicyTab", "description": "", "x-ms-summary": "" }, - "folderSharedItem": { + "lockInformation": { "type": "object", "properties": { "errorDetails": { "$ref": "#/definitions/errorDetails", "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." }, - "folderId": { - "description": "Unique identifier for the folder.", + "lockDurationInSeconds": { + "description": "The number of seconds to lock the envelope for editing. This value must be greater than `0` seconds.", "type": "string" }, - "name": { - "description": "The folder name.", + "lockedByApp": { + "description": "The human-readable name of the application that is locking the envelope or template. This value displays to the user in error messages when lock conflicts occur.", "type": "string" }, - "owner": { + "lockedByUser": { "$ref": "#/definitions/userInfo", - "description": "Information about the user who owns the folder." + "description": "A complex type containing information about the user that has the envelope or template locked." }, - "parentFolderId": { - "description": "Unique identifier for the parent folder.", + "lockedUntilDateTime": { + "description": "The date and time that the lock expires.", "type": "string" }, - "parentFolderUri": { - "description": "URI for the parent folder.", + "lockToken": { + "description": "A unique identifier provided to the owner of the lock. You must use this token with subsequent calls to prove ownership of the lock.", "type": "string" }, - "shared": { - "description": "How the folder is shared. One of:\n\n- `not_shared`\n- `shared_to`\n- `shared_from`\n- `shared_to_and_from`", + "lockType": { + "description": "The type of lock. Currently `edit` is the only supported type.", "type": "string" }, - "sharedGroups": { - "description": "List of groups that share the folder.", - "type": "array", - "items": { - "$ref": "#/definitions/memberGroupSharedItem" - } - }, - "sharedUsers": { - "description": "List of users that share the folder.", - "type": "array", - "items": { - "$ref": "#/definitions/userSharedItem" - } - }, - "uri": { - "description": "URI containing the user ID.", + "useScratchPad": { + "description": "When set to **true**, a scratchpad is used to edit information.\n ", "type": "string" - }, - "user": { - "$ref": "#/definitions/userInfo", - "description": "Information about the user associated with the folder." } }, - "x-ds-definition-name": "folderSharedItem", + "x-ds-definition-name": "lockInformation", "description": "", "x-ms-summary": "" }, - "foldersRequest": { + "lockRequest": { "type": "object", "properties": { - "envelopeIds": { - "description": "A comma-separated list of envelope IDs.", - "type": "array", - "items": { - "type": "string" - } + "lockDurationInSeconds": { + "description": "The number of seconds to lock the envelope for editing. Must be greater than 0 seconds.", + "type": "string" }, - "folders": { - "description": "A collection of folder objects returned in a response.", - "type": "array", - "items": { - "$ref": "#/definitions/folder" - } + "lockedByApp": { + "description": "A friendly name of the application used to lock the envelope. Will be used in error messages to the user when lock conflicts occur.", + "type": "string" }, - "fromFolderId": { - "description": " The folder ID the envelope is being moved from.", + "lockType": { + "description": "The type of lock. Currently `edit` is the only supported type.", + "type": "string" + }, + "templatePassword": { + "description": "The [password for the template](https://support.docusign.com/en/guides/ndse-user-guide-template-passwords). If you are using a lock for a template that has a password or an envelope that is based on a template that has a password, you must enter the `templatePassword` to save the changes.", + "type": "string" + }, + "useScratchPad": { + "description": "When set to **true**, a scratchpad is used to edit information.\n ", "type": "string" } }, - "x-ds-definition-name": "foldersRequest", - "description": "Information for a folder request.", - "x-ms-summary": "Information for a folder request." + "x-ds-definition-name": "lockRequest", + "description": "This request object contains information about the lock that you want to create or update.", + "x-ms-summary": "This request object contains information about the lock that you want to create or update." }, - "foldersResponse": { + "loginAccount": { "type": "object", "properties": { - "endPosition": { - "description": "The last position in the result set. ", + "accountId": { + "description": "The account ID associated with the envelope.", "type": "string" }, - "envelopes": { - "description": "An array containing PowerForm data.", + "accountIdGuid": { + "description": "The GUID associated with the account ID.", + "type": "string" + }, + "baseUrl": { + "description": "The URL that should be used for successive calls to this account. It includes the protocal (https), the DocuSign server where the account is located, and the account number. Use this Url to make API calls against this account. Many of the API calls provide Uri's that are relative to this baseUrl.", + "type": "string" + }, + "email": { + "description": "The email address for the user.", + "type": "string" + }, + "isDefault": { + "description": "This value is true if this is the default account for the user, otherwise false is returned.", + "type": "string" + }, + "loginAccountSettings": { + "description": "A list of settings on the acccount that indicate what features are available.", "type": "array", "items": { - "$ref": "#/definitions/envelopeSummary" + "$ref": "#/definitions/nameValue" } }, - "folders": { - "description": "A collection of folder objects returned in a response.", + "loginUserSettings": { + "description": "A list of user-level settings that indicate what user-specific features are available.", "type": "array", "items": { - "$ref": "#/definitions/folder" + "$ref": "#/definitions/nameValue" } }, - "nextUri": { - "description": "The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. ", - "type": "string" - }, - "previousUri": { - "description": "The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. ", + "name": { + "description": "The name associated with the account.", "type": "string" }, - "resultSetSize": { - "description": "The number of results returned in this response. Because you can filter which entries are included in the response, this value is always less than or equal to `totalSetSize`.", + "siteDescription": { + "description": "An optional descirption of the site that hosts the account.", "type": "string" }, - "startPosition": { - "description": "The starting position of the current result set.", + "userId": { + "description": "The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.\n", "type": "string" }, - "totalSetSize": { - "description": "The total number of items in the search's result set. This value is always greater than or equal to the value of `resultSetSize`.", + "userName": { + "description": "The name of this user as defined by the account.", "type": "string" } }, - "x-ds-definition-name": "foldersResponse", + "x-ds-definition-name": "loginAccount", "description": "", "x-ms-summary": "" }, - "forgottenPasswordInformation": { - "description": "A complex element that has up to four Question/Answer pairs for forgotten password information.", + "loginInformation": { "type": "object", "properties": { - "forgottenPasswordAnswer1": { - "description": "The answer to the first forgotten password challenge question.", - "type": "string" - }, - "forgottenPasswordAnswer2": { - "description": "The answer to the second forgotten password challenge question.", - "type": "string" - }, - "forgottenPasswordAnswer3": { - "description": "The answer to the third forgotten password challenge question.", + "apiPassword": { + "description": "Contains a token that can be used for authentication in API calls instead of using the user name and password.", "type": "string" }, - "forgottenPasswordAnswer4": { - "description": "The answer to the fourth forgotten password challenge question.", + "loginAccounts": { + "description": "The list of accounts that authenticating user is a member of.", + "type": "array", + "items": { + "$ref": "#/definitions/loginAccount" + } + } + }, + "x-ds-definition-name": "loginInformation", + "description": "", + "x-ms-summary": "" + }, + "matchBox": { + "type": "object", + "properties": { + "height": { + "description": "The height of the tab in pixels.", "type": "string" }, - "forgottenPasswordQuestion1": { - "description": "The first challenge question presented to a user who has forgotten their password.", + "pageNumber": { + "description": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n", "type": "string" }, - "forgottenPasswordQuestion2": { - "description": "The second challenge question presented to a user who has forgotten their password.", + "width": { + "description": "The width of the tab in pixels.", "type": "string" }, - "forgottenPasswordQuestion3": { - "description": "The third challenge question presented to a user who has forgotten their password.", + "xPosition": { + "description": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n", "type": "string" }, - "forgottenPasswordQuestion4": { - "description": "The fourth challenge question presented to a user who has forgotten their password.", + "yPosition": { + "description": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n", "type": "string" } }, - "x-ds-definition-name": "forgottenPasswordInformation", - "x-ms-summary": "A complex element that has up to four Question/Answer pairs for forgotten password information." + "x-ds-definition-name": "matchBox", + "description": "", + "x-ms-summary": "" }, - "formDataItem": { + "memberGroupSharedItem": { "type": "object", "properties": { "errorDetails": { "$ref": "#/definitions/errorDetails", "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." }, - "listSelectedValue": { - "description": "The selected value in a list.", - "type": "string" - }, - "name": { - "description": "The name of the form field.", - "type": "string" - }, - "originalValue": { - "description": "The initial value associated with the form field.", - "type": "string" + "group": { + "$ref": "#/definitions/group", + "description": "The group sharing the item." }, - "value": { - "description": "The current value associated with the form field.", + "shared": { + "description": "How the item is shared. One of:\n\n\n- `not_shared`: The item is not shared.\n\n- `shared_to`: The item is shared.", "type": "string" } }, - "x-ds-definition-name": "formDataItem", - "description": "", - "x-ms-summary": "" + "x-ds-definition-name": "memberGroupSharedItem", + "description": "Information about items shared among groups.", + "x-ms-summary": "Information about items shared among groups." }, - "formulaTab": { + "memberSharedItems": { "type": "object", "properties": { - "anchorCaseSensitive": { - "description": "Reserved for DocuSign.\n", - "type": "string" - }, - "anchorCaseSensitiveMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." - }, - "anchorHorizontalAlignment": { - "description": "Reserved for DocuSign.\n\n", - "type": "string" - }, - "anchorHorizontalAlignmentMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." - }, - "anchorIgnoreIfNotPresent": { - "description": "When set to **true**, this tab is ignored if the `anchorString` is not found in the document.", - "type": "string" - }, - "anchorIgnoreIfNotPresentMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable." - }, - "anchorMatchWholeWord": { - "description": "Reserved for DocuSign.\n\n", - "type": "string" - }, - "anchorMatchWholeWordMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." - }, - "anchorString": { - "description": "Specifies the string to find in the document and use as the basis for tab placement.", - "type": "string" - }, - "anchorStringMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `anchorString` property is editable." - }, - "anchorTabProcessorVersion": { - "description": "Reserved for DocuSign.", - "type": "string" - }, - "anchorTabProcessorVersionMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." - }, - "anchorUnits": { - "description": "Specifies the units of the X and Y offset. Units may be pixels, millimeters, centimeters, or inches.", - "type": "string" - }, - "anchorUnitsMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `anchorUnits` property is editable." - }, - "anchorXOffset": { - "description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.", - "type": "string" - }, - "anchorXOffsetMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `anchorXOffset` property is editable." - }, - "anchorYOffset": { - "description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.", - "type": "string" - }, - "anchorYOffsetMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `anchorYOffset` property is editable." - }, - "bold": { - "description": "When set to **true**, the information in the tab is bold.", - "type": "string" - }, - "boldMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `bold` property is editable." - }, - "concealValueOnDocument": { - "description": "When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender.\n\nWhen an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.", - "type": "string" - }, - "concealValueOnDocumentMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `concealValueOnDocument` property is editable." - }, - "conditionalParentLabel": { - "description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility.", - "type": "string" - }, - "conditionalParentLabelMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `conditionalParentLabel` property is editable." - }, - "conditionalParentValue": { - "description": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use \"on\" as the value to show that the parent tab is active.\n", - "type": "string" - }, - "conditionalParentValueMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `conditionalParentValue` property is editable." - }, - "customTabId": { - "description": "The DocuSign-generated custom tab id for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.", - "type": "string" - }, - "customTabIdMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `customTabId` property is editable." - }, - "disableAutoSize": { - "description": "When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes.", - "type": "string" - }, - "disableAutoSizeMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `disableAutoSize` property is editable." - }, - "documentId": { - "description": "Integer that identifies the document in the envelope.", - "type": "string" - }, - "documentIdMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `documentId` property is editable." + "envelopes": { + "description": "List of information about shared envelopes.", + "type": "array", + "items": { + "$ref": "#/definitions/sharedItem" + } }, "errorDetails": { "$ref": "#/definitions/errorDetails", "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." }, - "font": { - "description": "The font to be used for the tab value. Supported fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n", - "type": "string" - }, - "fontColor": { - "description": "The font color to use for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n", - "type": "string" - }, - "fontColorMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `fontColor` property is editable." + "folders": { + "description": "List of information about shared folders.", + "type": "array", + "items": { + "$ref": "#/definitions/folderSharedItem" + } }, - "fontMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `font` property is editable." + "templates": { + "description": "List of information about shared templates.", + "type": "array", + "items": { + "$ref": "#/definitions/templateSharedItem" + } }, - "fontSize": { - "description": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72", + "user": { + "$ref": "#/definitions/userInfo", + "description": "Information about the user requesting sharing information." + } + }, + "x-ds-definition-name": "memberSharedItems", + "description": "Information about shared items.", + "x-ms-summary": "Information about shared items." + }, + "mergeField": { + "description": "Contains information for transfering values between Salesforce data fields and DocuSign Tabs.", + "type": "object", + "properties": { + "allowSenderToEdit": { + "description": "When **true**, the sender can modify the value of the `mergeField` tab during the sending process.", "type": "string" }, - "fontSizeMetadata": { + "allowSenderToEditMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `fontSize` property is editable." + "description": "Metadata that indicates if the sender can edit the `allowSenderToEdit` property." }, - "formOrder": { - "description": "An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block.", + "configurationType": { + "description": "If you are using merge fields, this property specifies the type of the merge field. The only supported value is `salesforce`.", "type": "string" }, - "formOrderMetadata": { + "configurationTypeMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `formOrder` property is editable." + "description": "Metadata that indicates if the sender can edit the `configurationType` property." }, - "formPageLabel": { - "description": "A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience.", + "path": { + "description": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.", "type": "string" }, - "formPageLabelMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `formPageLabel` property is editable." - }, - "formPageNumber": { - "description": "An integer specifying the order in which to present the guided form pages.", - "type": "string" + "pathExtended": { + "description": "Reserved for DocuSign.", + "type": "array", + "items": { + "$ref": "#/definitions/pathExtendedElement" + } }, - "formPageNumberMetadata": { + "pathExtendedMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `fromPageNumber` property is editable." - }, - "formula": { - "description": "Contains the formula\nfor calculating the value of\nthis tab.\n\nUse a tab's `tabLabel`,\nenclosed in brackets,\nto refer to it.\n\nFor example,\nyou want to present the total cost\nof two items, tax included.\n\nThe cost of each item is stored\nin number tabs labeled Item1 and Item2.\nThe tax rate is in a number tab\nlabeled TaxRate.\n\nThe formula string for this property\nwould be:\n`([Item1] + [Item2]) * (1 + [TaxRate])`\n\nSee [Calculated Fields][calculatedfields]\nin the DocuSign Support Center\nto learn more about formulas.\n\nMaximum Length: 2000 characters\n\n[calculatedfields]: https://support.docusign.com/en/guides/ndse-user-guide-calculated-fields\n", - "type": "string" + "description": "Reserved for DocuSign." }, - "formulaMetadata": { + "pathMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata indicating if the sender can edit the `formula` property." + "description": "Metadata that indicates whether the `path` property is editable.\n" }, - "height": { - "description": "The height of the tab in pixels.", + "row": { + "description": "Specifies the row number in a Salesforce table that the merge field value corresponds to.", "type": "string" }, - "heightMetadata": { + "rowMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `height` property is editable." + "description": "Metadata that indicates whether the `row` property is editable.\n" }, - "hidden": { - "description": "If this is a regular formula (no `paymentDetails` property is present):\n\n* **true**: The tab is hidden.\n* **false**: The tab is shown.\n\nIf the formula is payment item (a `paymentDetails` property is present):\n\n* **true**: The tab is displayed as a payment.\n* **false**: The tab is displayed as a regular formula.\n", + "writeBack": { + "description": "When **true**, data entered into the merge field during Signing will update the mapped Salesforce field.", "type": "string" }, - "hiddenMetadata": { + "writeBackMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `hidden` property is editable." - }, - "isPaymentAmount": { - "description": "When set to **true**, sets this as a payment tab. Can only be used with Text, Number, Formula, or List tabs. The value of the tab must be a number. ", + "description": "Metadata that indicates if the sender can edit the `writeBack` property." + } + }, + "x-ds-definition-name": "mergeField", + "x-ms-summary": "Contains information for transfering values between Salesforce data fields and DocuSign Tabs." + }, + "mobileNotifierConfiguration": { + "type": "object", + "properties": { + "deviceId": { + "description": "", "type": "string" }, - "isPaymentAmountMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `isPaymentAmount` property is editable." + "errorDetails": { + "$ref": "#/definitions/errorDetails", + "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." }, - "italic": { - "description": "When set to **true**, the information in the tab is italic.", + "platform": { + "description": "The Platform of the client application", "type": "string" - }, - "italicMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `italic` property is editable." - }, - "localePolicy": { - "$ref": "#/definitions/localePolicyTab", - "description": "Reserved for DocuSign." - }, - "locked": { - "description": "When set to **true**, the signer cannot change the data of the custom tab.", + } + }, + "x-ds-definition-name": "mobileNotifierConfiguration", + "description": "", + "x-ms-summary": "" + }, + "mobileNotifierConfigurationInformation": { + "type": "object", + "properties": { + "mobileNotifierConfigurations": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/mobileNotifierConfiguration" + } + } + }, + "x-ds-definition-name": "mobileNotifierConfigurationInformation", + "description": "", + "x-ms-summary": "" + }, + "money": { + "type": "object", + "properties": { + "amountInBaseUnit": { + "description": "The total payment amount\nin the currency's base unit.\nFor example, for USD\nthe base currency is one cent.\n", "type": "string" }, - "lockedMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `locked` property is editable." - }, - "maxLength": { - "description": "An optional value that describes the maximum length of the property when the property is a string.", + "currency": { + "description": "The three-letter\n[ISO 4217][ISO4217] currency code for the payment.\n\nFor example:\n\n* AUD Australian dollar\n* CAD Canadian dollar\n* EUR Euro\n* GBP Great Britain pound\n* USD United States dollar\n\nThis is a read-only property.\n\n[ISO4217]: https://en.wikipedia.org/wiki/ISO_4217\n", "type": "string" }, - "maxLengthMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `maxLength` property is editable." - }, - "mergeField": { - "$ref": "#/definitions/mergeField", - "description": "Contains the information necessary to map the tab to a field in SalesForce." + "displayAmount": { + "description": "The payment amount as displayed\nin the `currency`.\n\nFor example, if the payment amount\nis USD 12.59,\nthe `amountInBaseUnit` is 1259 (cents),\nand the displayed amount is `$12.59 USD`.\n\nThis is a read-only property.\n", + "type": "string" + } + }, + "x-ds-definition-name": "money", + "description": "Describes information\nabout the `total` of a payment.\n", + "x-ms-summary": "Describes information\nabout the `total` of a payment.\n" + }, + "nameValue": { + "type": "object", + "properties": { + "errorDetails": { + "$ref": "#/definitions/errorDetails", + "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." }, "name": { - "description": "The name of the tab. For example, `Sign Here` or `Initial Here`.", + "description": "The name of the item.", "type": "string" }, - "nameMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `name` property is editable." - }, "originalValue": { - "description": "The initial value of the tab when it was sent to the recipient. ", - "type": "string" - }, - "originalValueMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `originalValue` property is editable." - }, - "pageNumber": { - "description": "The page number on which the tab is located. For supplemental documents, this value must be `1`.\n", + "description": "The initial value of the item.", "type": "string" }, - "pageNumberMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `pageNumber` property is editable." - }, - "paymentDetails": { - "$ref": "#/definitions/paymentDetails", - "description": "This property indicates \nthat this formula tab \nis a payment item. \nSee [Requesting Payments Along with Signatures][paymentguide] \nin the DocuSign Support Center \nto learn more about payments. \n\n[paymentguide]: https://support.docusign.com/en/guides/requesting-payments-along-with-signatures\n" - }, - "recipientId": { - "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", + "value": { + "description": "The current value of the item.", "type": "string" - }, - "recipientIdGuid": { - "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one.", + } + }, + "x-ds-definition-name": "nameValue", + "description": "A name-value pair that describes an item and provides a value for the item.", + "x-ms-summary": "A name-value pair that describes an item and provides a value for the item." + }, + "newAccountDefinition": { + "type": "object", + "properties": { + "accountName": { + "description": "The account name for the new account.", "type": "string" }, - "recipientIdGuidMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `recipientIdGuid` property is editable." + "accountSettings": { + "$ref": "#/definitions/accountSettingsInformation", + "description": "The list of\naccount settings accountsettings\nthat determine\nthe features available for the account.\nNote that some features are determined\nby the plan used to create the account and cannot be overridden.\n\n" }, - "recipientIdMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `recipientId` property is editable." + "addressInformation": { + "$ref": "#/definitions/accountAddress", + "description": "A complex type that contains the following information for the new account: `Street1`, `Street2`, `City`, `State`, `Zip`, `Phone`, and `Fax`." }, - "requireAll": { - "description": "When set to **true** and shared is true, information must be entered in this field to complete the envelope. ", - "type": "string" + "creditCardInformation": { + "$ref": "#/definitions/creditCardInformation", + "description": "A complex type that has information about the credit card used to pay for this account." }, - "requireAllMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `requireAll` property is editable." + "directDebitProcessorInformation": { + "$ref": "#/definitions/directDebitProcessorInformation", + "description": "Information about the bank that processes direct debits for the payment plan." }, - "required": { - "description": "When set to **true**, the signer is required to fill out this tab.", + "distributorCode": { + "description": "The Distributor Code that you received from DocuSign.", "type": "string" }, - "requiredMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `required` property is editable." - }, - "requireInitialOnSharedChange": { - "description": "Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.", + "distributorPassword": { + "description": "The password for the `distributorCode`.", "type": "string" }, - "requireInitialOnSharedChangeMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `requireInitialOnSharedChange` property is editable." - }, - "roundDecimalPlaces": { - "description": "The number of decimal places to round to.", + "envelopePartitionId": { + "description": "Reserved for DocuSign.", "type": "string" }, - "roundDecimalPlacesMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `roundDecimalPlaces` property is editable." + "initialUser": { + "$ref": "#/definitions/userInformation", + "description": "A complex type with the initial user information for the new account. Note that some user information is set internally based on the plan and cannot be overridden." }, - "senderRequired": { - "description": "When set to **true**, the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope.", + "paymentMethod": { + "description": "The payment method used for the billing plan. Valid values are:\n\n- `NotSupported`\n- `CreditCard`\n- `PurchaseOrder`\n- `Premium`\n- `Freemium`\n- `FreeTrial`\n- `AppStore`\n- `DigitalExternal`\n- `DirectDebit`", "type": "string" }, - "senderRequiredMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `senderRequired` property is editable." + "paymentProcessorInformation": { + "$ref": "#/definitions/paymentProcessorInformation", + "description": "Information about the entity that processes payments for the billing plan." }, - "shared": { - "description": "When set to **true**, this custom tab is shared.", - "type": "string" + "planInformation": { + "$ref": "#/definitions/planInformation", + "description": "An object used to identify the features and attributes of the account being created." }, - "sharedMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `shared` property is editable." + "referralInformation": { + "$ref": "#/definitions/referralInformation", + "description": "A complex type that contains properties for entering referral and discount information." }, - "status": { - "description": "The status of the tab. Possible values are:\n\n- `active`: The tab is active, but the recipient has not yet interacted with it.\n- `signed`: The recipient signed the tab.\n- `declined`: The recipient declined the envelope.\n- `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`).", + "socialAccountInformation": { + "$ref": "#/definitions/socialAccountInformation", + "description": "Contains properties that map a DocuSign user to a social account such as Facebook or Yahoo." + } + }, + "x-ds-definition-name": "newAccountDefinition", + "description": "", + "x-ms-summary": "" + }, + "newAccountSummary": { + "type": "object", + "properties": { + "accountId": { + "description": "The account ID associated with the envelope.", "type": "string" }, - "statusMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `status` property is editable." - }, - "tabGroupLabels": { - "description": "An array of tab group labels that uniquely identify tab groups. To assign a tab to a `tabGroup`, you assign the `TabGroupLabel` to the `Tab.TabGroupLabels` array.", - "type": "array", - "items": { - "type": "string" - } - }, - "tabGroupLabelsMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `tabGroupLabels` property is editable." - }, - "tabId": { - "description": "The unique identifier for the tab.", + "accountIdGuid": { + "description": "The GUID associated with the account ID.", "type": "string" }, - "tabIdMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `tabId` property is editable." - }, - "tabLabel": { - "description": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n", + "accountName": { + "description": "The account name for the new account.", "type": "string" }, - "tabLabelMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `tabLabel` property is editable." - }, - "tabOrder": { - "description": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.", + "apiPassword": { + "description": "Contains a token that can be used for authentication in API calls instead of using the user name and password.", "type": "string" }, - "tabOrderMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `tabOrder` property is editable." - }, - "tabType": { - "description": "Indicates the type of tab (for example, `signHere` or `initialHere`).", + "baseUrl": { + "description": "The URL that should be used for successive calls to this account. It includes the protocal (https), the DocuSign server where the account is located, and the account number. Use this Url to make API calls against this account. Many of the API calls provide Uri's that are relative to this baseUrl.", "type": "string" }, - "tabTypeMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `tabType` property is editable." + "billingPlanPreview": { + "$ref": "#/definitions/billingPlanPreview", + "description": "" }, - "templateLocked": { - "description": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ", + "userId": { + "description": "Specifies the user ID of the new user.", "type": "string" - }, - "templateLockedMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `templateLocked` property is editable." - }, - "templateRequired": { - "description": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.", + } + }, + "x-ds-definition-name": "newAccountSummary", + "description": "", + "x-ms-summary": "" + }, + "newUser": { + "type": "object", + "properties": { + "apiPassword": { + "description": "Contains a token that can be used for authentication in API calls instead of using the user name and password.", "type": "string" }, - "templateRequiredMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `templateRequired` property is editable." - }, - "tooltip": { - "description": "The text of a tooltip that appears when a user hovers over a form field or tab.", + "createdDateTime": { + "description": "The UTC DateTime when the item was created.", "type": "string" }, - "toolTipMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `toolTip` property is editable." - }, - "underline": { - "description": "When set to **true**, the information in the tab is underlined.", + "email": { + "description": "The user's email address.", "type": "string" }, - "underlineMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `underline` property is editable." + "errorDetails": { + "$ref": "#/definitions/errorDetails", + "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." }, - "validationMessage": { - "description": "The message displayed if the custom tab fails input validation (either custom of embedded).", + "membershipId": { + "description": "The user's membership ID.", "type": "string" }, - "validationMessageMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `validationMessage` property is editable." - }, - "validationPattern": { - "description": "A regular expression used to validate input for the tab.", + "permissionProfileId": { + "description": "The ID of the permission profile. Possible values include:\n\n- `2301416` (for the `DocuSign Viewer` profile)\n- `2301415` (for the `DocuSign Sender` profile)\n- `2301414` (for the `Account Administrator` profile)\n\nIn addition, any custom permission profiles associated with your account will have an automatically generated `permissionProfileId`.", "type": "string" }, - "validationPatternMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `validationPattern` property is editable." - }, - "value": { - "description": "Specifies the value of the tab. ", + "permissionProfileName": { + "description": "The name of the account permission profile. \n\nExample: `Account Administrator`", "type": "string" }, - "valueMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `value` property is editable." - }, - "width": { - "description": "The width of the tab in pixels.", + "uri": { + "description": "A URI containing the user ID.", "type": "string" }, - "widthMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `width` property is editable." - }, - "xPosition": { - "description": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n", + "userId": { + "description": "Specifies the user ID for the new user.", "type": "string" }, - "xPositionMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `xPosition` property is editable." - }, - "yPosition": { - "description": "This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.", + "userName": { + "description": "The name of the user.", "type": "string" }, - "yPositionMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `yPosition` property is editable." + "userStatus": { + "description": "Status of the user's account. One of:\n\n- `ActivationRequired`\n- `ActivationSent`\n- `Active`\n- `Closed`\n- `Disabled`\n", + "type": "string" } }, - "x-ds-definition-name": "formulaTab", - "description": "The value of a formula tab is calculated\nfrom the values of other\nnumber or date tabs in the document.\nWhen the recipient completes the underlying fields,\nthe formula tab calculates and displays the result.\n\nThe `formula` property of the tab\ncontains the references\nto the underlying tabs.\nSee [Calculated Fields][calculatedfields]\nin the DocuSign Support Center\nto learn more about formulas.\n\nIf a formula tab contains\na `paymentDetails` property,\nthe tab is considered a payment item.\nSee [Requesting Payments Along with Signatures][paymentguide]\nin the DocuSign Support Center\nto learn more about payments.\n\n[calculatedfields]: https://support.docusign.com/en/guides/ndse-user-guide-calculated-fields\n[paymentguide]: https://support.docusign.com/en/guides/requesting-payments-along-with-signatures\n", - "x-ms-summary": "The value of a formula tab is calculated\nfrom the values of other\nnumber or date tabs in the document.\nWhen the recipient completes the underlying fields,\nthe formula tab calculates and displays the result.\n\nThe `formula` property of the tab\ncontains the references\nto the underlying tabs.\nSee [Calculated Fields][calculatedfields]\nin the DocuSign Support Center\nto learn more about formulas.\n\nIf a formula tab contains\na `paymentDetails` property,\nthe tab is considered a payment item.\nSee [Requesting Payments Along with Signatures][paymentguide]\nin the DocuSign Support Center\nto learn more about payments.\n\n[calculatedfields]: https://support.docusign.com/en/guides/ndse-user-guide-calculated-fields\n[paymentguide]: https://support.docusign.com/en/guides/requesting-payments-along-with-signatures\n" + "x-ds-definition-name": "newUser", + "description": "Object representing a new user.", + "x-ms-summary": "Object representing a new user." }, - "fullName": { + "newUsersDefinition": { + "type": "object", + "properties": { + "newUsers": { + "description": "A list of one or more new users.", + "type": "array", + "items": { + "$ref": "#/definitions/userInformation" + } + } + }, + "x-ds-definition-name": "newUsersDefinition", + "description": "", + "x-ms-summary": "" + }, + "newUsersSummary": { + "type": "object", + "properties": { + "newUsers": { + "description": "A list of one or more new users.", + "type": "array", + "items": { + "$ref": "#/definitions/newUser" + } + } + }, + "x-ds-definition-name": "newUsersSummary", + "description": "Object representing a summary of data for new users.", + "x-ms-summary": "Object representing a summary of data for new users." + }, + "notarize": { "type": "object", "properties": { + "anchorAllowWhiteSpaceInCharacters": { + "description": "", + "type": "string" + }, + "anchorAllowWhiteSpaceInCharactersMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "" + }, "anchorCaseSensitive": { - "description": "Reserved for DocuSign.\n", + "description": "This property controls how [anchor tabs][AnchorTabs] are placed. When **true**, the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false**.\n\nFor example, when set to **true**, if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When set to **false**, `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**.\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place", "type": "string" }, "anchorCaseSensitiveMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "description": "Metadata that indicates whether the `anchorCaseSensitive` property is editable." }, "anchorHorizontalAlignment": { - "description": "Reserved for DocuSign.\n\n", + "description": "This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are :\n\n- `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value.\n- `right`: Aligns the tab’s left side with the last character of the matching anchor word.\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place\n", "type": "string" }, "anchorHorizontalAlignmentMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "description": "Metadata that indicates whether the `anchorHorizontalAlignment` property is editable." }, "anchorIgnoreIfNotPresent": { "description": "When set to **true**, this tab is ignored if the `anchorString` is not found in the document.", @@ -34511,12 +45742,12 @@ "description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable." }, "anchorMatchWholeWord": { - "description": "Reserved for DocuSign.\n\n", + "description": "When set to **true**, the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false**.\n\nFor example, when set to **true**, if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When set to **false**, if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**.\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTab]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place\n", "type": "string" }, "anchorMatchWholeWordMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "description": "Metadata that indicates whether the `anchorMatchWholeWord` property is editable." }, "anchorString": { "description": "Specifies the string to find in the document and use as the basis for tab placement.", @@ -34535,7 +45766,7 @@ "description": "Reserved for DocuSign." }, "anchorUnits": { - "description": "Specifies the units of the X and Y offset. Units may be pixels, millimeters, centimeters, or inches.", + "description": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n", "type": "string" }, "anchorUnitsMetadata": { @@ -34543,7 +45774,7 @@ "description": "Metadata that indicates whether the `anchorUnits` property is editable." }, "anchorXOffset": { - "description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.", + "description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n", "type": "string" }, "anchorXOffsetMetadata": { @@ -34551,21 +45782,13 @@ "description": "Metadata that indicates whether the `anchorXOffset` property is editable." }, "anchorYOffset": { - "description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.", + "description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n", "type": "string" }, "anchorYOffsetMetadata": { "$ref": "#/definitions/propertyMetadata", "description": "Metadata that indicates whether the `anchorYOffset` property is editable." }, - "bold": { - "description": "When set to **true**, the information in the tab is bold.", - "type": "string" - }, - "boldMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `bold` property is editable." - }, "conditionalParentLabel": { "description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility.", "type": "string" @@ -34583,7 +45806,7 @@ "description": "Metadata that indicates whether the `conditionalParentValue` property is editable." }, "customTabId": { - "description": "The DocuSign-generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.", + "description": "The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.", "type": "string" }, "customTabIdMetadata": { @@ -34591,7 +45814,7 @@ "description": "Metadata that indicates whether the `customTabId` property is editable." }, "documentId": { - "description": "Integer that identifies the document in the envelope.", + "description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.", "type": "string" }, "documentIdMetadata": { @@ -34602,30 +45825,6 @@ "$ref": "#/definitions/errorDetails", "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." }, - "font": { - "description": "The font to be used for the tab value. Supported fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n", - "type": "string" - }, - "fontColor": { - "description": "The font color to use for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n", - "type": "string" - }, - "fontColorMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `fontColor` property is editable." - }, - "fontMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `font` property is editable." - }, - "fontSize": { - "description": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72", - "type": "string" - }, - "fontSizeMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `fontSize` property is editable." - }, "formOrder": { "description": "An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block.", "type": "string" @@ -34657,33 +45856,25 @@ "heightMetadata": { "$ref": "#/definitions/propertyMetadata", "description": "Metadata that indicates whether the `height` property is editable." - }, - "italic": { - "description": "When set to **true**, the information in the tab is italic.", + }, + "locked": { + "description": "When set to **true**, the signer cannot change the data of the custom tab.", "type": "string" }, - "italicMetadata": { + "lockedMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `italic` property is editable." - }, - "localePolicy": { - "$ref": "#/definitions/localePolicyTab", - "description": "Reserved for DocuSign." + "description": "Metadata that indicates whether the `locked` property is editable." }, "mergeField": { "$ref": "#/definitions/mergeField", "description": "Contains the information necessary to map the tab to a field in SalesForce." }, - "name": { - "description": "The name of the tab. For example, `Sign Here` or `Initial Here`.", + "mergeFieldXml": { + "description": "", "type": "string" }, - "nameMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `name` property is editable." - }, "pageNumber": { - "description": "The page number on which the tab is located. For supplemental documents, this value must be `1`.\n", + "description": "Specifies the page number on which the tab is located.", "type": "string" }, "pageNumberMetadata": { @@ -34691,11 +45882,11 @@ "description": "Metadata that indicates whether the `pageNumber` property is editable." }, "recipientId": { - "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", + "description": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.", "type": "string" }, "recipientIdGuid": { - "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one.", + "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only.", "type": "string" }, "recipientIdGuidMetadata": { @@ -34706,6 +45897,18 @@ "$ref": "#/definitions/propertyMetadata", "description": "Metadata that indicates whether the `recipientId` property is editable." }, + "required": { + "description": "When set to **true**, the signer is required to fill out this tab.", + "type": "string" + }, + "requiredMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `required` property is editable." + }, + "smartContractInformation": { + "$ref": "#/definitions/smartContractInformation", + "description": "" + }, "status": { "description": "The status of the tab. Possible values are:\n\n- `active`: The tab is active, but the recipient has not yet interacted with it.\n- `signed`: The recipient signed the tab.\n- `declined`: The recipient declined the envelope.\n- `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`).", "type": "string" @@ -34733,14 +45936,6 @@ "$ref": "#/definitions/propertyMetadata", "description": "Metadata that indicates whether the `tabId` property is editable." }, - "tabLabel": { - "description": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n", - "type": "string" - }, - "tabLabelMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `tabLabel` property is editable." - }, "tabOrder": { "description": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.", "type": "string" @@ -34781,22 +45976,6 @@ "$ref": "#/definitions/propertyMetadata", "description": "Metadata that indicates whether the `toolTip` property is editable." }, - "underline": { - "description": "When set to **true**, the information in the tab is underlined.", - "type": "string" - }, - "underlineMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `underline` property is editable." - }, - "value": { - "description": "Specifies the value of the tab. ", - "type": "string" - }, - "valueMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `value` property is editable." - }, "width": { "description": "The width of the tab in pixels.", "type": "string" @@ -34806,7 +45985,7 @@ "description": "Metadata that indicates whether the `width` property is editable." }, "xPosition": { - "description": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n", + "description": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\n", "type": "string" }, "xPositionMetadata": { @@ -34814,7 +45993,7 @@ "description": "Metadata that indicates whether the `xPosition` property is editable." }, "yPosition": { - "description": "This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.", + "description": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\n", "type": "string" }, "yPositionMetadata": { @@ -34822,498 +46001,506 @@ "description": "Metadata that indicates whether the `yPosition` property is editable." } }, - "x-ds-definition-name": "fullName", - "description": "A tab that displays the recipient's full name.\n", - "x-ms-summary": "A tab that displays the recipient's full name.\n" + "x-ds-definition-name": "notarize", + "description": "A tab that alerts notary recipients that\nthey must take action on the page.\nOnly one notarize tab can appear on a page.", + "x-ms-summary": "A tab that alerts notary recipients that\nthey must take action on the page.\nOnly one notarize tab can appear on a page." }, - "graphicsContext": { + "notary": { "type": "object", "properties": { - "fillColor": { - "description": "The fill color to use for the overlay. Colors are typically specified by their RGB hex values, but you can also use a [friendly CSS color name](https://developer.mozilla.org/en-US/docs/Web/CSS/color_value).", + "createdDate": { + "description": "The creation date of the account in UTC timedate format.", "type": "string" }, - "lineColor": { - "description": "The line color to use for the overlay. Colors are typically specified by their RGB hex values, but you can also use a [friendly CSS color name](https://developer.mozilla.org/en-US/docs/Web/CSS/color_value).", + "enabled": { + "description": "The date the this object was created.", "type": "string" }, - "lineWeight": { - "description": "The line weight or thickness to use for the overlay.", + "searchable": { + "description": "If **true**, this notary is searchable.", "type": "string" + }, + "userInfo": { + "$ref": "#/definitions/userInformation", + "description": "Information about the user registering to be a notary." } }, - "x-ds-definition-name": "graphicsContext", + "x-ds-definition-name": "notary", "description": "", "x-ms-summary": "" }, - "group": { + "notaryHost": { "type": "object", "properties": { - "errorDetails": { - "$ref": "#/definitions/errorDetails", - "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." + "accessCode": { + "description": "If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. \n\nMaximum Length: 50 characters and it must conform to the account's access code format setting.\n\nIf blank, but the signer `accessCode` property is set in the envelope, then that value is used.\n\nIf blank and the signer `accessCode` property is not set, then the access code is not required.", + "type": "string" }, - "groupId": { - "description": "The DocuSign group ID for the group.", + "accessCodeMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `accessCode` property is editable. Read only." + }, + "addAccessCodeToEmail": { + "description": "Optional. When set to **true**, the access code will be added to the email sent to the recipient. This nullifies the security measure of `accessCode` on the recipient.", "type": "string" }, - "groupName": { - "description": "The name of the group.", + "allowSystemOverrideForLockedRecipient": { + "description": "", "type": "string" }, - "groupType": { - "description": "The group type. Potential values for POST and PUT requests include:\n\n- `adminstrators`\n- `everyone`\n- `customGroup`\n\n", + "clientUserId": { + "description": "Specifies whether the recipient is embedded or remote. \n\nIf the `clientUserId` property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing.\n\nNote: if the `clientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true**, an error is generated on sending. \n\nMaximum length: 100 characters. ", "type": "string" }, - "permissionProfileId": { - "description": "The ID of the permission profile associated with the group. Possible values include:\n\n- `2301416` (for the `DocuSign Viewer` profile)\n- `2301415` (for the `DocuSign Sender` profile)\n- `2301414` (for the `Account Administrator` profile)", + "completedCount": { + "description": "Indicates the number of times that the recipient has been through a signing completion for the envelope. If this number is greater than 0 for a signing group, only the user who previously completed may sign again. Read only.", "type": "string" }, - "users": { - "description": "A list of the users in the group.", + "customFields": { + "description": "An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters.", "type": "array", "items": { - "$ref": "#/definitions/userInfo" + "type": "string" } }, - "usersCount": { - "description": "The total number of users in the group.", - "type": "string" - } - }, - "x-ds-definition-name": "group", - "description": "Information about groups.", - "x-ms-summary": "Information about groups." - }, - "groupInformation": { - "type": "object", - "properties": { - "endPosition": { - "description": "The last position in the result set. ", + "declinedDateTime": { + "description": "The date and time the recipient declined the document. Read only.", "type": "string" }, - "groups": { - "description": "A collection group objects containing information about the groups.", - "type": "array", - "items": { - "$ref": "#/definitions/group" - } - }, - "nextUri": { - "description": "The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. ", + "declinedReason": { + "description": "The reason the recipient declined the document. Read only.", "type": "string" }, - "previousUri": { - "description": "The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. ", + "deliveredDateTime": { + "description": "The date and time that the envelope was delivered to the recipient. Read only.", "type": "string" }, - "resultSetSize": { - "description": "The number of results returned in this response. Because you can filter which entries are included in the response, this value is always less than or equal to `totalSetSize`.", + "deliveryMethod": { + "description": "Reserved for DocuSign.", "type": "string" }, - "startPosition": { - "description": "The starting position of the current result set.", + "deliveryMethodMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Reserved for DocuSign." + }, + "designatorId": { + "description": "", "type": "string" }, - "totalSetSize": { - "description": "The total number of items in the search's result set. This value is always greater than or equal to the value of `resultSetSize`.", + "designatorIdGuid": { + "description": "", "type": "string" - } - }, - "x-ds-definition-name": "groupInformation", - "description": "", - "x-ms-summary": "" - }, - "idCheckConfiguration": { - "type": "object", - "properties": { - "authSteps": { - "description": "A list of ID check security steps, each specifying an authorization type.", + }, + "documentVisibility": { + "description": "A list of `documentVisibility` objects. Each object in the list specifies whether a document in the envelope is visible to this recipient. For the envelope to use this functionality, Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true**.", "type": "array", "items": { - "$ref": "#/definitions/idCheckSecurityStep" + "$ref": "#/definitions/documentVisibility" } }, - "isDefault": { - "description": "Boolean that specifies whether the signature is the default signature for the user.", - "type": "string" - }, - "name": { - "description": "The name of the signature.", + "email": { + "description": "The notary's email address.\n\nMaximum Length: 100 characters.\n", "type": "string" - } - }, - "x-ds-definition-name": "idCheckConfiguration", - "description": "A complex object specifying ID check configuration.", - "x-ms-summary": "A complex object specifying ID check configuration." - }, - "idCheckInformationInput": { - "description": "A complex element that contains input information related to a recipient ID check.", - "type": "object", - "properties": { - "addressInformationInput": { - "$ref": "#/definitions/addressInformationInput", - "description": "An object that specifies recipient address information and how it is displayed." }, - "dobInformationInput": { - "$ref": "#/definitions/dobInformationInput", - "description": "An object that specifies recipient date of birth information and how it is displayed." + "emailMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `email` property is editable. Read only." }, - "ssn4InformationInput": { - "$ref": "#/definitions/ssn4InformationInput", - "description": "An object that specifies the last four digits of the recipient's Social Security Number (SSN)." + "emailNotification": { + "$ref": "#/definitions/recipientEmailNotification", + "description": "An optional complex type that sets a specific email subject and body for this recipient's notification email. \n\n**Note**: You can set the `emailNotification` property separately for each recipient. If you set the value only for certain recipients, the other recipients will inherit the this value from the top-level `emailSubject` and `emailBlurb`. " }, - "ssn9InformationInput": { - "$ref": "#/definitions/ssn9InformationInput", - "description": "An object that specifies the recipient's Social Security Number (SSN) information. Note that ssn9 information cannot be returned in a response." - } - }, - "x-ds-definition-name": "idCheckInformationInput", - "x-ms-summary": "A complex element that contains input information related to a recipient ID check." - }, - "idCheckSecurityStep": { - "type": "object", - "properties": { - "authType": { - "description": "Type of authorization used for the security check.", - "type": "string" - } - }, - "x-ds-definition-name": "idCheckSecurityStep", - "description": "", - "x-ms-summary": "" - }, - "initialHere": { - "type": "object", - "properties": { - "anchorCaseSensitive": { - "description": "Reserved for DocuSign.\n", + "embeddedRecipientStartURL": { + "description": "Specifies a sender-provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. \n\nIf set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation launched by a partner.\n\nIt is important to understand that in a typical embedded workflow, the authentication of an embedded recipient is the responsibility of the sending application. DocuSign expects that senders will follow their own processes for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process is initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process, bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient.\n\nIf the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: `envelopeId`, `recipientId`, `recipientName`, `recipientEmail`, and `customFields`. The `customFields` property must be set for the recipient or envelope. The merge fields are enclosed in double brackets. \n\n*Example*: \n\n`http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` ", "type": "string" }, - "anchorCaseSensitiveMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "errorDetails": { + "$ref": "#/definitions/errorDetails", + "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." }, - "anchorHorizontalAlignment": { - "description": "Reserved for DocuSign.\n\n", + "faxNumber": { + "description": "Reserved for DocuSign.", "type": "string" }, - "anchorHorizontalAlignmentMetadata": { + "faxNumberMetadata": { "$ref": "#/definitions/propertyMetadata", "description": "Reserved for DocuSign." }, - "anchorIgnoreIfNotPresent": { - "description": "When set to **true**, this tab is ignored if the `anchorString` is not found in the document.", + "hostRecipientId": { + "description": "", "type": "string" }, - "anchorIgnoreIfNotPresentMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable." - }, - "anchorMatchWholeWord": { - "description": "Reserved for DocuSign.\n\n", + "idCheckConfigurationName": { + "description": "The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are:\n\n- `Phone Auth $`: The recipient must authenticate by using two-factor authentication (2FA). You provide the phone number to use for 2FA in the `phoneAuthentication` object.\n- `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object.\n- `ID Check $`: The recipient must answer detailed security questions. \n\n**Example**: Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node.", "type": "string" }, - "anchorMatchWholeWordMetadata": { + "idCheckConfigurationNameMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "description": "Metadata that indicates whether the `idCheckConfigurationName` property is editable. Read only." }, - "anchorString": { - "description": "Specifies the string to find in the document and use as the basis for tab placement.", - "type": "string" + "idCheckInformationInput": { + "$ref": "#/definitions/idCheckInformationInput", + "description": "An object that contains input information related to a recipient ID check." }, - "anchorStringMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `anchorString` property is editable." + "identityVerification": { + "$ref": "#/definitions/recipientIdentityVerification", + "description": "Specifies the ID Verification workflow applied on an envelope by workflow ID.
See the [list](https://developers.docusign.com/docs/esign-rest-api/reference/Accounts/IdentityVerifications/list) method in the [IdentityVerifications](https://developers.docusign.com/docs/esign-rest-api/reference/Accounts/IdentityVerifications) resource for more information on how to retrieve workflow IDs available for an account.
This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods.
Note that ID Verification and ID Check are two distinct methods. ID Verification checks recipients' identity by verifying their ID while ID Check relies on data available on public records (such as current and former address)." }, - "anchorTabProcessorVersion": { + "inheritEmailNotificationConfiguration": { + "description": "When set to **true** and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account. ", + "type": "string" + }, + "lockedRecipientPhoneAuthEditable": { "description": "Reserved for DocuSign.", "type": "string" }, - "anchorTabProcessorVersionMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "lockedRecipientSmsEditable": { + "description": "Reserved for DocuSign.", + "type": "string" }, - "anchorUnits": { - "description": "Specifies the units of the X and Y offset. Units may be pixels, millimeters, centimeters, or inches.", + "name": { + "description": "The notary's full legal name.\n\nMaximum Length: 100 characters.\n", "type": "string" }, - "anchorUnitsMetadata": { + "nameMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `anchorUnits` property is editable." + "description": "Metadata that indicates whether the `name` property is editable. Read only." }, - "anchorXOffset": { - "description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.", + "note": { + "description": "A note sent to the notary in the signing email.\nThis note is visible only to this notary.\n\nMaximum Length: 1000 characters.\n", "type": "string" }, - "anchorXOffsetMetadata": { + "noteMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `anchorXOffset` property is editable." + "description": "Metadata that indicates whether the `note` property is editable. Read only." }, - "anchorYOffset": { - "description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.", - "type": "string" + "phoneAuthentication": { + "$ref": "#/definitions/recipientPhoneAuthentication", + "description": "When `idCheckConfigurationName` is set to `Phone Auth $`, you use this complex type to provide the recipient authentication method details. It contains the following elements:\n\n* `recipMayProvideNumber`: Boolean. When set to **true**, the recipient can use whatever phone number they choose.\n* `senderProvidedNumbers`: ArrayOfStrings. A list of phone numbers the recipient can use.\n* `recordVoicePrint`: Reserved for DocuSign.\n* `validateRecipProvidedNumber`: Reserved for DocuSign.\n\n" }, - "anchorYOffsetMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `anchorYOffset` property is editable." + "recipientAttachments": { + "description": "Reserved for DocuSign.", + "type": "array", + "items": { + "$ref": "#/definitions/recipientAttachment" + } }, - "conditionalParentLabel": { - "description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility.", - "type": "string" + "recipientAuthenticationStatus": { + "$ref": "#/definitions/authenticationStatus", + "description": "Information about the recipient's authentication status. Read only." }, - "conditionalParentLabelMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `conditionalParentLabel` property is editable." + "recipientFeatureMetadata": { + "description": "Metadata about the features that are supported for the recipient type. Read only.", + "type": "array", + "items": { + "$ref": "#/definitions/featureAvailableMetadata" + } }, - "conditionalParentValue": { - "description": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use \"on\" as the value to show that the parent tab is active.\n", + "recipientId": { + "description": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.", "type": "string" }, - "conditionalParentValueMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `conditionalParentValue` property is editable." + "recipientIdGuid": { + "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only.", + "type": "string" }, - "customTabId": { - "description": "The DocuSign-generated custom tab id for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.", + "recipientType": { + "description": "The recipient type, as specified by the following values:\n- `agent`: Agent recipients can add name and email information for recipients that appear after the agent in routing order.\n- `carbonCopy`: Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date, or add information to any of the documents. This type of recipient can be used in any routing order.\n- `certifiedDelivery`: Certified delivery recipients must receive the completed documents for the envelope to be completed. They don't need to sign, initial, date, or add information to any of the documents.\n- `editor`: Editors have the same management and access rights for the envelope as the sender. Editors can add name and email information, add or change the routing order, set authentication options, and can edit signature/initial tabs and data fields for the remaining recipients.\n- `inPersonSigner`: In-person recipients are DocuSign users who act as signing hosts in the same physical location as the signer.\n- `intermediaries`: Intermediary recipients can optionally add name and email information for recipients at the same or subsequent level in the routing order.\n- `seal`: Electronic seal recipients represent legal entities.\n- `signer`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope.\n- `witness`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope.", "type": "string" }, - "customTabIdMetadata": { + "recipientTypeMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `customTabId` property is editable." + "description": "Metadata that indicates whether the `recipientType` property is editable. Read only." }, - "documentId": { - "description": "Integer that identifies the document in the envelope.", + "requireIdLookup": { + "description": "When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. ", "type": "string" }, - "documentIdMetadata": { + "requireIdLookupMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `documentId` property is editable." + "description": "Metadata that indicates whether the `requireIdLookup` property is editable. Read only." }, - "errorDetails": { - "$ref": "#/definitions/errorDetails", - "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." + "roleName": { + "description": "Optional element. Specifies the role name associated with the recipient.

This property is required when you are working with template recipients.", + "type": "string" }, - "formOrder": { - "description": "An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block.", + "routingOrder": { + "description": "Specifies the routing order of the recipient in the envelope. ", "type": "string" }, - "formOrderMetadata": { + "routingOrderMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `formOrder` property is editable." + "description": "Metadata that indicates whether the `routingOrder` property is editable. Read only." }, - "formPageLabel": { - "description": "A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience.", + "sentDateTime": { + "description": "The UTC DateTime when the envelope was sent. Read only.", "type": "string" }, - "formPageLabelMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `formPageLabel` property is editable." + "signedDateTime": { + "description": "Reserved for DocuSign.", + "type": "string" }, - "formPageNumber": { - "description": "An integer specifying the order in which to present the guided form pages.", + "signingGroupId": { + "description": "When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once).", "type": "string" }, - "formPageNumberMetadata": { + "signingGroupIdMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `fromPageNumber` property is editable." + "description": "Metadata that indicates whether the `signingGroupId` property is editable. Read only." }, - "height": { - "description": "The height of the tab in pixels.", + "signingGroupName": { + "description": "Optional. The name of the signing group. \n\nMaximum Length: 100 characters. ", "type": "string" }, - "heightMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `height` property is editable." + "signingGroupUsers": { + "description": "A complex type that contains information about users in the signing group.", + "type": "array", + "items": { + "$ref": "#/definitions/userInfo" + } }, - "mergeField": { - "$ref": "#/definitions/mergeField", - "description": "Contains the information necessary to map the tab to a field in SalesForce." + "smsAuthentication": { + "$ref": "#/definitions/recipientSMSAuthentication", + "description": "When `idCheckConfigurationName` is set to `SMS Auth $`, you use this complex type to provide the recipient authentication method details. It contains the element `senderProvidedNumbers`, which is an array of phone numbers that the recipient can use for SMS text authentication. \n\n" }, - "name": { - "description": "The name of the tab. For example, `Sign Here` or `Initial Here`.", + "socialAuthentications": { + "description": "Deprecated.", + "type": "array", + "items": { + "$ref": "#/definitions/socialAuthentication" + } + }, + "status": { + "description": "The recipient's status. Read only. \n\nPossible values:\n\n- `autoresponded`: The recipient's email system auto-responded to the email from DocuSign. This status is used in the web console to inform senders about the bounced-back email. This recipient status is only used if **Send-on-behalf-of** is turned off for the account.\n- `completed`: The recipient has completed their actions (signing or other required actions if not a signer) for an envelope.\n- `created`: The recipient is in a draft state. This value is only associated with draft envelopes (envelopes that have a status of `created`).\n- `declined`: The recipient declined to sign the document(s) in the envelope.\n- `delivered`: The recipient has viewed the document(s) in an envelope through the DocuSign signing website. This is not an email delivery of the documents in an envelope.\n- `faxPending`: The recipient has finished signing and the system is waiting for a fax attachment from the recipient before completing their signing step.\n- `sent`: The recipient has been sent an email notification that it is their turn to sign an envelope.\n- `signed`: The recipient has completed (signed) all required tags in an envelope. This is a temporary state during processing, after which the recipient's status automatically switches to `completed`.", "type": "string" }, - "nameMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `name` property is editable." + "statusCode": { + "description": "The code associated with the recipient's status. Read only. ", + "type": "string" }, - "optional": { - "description": "When set to **true**, the recipient does not need to complete this tab to complete the signing process.", + "suppressEmails": { + "description": "When set to **true**, email notifications are suppressed for the recipient, and they must access envelopes and documents from their DocuSign inbox.", "type": "string" }, - "optionalMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `optional` property is editable." + "tabs": { + "$ref": "#/definitions/EnvelopeRecipientTabs", + "description": "A list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients." }, - "pageNumber": { - "description": "The page number on which the tab is located. For supplemental documents, this value must be `1`.", + "templateLocked": { + "description": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ", "type": "string" }, - "pageNumberMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `pageNumber` property is editable." + "templateRequired": { + "description": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.", + "type": "string" }, - "recipientId": { - "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", + "totalTabCount": { + "description": "The total number of tabs in the documents. Read only.", "type": "string" }, - "recipientIdGuid": { - "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one.", + "userId": { + "description": "The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.\n", + "type": "string" + } + }, + "x-ds-definition-name": "notaryHost", + "description": "This object is used only when `inPersonSigningType` in the `inPersonSigner` object is `notary`.\n\nIt describes information about the notary host.\nThe following information is required\nwhen using the eNotary in-person signing flow:\n\n* `name`: Specifies the notary's full legal name.\n* `email`: Specifies the notary's email address.\n* `recipientId`: A unique ID number for the notary signing host.\n", + "x-ms-summary": "This object is used only when `inPersonSigningType` in the `inPersonSigner` object is `notary`.\n\nIt describes information about the notary host.\nThe following information is required\nwhen using the eNotary in-person signing flow:\n\n* `name`: Specifies the notary's full legal name.\n* `email`: Specifies the notary's email address.\n* `recipientId`: A unique ID number for the notary signing host.\n" + }, + "notaryJournal": { + "type": "object", + "properties": { + "createdDate": { + "description": "The creation date of the account in UTC timedate format.", "type": "string" }, - "recipientIdGuidMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `recipientIdGuid` property is editable." + "documentName": { + "description": "", + "type": "string" }, - "recipientIdMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `recipientId` property is editable." + "jurisdiction": { + "$ref": "#/definitions/jurisdiction", + "description": "" }, - "scaleValue": { - "description": "Sets the size of the tab. This field accepts values from `0.5` to `1.0`, where `1.0` represents full size and `0.5` is 50% of full size.", + "notaryJournalId": { + "description": "", "type": "string" }, - "scaleValueMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `scaleValue` property is editable." + "notaryJournalMetaData": { + "$ref": "#/definitions/notaryJournalMetaData", + "description": "" }, - "status": { - "description": "The status of the tab. Possible values are:\n\n- `active`: The tab is active, but the recipient has not yet interacted with it.\n- `signed`: The recipient signed the tab.\n- `declined`: The recipient declined the envelope.\n- `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`).", + "signerName": { + "description": "The in-person signer's full legal name.\n\nRequired when `inPersonSigningType` is `inPersonSigner`.\nFor eNotary flow, use `name` instead.\n\nMaximum Length: 100 characters.\n", + "type": "string" + } + }, + "x-ds-definition-name": "notaryJournal", + "description": "", + "x-ms-summary": "" + }, + "notaryJournalCredibleWitness": { + "type": "object", + "properties": { + "address": { + "description": "The user's address.", "type": "string" }, - "statusMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `status` property is editable." + "name": { + "description": "", + "type": "string" }, - "tabGroupLabels": { - "description": "An array of tab group labels that uniquely identify tab groups. To assign a tab to a `tabGroup`, you assign the `TabGroupLabel` to the `Tab.TabGroupLabels` array.", + "signatureImage": { + "description": "", + "type": "string" + } + }, + "x-ds-definition-name": "notaryJournalCredibleWitness", + "description": "", + "x-ms-summary": "" + }, + "notaryJournalList": { + "type": "object", + "properties": { + "endPosition": { + "description": "The last index position in the result set. ", + "type": "string" + }, + "nextUri": { + "description": "The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. ", + "type": "string" + }, + "notaryJournals": { + "description": "", "type": "array", "items": { - "type": "string" + "$ref": "#/definitions/notaryJournal" } }, - "tabGroupLabelsMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `tabGroupLabels` property is editable." - }, - "tabId": { - "description": "The unique identifier for the tab.", + "previousUri": { + "description": "The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. ", "type": "string" }, - "tabIdMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `tabId` property is editable." - }, - "tabLabel": { - "description": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n", + "resultSetSize": { + "description": "The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`.", "type": "string" }, - "tabLabelMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `tabLabel` property is editable." - }, - "tabOrder": { - "description": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.", + "startPosition": { + "description": "The starting index position of the current result set.", "type": "string" }, - "tabOrderMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `tabOrder` property is editable." - }, - "tabType": { - "description": "Indicates the type of tab (for example, `signHere` or `initialHere`).", + "totalSetSize": { + "description": "The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`.", + "type": "string" + } + }, + "x-ds-definition-name": "notaryJournalList", + "description": "", + "x-ms-summary": "" + }, + "notaryJournalMetaData": { + "type": "object", + "properties": { + "comment": { + "description": "", "type": "string" }, - "tabTypeMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `tabType` property is editable." + "credibleWitnesses": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/notaryJournalCredibleWitness" + } }, - "templateLocked": { - "description": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ", + "signatureImage": { + "description": "", "type": "string" }, - "templateLockedMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `templateLocked` property is editable." - }, - "templateRequired": { - "description": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.", + "signerIdType": { + "description": "", "type": "string" - }, - "templateRequiredMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `templateRequired` property is editable." - }, - "tooltip": { - "description": "The text of a tooltip that appears when a user hovers over a form field or tab.", + } + }, + "x-ds-definition-name": "notaryJournalMetaData", + "description": "", + "x-ms-summary": "" + }, + "notaryJurisdiction": { + "type": "object", + "properties": { + "commissionExpiration": { + "description": "The expiration date of the notary's commission in format: `MM/DD/YYYY`.", "type": "string" }, - "toolTipMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `toolTip` property is editable." - }, - "width": { - "description": "The width of the tab in pixels.", + "commissionId": { + "description": "The notary's commission identification. This varies from jurisdiction to jurisdiction.", "type": "string" }, - "widthMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `width` property is editable." - }, - "xPosition": { - "description": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n", + "county": { + "description": "The county that the commission is valid in.", "type": "string" }, - "xPositionMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `xPosition` property is editable." + "errorDetails": { + "$ref": "#/definitions/errorDetails", + "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." }, - "yPosition": { - "description": "This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.", + "jurisdiction": { + "$ref": "#/definitions/jurisdiction", + "description": "Description of the jurisdiction for this notary.\nThis is a read-only property." + }, + "registeredName": { + "description": "The registered name of the notary.", "type": "string" }, - "yPositionMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `yPosition` property is editable." + "sealType": { + "description": "The seal type used for this juridiction.\n\n- `not_available`\n- `system_created`\n- `user_uploaded`", + "type": "string" } }, - "x-ds-definition-name": "initialHere", - "description": "A tab that allows the recipient to initial the document. May\nbe optional.\n", - "x-ms-summary": "A tab that allows the recipient to initial the document. May\nbe optional.\n" + "x-ds-definition-name": "notaryJurisdiction", + "description": "A notary jurisdiction.", + "x-ms-summary": "A notary jurisdiction." }, - "inlineTemplate": { + "notaryJurisdictionList": { "type": "object", "properties": { - "customFields": { - "$ref": "#/definitions/AccountCustomFields", - "description": "An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters." + "endPosition": { + "description": "The last index position in the result set. ", + "type": "string" }, - "documents": { - "description": "Complex element contains the details on the documents in the envelope.", + "nextUri": { + "description": "The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. ", + "type": "string" + }, + "notaryJurisdictions": { + "description": "An array of jurisdictions.", "type": "array", "items": { - "$ref": "#/definitions/document" + "$ref": "#/definitions/notaryJurisdiction" } }, - "envelope": { - "$ref": "#/definitions/Envelopes", - "description": "A container used to send documents to recipients. The envelope carries information about the sender and timestamps to indicate the progress of the delivery procedure. It can contain collections of Documents, Tabs and Recipients." + "previousUri": { + "description": "The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. ", + "type": "string" }, - "recipients": { - "$ref": "#/definitions/EnvelopeRecipients", - "description": "An array of recipient objects that provides details about the recipients of the envelope." + "resultSetSize": { + "description": "The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`.", + "type": "string" }, - "sequence": { - "description": "Specifies the order in which templates are overlaid.", + "startPosition": { + "description": "The starting index position of the current result set.", + "type": "string" + }, + "totalSetSize": { + "description": "The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`.", "type": "string" } }, - "x-ds-definition-name": "inlineTemplate", - "description": "", - "x-ms-summary": "" + "x-ds-definition-name": "notaryJurisdictionList", + "description": "A paged list of jurisdictions.", + "x-ms-summary": "A paged list of jurisdictions." }, - "inPersonSigner": { + "notaryRecipient": { "type": "object", "properties": { "accessCode": { @@ -35322,14 +46509,37 @@ }, "accessCodeMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `accessCode` property is editable.\n" + "description": "Metadata that indicates whether the `accessCode` property is editable. Read only." }, "addAccessCodeToEmail": { - "description": "This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient.", + "description": "Optional. When set to **true**, the access code will be added to the email sent to the recipient. This nullifies the security measure of `accessCode` on the recipient.", + "type": "string" + }, + "additionalNotifications": { + "description": "An array of additional notification objects.", + "type": "array", + "items": { + "$ref": "#/definitions/recipientAdditionalNotification" + } + }, + "agentCanEditEmail": { + "description": "Optional element. When set to **true**, the agents recipient associated with this recipient can change the recipient's pre-populated email address. This element is only active if enabled for the account.", + "type": "string" + }, + "agentCanEditName": { + "description": "Optional element. When set to **true**, the agents recipient associated with this recipient can change the recipient's pre-populated name. This element is only active if enabled for the account.", + "type": "string" + }, + "allowSystemOverrideForLockedRecipient": { + "description": "", "type": "string" }, "autoNavigation": { - "description": "When **true**, auto navigation is set for the recipient.\n", + "description": "When set to **true**, autonavigation is set for the recipient.\n", + "type": "string" + }, + "bulkRecipientsUri": { + "description": "Reserved for DocuSign.", "type": "string" }, "canSignOffline": { @@ -35341,11 +46551,11 @@ "type": "string" }, "completedCount": { - "description": "Indicates the number of times that the recipient has been through a signing completion. \n\nIf this number is greater than `0` for a signing group, only the user who previously completed may sign again.", + "description": "Indicates the number of times that the recipient has been through a signing completion for the envelope. If this number is greater than 0 for a signing group, only the user who previously completed may sign again. Read only.", "type": "string" }, "creationReason": { - "description": "Payment status for payment services.", + "description": "The reason why the item was created.", "type": "string" }, "customFields": { @@ -35356,19 +46566,19 @@ } }, "declinedDateTime": { - "description": "The date and time the recipient declined the document.", + "description": "The date and time the recipient declined the document. Read only.", "type": "string" }, "declinedReason": { - "description": "The reason the recipient declined the document.", + "description": "The reason the recipient declined the document. Read only.", "type": "string" }, "defaultRecipient": { - "description": "When set to **true**,\nthis is the default recipient for the envelope.\nThis option is used when creating an envelope from a template.\n", + "description": "When set to **true**, this recipient is the default recipient and any tabs generated by the transformPdfFields option are mapped to this recipient.", "type": "string" }, "deliveredDateTime": { - "description": "The date and time that the envelope was delivered to the recipient.", + "description": "The date and time that the envelope was delivered to the recipient. Read only.", "type": "string" }, "deliveryMethod": { @@ -35377,29 +46587,37 @@ }, "deliveryMethodMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `deliveryMethod` property is editable.\n" + "description": "Reserved for DocuSign." + }, + "designatorId": { + "description": "", + "type": "string" + }, + "designatorIdGuid": { + "description": "", + "type": "string" }, "documentVisibility": { - "description": "Specifies if the documents are visible to this recipient. Document Visibility must be enabled for the account and the enforceSignerVisibility property must be set to true for the envelope to use this.", + "description": "A list of `documentVisibility` objects. Each object in the list specifies whether a document in the envelope is visible to this recipient. For the envelope to use this functionality, Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true**.", "type": "array", "items": { "$ref": "#/definitions/documentVisibility" } }, "email": { - "description": "The signer's email address in an eNotary flow.\n\nUse only when `inPersonSigningType` is `notary`.\nFor regular in-person-signer flow, use `signerEmail` instead.\n", + "description": "", "type": "string" }, "emailMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the signer's email address in an eNotary flow." + "description": "Metadata that indicates whether the `email` property is editable. Read only." }, "emailNotification": { "$ref": "#/definitions/recipientEmailNotification", - "description": "An optional complex type that sets a specific email subject and body for this recipient's notification email. \n\n**Note**: If you use this field to set a specific email notification for one recipient, you must also set the email notification for the other recipients. Using this field for one or more recipients negates the Envelope `Subject` and `EmailBlurb` property settings. " + "description": "An optional complex type that sets a specific email subject and body for this recipient's notification email. \n\n**Note**: You can set the `emailNotification` property separately for each recipient. If you set the value only for certain recipients, the other recipients will inherit the this value from the top-level `emailSubject` and `emailBlurb`. " }, "embeddedRecipientStartURL": { - "description": "Specifies a sender-provided valid URL string for redirecting an embedded recipient. When this option is used, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the recipient clicks the document link in the email, the recipient is redirected through DocuSign to the specified URL to complete the required actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. \n\nIf set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation launched by a partner.\n\nIt is important to understand that in a typical embedded workflow, the authentication of an embedded recipient is the responsibility of the sending application. DocuSign expects that senders will follow their own processes for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process is initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process, bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient.\n\nIf the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: `envelopeId`, `recipientId`, `recipientName`, `recipientEmail`, and `customFields`. The `customFields` property must be set for the recipient or envelope. The merge fields are enclosed in double brackets. \n\n*Example*: \n\n`http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` ", + "description": "Specifies a sender-provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. \n\nIf set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation launched by a partner.\n\nIt is important to understand that in a typical embedded workflow, the authentication of an embedded recipient is the responsibility of the sending application. DocuSign expects that senders will follow their own processes for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process is initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process, bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient.\n\nIf the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: `envelopeId`, `recipientId`, `recipientName`, `recipientEmail`, and `customFields`. The `customFields` property must be set for the recipient or envelope. The merge fields are enclosed in double brackets. \n\n*Example*: \n\n`http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` ", "type": "string" }, "errorDetails": { @@ -35421,45 +46639,61 @@ "$ref": "#/definitions/propertyMetadata", "description": "Reserved for DocuSign." }, - "hostEmail": { - "description": "The email address of the signing host.\nThis is the DocuSign user that is hosting the in-person signing session.\n\nRequired when `inPersonSigningType` is `inPersonSigner`.\nFor eNotary flow, use `email` instead.\n\nMaximum Length: 100 characters.\n", + "firstName": { + "description": "The user's first name. \nMaximum Length: 50 characters.", "type": "string" }, - "hostEmailMetadata": { + "firstNameMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the email address of the signing host." + "description": "Metadata that indicates whether the `firstame` property is editable. Read only." }, - "hostName": { - "description": "The name of the signing host.\nThis is the DocuSign user that is hosting the in-person signing session.\n\nRequired when `inPersonSigningType` is `inPersonSigner`.\nFor eNotary flow, use `name` instead.\n\nMaximum Length: 100 characters.\n", + "fullName": { + "description": "Reserved for DocuSign.", "type": "string" }, - "hostNameMetadata": { + "fullNameMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `hostName` property is editable.\n" + "description": "Reserved for DocuSign." }, "idCheckConfigurationName": { - "description": "The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting.\n\n**Example**: Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node.", + "description": "The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are:\n\n- `Phone Auth $`: The recipient must authenticate by using two-factor authentication (2FA). You provide the phone number to use for 2FA in the `phoneAuthentication` object.\n- `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object.\n- `ID Check $`: The recipient must answer detailed security questions. \n\n**Example**: Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node.", "type": "string" }, "idCheckConfigurationNameMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `idCheckConfigurationName` property is editable.\n" + "description": "Metadata that indicates whether the `idCheckConfigurationName` property is editable. Read only." }, "idCheckInformationInput": { "$ref": "#/definitions/idCheckInformationInput", "description": "An object that contains input information related to a recipient ID check." }, + "identityVerification": { + "$ref": "#/definitions/recipientIdentityVerification", + "description": "Specifies the ID Verification workflow applied on an envelope by workflow ID.
See the [list](https://developers.docusign.com/docs/esign-rest-api/reference/Accounts/IdentityVerifications/list) method in the [IdentityVerifications](https://developers.docusign.com/docs/esign-rest-api/reference/Accounts/IdentityVerifications) resource for more information on how to retrieve workflow IDs available for an account.
This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods.
Note that ID Verification and ID Check are two distinct methods. ID Verification checks recipients' identity by verifying their ID while ID Check relies on data available on public records (such as current and former address)." + }, "inheritEmailNotificationConfiguration": { "description": "When set to **true** and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account. ", "type": "string" }, - "inPersonSigningType": { - "description": "Specifies whether the envelope uses the eNotary feature.\nValid values:\n\n* `inPersonSigner` The envelope uses the normal in-person signing flow.\n* `notary`: The envelope uses the eNotary in-person signing flow.\n", + "isBulkRecipient": { + "description": "Reserved for DocuSign.\n", "type": "string" }, - "inPersonSigningTypeMetadata": { + "isBulkRecipientMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Reserved for DocuSign." + }, + "lastName": { + "description": "The user's last name. \nMaximum Length: 50 characters.", + "type": "string" + }, + "lastNameMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `inPersonSigningType` property is editable.\n" + "description": "Metadata that indicates whether the `lastName` property is editable. Read only." + }, + "liveOakStartURL": { + "description": "", + "type": "string" }, "lockedRecipientPhoneAuthEditable": { "description": "Reserved for DocuSign.", @@ -35470,28 +46704,47 @@ "type": "string" }, "name": { - "description": "The signer's full legal name in an eNotary flow.\n\nRequired when `inPersonSigningType` is `notary`.\nFor regular in-person-signer flow, use `signerName` instead.\n\nMaximum Length: 100 characters.\n", + "description": "", "type": "string" }, "nameMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the signer's full legal name in an eNotary flow." + "description": "Metadata that indicates whether the `name` property is editable. Read only." }, - "notaryHost": { - "$ref": "#/definitions/notaryHost", - "description": "Information about the notary host. The following information is required when using the eNotary in-person signing flow:\n\n- `name`: The name of the notary.\n- `email`: The email address of the notary.\n- `recipientId`: A unique ID number for the notary signing host." + "notaryId": { + "description": "", + "type": "string" + }, + "notarySigners": { + "description": "", + "type": "array", + "items": { + "type": "string" + } + }, + "notaryType": { + "description": "", + "type": "string" }, "note": { - "description": "A note sent to the in-person signer in the signing email.\nThis note is visible only to this recipient.\n\nMaximum Length: 1000 characters.\n", + "description": "A note sent to the recipient in the signing email.\nThis note is unique to this recipient.\nIn the user interface,\nit appears near the upper left corner\nof the document\non the signing screen.\n\nMaximum Length: 1000 characters.\n", "type": "string" }, "noteMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the note sent to the in-person signer in the signing email." + "description": "Metadata that indicates whether the `note` property is editable. Read only." + }, + "offlineAttributes": { + "$ref": "#/definitions/offlineAttributes", + "description": "Reserved for DocuSign." }, "phoneAuthentication": { "$ref": "#/definitions/recipientPhoneAuthentication", - "description": "A complex type that contains the following elements:\n\n* `recipMayProvideNumber` - Boolean. When set to **true**, the recipient can use whatever phone number they choose.\n* `senderProvidedNumbers` - ArrayOfString. A list of phone numbers the recipient can use.\n* `recordVoicePrint` - Reserved.\n* `validateRecipProvidedNumber` - Reserved." + "description": "When `idCheckConfigurationName` is set to `Phone Auth $`, you use this complex type to provide the recipient authentication method details. It contains the following elements:\n\n* `recipMayProvideNumber`: Boolean. When set to **true**, the recipient can use whatever phone number they choose.\n* `senderProvidedNumbers`: ArrayOfStrings. A list of phone numbers the recipient can use.\n* `recordVoicePrint`: Reserved for DocuSign.\n* `validateRecipProvidedNumber`: Reserved for DocuSign.\n\n" + }, + "proofFile": { + "$ref": "#/definitions/recipientProofFile", + "description": "" }, "recipientAttachments": { "description": "Reserved for DocuSign.", @@ -35502,10 +46755,10 @@ }, "recipientAuthenticationStatus": { "$ref": "#/definitions/authenticationStatus", - "description": "Information about the recipient's authentication status." + "description": "Information about the recipient's authentication status. Read only." }, "recipientFeatureMetadata": { - "description": "Metadata that indicates whether the `recipientFeature` property is editable.\n", + "description": "Metadata about the features that are supported for the recipient type. Read only.", "type": "array", "items": { "$ref": "#/definitions/featureAvailableMetadata" @@ -35516,7 +46769,7 @@ "type": "string" }, "recipientIdGuid": { - "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one.", + "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only.", "type": "string" }, "recipientSignatureProviders": { @@ -35527,16 +46780,16 @@ } }, "recipientSuppliesTabs": { - "description": "Specifies whether the recipient creates the tabs.", + "description": "When set to **true**, specifies that the recipient creates the tabs.", "type": "string" }, "recipientType": { - "description": "The recipient type, as specified by the following values:\n- `agents`: Agent recipients can add name and email information for recipients that appear after the agent in routing order.\n- `carbonCopies`: Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date, or add information to any of the documents. This type of recipient can be used in any routing order.\n- `certifiedDeliveries`: Certified delivery recipients must receive the completed documents for the envelope to be completed. They don't need to sign, initial, date, or add information to any of the documents.\n- `editors`: Editors have the same management and access rights for the envelope as the sender. Editors can add name and email information, add or change the routing order, set authentication options, and can edit signature/initial tabs and data fields for the remaining recipients.\n- `inPersonSigners`: In-person recipients are DocuSign users who act as signing hosts in the same physical location as the signer.\n- `intermediaries`: Intermediary recipients can optionally add name and email information for recipients at the same or subsequent level in the routing order.\n- `seals`: Electronic seal recipients represent legal entities.\n- `signers`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope.\n- `witnesses`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope.", + "description": "The recipient type, as specified by the following values:\n- `agent`: Agent recipients can add name and email information for recipients that appear after the agent in routing order.\n- `carbonCopy`: Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date, or add information to any of the documents. This type of recipient can be used in any routing order.\n- `certifiedDelivery`: Certified delivery recipients must receive the completed documents for the envelope to be completed. They don't need to sign, initial, date, or add information to any of the documents.\n- `editor`: Editors have the same management and access rights for the envelope as the sender. Editors can add name and email information, add or change the routing order, set authentication options, and can edit signature/initial tabs and data fields for the remaining recipients.\n- `inPersonSigner`: In-person recipients are DocuSign users who act as signing hosts in the same physical location as the signer.\n- `intermediaries`: Intermediary recipients can optionally add name and email information for recipients at the same or subsequent level in the routing order.\n- `seal`: Electronic seal recipients represent legal entities.\n- `signer`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope.\n- `witness`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope.", "type": "string" }, "recipientTypeMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `recipientType` property is editable.\n" + "description": "Metadata that indicates whether the `recipientType` property is editable. Read only." }, "requireIdLookup": { "description": "When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. ", @@ -35544,7 +46797,7 @@ }, "requireIdLookupMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `requireIdLookup` property is editable.\n" + "description": "Metadata that indicates whether the `requireIdLookup` property is editable. Read only." }, "requireSignerCertificate": { "description": "By default, DocuSign signers create electronic signatures. This field can be used to require the signer to use a SAFE-BioPharma digital certificate for signing.\n\nThis parameter should only be used to select a SAFE-BioPharma certificate. New integrations should use the `recipientSignatureProviders` parameter for other types of digital certificates. \n\nSet this parameter to `safe` to use a SAFE-BioPharma certificate.\n\nThe signer must be enrolled in the SAFE program to sign with a SAFE certificate.", @@ -35554,8 +46807,12 @@ "description": "When set to **true**, the signer must print, sign, and upload or fax the signed documents to DocuSign.", "type": "string" }, + "requireUploadSignature": { + "description": "When set to **true**, the signer is required to upload a new signature, even if they have a pre-adopted signature in their personal DocuSign account.", + "type": "string" + }, "roleName": { - "description": "Optional element. Specifies the role name associated with the recipient.

This is required when working with template recipients.", + "description": "Optional element. Specifies the role name associated with the recipient.

This property is required when you are working with template recipients.", "type": "string" }, "routingOrder": { @@ -35564,70 +46821,38 @@ }, "routingOrderMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `routingOrder` property is editable.\n" + "description": "Metadata that indicates whether the `routingOrder` property is editable. Read only." }, "sentDateTime": { - "description": "The date and time the envelope was sent.", + "description": "The UTC DateTime when the envelope was sent. Read only.", "type": "string" }, "signatureInfo": { "$ref": "#/definitions/recipientSignatureInformation", - "description": "Allows the sender to pre-specify the signature name, signature initials and signature font used in the signature stamp for the recipient.\n\nUsed only with recipient types In Person Signers and Signers. \n " + "description": "Allows the sender to pre-specify the signature name, signature initials and signature font used in the signature stamp for the recipient.\n\nUsed only with recipient types In Person Signers and Signers." }, "signedDateTime": { "description": "Reserved for DocuSign.", "type": "string" }, - "signerEmail": { - "description": "The in-person signer's email address.\n\nRequired when `inPersonSigningType` is `inPersonSigner`.\nFor eNotary flow, use `email` instead.\n\nMaximum Length: 100 characters.\n\n", - "type": "string" - }, - "signerEmailMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the in-person signer's email address." - }, - "signerFirstName": { - "description": "The first name of the in-person signer.", - "type": "string" - }, - "signerFirstNameMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the first name of the in-person signer." - }, - "signerLastName": { - "description": "The last name of the in-person siger.", - "type": "string" - }, - "signerLastNameMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the last name of the in-person signer." - }, - "signerName": { - "description": "The in-person signer's full legal name.\n\nRequired when `inPersonSigningType` is `inPersonSigner`.\nFor eNotary flow, use `name` instead.\n\nMaximum Length: 100 characters.\n", - "type": "string" - }, - "signerNameMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the in-person signer's full legal name." - }, "signInEachLocation": { "description": "When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab (instead of adopting a signature/initial style or only drawing a signature/initial once).", "type": "string" }, "signInEachLocationMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the `signInEachLocation` property." + "description": "Metadata that indicates whether the `signInEachLocation` property is editable. Read only." }, "signingGroupId": { - "description": "The id of the signing group of which the in-person signer is a member.", + "description": "When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once).", "type": "string" }, "signingGroupIdMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `signingGroupId` property is editable.\n" + "description": "Metadata that indicates whether the `signingGroupId` property is editable. Read only." }, "signingGroupName": { - "description": "The display name for the signing group. \n\nMaximum Length: 100 characters. ", + "description": "Optional. The name of the signing group. \n\nMaximum Length: 100 characters. ", "type": "string" }, "signingGroupUsers": { @@ -35639,26 +46864,30 @@ }, "smsAuthentication": { "$ref": "#/definitions/recipientSMSAuthentication", - "description": "Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication. \n" + "description": "When `idCheckConfigurationName` is set to `SMS Auth $`, you use this complex type to provide the recipient authentication method details. It contains the element `senderProvidedNumbers`, which is an array of phone numbers that the recipient can use for SMS text authentication. \n\n" }, "socialAuthentications": { - "description": " Lists the social ID type that can be used for recipient authentication.", + "description": "Deprecated.", "type": "array", "items": { "$ref": "#/definitions/socialAuthentication" } }, "status": { - "description": "Recipient status.\n\n", + "description": "Indicates the envelope status. Valid values are:\n\n* sent - The envelope is sent to the recipients. \n* created - The envelope is saved as a draft and can be modified and sent later.", "type": "string" }, "statusCode": { "description": "Reserved for DocuSign.", "type": "string" }, + "suppressEmails": { + "description": "When set to **true**, email notifications are suppressed for the recipient, and they must access envelopes and documents from their DocuSign inbox.", + "type": "string" + }, "tabs": { "$ref": "#/definitions/EnvelopeRecipientTabs", - "description": "A list of `signHere` tabs, which can be used to add a visual representation for an electronic seal in a document." + "description": "A list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients." }, "templateLocked": { "description": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ", @@ -35669,7 +46898,7 @@ "type": "string" }, "totalTabCount": { - "description": "The total number of tabs in the documents.", + "description": "The total number of tabs in the documents. Read only.", "type": "string" }, "userId": { @@ -35677,400 +46906,362 @@ "type": "string" } }, - "x-ds-definition-name": "inPersonSigner", - "description": "An in-person recipient is a DocuSign user,\nacting as a Signing Host,\nwho is in the same physical location as the signer.\nTo learn about fields used\nfor eNotary feature,\nsee the [EnvelopeRecipients resource][enveloperecipientsInPerson].\n\n[enveloperecipientsInPerson]: /https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipients/#in-person-signers-recipient\n", - "x-ms-summary": "An in-person recipient is a DocuSign user,\nacting as a Signing Host,\nwho is in the same physical location as the signer.\nTo learn about fields used\nfor eNotary feature,\nsee the [EnvelopeRecipients resource][enveloperecipientsInPerson].\n\n[enveloperecipientsInPerson]: /https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipients/#in-person-signers-recipient\n" + "x-ds-definition-name": "notaryRecipient", + "description": "", + "x-ms-summary": "" }, - "integratedUserInfoList": { + "notaryResult": { "type": "object", "properties": { - "allUsersSelected": { + "jurisdictions": { "description": "", - "type": "string" - }, - "endPosition": { - "description": "The last position in the result set. ", - "type": "string" - }, - "nextUri": { - "description": "The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. ", - "type": "string" - }, - "previousUri": { - "description": "The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. ", - "type": "string" - }, - "resultSetSize": { - "description": "The number of results returned in this response. Because you can filter which entries are included in the response, this value is always less than or equal to `totalSetSize`.", - "type": "string" - }, - "startPosition": { - "description": "The starting position of the current result set.", - "type": "string" - }, - "totalSetSize": { - "description": "The total number of items in the search's result set. This value is always greater than or equal to the value of `resultSetSize`.", - "type": "string" - }, - "users": { - "description": "User management information.", "type": "array", "items": { - "$ref": "#/definitions/userInfo" + "$ref": "#/definitions/jurisdiction" } + }, + "notary": { + "$ref": "#/definitions/notary", + "description": "" } }, - "x-ds-definition-name": "integratedUserInfoList", - "description": "", - "x-ms-summary": "" + "x-ds-definition-name": "notaryResult", + "description": "Describes a single notary jurisdiction.", + "x-ms-summary": "Describes a single notary jurisdiction." }, - "intermediary": { + "notarySeal": { "type": "object", "properties": { - "accessCode": { - "description": "If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. \n\nMaximum Length: 50 characters and it must conform to the account's access code format setting.\n\nIf blank, but the signer `accessCode` property is set in the envelope, then that value is used.\n\nIf blank and the signer `accessCode` property is not set, then the access code is not required.", + "anchorAllowWhiteSpaceInCharacters": { + "description": "", "type": "string" }, - "accessCodeMetadata": { + "anchorAllowWhiteSpaceInCharactersMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the `accessCode` property." + "description": "" }, - "addAccessCodeToEmail": { - "description": "This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient.", + "anchorCaseSensitive": { + "description": "This property controls how [anchor tabs][AnchorTabs] are placed. When **true**, the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false**.\n\nFor example, when set to **true**, if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When set to **false**, `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**.\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place", "type": "string" }, - "clientUserId": { - "description": "Specifies whether the recipient is embedded or remote. \n\nIf the `clientUserId` property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing.\n\nNote: if the `clientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true**, an error is generated on sending. \n\nMaximum length: 100 characters. ", - "type": "string" + "anchorCaseSensitiveMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorCaseSensitive` property is editable." }, - "completedCount": { - "description": "Indicates the number of times that the recipient has been through a signing completion for the envelope.\n\nIf this number is greater than 0 for a signing group, only the user who previously completed may sign again.", + "anchorHorizontalAlignment": { + "description": "This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are :\n\n- `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value.\n- `right`: Aligns the tab’s left side with the last character of the matching anchor word.\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place\n", "type": "string" }, - "customFields": { - "description": "An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters.", - "type": "array", - "items": { - "type": "string" - } + "anchorHorizontalAlignmentMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorHorizontalAlignment` property is editable." }, - "declinedDateTime": { - "description": "The date and time the recipient declined the document.", + "anchorIgnoreIfNotPresent": { + "description": "When set to **true**, this tab is ignored if the `anchorString` is not found in the document.", "type": "string" }, - "declinedReason": { - "description": "The reason the recipient declined the document.", + "anchorIgnoreIfNotPresentMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable." + }, + "anchorMatchWholeWord": { + "description": "When set to **true**, the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false**.\n\nFor example, when set to **true**, if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When set to **false**, if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**.\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTab]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place\n", "type": "string" }, - "deliveredDateTime": { - "description": "The date and time that the envelope was delivered to the recipient.", + "anchorMatchWholeWordMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorMatchWholeWord` property is editable." + }, + "anchorString": { + "description": "Specifies the string to find in the document and use as the basis for tab placement.", "type": "string" }, - "deliveryMethod": { + "anchorStringMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorString` property is editable." + }, + "anchorTabProcessorVersion": { "description": "Reserved for DocuSign.", "type": "string" }, - "deliveryMethodMetadata": { + "anchorTabProcessorVersionMetadata": { "$ref": "#/definitions/propertyMetadata", "description": "Reserved for DocuSign." }, - "documentVisibility": { - "description": "A list of documentVisibility objects, which define a recipient's read/write access to a document.", - "type": "array", - "items": { - "$ref": "#/definitions/documentVisibility" - } - }, - "email": { - "description": "Email id of the recipient. Notification of the document to sign is sent to this email id. \n\nMaximum length: 100 characters. ", + "anchorUnits": { + "description": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n", "type": "string" }, - "emailMetadata": { + "anchorUnitsMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the email id of the recipient." - }, - "emailNotification": { - "$ref": "#/definitions/recipientEmailNotification", - "description": "An optional complex type that sets a specific email subject and body for this recipient's notification email. \n\n**Note**: If you use this field to set a specific email notification for one recipient, you must also set the email notification for the other recipients. Using this field for one or more recipients negates the Envelope `Subject` and `EmailBlurb` property settings. " + "description": "Metadata that indicates whether the `anchorUnits` property is editable." }, - "embeddedRecipientStartURL": { - "description": "Specifies a sender-provided valid URL string for redirecting an embedded recipient. When this option is used, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the recipient clicks the document link in the email, the recipient is redirected through DocuSign to the specified URL to complete the required actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. \n\nIf set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation launched by a partner.\n\nIt is important to understand that in a typical embedded workflow, the authentication of an embedded recipient is the responsibility of the sending application. DocuSign expects that senders will follow their own processes for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process is initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process, bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient.\n\nIf the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: `envelopeId`, `recipientId`, `recipientName`, `recipientEmail`, and `customFields`. The `customFields` property must be set for the recipient or envelope. The merge fields are enclosed in double brackets. \n\n*Example*: \n\n`http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` ", + "anchorXOffset": { + "description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n", "type": "string" }, - "errorDetails": { - "$ref": "#/definitions/errorDetails", - "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." + "anchorXOffsetMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorXOffset` property is editable." }, - "excludedDocuments": { - "description": "Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true** for the envelope to use this.\n\nWhen enforce signer visibility is enabled, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent.", - "type": "array", - "items": { - "type": "string" - } + "anchorYOffset": { + "description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n", + "type": "string" }, - "faxNumber": { - "description": "Reserved for DocuSign.", + "anchorYOffsetMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorYOffset` property is editable." + }, + "conditionalParentLabel": { + "description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility.", "type": "string" }, - "faxNumberMetadata": { + "conditionalParentLabelMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `faxNumber` property is editable.\n" + "description": "Metadata that indicates whether the `conditionalParentLabel` property is editable." }, - "firstName": { - "description": "The recipient's first name. Maximum Length: 50 characters.", + "conditionalParentValue": { + "description": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use \"on\" as the value to show that the parent tab is active.\n", "type": "string" }, - "firstNameMetadata": { + "conditionalParentValueMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the recipient's first name." + "description": "Metadata that indicates whether the `conditionalParentValue` property is editable." }, - "fullName": { - "description": "Reserved for DocuSign.", + "customTabId": { + "description": "The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.", "type": "string" }, - "fullNameMetadata": { + "customTabIdMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "description": "Metadata that indicates whether the `customTabId` property is editable." }, - "idCheckConfigurationName": { - "description": "The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting.\n\n**Example**: Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node.", + "documentId": { + "description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.", "type": "string" }, - "idCheckConfigurationNameMetadata": { + "documentIdMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the `idCheckConfigurationName` property." + "description": "Metadata that indicates whether the `documentId` property is editable." }, - "idCheckInformationInput": { - "$ref": "#/definitions/idCheckInformationInput", - "description": "An object that contains input information related to a recipient ID check." + "errorDetails": { + "$ref": "#/definitions/errorDetails", + "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." }, - "inheritEmailNotificationConfiguration": { - "description": "When set to **true** and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account. ", + "formOrder": { + "description": "An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block.", "type": "string" }, - "lastName": { - "description": "The recipient's last name.", + "formOrderMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `formOrder` property is editable." + }, + "formPageLabel": { + "description": "A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience.", "type": "string" }, - "lastNameMetadata": { + "formPageLabelMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the recipient's last name." + "description": "Metadata that indicates whether the `formPageLabel` property is editable." }, - "lockedRecipientPhoneAuthEditable": { - "description": "Reserved for DocuSign.", + "formPageNumber": { + "description": "An integer specifying the order in which to present the guided form pages.", "type": "string" }, - "lockedRecipientSmsEditable": { - "description": "Reserved for DocuSign.", + "formPageNumberMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `fromPageNumber` property is editable." + }, + "height": { + "description": "The height of the tab in pixels.", + "type": "string" + }, + "heightMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `height` property is editable." + }, + "mergeField": { + "$ref": "#/definitions/mergeField", + "description": "Contains the information necessary to map the tab to a field in SalesForce." + }, + "mergeFieldXml": { + "description": "", "type": "string" }, "name": { - "description": "The full legal name of the recipient.", + "description": "", "type": "string" }, "nameMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the full legal name of the recipient." + "description": "Metadata that indicates whether the `name` property is editable. Read only." }, - "note": { - "description": "A note sent to the recipient in the signing email.\nThis note is unique to this recipient.\nIn the user interface,\nit appears near the upper left corner\nof the document\non the signing screen.\n\nMaximum Length: 1000 characters.\n", + "pageNumber": { + "description": "Specifies the page number on which the tab is located.", "type": "string" }, - "noteMetadata": { + "pageNumberMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the note to the recipient." - }, - "phoneAuthentication": { - "$ref": "#/definitions/recipientPhoneAuthentication", - "description": "A complex type that contains the following elements:\n\n* `recipMayProvideNumber` - Boolean. When set to **true**, the recipient can use whatever phone number they choose.\n* `senderProvidedNumbers` - ArrayOfString. A list of phone numbers the recipient can use.\n* `recordVoicePrint` - Reserved.\n* `validateRecipProvidedNumber` - Reserved." - }, - "recipientAttachments": { - "description": "Reserved for DocuSign.", - "type": "array", - "items": { - "$ref": "#/definitions/recipientAttachment" - } - }, - "recipientAuthenticationStatus": { - "$ref": "#/definitions/authenticationStatus", - "description": "Information about the recipient's authentication status." - }, - "recipientFeatureMetadata": { - "description": "Metadata about the features that are supported for the recipient type.", - "type": "array", - "items": { - "$ref": "#/definitions/featureAvailableMetadata" - } + "description": "Metadata that indicates whether the `pageNumber` property is editable." }, "recipientId": { "description": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.", "type": "string" }, "recipientIdGuid": { - "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one.", + "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only.", "type": "string" }, - "recipientType": { - "description": "The recipient type, as specified by the following values:\n- `agents`: Agent recipients can add name and email information for recipients that appear after the agent in routing order.\n- `carbonCopies`: Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date, or add information to any of the documents. This type of recipient can be used in any routing order.\n- `certifiedDeliveries`: Certified delivery recipients must receive the completed documents for the envelope to be completed. They don't need to sign, initial, date, or add information to any of the documents.\n- `editors`: Editors have the same management and access rights for the envelope as the sender. Editors can add name and email information, add or change the routing order, set authentication options, and can edit signature/initial tabs and data fields for the remaining recipients.\n- `inPersonSigners`: In-person recipients are DocuSign users who act as signing hosts in the same physical location as the signer.\n- `intermediaries`: Intermediary recipients can optionally add name and email information for recipients at the same or subsequent level in the routing order.\n- `seals`: Electronic seal recipients represent legal entities.\n- `signers`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope.\n- `witnesses`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope.", - "type": "string" + "recipientIdGuidMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `recipientIdGuid` property is editable." }, - "recipientTypeMetadata": { + "recipientIdMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the recipient type." + "description": "Metadata that indicates whether the `recipientId` property is editable." }, - "requireIdLookup": { - "description": "When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. ", + "scaleValue": { + "description": "Sets the size of the tab. This field accepts values from `0.5` to `1.0`, where `1.0` represents full size and `0.5` is 50% of full size.", "type": "string" }, - "requireIdLookupMetadata": { + "scaleValueMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `requireIdLookup` property is editable.\n" + "description": "Metadata that indicates whether the `scaleValue` property is editable." }, - "roleName": { - "description": "Optional element. Specifies the role name associated with the recipient.

This is required when working with template recipients.", - "type": "string" + "smartContractInformation": { + "$ref": "#/definitions/smartContractInformation", + "description": "" }, - "routingOrder": { - "description": "Specifies the routing order of the recipient in the envelope. ", + "status": { + "description": "Indicates the envelope status. Valid values are:\n\n* sent - The envelope is sent to the recipients. \n* created - The envelope is saved as a draft and can be modified and sent later.", "type": "string" }, - "routingOrderMetadata": { + "statusMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the routing order for the recipient." + "description": "Metadata that indicates whether the `status` property is editable." }, - "sentDateTime": { - "description": "The date and time the envelope was sent.", - "type": "string" + "tabGroupLabels": { + "description": "An array of tab group labels that uniquely identify tab groups. To assign a tab to a `tabGroup`, you assign the `TabGroupLabel` to the `Tab.TabGroupLabels` array.", + "type": "array", + "items": { + "type": "string" + } }, - "signedDateTime": { - "description": "Reserved for DocuSign.", - "type": "string" + "tabGroupLabelsMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `tabGroupLabels` property is editable." }, - "signingGroupId": { - "description": "The id of the signing group of which the recipient is a member, if applicable.", + "tabId": { + "description": "The unique identifier for the tab.", "type": "string" }, - "signingGroupIdMetadata": { + "tabIdMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the signing group id." + "description": "Metadata that indicates whether the `tabId` property is editable." }, - "signingGroupName": { - "description": "The display name for the signing group. \n\nMaximum Length: 100 characters. ", + "tabLabel": { + "description": "The label associated with the tab. This value may be an empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum Length: 500 characters.\n", "type": "string" }, - "signingGroupUsers": { - "description": "A complex type that contains information about users in the signing group.", - "type": "array", - "items": { - "$ref": "#/definitions/userInfo" - } + "tabLabelMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `tabLabel` property is editable." }, - "smsAuthentication": { - "$ref": "#/definitions/recipientSMSAuthentication", - "description": "Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication. \n" + "tabOrder": { + "description": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.", + "type": "string" }, - "socialAuthentications": { - "description": " Lists the social ID type that can be used for recipient authentication.", - "type": "array", - "items": { - "$ref": "#/definitions/socialAuthentication" - } + "tabOrderMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `tabOrder` property is editable." }, - "status": { - "description": "Recipient status.\n\n", + "tabType": { + "description": "Indicates the type of tab (for example, `signHere` or `initialHere`).", "type": "string" }, - "statusCode": { - "description": "Reserved for DocuSign.", - "type": "string" + "tabTypeMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `tabType` property is editable." }, "templateLocked": { "description": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ", "type": "string" }, + "templateLockedMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `templateLocked` property is editable." + }, "templateRequired": { "description": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.", "type": "string" }, - "totalTabCount": { - "description": "The total number of tabs in the documents.", - "type": "string" - }, - "userId": { - "description": "The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.\n", - "type": "string" - } - }, - "x-ds-definition-name": "intermediary", - "description": "", - "x-ms-summary": "" - }, - "jurisdiction": { - "type": "object", - "properties": { - "allowSystemCreatedSeal": { - "description": "", - "type": "string" - }, - "allowUserUploadedSeal": { - "description": "", - "type": "string" + "templateRequiredMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `templateRequired` property is editable." }, - "commissionIdInSeal": { - "description": "", + "tooltip": { + "description": "The text of a tooltip that appears when a user hovers over a form field or tab.", "type": "string" }, - "county": { - "description": "", - "type": "string" + "toolTipMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `toolTip` property is editable." }, - "countyInSeal": { - "description": "", + "width": { + "description": "The width of the tab in pixels.", "type": "string" }, - "enabled": { - "description": "", - "type": "string" + "widthMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `width` property is editable." }, - "jurisdictionId": { - "description": "", + "xPosition": { + "description": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n", "type": "string" }, - "name": { - "description": "", - "type": "string" + "xPositionMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `xPosition` property is editable." }, - "notaryPublicInSeal": { - "description": "", + "yPosition": { + "description": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n", "type": "string" }, - "stateNameInSeal": { - "description": "", - "type": "string" + "yPositionMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `yPosition` property is editable." } }, - "x-ds-definition-name": "jurisdiction", + "x-ds-definition-name": "notarySeal", "description": "", "x-ms-summary": "" }, - "lastName": { + "note": { "type": "object", "properties": { + "anchorAllowWhiteSpaceInCharacters": { + "description": "", + "type": "string" + }, + "anchorAllowWhiteSpaceInCharactersMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "" + }, "anchorCaseSensitive": { - "description": "Reserved for DocuSign.\n", + "description": "This property controls how [anchor tabs][AnchorTabs] are placed. When **true**, the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false**.\n\nFor example, when set to **true**, if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When set to **false**, `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**.\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place", "type": "string" }, "anchorCaseSensitiveMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "description": "Metadata that indicates whether the `anchorCaseSensitive` property is editable." }, "anchorHorizontalAlignment": { - "description": "Reserved for DocuSign.\n\n", + "description": "This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are :\n\n- `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value.\n- `right`: Aligns the tab’s left side with the last character of the matching anchor word.\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place\n", "type": "string" }, "anchorHorizontalAlignmentMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "description": "Metadata that indicates whether the `anchorHorizontalAlignment` property is editable." }, "anchorIgnoreIfNotPresent": { "description": "When set to **true**, this tab is ignored if the `anchorString` is not found in the document.", @@ -36081,12 +47272,12 @@ "description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable." }, "anchorMatchWholeWord": { - "description": "Reserved for DocuSign.\n\n", + "description": "When set to **true**, the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false**.\n\nFor example, when set to **true**, if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When set to **false**, if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**.\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTab]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place\n", "type": "string" }, "anchorMatchWholeWordMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "description": "Metadata that indicates whether the `anchorMatchWholeWord` property is editable." }, "anchorString": { "description": "Specifies the string to find in the document and use as the basis for tab placement.", @@ -36105,7 +47296,7 @@ "description": "Reserved for DocuSign." }, "anchorUnits": { - "description": "Specifies the units of the X and Y offset. Units may be pixels, millimeters, centimeters, or inches.", + "description": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n", "type": "string" }, "anchorUnitsMetadata": { @@ -36113,7 +47304,7 @@ "description": "Metadata that indicates whether the `anchorUnits` property is editable." }, "anchorXOffset": { - "description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.", + "description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n", "type": "string" }, "anchorXOffsetMetadata": { @@ -36121,7 +47312,7 @@ "description": "Metadata that indicates whether the `anchorXOffset` property is editable." }, "anchorYOffset": { - "description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.", + "description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n", "type": "string" }, "anchorYOffsetMetadata": { @@ -36153,7 +47344,7 @@ "description": "Metadata that indicates whether the `conditionalParentValue` property is editable." }, "customTabId": { - "description": "The DocuSign-generated custom tab id for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.", + "description": "The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.", "type": "string" }, "customTabIdMetadata": { @@ -36161,7 +47352,7 @@ "description": "Metadata that indicates whether the `customTabId` property is editable." }, "documentId": { - "description": "Integer that identifies the document in the envelope.", + "description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.", "type": "string" }, "documentIdMetadata": { @@ -36244,13 +47435,17 @@ "$ref": "#/definitions/mergeField", "description": "Contains the information necessary to map the tab to a field in SalesForce." }, + "mergeFieldXml": { + "description": "", + "type": "string" + }, "name": { "description": "The name of the tab. For example, `Sign Here` or `Initial Here`.", "type": "string" }, "nameMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `name` property is editable." + "description": "Metadata that indicates whether the `name` property is editable. Read only." }, "pageNumber": { "description": "The page number on which the tab is located. For supplemental documents, this value must be `1`.\n", @@ -36261,11 +47456,11 @@ "description": "Metadata that indicates whether the `pageNumber` property is editable." }, "recipientId": { - "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", + "description": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.", "type": "string" }, "recipientIdGuid": { - "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one.", + "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only.", "type": "string" }, "recipientIdGuidMetadata": { @@ -36276,6 +47471,18 @@ "$ref": "#/definitions/propertyMetadata", "description": "Metadata that indicates whether the `recipientId` property is editable." }, + "shared": { + "description": "When set to **true**, this custom tab is shared.", + "type": "string" + }, + "sharedMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `shared` property is editable." + }, + "smartContractInformation": { + "$ref": "#/definitions/smartContractInformation", + "description": "" + }, "status": { "description": "The status of the tab. Possible values are:\n\n- `active`: The tab is active, but the recipient has not yet interacted with it.\n- `signed`: The recipient signed the tab.\n- `declined`: The recipient declined the envelope.\n- `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`).", "type": "string" @@ -36304,7 +47511,7 @@ "description": "Metadata that indicates whether the `tabId` property is editable." }, "tabLabel": { - "description": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n", + "description": "The label associated with the tab. This value may be an empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum Length: 500 characters.\n", "type": "string" }, "tabLabelMetadata": { @@ -36376,7 +47583,7 @@ "description": "Metadata that indicates whether the `width` property is editable." }, "xPosition": { - "description": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n", + "description": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n", "type": "string" }, "xPositionMetadata": { @@ -36384,7 +47591,7 @@ "description": "Metadata that indicates whether the `xPosition` property is editable." }, "yPosition": { - "description": "This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.", + "description": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n", "type": "string" }, "yPositionMetadata": { @@ -36392,28 +47599,88 @@ "description": "Metadata that indicates whether the `yPosition` property is editable." } }, - "x-ds-definition-name": "lastName", - "description": "A tab that displays the recipient's last name. This tab\ntakes the recipient's name as entered in the recipient\ninformation, splits it into sections based on spaces and\nuses the last section as the last name.\n", - "x-ms-summary": "A tab that displays the recipient's last name. This tab\ntakes the recipient's name as entered in the recipient\ninformation, splits it into sections based on spaces and\nuses the last section as the last name.\n" + "x-ds-definition-name": "note", + "description": "A tab that displays additional information, in the form of a\nnote, for the recipient.\n", + "x-ms-summary": "A tab that displays additional information, in the form of a\nnote, for the recipient.\n" }, - "list": { + "notification": { + "description": "A complex element that specifies the notification settings for the envelope.", + "type": "object", + "properties": { + "expirations": { + "$ref": "#/definitions/expirations", + "description": "A complex element that specifies the expiration settings for the envelope." + }, + "reminders": { + "$ref": "#/definitions/reminders", + "description": "A complex element that specifies reminder settings for the envelope" + }, + "useAccountDefaults": { + "description": "When set to **true**, the account default notification settings are used for the envelope, overriding the reminders and expirations settings. When set to **false**, the reminders and expirations settings specified in this request are used.", + "type": "string" + } + }, + "x-ds-definition-name": "notification", + "x-ms-summary": "A complex element that specifies the notification settings for the envelope." + }, + "notificationDefaults": { + "type": "object", + "properties": { + "apiEmailNotifications": { + "$ref": "#/definitions/notificationDefaultSettings", + "description": "The default notification settings for envelopes sent by using the console." + }, + "emailNotifications": { + "$ref": "#/definitions/notificationDefaultSettings", + "description": "The default notification settings for envelopes sent by using the API." + } + }, + "x-ds-definition-name": "notificationDefaults", + "description": "", + "x-ms-summary": "" + }, + "notificationDefaultSettings": { + "type": "object", + "properties": { + "senderEmailNotifications": { + "$ref": "#/definitions/senderEmailNotifications", + "description": " \nAn array of email notifications that sets the email the user receives when they are a sender. When the specific email notification is set to true, the user will receive those types of email notifications from DocuSign. \n\nThe user inherits the default account sender email notification settings when the user is created. The email notifications are:\n\n* envelopeComplete\n* changedSigner \n* senderEnvelopeDeclined \n* withdrawnConsent \n* recipientViewed \n* deliveryFailed \n " + }, + "signerEmailNotifications": { + "$ref": "#/definitions/signerEmailNotifications", + "description": "An array of email notifications that specifies the email the user receives when they are a sender. When the specific email notification is set to true, the user receives those types of email notifications from DocuSign. The user inherits the default account sender email notification settings when the user is created." + } + }, + "x-ds-definition-name": "notificationDefaultSettings", + "description": "Contains details about the default notification settings for the envelope notifications that senders and signers receive.", + "x-ms-summary": "Contains details about the default notification settings for the envelope notifications that senders and signers receive." + }, + "number": { "type": "object", "properties": { + "anchorAllowWhiteSpaceInCharacters": { + "description": "", + "type": "string" + }, + "anchorAllowWhiteSpaceInCharactersMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "" + }, "anchorCaseSensitive": { - "description": "Reserved for DocuSign.\n", + "description": "This property controls how [anchor tabs][AnchorTabs] are placed. When **true**, the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false**.\n\nFor example, when set to **true**, if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When set to **false**, `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**.\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place", "type": "string" }, "anchorCaseSensitiveMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "description": "Metadata that indicates whether the `anchorCaseSensitive` property is editable." }, "anchorHorizontalAlignment": { - "description": "Reserved for DocuSign.\n\n", + "description": "This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are :\n\n- `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value.\n- `right`: Aligns the tab’s left side with the last character of the matching anchor word.\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place\n", "type": "string" }, "anchorHorizontalAlignmentMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "description": "Metadata that indicates whether the `anchorHorizontalAlignment` property is editable." }, "anchorIgnoreIfNotPresent": { "description": "When set to **true**, this tab is ignored if the `anchorString` is not found in the document.", @@ -36424,12 +47691,12 @@ "description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable." }, "anchorMatchWholeWord": { - "description": "Reserved for DocuSign.\n\n", + "description": "When set to **true**, the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false**.\n\nFor example, when set to **true**, if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When set to **false**, if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**.\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTab]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place\n", "type": "string" }, "anchorMatchWholeWordMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "description": "Metadata that indicates whether the `anchorMatchWholeWord` property is editable." }, "anchorString": { "description": "Specifies the string to find in the document and use as the basis for tab placement.", @@ -36448,7 +47715,7 @@ "description": "Reserved for DocuSign." }, "anchorUnits": { - "description": "Specifies the units of the X and Y offset. Units may be pixels, millimeters, centimeters, or inches.", + "description": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n", "type": "string" }, "anchorUnitsMetadata": { @@ -36456,7 +47723,7 @@ "description": "Metadata that indicates whether the `anchorUnits` property is editable." }, "anchorXOffset": { - "description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.", + "description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n", "type": "string" }, "anchorXOffsetMetadata": { @@ -36464,7 +47731,7 @@ "description": "Metadata that indicates whether the `anchorXOffset` property is editable." }, "anchorYOffset": { - "description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.", + "description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n", "type": "string" }, "anchorYOffsetMetadata": { @@ -36479,6 +47746,14 @@ "$ref": "#/definitions/propertyMetadata", "description": "Metadata that indicates whether the `bold` property is editable." }, + "concealValueOnDocument": { + "description": "When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender.\n\nWhen an envelope is completed the information is only available to the sender through the Form Data link in the DocuSign Console. The information on the downloaded document remains masked by asterisks.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.", + "type": "string" + }, + "concealValueOnDocumentMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `concealValueOnDocument` property is editable." + }, "conditionalParentLabel": { "description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility.", "type": "string" @@ -36496,15 +47771,23 @@ "description": "Metadata that indicates whether the `conditionalParentValue` property is editable." }, "customTabId": { - "description": "The DocuSign-generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.", + "description": "The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.", "type": "string" }, "customTabIdMetadata": { "$ref": "#/definitions/propertyMetadata", "description": "Metadata that indicates whether the `customTabId` property is editable." }, + "disableAutoSize": { + "description": "When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes.", + "type": "string" + }, + "disableAutoSizeMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `disableAutoSize` property is editable." + }, "documentId": { - "description": "Integer that identifies the document in the envelope.", + "description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.", "type": "string" }, "documentIdMetadata": { @@ -36563,6 +47846,14 @@ "$ref": "#/definitions/propertyMetadata", "description": "Metadata that indicates whether the `fromPageNumber` property is editable." }, + "formula": { + "description": "Contains the formula\nfor calculating the value of\nthis tab.\n\nUse a tab's `tabLabel`,\nenclosed in brackets,\nto refer to it.\n\nFor example,\nyou want to present the total cost\nof two items, tax included.\n\nThe cost of each item is stored\nin number tabs labeled Item1 and Item2.\nThe tax rate is in a number tab\nlabeled TaxRate.\n\nThe formula string for this property\nwould be:\n`([Item1] + [Item2]) * (1 + [TaxRate])`\n\nSee [Calculated Fields][calculatedfields]\nin the DocuSign Support Center\nto learn more about formulas.\n\nMaximum Length: 2000 characters\n\n[calculatedfields]: https://support.docusign.com/en/guides/ndse-user-guide-calculated-fields\n", + "type": "string" + }, + "formulaMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata indicating if the sender can edit the `formula` property." + }, "height": { "description": "The height of the tab in pixels.", "type": "string" @@ -36579,21 +47870,6 @@ "$ref": "#/definitions/propertyMetadata", "description": "Metadata that indicates whether the `italic` property is editable." }, - "listItems": { - "description": "The list of values that can be selected by senders. The list values are separated by semi-colons. Example: [one;two;three;four]\n\nMaximum Length of listItems: 2048 characters.\nMaximum Length of items in the list: 100 characters. \n", - "type": "array", - "items": { - "$ref": "#/definitions/listItem" - } - }, - "listSelectedValue": { - "description": "The value in the list that is selected by default.", - "type": "string" - }, - "listSelectedValueMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `listSelectedValue` property is editable." - }, "localePolicy": { "$ref": "#/definitions/localePolicyTab", "description": "Reserved for DocuSign." @@ -36606,10 +47882,38 @@ "$ref": "#/definitions/propertyMetadata", "description": "Metadata that indicates whether the `locked` property is editable." }, + "maxLength": { + "description": "An optional value that describes the maximum length of the property when the property is a string.", + "type": "string" + }, + "maxLengthMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `maxLength` property is editable." + }, "mergeField": { "$ref": "#/definitions/mergeField", "description": "Contains the information necessary to map the tab to a field in SalesForce." }, + "mergeFieldXml": { + "description": "", + "type": "string" + }, + "name": { + "description": "The name of the tab. For example, `Sign Here` or `Initial Here`.", + "type": "string" + }, + "nameMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `name` property is editable. Read only." + }, + "originalValue": { + "description": "The initial value of the tab when it was sent to the recipient. ", + "type": "string" + }, + "originalValueMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `originalValue` property is editable." + }, "pageNumber": { "description": "The page number on which the tab is located. For supplemental documents, this value must be `1`.\n", "type": "string" @@ -36619,11 +47923,11 @@ "description": "Metadata that indicates whether the `pageNumber` property is editable." }, "recipientId": { - "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", + "description": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.", "type": "string" }, "recipientIdGuid": { - "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one.", + "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only.", "type": "string" }, "recipientIdGuidMetadata": { @@ -36674,6 +47978,10 @@ "$ref": "#/definitions/propertyMetadata", "description": "Metadata that indicates whether the `shared` property is editable." }, + "smartContractInformation": { + "$ref": "#/definitions/smartContractInformation", + "description": "" + }, "status": { "description": "The status of the tab. Possible values are:\n\n- `active`: The tab is active, but the recipient has not yet interacted with it.\n- `signed`: The recipient signed the tab.\n- `declined`: The recipient declined the envelope.\n- `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`).", "type": "string" @@ -36702,7 +48010,7 @@ "description": "Metadata that indicates whether the `tabId` property is editable." }, "tabLabel": { - "description": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n", + "description": "The label associated with the tab. This value may be an empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum Length: 500 characters.\n", "type": "string" }, "tabLabelMetadata": { @@ -36757,8 +48065,24 @@ "$ref": "#/definitions/propertyMetadata", "description": "Metadata that indicates whether the `underline` property is editable." }, + "validationMessage": { + "description": "The message displayed if the custom tab fails input validation (either custom of embedded).", + "type": "string" + }, + "validationMessageMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `validationMessage` property is editable." + }, + "validationPattern": { + "description": "A regular expression used to validate input for the tab.", + "type": "string" + }, + "validationPatternMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `validationPattern` property is editable." + }, "value": { - "description": "The value to use when the item is selected.", + "description": "Specifies the value of the tab. ", "type": "string" }, "valueMetadata": { @@ -36774,7 +48098,7 @@ "description": "Metadata that indicates whether the `width` property is editable." }, "xPosition": { - "description": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n", + "description": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n", "type": "string" }, "xPositionMetadata": { @@ -36782,7 +48106,7 @@ "description": "Metadata that indicates whether the `xPosition` property is editable." }, "yPosition": { - "description": "This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.", + "description": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n", "type": "string" }, "yPositionMetadata": { @@ -36790,804 +48114,471 @@ "description": "Metadata that indicates whether the `yPosition` property is editable." } }, - "x-ds-definition-name": "list", - "description": "This tab offers a list of options to choose from.\nThe `listItems`\nproperty contains a list of\n[`listItem`](https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/listItem)\nobjects to specify the selectable options.\n", - "x-ms-summary": "This tab offers a list of options to choose from.\nThe `listItems`\nproperty contains a list of\n[`listItem`](https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/listItem)\nobjects to specify the selectable options.\n" - }, - "listCustomField": { - "type": "object", - "properties": { - "configurationType": { - "description": "If merge fields are being used, specifies the type of the merge field. The only supported value is **salesforce**.", - "type": "string" - }, - "errorDetails": { - "$ref": "#/definitions/errorDetails", - "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." - }, - "fieldId": { - "description": "An ID used to specify a custom field.", - "type": "string" - }, - "listItems": { - "description": "An array of strings that represent the items in a list.", - "type": "array", - "items": { - "type": "string" - } - }, - "name": { - "description": "The name of the custom field.", - "type": "string" - }, - "required": { - "description": "When set to **true**, the signer is required to fill out this tab.", - "type": "string" - }, - "show": { - "description": "A boolean indicating if the value should be displayed. If this value is set to **true**, the custom field is displayed at the top of the certificate of completion. If this value is left blank/ or set to **false**, then it does not appear in the certificate of completion. ", - "type": "string" - }, - "value": { - "description": "The value of the custom field.\n\nMaximum Length: 100 characters.", - "type": "string" - } - }, - "x-ds-definition-name": "listCustomField", - "description": "", - "x-ms-summary": "" - }, - "listItem": { - "type": "object", - "properties": { - "selected": { - "description": "When set to **true**, indicates that this item is the default selection shown to a signer. \n\nOnly one selection can be set as the default.", - "type": "string" - }, - "selectedMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `selected` property is editable." - }, - "text": { - "description": "Specifies the text that is shown in the dropdown list. ", - "type": "string" - }, - "textMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "" - }, - "value": { - "description": "Specifies the value that is used when the list item is selected.", - "type": "string" - }, - "valueMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `value` property is editable." - } - }, - "x-ds-definition-name": "listItem", - "description": "One of the selectable items\nin the `listItems` property\nof a [`list`](https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/list) tab.", - "x-ms-summary": "One of the selectable items\nin the `listItems` property\nof a [`list`](https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/list) tab." - }, - "localePolicy": { - "type": "object", - "properties": { - "addressFormat": { - "description": "", - "type": "string" - }, - "addressFormatMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "" - }, - "allowRegion": { - "description": "", - "type": "string" - }, - "calendarType": { - "description": "", - "type": "string" - }, - "calendarTypeMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "" - }, - "cultureName": { - "description": "", - "type": "string" - }, - "cultureNameMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "" - }, - "currencyCode": { - "description": "The currency code for the account, based on the [ISO 4217 currency code](https://www.iso.org/iso-4217-currency-codes.html).", - "type": "string" - }, - "currencyCodeMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "" - }, - "currencyNegativeFormat": { - "description": "", - "type": "string" - }, - "currencyNegativeFormatMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "" - }, - "currencyPositiveFormat": { - "description": "", - "type": "string" - }, - "currencyPositiveFormatMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "" - }, - "customDateFormat": { - "description": "", - "type": "string" - }, - "customSignDateFormat": { - "description": "", - "type": "string" - }, - "customSignTimeFormat": { - "description": "", - "type": "string" - }, - "customTimeFormat": { - "description": "", - "type": "string" - }, - "dateFormat": { - "description": "", - "type": "string" - }, - "dateFormatMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "" - }, - "effectiveAddressFormat": { - "description": "", - "type": "string" - }, - "effectiveCalendarType": { - "description": "", - "type": "string" - }, - "effectiveCurrencyCode": { - "description": "", - "type": "string" - }, - "effectiveCurrencyNegativeFormat": { - "description": "", - "type": "string" - }, - "effectiveCurrencyPositiveFormat": { - "description": "", - "type": "string" - }, - "effectiveCustomDateFormat": { - "description": "", - "type": "string" - }, - "effectiveCustomTimeFormat": { - "description": "", - "type": "string" - }, - "effectiveDateFormat": { - "description": "", - "type": "string" - }, - "effectiveInitialFormat": { - "description": "", - "type": "string" - }, - "effectiveNameFormat": { - "description": "", - "type": "string" - }, - "effectiveTimeFormat": { - "description": "", - "type": "string" - }, - "effectiveTimeZone": { - "description": "", - "type": "string" - }, - "initialFormat": { - "description": "", - "type": "string" - }, - "initialFormatMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "" - }, - "nameFormat": { - "description": "", - "type": "string" - }, - "nameFormatMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "" - }, - "signDateFormat": { - "description": "The format for the signature date. Valid values are:\n\n\n- `d/M/yyyy`\n- `dd-MM-yy`\n- `dd-MMM-yy`\n- `dd-MM-yyyy`\n- `dd.MM.yyyy`\n- `dd-MMM-yyyy`\n- `dd MMMM yyyy`\n- `M/d/yyyy`\n- `MM-dd-yyyy`\n- `MM/dd/yyyy`\n- `MM/dd/yy`\n- `MMM-dd-yyyy`\n- `MMM d, yyyy`\n- `MMMM d, yyyy`\n- `yyyy-MM-dd`\n- `yyyy-MMM-dd`\n- `yyyy/MM/dd`\n- `yyyy MMMM d`\n\n\n", - "type": "string" - }, - "signDateFormatMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `signDateFormat` property is editable.\n" - }, - "signTimeFormat": { - "description": "The format for the signature time. Valid values are:\n\n- `none`\n- `HH:mm`\n- `h:mm`\n- `HH:mm:ss`\n- `h:mm:ss`\n", - "type": "string" - }, - "signTimeFormatMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `signTimeFormat` property is editable.\n" - }, - "timeFormat": { - "description": "", - "type": "string" - }, - "timeFormatMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "" - }, - "timeZone": { - "description": "", - "type": "string" - }, - "timeZoneMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "" - } - }, - "x-ds-definition-name": "localePolicy", - "description": "", - "x-ms-summary": "" + "x-ds-definition-name": "number", + "description": "A tab that allows the recipient to enter numbers and decimal\n(.) points.\n", + "x-ms-summary": "A tab that allows the recipient to enter numbers and decimal\n(.) points.\n" }, - "localePolicyTab": { + "oauthAccess": { "type": "object", "properties": { - "addressFormat": { - "description": "", + "access_token": { + "description": "Access token information.", "type": "string" }, - "calendarType": { - "description": "", - "type": "string" + "data": { + "description": "A Base64-encoded representation of the attachment that is used to upload and download the file. File attachments may be up to 50 MB in size.", + "type": "array", + "items": { + "$ref": "#/definitions/nameValue" + } }, - "cultureName": { + "expires_in": { "description": "", "type": "string" }, - "currencyNegativeFormat": { + "refresh_token": { "description": "", "type": "string" }, - "currencyPositiveFormat": { - "description": "", + "scope": { + "description": "Must be set to \"api\".", "type": "string" }, - "customDateFormat": { + "token_type": { "description": "", "type": "string" + } + }, + "x-ds-definition-name": "oauthAccess", + "description": "", + "x-ms-summary": "" + }, + "page": { + "description": "Description of a page of a document.", + "type": "object", + "properties": { + "dpi": { + "description": "The number of dots per inch used for the page image.", + "type": "string" }, - "customTimeFormat": { - "description": "", + "errorDetails": { + "$ref": "#/definitions/errorDetails", + "description": "If an error occurs, this property describes the error." + }, + "height": { + "description": "The height of the page in pixels.", "type": "string" }, - "dateFormat": { - "description": "", + "imageBytes": { + "description": "The number of image bytes.", "type": "string" }, - "initialFormat": { - "description": "", + "mimeType": { + "description": "The MIME type.", "type": "string" }, - "nameFormat": { - "description": "", + "pageId": { + "description": "The id of the page.", "type": "string" }, - "timeFormat": { - "description": "", + "sequence": { + "description": "The sequence of the page in the document, or page number.", "type": "string" }, - "timeZone": { - "description": "", + "width": { + "description": "The width of the page in pixels.", "type": "string" } }, - "x-ds-definition-name": "localePolicyTab", - "description": "", - "x-ms-summary": "" + "x-ds-definition-name": "page", + "x-ms-summary": "Description of a page of a document." }, - "lockInformation": { + "pageImages": { "type": "object", "properties": { - "errorDetails": { - "$ref": "#/definitions/errorDetails", - "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." - }, - "lockDurationInSeconds": { - "description": "The number of seconds to lock the envelope for editing. This value must be greater than `0` seconds.", + "endPosition": { + "description": "The last index position in the result set. ", "type": "string" }, - "lockedByApp": { - "description": "The friendly name of the application that is locking the envelope or template. It appears in error messages to the user when lock conflicts occur.", + "nextUri": { + "description": "The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. ", "type": "string" }, - "lockedByUser": { - "$ref": "#/definitions/userInfo", - "description": "A complex type containing information about the user that has the envelope or template locked." + "pages": { + "description": "An array of page objects.", + "type": "array", + "items": { + "$ref": "#/definitions/page" + } }, - "lockedUntilDateTime": { - "description": "The date and time that the lock expires.", + "previousUri": { + "description": "The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. ", "type": "string" }, - "lockToken": { - "description": "A unique identifier provided to the owner of the lock. You must use this token with subsequent calls to prove ownership of the lock.", + "resultSetSize": { + "description": "The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`.", "type": "string" }, - "lockType": { - "description": "The type of lock. Currently `edit` is the only supported type.", + "startPosition": { + "description": "The starting index position of the current result set.", "type": "string" }, - "useScratchPad": { - "description": "Indicates whether a scratchpad is used for editing information.\n ", + "totalSetSize": { + "description": "The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`.", "type": "string" } }, - "x-ds-definition-name": "lockInformation", + "x-ds-definition-name": "pageImages", "description": "", "x-ms-summary": "" }, - "lockRequest": { + "pageRequest": { "type": "object", "properties": { - "lockDurationInSeconds": { - "description": "The number of seconds to lock the envelope for editing. This value must be greater than `0` seconds.", + "password": { + "description": "The user's encrypted password hash.", "type": "string" }, - "lockedByApp": { - "description": "The friendly name of the application that is locking the envelope or template. It appears in error messages to the user when lock conflicts occur.", + "rotate": { + "description": "Sets the direction the page image is rotated. The possible settings are: left or right", "type": "string" - }, - "lockType": { - "description": "The type of lock. Currently `edit` is the only supported type.", + } + }, + "x-ds-definition-name": "pageRequest", + "description": "", + "x-ms-summary": "" + }, + "pathExtendedElement": { + "type": "object", + "properties": { + "name": { + "description": "", "type": "string" }, - "templatePassword": { + "type": { "description": "", "type": "string" }, - "useScratchPad": { - "description": "Indicates whether a scratchpad is used for editing information.\n ", + "typeName": { + "description": "", "type": "string" } }, - "x-ds-definition-name": "lockRequest", + "x-ds-definition-name": "pathExtendedElement", "description": "", "x-ms-summary": "" }, - "loginAccount": { + "paymentDetails": { "type": "object", "properties": { - "accountId": { - "description": "The account ID associated with the envelope.", + "allowedPaymentMethods": { + "description": "An array of accepted payment methods:\n\n* `CreditCard`\n* `ApplePay`\n* `AndroidPay`\n* `BankAccount`\n\nFor example, if you only accept credit cards and ACH transfers, you would set this property to:\n\n`'[\"BankAccount\", \"CreditCard\"]'`\n\nDo not specify `BankAccount` (ACH) if you are also using in-person signing.\n", + "type": "array", + "items": { + "type": "string" + } + }, + "chargeId": { + "description": "The GUID set by the payment gateway (such as Stripe) that identifies a transaction. The `chargeId` is created when authorizing a payment and must be referenced when completing a payment.", "type": "string" }, - "accountIdGuid": { - "description": "The GUID associated with the account ID.", + "currencyCode": { + "description": "Specifies the three-letter\n[ISO 4217][ISO4217] currency code for the payment.\n\nSupported currencies are:\n\n* AUD: Australian dollar\n* CAD: Canadian dollar\n* EUR: Euro\n* GBP: Great Britain pound\n* USD: United States dollar\n\nSpecifying any other ISO 4217 code for payments is an error.\n\n[ISO4217]: https://en.wikipedia.org/wiki/ISO_4217\n", "type": "string" }, - "baseUrl": { - "description": "The URL that should be used for successive calls to this account. It includes the protocal (https), the DocuSign server where the account is located, and the account number. Use this Url to make API calls against this account. Many of the API calls provide Uri's that are relative to this baseUrl.", + "currencyCodeMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `currencyCode` property is editable." + }, + "customerId": { + "description": "The customer ID.", "type": "string" }, - "email": { - "description": "The email address for the user.", + "customMetadata": { + "description": "This is a sender-defined field that passes any extra metadata about the payment that will show up in the Authorize.net transaction under **Description** in the merchant gateway portal. The custom metadata will be recorded in downloaded Authorize.net reports. \n\nThe following example shows what the **Description** field of the transaction will look like: \n\n`, `", "type": "string" }, - "isDefault": { - "description": "This value is true if this is the default account for the user, otherwise false is returned.", + "customMetadataRequired": { + "description": "A sender-defined field that specifies whether custom metadata is required for the transaction. When set to **true**, custom metadata is required. This property only applies if you are using an Authorize.net payment gateway account.", + "type": "boolean" + }, + "gatewayAccountId": { + "description": "A GUID that identifies the payment gateway\nconnected to the sender's DocuSign account.\n\nThere is no public API\nfor connecting payment gateway accounts\nYou must connect and manage payment gateway accounts\nthrough the DocuSign Admin console\nand through your chosen payment gateway.\n\nYou can get the gateway account ID\nin the Payments section\nof the DocuSign Admin console.\n\n\n[paymentgateways]: https://support.docusign.com/en/guides/managing-payment-gateways\n", "type": "string" }, - "loginAccountSettings": { - "description": "A list of settings on the acccount that indicate what features are available.", - "type": "array", - "items": { - "$ref": "#/definitions/nameValue" - } + "gatewayAccountIdMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `gatewayAccountId` property is editable." }, - "loginUserSettings": { - "description": "A list of user-level settings that indicate what user-specific features are available.", + "gatewayDisplayName": { + "description": "Display name of the gateway connected to sender's Docusign account.\n\nPossible values are: Stripe, Braintree, Authorize.Net.", + "type": "string" + }, + "gatewayName": { + "description": "Name of the gateway connected to sender's DocuSign account.\n\nPossible values are:\n\n* `Stripe`\n* `Braintree`\n* `AuthorizeDotNet`", + "type": "string" + }, + "lineItems": { + "description": "A payment formula can have\none or more line items\nthat provide detail about\nindividual items in a payment request.\n\nThe list of line items\nare returned as metadata\nto the payment gateway.\n", "type": "array", "items": { - "$ref": "#/definitions/nameValue" + "$ref": "#/definitions/paymentLineItem" } }, - "name": { - "description": "The name associated with the account.", + "paymentOption": { + "description": "This property specifies how the signer's collected payment details will be used.\n\nPossible values:\n\n- `authorize`: The payment details will be used to collect payment. This is the default value.\n- `save`: The signer's payment method (credit card or bank account) will be saved to the sender's payment gateway.\n- `save_and_authorize`: The signer's payment method (credit card or bank account) will be saved to the sender's payment gateway and will also be used to collect payment.", "type": "string" }, - "siteDescription": { - "description": "An optional descirption of the site that hosts the account.", + "paymentSourceId": { + "description": "The payment source ID.", "type": "string" }, - "userId": { - "description": "The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.\n", - "type": "string" + "signerValues": { + "$ref": "#/definitions/paymentSignerValues", + "description": "" }, - "userName": { - "description": "The name of this user as defined by the account.", - "type": "string" - } - }, - "x-ds-definition-name": "loginAccount", - "description": "", - "x-ms-summary": "" - }, - "loginInformation": { - "type": "object", - "properties": { - "apiPassword": { - "description": "Contains a token that can be used for authentication in API calls instead of using the user name and password.", + "status": { + "description": "This read-only property describes the status of a payment.\n\n* `new`
\n This is a new payment request.\n The envelope has been created,\n but no payment authorizations have been made.\n\n* `auth_complete`
\n A recipient has entered their credit card information,\n but the envelope has not been completed.\n The card has not been charged.\n\n* `payment_complete`
\n The recipient's card has been charged.\n\n* `payment_capture_failed`
\n Final charge failed.\n This can happen when too much time\n passes between authorizing the payment\n and completing the document.\n\n* `future_payment_saved`
\nThe recipient's payment method has been saved to the sender's payment gateway.\n", "type": "string" }, - "loginAccounts": { - "description": "The list of accounts that authenticating user is a member of.", - "type": "array", - "items": { - "$ref": "#/definitions/loginAccount" - } + "total": { + "$ref": "#/definitions/money", + "description": "This read-only property\nis a currency-formatted string\nthat represents the total\nof all the line items.\nThe total is available\nonly after the document is completed,\nwhich is when all recipients have paid and\nhave completed all required fields.\n" } }, - "x-ds-definition-name": "loginInformation", - "description": "", - "x-ms-summary": "" + "x-ds-definition-name": "paymentDetails", + "description": "When a formula tab\nhas a `paymentDetails` property,\nthe formula tab\nis a payment item.\nSee [Requesting Payments Along with Signatures][paymentguide]\nin the DocuSign Support Center\nto learn more about payments.\n\n[paymentguide]: https://support.docusign.com/en/guides/requesting-payments-along-with-signatures\n", + "x-ms-summary": "When a formula tab\nhas a `paymentDetails` property,\nthe formula tab\nis a payment item.\nSee [Requesting Payments Along with Signatures][paymentguide]\nin the DocuSign Support Center\nto learn more about payments.\n\n[paymentguide]: https://support.docusign.com/en/guides/requesting-payments-along-with-signatures\n" }, - "matchBox": { + "paymentGatewayAccount": { "type": "object", "properties": { - "height": { - "description": "The height of the tab in pixels.", + "allowCustomMetadata": { + "description": "When **true**, the sender can pass custom metadata about the payment to the payment gateway. You pass in this metadata on an EnvelopeRecipientTab, in the `customMetadata` property under `paymentDetails`. \n\nFor example, this property is set to **true** for the Authorize.net gateway by default. As a result, the extra metadata that you send displays for the Authorize.net transaction in the merchant gateway portal under **Description**.\n\n**Note**: This property is read only and cannot be changed.", + "type": "boolean" + }, + "config": { + "$ref": "#/definitions/paymentGatewayAccountSetting", + "description": "This property contains metadata about the payment gateway account's configuration such as the API key, `userId`, and `merchantId` details." + }, + "displayName": { + "description": "A user-defined name for a connected gateway account.\n\nThis name is used in the Admin panel in the list of connected accounts and in Tagger in the payment gateway selector.\n\nThe human-readable version of `paymentGatewayAccountId`.", "type": "string" }, - "pageNumber": { - "description": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n", + "isEnabled": { + "description": "When **true**, the payment gateway account is enabled.", "type": "string" }, - "width": { - "description": "The width of the tab in pixels.", + "isLegacy": { + "description": "Reserved for DocuSign.", "type": "string" }, - "xPosition": { - "description": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n", + "lastModified": { + "description": "The UTC DateTime that the payment gateway account was last updated.", "type": "string" }, - "yPosition": { - "description": "This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.", + "paymentGateway": { + "description": "Payment gateway used by the connected gateway account.\nThis is the name used by the API.\nFor a human-readable version use `paymentGatewayDisplayName`.\n\nPossible values are:\n\n* `Stripe`\n* `Braintree`\n* `AuthorizeDotNet`", "type": "string" - } - }, - "x-ds-definition-name": "matchBox", - "description": "", - "x-ms-summary": "" - }, - "memberGroupSharedItem": { - "type": "object", - "properties": { - "errorDetails": { - "$ref": "#/definitions/errorDetails", - "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." }, - "group": { - "$ref": "#/definitions/group", - "description": "The group sharing the item." + "paymentGatewayAccountId": { + "description": "A GUID that identifies the payment gateway account. For a human-readable version use `displayName`.", + "type": "string" }, - "shared": { - "description": "How the item is shared. One of:\n\n\n- `not_shared`: The item is not shared.\n\n- `shared_to`: The item is shared.", + "paymentGatewayDisplayName": { + "description": "The display name of the payment gateway that the connected gateway account uses.\nThis is the human-readable version of `paymentGateway`.\n\nPossible values are:\n\n* Stripe\n* Braintree\n* Authorize.Net", "type": "string" - } - }, - "x-ds-definition-name": "memberGroupSharedItem", - "description": "Information about items shared among groups.", - "x-ms-summary": "Information about items shared among groups." - }, - "memberSharedItems": { - "type": "object", - "properties": { - "envelopes": { - "description": "List of information about shared envelopes.", + }, + "payPalLegacySettings": { + "$ref": "#/definitions/payPalLegacySettings", + "description": "Reserved for DocuSign." + }, + "supportedCurrencies": { + "description": "A list of ISO 4217 currency codes for the currencies that the payment gateway account supports.\n\nExamples: \n\n- `USD`\n- `CAD`\n- `EUR`\n- `HKD`", "type": "array", "items": { - "$ref": "#/definitions/sharedItem" + "type": "string" } }, - "errorDetails": { - "$ref": "#/definitions/errorDetails", - "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." - }, - "folders": { - "description": "List of information about shared folders.", + "supportedPaymentMethods": { + "description": "An array of paymentMethodWithOptions objects that specify the payment methods that are available for the gateway.", "type": "array", "items": { - "$ref": "#/definitions/folderSharedItem" + "type": "string" } }, - "templates": { - "description": "List of information about shared templates.", + "supportedPaymentMethodsWithOptions": { + "description": "An array of `paymentMethodWithOptions` objects that specify the payment methods that are available for the gateway, as well as the payment options that are compatible with each payment method.", "type": "array", "items": { - "$ref": "#/definitions/templateSharedItem" + "$ref": "#/definitions/paymentMethodWithOptions" } }, - "user": { - "$ref": "#/definitions/userInfo", - "description": "Information about the user requesting sharing information." - } - }, - "x-ds-definition-name": "memberSharedItems", - "description": "Information about shared items.", - "x-ms-summary": "Information about shared items." - }, - "mergeField": { - "description": "Contains information for transfering values between Salesforce data fields and DocuSign Tabs.", - "type": "object", - "properties": { - "allowSenderToEdit": { - "description": "When **true**, the sender can modify the value of the `mergeField` tab during the sending process.", - "type": "string" - }, - "allowSenderToEditMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the `allowSenderToEdit` property." - }, - "configurationType": { - "description": "If merge fields are being used, specifies the type of the merge field. The only supported value is **salesforce**.", - "type": "string" - }, - "configurationTypeMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the `configurationType` property." - }, - "path": { - "description": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.", - "type": "string" - }, - "pathExtended": { - "description": "Reserved for DocuSign.", + "zeroDecimalCurrencies": { + "description": "", "type": "array", "items": { - "$ref": "#/definitions/pathExtendedElement" + "type": "string" } - }, - "pathExtendedMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." - }, - "pathMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `path` property is editable.\n" - }, - "row": { - "description": "Specifies the row number in a Salesforce table that the merge field value corresponds to.", - "type": "string" - }, - "rowMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `row` property is editable.\n" - }, - "writeBack": { - "description": "When **true**, data entered into the merge field during Signing will update the mapped Salesforce field.", - "type": "string" - }, - "writeBackMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the `writeBack` property." } }, - "x-ds-definition-name": "mergeField", - "x-ms-summary": "Contains information for transfering values between Salesforce data fields and DocuSign Tabs." + "x-ds-definition-name": "paymentGatewayAccount", + "description": "This object contains details about a payment gateway account.", + "x-ms-summary": "This object contains details about a payment gateway account." }, - "mobileNotifierConfiguration": { + "paymentGatewayAccountSetting": { "type": "object", "properties": { - "deviceId": { + "apiFields": { "description": "", "type": "string" }, - "errorDetails": { - "$ref": "#/definitions/errorDetails", - "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." + "authorizationCode": { + "description": "", + "type": "string" }, - "platform": { - "description": "The Platform of the client application", + "credentialStatus": { + "description": "", + "type": "string" + }, + "merchantId": { + "description": "", "type": "string" } }, - "x-ds-definition-name": "mobileNotifierConfiguration", + "x-ds-definition-name": "paymentGatewayAccountSetting", "description": "", "x-ms-summary": "" }, - "mobileNotifierConfigurationInformation": { + "paymentGatewayAccountsInfo": { "type": "object", "properties": { - "mobileNotifierConfigurations": { - "description": "", + "paymentGatewayAccounts": { + "description": "A list of payment gateway accounts.", "type": "array", "items": { - "$ref": "#/definitions/mobileNotifierConfiguration" + "$ref": "#/definitions/paymentGatewayAccount" } } }, - "x-ds-definition-name": "mobileNotifierConfigurationInformation", - "description": "", - "x-ms-summary": "" + "x-ds-definition-name": "paymentGatewayAccountsInfo", + "description": "Holds information about connected payment accounts.", + "x-ms-summary": "Holds information about connected payment accounts." }, - "money": { + "paymentLineItem": { "type": "object", "properties": { - "amountInBaseUnit": { - "description": "The total payment amount\nin the currency's base unit.\nFor example, for USD\nthe base currency is one cent.\n", + "amountReference": { + "description": "This is a the `tabLabel`\nthat specifies the amount paid\nfor the line items.\n\n", "type": "string" }, - "currency": { - "description": "The three-letter\n[ISO 4217][ISO4217] currency code for the payment.\n\nFor example:\n\n* AUD Australian dollar\n* CAD Canadian dollar\n* EUR Euro\n* GBP Great Britain pound\n* USD United States dollar\n\nThis is a read-only property.\n\n[ISO4217]: https://en.wikipedia.org/wiki/ISO_4217\n", + "description": { + "description": "A sender-defined description of the line item.\n", "type": "string" }, - "displayAmount": { - "description": "The payment amount as displayed\nin the `currency`.\n\nFor example, if the payment amount\nis USD 12.59,\nthe `amountInBaseUnit` is 1259 (cents),\nand the displayed amount is `$12.59 USD`.\n\nThis is a read-only property.\n", + "itemCode": { + "description": "This is the sender-defined\nSKU, inventory number, or other item code\nfor the line item.\n", + "type": "string" + }, + "name": { + "description": "This is a sender-defined\nproduct name, service name,\nor other designation for the line item.\n", "type": "string" } }, - "x-ds-definition-name": "money", - "description": "Describes information\nabout the `total` of a payment.\n", - "x-ms-summary": "Describes information\nabout the `total` of a payment.\n" + "x-ds-definition-name": "paymentLineItem", + "description": "A line item describes details\nabout an individual line item\nin a payment request.\n\n", + "x-ms-summary": "A line item describes details\nabout an individual line item\nin a payment request.\n\n" }, - "nameValue": { + "paymentMethodWithOptions": { "type": "object", "properties": { - "errorDetails": { - "$ref": "#/definitions/errorDetails", - "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." + "supportedOptions": { + "description": "The payment options that are compatible with the payment method in the `type` property.\n\nPossible values are:\n\n- `save` \n- `save_and_authorize`\n- `authorize`", + "type": "array", + "items": { + "type": "string" + } }, - "name": { - "description": "The name of the item.", + "type": { + "description": "The name of a payment method that the gateway accepts.\n\nPossible values are:\n\n- `CreditCard`\n- `ApplePay`\n- `AndroidPay`\n- `BankAccount`\n- `PayPal`", "type": "string" + } + }, + "x-ds-definition-name": "paymentMethodWithOptions", + "description": "This object contains information about a payment method that the gateway accepts and the payment options that are compatible with it.", + "x-ms-summary": "This object contains information about a payment method that the gateway accepts and the payment options that are compatible with it." + }, + "paymentProcessorInformation": { + "type": "object", + "properties": { + "address": { + "$ref": "#/definitions/addressInformation", + "description": "The mailing address associated with the payment processor." }, - "originalValue": { - "description": "The initial value of the item.", + "billingAgreementId": { + "description": "The id of the billing agreement.", "type": "string" }, - "value": { - "description": "The current value of the item.", + "email": { + "description": "The email address associated with the payment processor.", "type": "string" } }, - "x-ds-definition-name": "nameValue", + "x-ds-definition-name": "paymentProcessorInformation", "description": "", "x-ms-summary": "" }, - "newAccountDefinition": { + "paymentSignerValues": { "type": "object", "properties": { - "accountName": { - "description": "The account name for the new account.", - "type": "string" - }, - "accountSettings": { - "$ref": "#/definitions/accountSettingsInformation", - "description": "The list of\n[account settings][accountsettings]\nthat determine\nthe features available for the account.\nNote that some features are determined\nby the plan used to create the account and cannot be overridden.\n\n[accountsettings]: https://developers.docusign.com/esign-rest-api/reference/Accounts/Accounts/create/#account-settings\n" - }, - "addressInformation": { - "$ref": "#/definitions/accountAddress", - "description": "A complex type that contains the following information for the new account: `Street1`, `Street2`, `City`, `State`, `Zip`, `Phone`, and `Fax`." - }, - "creditCardInformation": { - "$ref": "#/definitions/creditCardInformation", - "description": "A complex type that has information about the credit card used to pay for this account." - }, - "directDebitProcessorInformation": { - "$ref": "#/definitions/directDebitProcessorInformation", - "description": "Information about the bank that processes direct debits for the payment plan." - }, - "distributorCode": { - "description": "The code that identifies the billing plan groups and plans for the new account.", - "type": "string" - }, - "distributorPassword": { - "description": "The password for the distributorCode.", - "type": "string" - }, - "initialUser": { - "$ref": "#/definitions/Users", - "description": "A complex type with the initial user information for the new account. Note that some user information is set internally based on the plan and cannot be overridden." - }, - "paymentMethod": { - "description": "The payment method used for the billing plan. Valid values are:\n\n- `NotSupported`\n- `CreditCard`\n- `PurchaseOrder`\n- `Premium`\n- `Freemium`\n- `FreeTrial`\n- `AppStore`\n- `DigitalExternal`\n- `DirectDebit`", + "paymentOption": { + "description": "This property specifies how the signer's collected payment details will be used.\n\nPossible values:\n\n- `authorize`: The payment details will be used to collect payment. This is the default value.\n- `save`: The signer's payment method (credit card or bank account) will be saved to the sender's payment gateway.\n- `save_and_authorize`: The signer's payment method (credit card or bank account) will be saved to the sender's payment gateway and will also be used to collect payment.", "type": "string" - }, - "paymentProcessorInformation": { - "$ref": "#/definitions/paymentProcessorInformation", - "description": "Information about the entity that processes payments for the billing plan." - }, - "planInformation": { - "$ref": "#/definitions/planInformation", - "description": "An object used to identify the features and attributes of the account being created." - }, - "referralInformation": { - "$ref": "#/definitions/referralInformation", - "description": "A complex type that contains the following information for entering referral and discount information. The following items are included in the referral information (all string content): enableSupport, includedSeats, saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, saleDiscountSeatPriceOverride, planStartMonth, referralCode, referrerName, advertisementId, publisherId, shopperId, promoCode, groupMemberId, idType, and industry \n\n###### Note: saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, and saleDiscountSeatPriceOverride are reserved for DoucSign use only. \n" - }, - "socialAccountInformation": { - "$ref": "#/definitions/UserSocialAccountLogins", - "description": "Contains properties that map a DocuSign user to a social account (Facebook, Yahoo, etc.)" } }, - "x-ds-definition-name": "newAccountDefinition", + "x-ds-definition-name": "paymentSignerValues", "description": "", "x-ms-summary": "" }, - "newAccountSummary": { + "payPalLegacySettings": { "type": "object", "properties": { - "accountId": { - "description": "The account ID associated with the envelope.", - "type": "string" - }, - "accountIdGuid": { - "description": "The GUID associated with the account ID.", + "currency": { + "description": "The three-letter\n[ISO 4217][ISO4217] currency code for the payment.\n\nFor example:\n\n* AUD Australian dollar\n* CAD Canadian dollar\n* EUR Euro\n* GBP Great Britain pound\n* USD United States dollar\n\nThis is a read-only property.\n\n[ISO4217]: https://en.wikipedia.org/wiki/ISO_4217\n", "type": "string" }, - "accountName": { - "description": "The account name for the new account.", + "partner": { + "description": "", "type": "string" }, - "apiPassword": { - "description": "Contains a token that can be used for authentication in API calls instead of using the user name and password.", + "password": { + "description": "The user's encrypted password hash.", "type": "string" }, - "baseUrl": { - "description": "The URL that should be used for successive calls to this account. It includes the protocal (https), the DocuSign server where the account is located, and the account number. Use this Url to make API calls against this account. Many of the API calls provide Uri's that are relative to this baseUrl.", + "userName": { + "description": "The name of the user.", "type": "string" }, - "billingPlanPreview": { - "$ref": "#/definitions/billingPlanPreview", - "description": "" - }, - "userId": { - "description": "Specifies the user ID of the new user.", + "vendor": { + "description": "", "type": "string" } }, - "x-ds-definition-name": "newAccountSummary", + "x-ds-definition-name": "payPalLegacySettings", "description": "", "x-ms-summary": "" }, - "newUser": { + "permissionProfile": { "type": "object", "properties": { - "apiPassword": { - "description": "Contains a token that can be used for authentication in API calls instead of using the user name and password.", - "type": "string" - }, - "createdDateTime": { - "description": "The date and time the item was created.", + "modifiedByUsername": { + "description": "The username of the user who last modified the permission profile.", "type": "string" }, - "email": { - "description": "Filters returned user records by the specified email address.", + "modifiedDateTime": { + "description": "The date and time when the permission profile was last modified.", "type": "string" }, - "errorDetails": { - "$ref": "#/definitions/errorDetails", - "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." - }, "permissionProfileId": { "description": "The ID of the permission profile. Possible values include:\n\n- `2301416` (for the `DocuSign Viewer` profile)\n- `2301415` (for the `DocuSign Sender` profile)\n- `2301414` (for the `Account Administrator` profile)\n\nIn addition, any custom permission profiles associated with your account will have an automatically generated `permissionProfileId`.", "type": "string" @@ -37596,75 +48587,67 @@ "description": "The name of the account permission profile. \n\nExample: `Account Administrator`", "type": "string" }, - "uri": { - "description": "URI containing the user ID.", - "type": "string" - }, - "userId": { - "description": "Specifies the user ID for the new user.", - "type": "string" + "settings": { + "$ref": "#/definitions/accountRoleSettings", + "description": "This object specifies the permissions that are associated with the account permission profile." }, - "userName": { - "description": "The name of the user.", + "userCount": { + "description": "The total number of users in the group associated with the account permission profile.", "type": "string" }, - "userStatus": { - "description": "Status of the user's account. One of:\n\n- `ActivationRequired`\n- `ActivationSent`\n- `Active`\n- `Closed`\n- `Disabled`\n", - "type": "string" - } - }, - "x-ds-definition-name": "newUser", - "description": "Object representing a new user.", - "x-ms-summary": "Object representing a new user." - }, - "newUsersDefinition": { - "type": "object", - "properties": { - "newUsers": { - "description": "A list of one or more new users.", + "users": { + "description": "A list of user objects containing information about the users who are associated with the account permission profile.", "type": "array", "items": { - "$ref": "#/definitions/Users" + "$ref": "#/definitions/userInformation" } } }, - "x-ds-definition-name": "newUsersDefinition", - "description": "", - "x-ms-summary": "" + "x-ds-definition-name": "permissionProfile", + "description": "This object defines the account permissions for a profile that you can apply to a group of users.", + "x-ms-summary": "This object defines the account permissions for a profile that you can apply to a group of users." }, - "newUsersSummary": { + "permissionProfileInformation": { "type": "object", "properties": { - "newUsers": { - "description": "A list of one or more new users.", + "permissionProfiles": { + "description": "A complex type containing a collection of permission profiles.", "type": "array", "items": { - "$ref": "#/definitions/newUser" + "$ref": "#/definitions/permissionProfile" } } }, - "x-ds-definition-name": "newUsersSummary", - "description": "Object representing a summary of data for new users.", - "x-ms-summary": "Object representing a summary of data for new users." + "x-ds-definition-name": "permissionProfileInformation", + "description": "Contains details about the permission profiles associated with an account.", + "x-ms-summary": "Contains details about the permission profiles associated with an account." }, - "notarize": { + "phoneNumber": { "type": "object", "properties": { + "anchorAllowWhiteSpaceInCharacters": { + "description": "", + "type": "string" + }, + "anchorAllowWhiteSpaceInCharactersMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "" + }, "anchorCaseSensitive": { - "description": "Reserved for DocuSign.\n", + "description": "This property controls how [anchor tabs][AnchorTabs] are placed. When **true**, the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false**.\n\nFor example, when set to **true**, if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When set to **false**, `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**.\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place", "type": "string" }, "anchorCaseSensitiveMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "description": "Metadata that indicates whether the `anchorCaseSensitive` property is editable." }, "anchorHorizontalAlignment": { - "description": "Reserved for DocuSign.\n\n", + "description": "This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are :\n\n- `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value.\n- `right`: Aligns the tab’s left side with the last character of the matching anchor word.\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place\n", "type": "string" }, "anchorHorizontalAlignmentMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "description": "Metadata that indicates whether the `anchorHorizontalAlignment` property is editable." }, "anchorIgnoreIfNotPresent": { "description": "When set to **true**, this tab is ignored if the `anchorString` is not found in the document.", @@ -37675,12 +48658,12 @@ "description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable." }, "anchorMatchWholeWord": { - "description": "Reserved for DocuSign.\n\n", + "description": "When set to **true**, the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false**.\n\nFor example, when set to **true**, if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When set to **false**, if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**.\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTab]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place\n", "type": "string" }, "anchorMatchWholeWordMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "description": "Metadata that indicates whether the `anchorMatchWholeWord` property is editable." }, "anchorString": { "description": "Specifies the string to find in the document and use as the basis for tab placement.", @@ -37699,7 +48682,7 @@ "description": "Reserved for DocuSign." }, "anchorUnits": { - "description": "Specifies the units of the X and Y offset. Units may be pixels, millimeters, centimeters, or inches.", + "description": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n", "type": "string" }, "anchorUnitsMetadata": { @@ -37707,7 +48690,7 @@ "description": "Metadata that indicates whether the `anchorUnits` property is editable." }, "anchorXOffset": { - "description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.", + "description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n", "type": "string" }, "anchorXOffsetMetadata": { @@ -37715,13 +48698,29 @@ "description": "Metadata that indicates whether the `anchorXOffset` property is editable." }, "anchorYOffset": { - "description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.", + "description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n", "type": "string" }, "anchorYOffsetMetadata": { "$ref": "#/definitions/propertyMetadata", "description": "Metadata that indicates whether the `anchorYOffset` property is editable." }, + "bold": { + "description": "When set to **true**, the information in the tab is bold.", + "type": "string" + }, + "boldMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `bold` property is editable." + }, + "concealValueOnDocument": { + "description": "When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender.\n\nWhen an envelope is completed the information is only available to the sender through the Form Data link in the DocuSign Console. The information on the downloaded document remains masked by asterisks.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.", + "type": "string" + }, + "concealValueOnDocumentMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `concealValueOnDocument` property is editable." + }, "conditionalParentLabel": { "description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility.", "type": "string" @@ -37739,15 +48738,23 @@ "description": "Metadata that indicates whether the `conditionalParentValue` property is editable." }, "customTabId": { - "description": "The DocuSign-generated custom tab id for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.", + "description": "The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.", "type": "string" }, "customTabIdMetadata": { "$ref": "#/definitions/propertyMetadata", "description": "Metadata that indicates whether the `customTabId` property is editable." }, + "disableAutoSize": { + "description": "When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes.", + "type": "string" + }, + "disableAutoSizeMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `disableAutoSize` property is editable." + }, "documentId": { - "description": "Integer that identifies the document in the envelope.", + "description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.", "type": "string" }, "documentIdMetadata": { @@ -37758,6 +48765,30 @@ "$ref": "#/definitions/errorDetails", "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." }, + "font": { + "description": "The font to be used for the tab value. Supported fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n", + "type": "string" + }, + "fontColor": { + "description": "The font color to use for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n", + "type": "string" + }, + "fontColorMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `fontColor` property is editable." + }, + "fontMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `font` property is editable." + }, + "fontSize": { + "description": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72", + "type": "string" + }, + "fontSizeMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `fontSize` property is editable." + }, "formOrder": { "description": "An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block.", "type": "string" @@ -37790,6 +48821,18 @@ "$ref": "#/definitions/propertyMetadata", "description": "Metadata that indicates whether the `height` property is editable." }, + "italic": { + "description": "When set to **true**, the information in the tab is italic.", + "type": "string" + }, + "italicMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `italic` property is editable." + }, + "localePolicy": { + "$ref": "#/definitions/localePolicyTab", + "description": "Reserved for DocuSign." + }, "locked": { "description": "When set to **true**, the signer cannot change the data of the custom tab.", "type": "string" @@ -37798,12 +48841,40 @@ "$ref": "#/definitions/propertyMetadata", "description": "Metadata that indicates whether the `locked` property is editable." }, + "maxLength": { + "description": "An optional value that describes the maximum length of the property when the property is a string.", + "type": "string" + }, + "maxLengthMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `maxLength` property is editable." + }, "mergeField": { "$ref": "#/definitions/mergeField", "description": "Contains the information necessary to map the tab to a field in SalesForce." }, + "mergeFieldXml": { + "description": "", + "type": "string" + }, + "name": { + "description": "", + "type": "string" + }, + "nameMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `name` property is editable. Read only." + }, + "originalValue": { + "description": "The initial value of the tab when it was sent to the recipient. ", + "type": "string" + }, + "originalValueMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `originalValue` property is editable." + }, "pageNumber": { - "description": "The page number being accessed.", + "description": "Specifies the page number on which the tab is located.", "type": "string" }, "pageNumberMetadata": { @@ -37811,11 +48882,11 @@ "description": "Metadata that indicates whether the `pageNumber` property is editable." }, "recipientId": { - "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", + "description": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.", "type": "string" }, "recipientIdGuid": { - "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one.", + "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only.", "type": "string" }, "recipientIdGuidMetadata": { @@ -37834,8 +48905,12 @@ "$ref": "#/definitions/propertyMetadata", "description": "Metadata that indicates whether the `required` property is editable." }, + "smartContractInformation": { + "$ref": "#/definitions/smartContractInformation", + "description": "" + }, "status": { - "description": "The status of the tab. Possible values are:\n\n- `active`: The tab is active, but the recipient has not yet interacted with it.\n- `signed`: The recipient signed the tab.\n- `declined`: The recipient declined the envelope.\n- `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`).", + "description": "Indicates the envelope status. Valid values are:\n\n* sent - The envelope is sent to the recipients. \n* created - The envelope is saved as a draft and can be modified and sent later.", "type": "string" }, "statusMetadata": { @@ -37861,6 +48936,14 @@ "$ref": "#/definitions/propertyMetadata", "description": "Metadata that indicates whether the `tabId` property is editable." }, + "tabLabel": { + "description": "The label associated with the tab. This value may be an empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum Length: 500 characters.\n", + "type": "string" + }, + "tabLabelMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `tabLabel` property is editable." + }, "tabOrder": { "description": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.", "type": "string" @@ -37901,6 +48984,22 @@ "$ref": "#/definitions/propertyMetadata", "description": "Metadata that indicates whether the `toolTip` property is editable." }, + "underline": { + "description": "When set to **true**, the information in the tab is underlined.", + "type": "string" + }, + "underlineMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `underline` property is editable." + }, + "value": { + "description": "Specifies the value of the tab. ", + "type": "string" + }, + "valueMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `value` property is editable." + }, "width": { "description": "The width of the tab in pixels.", "type": "string" @@ -37918,7 +49017,7 @@ "description": "Metadata that indicates whether the `xPosition` property is editable." }, "yPosition": { - "description": "This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.", + "description": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n", "type": "string" }, "yPositionMetadata": { @@ -37926,404 +49025,101 @@ "description": "Metadata that indicates whether the `yPosition` property is editable." } }, - "x-ds-definition-name": "notarize", - "description": "A tab that alerts notary recipients that\nthey must take action on the page.\nOnly one notarize tab can appear on a page.", - "x-ms-summary": "A tab that alerts notary recipients that\nthey must take action on the page.\nOnly one notarize tab can appear on a page." + "x-ds-definition-name": "phoneNumber", + "description": "", + "x-ms-summary": "" }, - "notaryHost": { + "planInformation": { + "description": "An object used to identify the features and attributes of the account being created.", "type": "object", "properties": { - "accessCode": { - "description": "If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. \n\nMaximum Length: 50 characters and it must conform to the account's access code format setting.\n\nIf blank, but the signer `accessCode` property is set in the envelope, then that value is used.\n\nIf blank and the signer `accessCode` property is not set, then the access code is not required.", - "type": "string" - }, - "accessCodeMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the `accessCode` property." - }, - "addAccessCodeToEmail": { - "description": "This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient.", - "type": "string" - }, - "clientUserId": { - "description": "Specifies whether the recipient is embedded or remote. \n\nIf the `clientUserId` property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing.\n\nNote: if the `clientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true**, an error is generated on sending. \n\nMaximum length: 100 characters. ", - "type": "string" - }, - "completedCount": { - "description": "Indicates the number of times that the recipient has been through a signing completion for the envelope.\n\nIf this number is greater than 0 for a signing group, only the user who previously completed may sign again.", - "type": "string" - }, - "customFields": { - "description": "An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters.", - "type": "array", - "items": { - "type": "string" - } - }, - "declinedDateTime": { - "description": "The date and time the recipient declined the document.", - "type": "string" - }, - "declinedReason": { - "description": "The reason the recipient declined the document.", - "type": "string" - }, - "deliveredDateTime": { - "description": "The date and time that the envelope was delivered to the recipient.", - "type": "string" - }, - "deliveryMethod": { - "description": "Reserved for DocuSign.", - "type": "string" - }, - "deliveryMethodMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `deliveryMethod` property is editable.\n" - }, - "documentVisibility": { - "description": "A list of documentVisibility objects, which define a recipient's read/write access to a document.", - "type": "array", - "items": { - "$ref": "#/definitions/documentVisibility" - } - }, - "email": { - "description": "The notary's email address.\n\nMaximum Length: 100 characters.\n", - "type": "string" - }, - "emailMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the notary's email address." - }, - "emailNotification": { - "$ref": "#/definitions/recipientEmailNotification", - "description": "An optional complex type that sets a specific email subject and body for this recipient's notification email. \n\n**Note**: If you use this field to set a specific email notification for one recipient, you must also set the email notification for the other recipients. Using this field for one or more recipients negates the Envelope `Subject` and `EmailBlurb` property settings. " - }, - "embeddedRecipientStartURL": { - "description": "Specifies a sender-provided valid URL string for redirecting an embedded recipient. When this option is used, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the recipient clicks the document link in the email, the recipient is redirected through DocuSign to the specified URL to complete the required actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. \n\nIf set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation launched by a partner.\n\nIt is important to understand that in a typical embedded workflow, the authentication of an embedded recipient is the responsibility of the sending application. DocuSign expects that senders will follow their own processes for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process is initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process, bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient.\n\nIf the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: `envelopeId`, `recipientId`, `recipientName`, `recipientEmail`, and `customFields`. The `customFields` property must be set for the recipient or envelope. The merge fields are enclosed in double brackets. \n\n*Example*: \n\n`http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` ", - "type": "string" - }, - "errorDetails": { - "$ref": "#/definitions/errorDetails", - "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." - }, - "faxNumber": { - "description": "Reserved for DocuSign.", - "type": "string" - }, - "faxNumberMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." - }, - "hostRecipientId": { - "description": "", - "type": "string" - }, - "idCheckConfigurationName": { - "description": "The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting.\n\n**Example**: Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node.", - "type": "string" - }, - "idCheckConfigurationNameMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `idCheckConfigurationName` property is editable.\n" - }, - "idCheckInformationInput": { - "$ref": "#/definitions/idCheckInformationInput", - "description": "An object that contains input information related to a recipient ID check." - }, - "inheritEmailNotificationConfiguration": { - "description": "When set to **true** and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account. ", - "type": "string" - }, - "lockedRecipientPhoneAuthEditable": { - "description": "Reserved for DocuSign.", - "type": "string" - }, - "lockedRecipientSmsEditable": { - "description": "Reserved for DocuSign.", - "type": "string" - }, - "name": { - "description": "The notary's full legal name.\n\nMaximum Length: 100 characters.\n", - "type": "string" - }, - "nameMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the notary's full legal name." - }, - "note": { - "description": "A note sent to the notary in the signing email.\nThis note is visible only to this notary.\n\nMaximum Length: 1000 characters.\n", - "type": "string" - }, - "noteMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the note sent to the notary in the signing email." - }, - "phoneAuthentication": { - "$ref": "#/definitions/recipientPhoneAuthentication", - "description": "A complex type that contains the following elements:\n\n* `recipMayProvideNumber` - Boolean. When set to **true**, the recipient can use whatever phone number they choose.\n* `senderProvidedNumbers` - ArrayOfString. A list of phone numbers the recipient can use.\n* `recordVoicePrint` - Reserved.\n* `validateRecipProvidedNumber` - Reserved." - }, - "recipientAttachments": { + "addOns": { "description": "Reserved for DocuSign.", "type": "array", "items": { - "$ref": "#/definitions/recipientAttachment" - } - }, - "recipientAuthenticationStatus": { - "$ref": "#/definitions/authenticationStatus", - "description": "Information about the recipient's authentication status." - }, - "recipientFeatureMetadata": { - "description": "Metadata about the features that are supported for the recipient type.", - "type": "array", - "items": { - "$ref": "#/definitions/featureAvailableMetadata" + "$ref": "#/definitions/addOn" } }, - "recipientId": { - "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", - "type": "string" - }, - "recipientIdGuid": { - "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one.", - "type": "string" - }, - "recipientType": { - "description": "The recipient type, as specified by the following values:\n- `agents`: Agent recipients can add name and email information for recipients that appear after the agent in routing order.\n- `carbonCopies`: Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date, or add information to any of the documents. This type of recipient can be used in any routing order.\n- `certifiedDeliveries`: Certified delivery recipients must receive the completed documents for the envelope to be completed. They don't need to sign, initial, date, or add information to any of the documents.\n- `editors`: Editors have the same management and access rights for the envelope as the sender. Editors can add name and email information, add or change the routing order, set authentication options, and can edit signature/initial tabs and data fields for the remaining recipients.\n- `inPersonSigners`: In-person recipients are DocuSign users who act as signing hosts in the same physical location as the signer.\n- `intermediaries`: Intermediary recipients can optionally add name and email information for recipients at the same or subsequent level in the routing order.\n- `seals`: Electronic seal recipients represent legal entities.\n- `signers`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope.\n- `witnesses`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope.", - "type": "string" - }, - "recipientTypeMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `recipientType` property is editable.\n" - }, - "requireIdLookup": { - "description": "When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. ", - "type": "string" - }, - "requireIdLookupMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `requireIdLookup` property is editable.\n" - }, - "roleName": { - "description": "Optional element. Specifies the role name associated with the recipient.

This is required when working with template recipients.", - "type": "string" - }, - "routingOrder": { - "description": "Specifies the routing order of the recipient in the envelope. ", - "type": "string" - }, - "routingOrderMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `routingOrder` property is editable.\n" - }, - "sentDateTime": { - "description": "The date and time the envelope was sent.", + "currencyCode": { + "description": "Specifies the ISO currency code for the account.", "type": "string" }, - "signedDateTime": { + "freeTrialDaysOverride": { "description": "Reserved for DocuSign.", "type": "string" }, - "signingGroupId": { - "description": "The ID of the signing group of which the notary is a member, if applicable.", - "type": "string" - }, - "signingGroupIdMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `signingGroupId` property is editable.\n" - }, - "signingGroupName": { - "description": "The display name for the signing group. \n\nMaximum Length: 100 characters. ", - "type": "string" - }, - "signingGroupUsers": { - "description": "A complex type that contains information about users in the signing group.", - "type": "array", - "items": { - "$ref": "#/definitions/userInfo" - } - }, - "smsAuthentication": { - "$ref": "#/definitions/recipientSMSAuthentication", - "description": "Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication. \n" - }, - "socialAuthentications": { - "description": " Lists the social ID type that can be used for recipient authentication.", - "type": "array", - "items": { - "$ref": "#/definitions/socialAuthentication" - } - }, - "status": { - "description": "Indicates the envelope status. Valid values are:\n\n* sent - The envelope is sent to the recipients. \n* created - The envelope is saved as a draft and can be modified and sent later.", - "type": "string" - }, - "statusCode": { + "planFeatureSets": { "description": "Reserved for DocuSign.", - "type": "string" - }, - "tabs": { - "$ref": "#/definitions/EnvelopeRecipientTabs", - "description": "A list of `signHere` tabs, which can be used to add a visual representation for an electronic seal in a document." - }, - "templateLocked": { - "description": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ", - "type": "string" - }, - "templateRequired": { - "description": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.", - "type": "string" - }, - "totalTabCount": { - "description": "The total number of tabs in the documents.", - "type": "string" - }, - "userId": { - "description": "The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.\n", - "type": "string" - } - }, - "x-ds-definition-name": "notaryHost", - "description": "This object is used only when `inPersonSigningType` in the `inPersonSigner` object is `notary`.\n\nIt describes information about the notary host.\nThe following information is required\nwhen using the eNotary in-person signing flow:\n\n* `name`: Specifies the notary's full legal name.\n* `email`: Specifies the notary's email address.\n* `recipientId`: A unique ID number for the notary signing host.\n", - "x-ms-summary": "This object is used only when `inPersonSigningType` in the `inPersonSigner` object is `notary`.\n\nIt describes information about the notary host.\nThe following information is required\nwhen using the eNotary in-person signing flow:\n\n* `name`: Specifies the notary's full legal name.\n* `email`: Specifies the notary's email address.\n* `recipientId`: A unique ID number for the notary signing host.\n" - }, - "notaryJournal": { - "type": "object", - "properties": { - "createdDate": { - "description": "The creation date of the account in UTC timedate format.", - "type": "string" - }, - "documentName": { - "description": "", - "type": "string" - }, - "jurisdiction": { - "$ref": "#/definitions/jurisdiction", - "description": "" - }, - "notaryJournalId": { - "description": "", - "type": "string" - }, - "notaryJournalMetaData": { - "$ref": "#/definitions/notaryJournalMetaData", - "description": "" - }, - "signerName": { - "description": "The in-person signer's full legal name.\n\nRequired when `inPersonSigningType` is `inPersonSigner`.\nFor eNotary flow, use `name` instead.\n\nMaximum Length: 100 characters.\n", - "type": "string" - } - }, - "x-ds-definition-name": "notaryJournal", - "description": "", - "x-ms-summary": "" - }, - "notaryJournalCredibleWitness": { - "type": "object", - "properties": { - "address": { - "description": "The user's address.", - "type": "string" - }, - "name": { - "description": "", - "type": "string" - }, - "signatureImage": { - "description": "", - "type": "string" - } - }, - "x-ds-definition-name": "notaryJournalCredibleWitness", - "description": "", - "x-ms-summary": "" - }, - "notaryJournalList": { - "type": "object", - "properties": { - "endPosition": { - "description": "The last position in the result set. ", - "type": "string" - }, - "nextUri": { - "description": "The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. ", - "type": "string" - }, - "notaryJournals": { - "description": "", "type": "array", "items": { - "$ref": "#/definitions/NotaryJournals" + "$ref": "#/definitions/featureSet" } }, - "previousUri": { - "description": "The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. ", - "type": "string" - }, - "resultSetSize": { - "description": "The number of results returned in this response. Because you can filter which entries are included in the response, this value is always less than or equal to `totalSetSize`.", - "type": "string" - }, - "startPosition": { - "description": "The starting position of the current result set.", + "planId": { + "description": "DocuSign's id for the account plan.", "type": "string" }, - "totalSetSize": { - "description": "The total number of items in the search's result set. This value is always greater than or equal to the value of `resultSetSize`.", - "type": "string" + "recipientDomains": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/recipientDomain" + } } }, - "x-ds-definition-name": "notaryJournalList", - "description": "", - "x-ms-summary": "" + "x-ds-definition-name": "planInformation", + "x-ms-summary": "An object used to identify the features and attributes of the account being created." }, - "notaryJournalMetaData": { + "polyLine": { "type": "object", "properties": { - "comment": { + "x1": { "description": "", "type": "string" }, - "credibleWitnesses": { + "x2": { "description": "", - "type": "array", - "items": { - "$ref": "#/definitions/notaryJournalCredibleWitness" - } + "type": "string" }, - "signatureImage": { + "y1": { "description": "", "type": "string" }, - "signerIdType": { + "y2": { "description": "", "type": "string" } }, - "x-ds-definition-name": "notaryJournalMetaData", + "x-ds-definition-name": "polyLine", "description": "", "x-ms-summary": "" }, - "note": { + "polyLineOverlay": { "type": "object", "properties": { + "anchorAllowWhiteSpaceInCharacters": { + "description": "", + "type": "string" + }, + "anchorAllowWhiteSpaceInCharactersMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "" + }, "anchorCaseSensitive": { - "description": "Reserved for DocuSign.\n", + "description": "This property controls how [anchor tabs][AnchorTabs] are placed. When **true**, the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false**.\n\nFor example, when set to **true**, if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When set to **false**, `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**.\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place", "type": "string" }, "anchorCaseSensitiveMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "description": "Metadata that indicates whether the `anchorCaseSensitive` property is editable." }, "anchorHorizontalAlignment": { - "description": "Reserved for DocuSign.\n\n", + "description": "This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are :\n\n- `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value.\n- `right`: Aligns the tab’s left side with the last character of the matching anchor word.\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place\n", "type": "string" }, "anchorHorizontalAlignmentMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "description": "Metadata that indicates whether the `anchorHorizontalAlignment` property is editable." }, "anchorIgnoreIfNotPresent": { "description": "When set to **true**, this tab is ignored if the `anchorString` is not found in the document.", @@ -38334,12 +49130,12 @@ "description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable." }, "anchorMatchWholeWord": { - "description": "Reserved for DocuSign.\n\n", + "description": "When set to **true**, the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false**.\n\nFor example, when set to **true**, if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When set to **false**, if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**.\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTab]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place\n", "type": "string" }, "anchorMatchWholeWordMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "description": "Metadata that indicates whether the `anchorMatchWholeWord` property is editable." }, "anchorString": { "description": "Specifies the string to find in the document and use as the basis for tab placement.", @@ -38358,7 +49154,7 @@ "description": "Reserved for DocuSign." }, "anchorUnits": { - "description": "Specifies the units of the X and Y offset. Units may be pixels, millimeters, centimeters, or inches.", + "description": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n", "type": "string" }, "anchorUnitsMetadata": { @@ -38366,7 +49162,7 @@ "description": "Metadata that indicates whether the `anchorUnits` property is editable." }, "anchorXOffset": { - "description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.", + "description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n", "type": "string" }, "anchorXOffsetMetadata": { @@ -38374,21 +49170,13 @@ "description": "Metadata that indicates whether the `anchorXOffset` property is editable." }, "anchorYOffset": { - "description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.", + "description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n", "type": "string" }, "anchorYOffsetMetadata": { "$ref": "#/definitions/propertyMetadata", "description": "Metadata that indicates whether the `anchorYOffset` property is editable." }, - "bold": { - "description": "When set to **true**, the information in the tab is bold.", - "type": "string" - }, - "boldMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `bold` property is editable." - }, "conditionalParentLabel": { "description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility.", "type": "string" @@ -38406,7 +49194,7 @@ "description": "Metadata that indicates whether the `conditionalParentValue` property is editable." }, "customTabId": { - "description": "The DocuSign-generated custom tab id for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.", + "description": "The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.", "type": "string" }, "customTabIdMetadata": { @@ -38414,7 +49202,7 @@ "description": "Metadata that indicates whether the `customTabId` property is editable." }, "documentId": { - "description": "Integer that identifies the document in the envelope.", + "description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.", "type": "string" }, "documentIdMetadata": { @@ -38425,30 +49213,6 @@ "$ref": "#/definitions/errorDetails", "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." }, - "font": { - "description": "The font to be used for the tab value. Supported fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n", - "type": "string" - }, - "fontColor": { - "description": "The font color to use for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n", - "type": "string" - }, - "fontColorMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `fontColor` property is editable." - }, - "fontMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `font` property is editable." - }, - "fontSize": { - "description": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72", - "type": "string" - }, - "fontSizeMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `fontSize` property is editable." - }, "formOrder": { "description": "An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block.", "type": "string" @@ -38473,6 +49237,10 @@ "$ref": "#/definitions/propertyMetadata", "description": "Metadata that indicates whether the `fromPageNumber` property is editable." }, + "graphicsContext": { + "$ref": "#/definitions/graphicsContext", + "description": "Contains details about the style used for the strike through graphic." + }, "height": { "description": "The height of the tab in pixels.", "type": "string" @@ -38481,44 +49249,51 @@ "$ref": "#/definitions/propertyMetadata", "description": "Metadata that indicates whether the `height` property is editable." }, - "italic": { - "description": "When set to **true**, the information in the tab is italic.", + "locked": { + "description": "When set to **true**, the signer cannot change the data of the custom tab.", "type": "string" }, - "italicMetadata": { + "lockedMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `italic` property is editable." - }, - "localePolicy": { - "$ref": "#/definitions/localePolicyTab", - "description": "Reserved for DocuSign." + "description": "Metadata that indicates whether the `locked` property is editable." }, "mergeField": { "$ref": "#/definitions/mergeField", "description": "Contains the information necessary to map the tab to a field in SalesForce." }, - "name": { - "description": "The name of the tab. For example, `Sign Here` or `Initial Here`.", + "mergeFieldXml": { + "description": "", "type": "string" }, - "nameMetadata": { + "overlayType": { + "description": "The type of overlay to use. The API currently supports only the `outline` overlay type.", + "type": "string" + }, + "overlayTypeMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `name` property is editable." + "description": "Metadata that indicates whether the `overlayType` property is editable.\n" }, "pageNumber": { - "description": "The page number on which the tab is located. For supplemental documents, this value must be `1`.\n", + "description": "Specifies the page number on which the tab is located.", "type": "string" }, "pageNumberMetadata": { "$ref": "#/definitions/propertyMetadata", "description": "Metadata that indicates whether the `pageNumber` property is editable." }, + "polyLines": { + "description": "An array of `polyLine` objects that contain x- and y-coordinates representing the locations of the lines.", + "type": "array", + "items": { + "$ref": "#/definitions/polyLine" + } + }, "recipientId": { - "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", + "description": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.", "type": "string" }, "recipientIdGuid": { - "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one.", + "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only.", "type": "string" }, "recipientIdGuidMetadata": { @@ -38530,203 +49305,658 @@ "description": "Metadata that indicates whether the `recipientId` property is editable." }, "shared": { - "description": "When set to **true**, this custom tab is shared.", + "description": "When set to **true**, indicates that the tab is shared.", + "type": "string" + }, + "sharedMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `shared` property is editable." + }, + "smartContractInformation": { + "$ref": "#/definitions/smartContractInformation", + "description": "" + }, + "status": { + "description": "The status of the tab. Possible values are:\n\n- `active`: The tab is active, but the recipient has not yet interacted with it.\n- `signed`: The recipient signed the tab.\n- `declined`: The recipient declined the envelope.\n- `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`).", + "type": "string" + }, + "statusMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `status` property is editable." + }, + "tabGroupLabels": { + "description": "An array of tab group labels that uniquely identify tab groups. To assign a tab to a `tabGroup`, you assign the `TabGroupLabel` to the `Tab.TabGroupLabels` array.", + "type": "array", + "items": { + "type": "string" + } + }, + "tabGroupLabelsMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `tabGroupLabels` property is editable." + }, + "tabId": { + "description": "The unique identifier for the tab.", + "type": "string" + }, + "tabIdMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `tabId` property is editable." + }, + "tabLabel": { + "description": "The label associated with the tab. This value may be an empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum Length: 500 characters.\n", + "type": "string" + }, + "tabOrder": { + "description": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.", + "type": "string" + }, + "tabOrderMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `tabOrder` property is editable." + }, + "tabType": { + "description": "Indicates the type of tab (for example, `signHere` or `initialHere`).", + "type": "string" + }, + "tabTypeMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `tabType` property is editable." + }, + "templateLocked": { + "description": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ", + "type": "string" + }, + "templateLockedMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `templateLocked` property is editable." + }, + "templateRequired": { + "description": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.", + "type": "string" + }, + "templateRequiredMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `templateRequired` property is editable." + }, + "tooltip": { + "description": "The text of a tooltip that appears when a user hovers over a form field or tab.", + "type": "string" + }, + "toolTipMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `toolTip` property is editable." + }, + "width": { + "description": "The width of the tab in pixels.", + "type": "string" + }, + "widthMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `width` property is editable." + }, + "xPosition": { + "description": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n", + "type": "string" + }, + "xPositionMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `xPosition` property is editable." + }, + "yPosition": { + "description": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n", + "type": "string" + }, + "yPositionMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `yPosition` property is editable." + } + }, + "x-ds-definition-name": "polyLineOverlay", + "description": "This tab enables users to strike through the text of a document. The tab is implemented as a line represented as a pair of x and y coordinates.", + "x-ms-summary": "This tab enables users to strike through the text of a document. The tab is implemented as a line represented as a pair of x and y coordinates." + }, + "powerForm": { + "type": "object", + "properties": { + "createdBy": { + "description": "The id of the user who created the PowerForm.", + "type": "string" + }, + "createdDateTime": { + "description": "The UTC DateTime when the item was created.", + "type": "string" + }, + "emailBody": { + "description": "The body of the email message sent to the recipients. \n\nMaximum length: 10000 characters.", + "type": "string" + }, + "emailSubject": { + "description": "The subject line of the email message that is sent to all recipients.\n\nFor information about adding merge field information to the email subject, see [Template Email Subject Merge Fields](https://developers.docusign.com/docs/esign-rest-api/reference/Templates/Templates/create#template-email-subject-merge-fields).\n", + "type": "string" + }, + "envelopes": { + "description": "An array containing PowerForm data.", + "type": "array", + "items": { + "$ref": "#/definitions/envelope" + } + }, + "errorDetails": { + "$ref": "#/definitions/errorDetails", + "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." + }, + "instructions": { + "description": "The instructions that display on the landing page for the first recipient. These instructions are important if the recipient accesses the PowerForm by a method other than email. If instructions are entered, they display as an introduction after the recipient accesses the PowerForm. Limit: 2000 characters.", + "type": "string" + }, + "isActive": { + "description": "When **true**, indicates that the PowerForm is active and can be sent to recipients. This is the default value.\n\nWhen **false**, the PowerForm cannot be emailed or accessed by a recipient, even if they arrive at the PowerForm URL. \n\nIf a recipient attempts to sign an inactive PowerForm, an error message informs the recipient that the document is not active and suggests that they contact the sender.\n", + "type": "string" + }, + "lastUsed": { + "description": "The UTC DateTime when the PowerForm was last used.", + "type": "string" + }, + "limitUseInterval": { + "description": "The length of time before the same recipient can sign the same PowerForm. This property is used in combination with the `limitUseIntervalUnits` property.", + "type": "string" + }, + "limitUseIntervalEnabled": { + "description": "When **true**, the `limitUseInterval` is enabled.", + "type": "string" + }, + "limitUseIntervalUnits": { + "description": "The units associated with the `limitUseInterval`. Valid values are:\n\n- `minutes`\n- `hours\n- `days`\n- `weeks`\n- `months`\n\nFor example, to limit a recipient to signing once per year, set the `limitUseInterval` to 365 and the `limitUseIntervalUnits` to `days`.\n", + "type": "string" + }, + "maxUseEnabled": { + "description": "When set to **true**, you can set a maximum number of uses for the PowerForm.", + "type": "string" + }, + "name": { + "description": "The name of the PowerForm.", + "type": "string" + }, + "powerFormId": { + "description": "The id of the PowerForm.", + "type": "string" + }, + "powerFormUrl": { + "description": "The URL for the PowerForm.", + "type": "string" + }, + "recipients": { + "description": "An array of recipient objects that provides details about the recipients of the envelope.", + "type": "array", + "items": { + "$ref": "#/definitions/powerFormRecipient" + } + }, + "senderName": { + "description": "The sender's name.", + "type": "string" + }, + "senderUserId": { + "description": "The id of the sender.", + "type": "string" + }, + "signingMode": { + "description": "The signing mode to use. Valid values are:\n \n- `email`: Verifies the recipient's identity using email authentication before the recipient can sign a document. The recipient enters their email address and then clicks **Begin Signing** to begin the signing process. The system then sends an email message with a validation code for the PowerForm to the recipient. If the recipient does not provide a valid email address, they cannot open and sign the document. \n- `direct`: Does not require any verification. After a recipient enters their email address and clicks **Begin Signing**, a new browser tab opens and the recipient can immediately begin the signing process. Because the recipient's identity is not verified by using email authentication, we strongly recommend that you only use the `direct` signing mode when the PowerForm is accessible behind a secure portal where the recipient's identity is already authenticated, or where another form of authentication is specified for the recipient in the DocuSign template (for example, an access code, phone authentication, or ID check). \n\n**Note**: In the account settings, `enablePowerFormDirect` must be **true** to use `direct` as the `signingMode`.", + "type": "string" + }, + "templateId": { + "description": "The id of the template used to create the PowerForm.", + "type": "string" + }, + "templateName": { + "description": "The name of the template used to create the PowerForm.", + "type": "string" + }, + "timesUsed": { + "description": "The number of times the PowerForm has been used. ", + "type": "string" + }, + "uri": { + "description": "The URI for the PowerForm.", + "type": "string" + }, + "usesRemaining": { + "description": "The number of times the PowerForm can still be used.", + "type": "string" + } + }, + "x-ds-definition-name": "powerForm", + "description": "Contains details about a PowerForm.", + "x-ms-summary": "Contains details about a PowerForm." + }, + "powerFormFormDataEnvelope": { + "type": "object", + "properties": { + "envelopeId": { + "description": "The envelope ID of the envelope status that failed to post.", + "type": "string" + }, + "recipients": { + "description": "An array of recipient objects that provides details about the recipients of the envelope.", + "type": "array", + "items": { + "$ref": "#/definitions/powerFormFormDataRecipient" + } + } + }, + "x-ds-definition-name": "powerFormFormDataEnvelope", + "description": "", + "x-ms-summary": "" + }, + "powerFormFormDataRecipient": { + "type": "object", + "properties": { + "email": { + "description": "", + "type": "string" + }, + "formData": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/nameValue" + } + }, + "name": { + "description": "The name of the recipient.", + "type": "string" + }, + "recipientId": { + "description": "The unique id for the recipient. It is used by the tab element to indicate which recipient is to sign the document.", + "type": "string" + } + }, + "x-ds-definition-name": "powerFormFormDataRecipient", + "description": "", + "x-ms-summary": "" + }, + "powerFormRecipient": { + "type": "object", + "properties": { + "accessCode": { + "description": "(Optional) The access code that the recipient must enter to access the PowerForm.\n\nMaximum Length: 50 characters. The code must also conform to the account's access code format setting.\n\nIf blank but the signer accessCode property is set in the envelope, then that value is used.\n\nIf blank and the signer accessCode property is not set, then the access code is not required.", + "type": "string" + }, + "accessCodeLocked": { + "description": "When **true**, the `accessCode` property is locked and cannot be edited.", + "type": "string" + }, + "accessCodeRequired": { + "description": "When **true**, the recipient must enter the `accessCode` to access the PowerForm.", + "type": "string" + }, + "email": { + "description": "The email address of the recipient.\n\n**Note**: For self-service documents where you do not know who the recipients are in advance, you can leave this property blank.", + "type": "string" + }, + "emailLocked": { + "description": "When **true**, the recipient's email address is locked and cannot be edited.", + "type": "string" + }, + "idCheckConfigurationName": { + "description": "The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are:\n\n- `Phone Auth $`: The recipient must authenticate by using two-factor authentication (2FA). You provide the phone number to use for 2FA in the `phoneAuthentication` object.\n- `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object.\n- `ID Check $`: The recipient must answer detailed security questions. \n\n**Example**: Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node.", + "type": "string" + }, + "idCheckRequired": { + "description": "Indicates if authentication is configured for the account. Valid values are:\n\n- `always`: Authentication checks are performed on every envelope. \n- `never`: Authentication checks are not performed on any envelopes. \n- `optional:` Authentication is configurable per envelope.", + "type": "string" + }, + "name": { + "description": "The name of the PowerForm recipient.\n\n**Note**: For self-service documents where you do not know who the recipients are in advance, you can leave this property blank.", + "type": "string" + }, + "recipientType": { + "description": "The recipient type, as specified by the following values:\n- `agent`: Agent recipients can add name and email information for recipients that appear after the agent in routing order.\n- `carbonCopy`: Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date, or add information to any of the documents. This type of recipient can be used in any routing order.\n- `certifiedDelivery`: Certified delivery recipients must receive the completed documents for the envelope to be completed. They don't need to sign, initial, date, or add information to any of the documents.\n- `editor`: Editors have the same management and access rights for the envelope as the sender. Editors can add name and email information, add or change the routing order, set authentication options, and can edit signature/initial tabs and data fields for the remaining recipients.\n- `inPersonSigner`: In-person recipients are DocuSign users who act as signing hosts in the same physical location as the signer.\n- `intermediaries`: Intermediary recipients can optionally add name and email information for recipients at the same or subsequent level in the routing order.\n- `seal`: Electronic seal recipients represent legal entities.\n- `signer`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope.\n- `witness`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope.", + "type": "string" + }, + "roleName": { + "description": "The role associated with the recipient (for example, `Member`).\n\nThis property is required when you are working with template recipients and PowerForm recipients.", + "type": "string" + }, + "routingOrder": { + "description": "Specifies the routing order of the recipient in the envelope. ", + "type": "string" + }, + "templateRequiresIdLookup": { + "description": "When **true**, the template used to create the PowerForm requires ID lookup for the recipient.", + "type": "string" + }, + "userNameLocked": { + "description": "When **true**, the `userName` property for the recipient is locked and cannot be edited.", + "type": "string" + } + }, + "x-ds-definition-name": "powerFormRecipient", + "description": "**Note**: For a self-service PowerForm on a website, you can specify the intended recipients generically (for example, use `Member` as the `Name`), and omit personal details such as `email`.", + "x-ms-summary": "**Note**: For a self-service PowerForm on a website, you can specify the intended recipients generically (for example, use `Member` as the `Name`), and omit personal details such as `email`." + }, + "powerFormSendersResponse": { + "type": "object", + "properties": { + "endPosition": { + "format": "int32", + "description": "The last index position in the result set. ", + "type": "integer" + }, + "nextUri": { + "description": "The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. ", + "type": "string" + }, + "powerFormSenders": { + "description": "An array of `userInfo` objects containing information about users who have sent PowerForms.", + "type": "array", + "items": { + "$ref": "#/definitions/userInfo" + } + }, + "previousUri": { + "description": "The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. ", + "type": "string" + }, + "resultSetSize": { + "format": "int32", + "description": "The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`.", + "type": "integer" + }, + "startPosition": { + "format": "int32", + "description": "The starting index position of the current result set.", + "type": "integer" + }, + "totalSetSize": { + "format": "int32", + "description": "The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`.", + "type": "integer" + } + }, + "x-ds-definition-name": "powerFormSendersResponse", + "description": "This object includes information about the users who have sent PowerForms.", + "x-ms-summary": "This object includes information about the users who have sent PowerForms." + }, + "powerFormsFormDataResponse": { + "type": "object", + "properties": { + "envelopes": { + "description": "An array containing PowerForm data.", + "type": "array", + "items": { + "$ref": "#/definitions/powerFormFormDataEnvelope" + } + } + }, + "x-ds-definition-name": "powerFormsFormDataResponse", + "description": "", + "x-ms-summary": "" + }, + "powerFormsRequest": { + "type": "object", + "properties": { + "powerForms": { + "description": "An array of PowerForm objects.", + "type": "array", + "items": { + "$ref": "#/definitions/powerForm" + } + } + }, + "x-ds-definition-name": "powerFormsRequest", + "description": "", + "x-ms-summary": "" + }, + "powerFormsResponse": { + "type": "object", + "properties": { + "endPosition": { + "format": "int32", + "description": "The last index position in the result set. ", + "type": "integer" + }, + "nextUri": { + "description": "The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. ", + "type": "string" + }, + "powerForms": { + "description": "An array of PowerForm objects.", + "type": "array", + "items": { + "$ref": "#/definitions/powerForm" + } + }, + "previousUri": { + "description": "The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. ", "type": "string" }, - "sharedMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `shared` property is editable." + "resultSetSize": { + "format": "int32", + "description": "The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`.", + "type": "integer" }, - "status": { - "description": "The status of the tab. Possible values are:\n\n- `active`: The tab is active, but the recipient has not yet interacted with it.\n- `signed`: The recipient signed the tab.\n- `declined`: The recipient declined the envelope.\n- `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`).", - "type": "string" + "startPosition": { + "format": "int32", + "description": "The starting index position of the current result set.", + "type": "integer" }, - "statusMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `status` property is editable." + "totalSetSize": { + "format": "int32", + "description": "The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`.", + "type": "integer" + } + }, + "x-ds-definition-name": "powerFormsResponse", + "description": "A list of PowerForms.", + "x-ms-summary": "A list of PowerForms." + }, + "prefillTabs": { + "type": "object", + "properties": { + "checkboxTabs": { + "description": "A list of\n[Checkbox tabs][checkbox].\n\n\nA Checkbox tab enables the recipient to select a yes/no (on/off) option. This value can be set.\n\n\n[checkbox]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", + "type": "array", + "items": { + "$ref": "#/definitions/checkbox" + } }, - "tabGroupLabels": { - "description": "An array of tab group labels that uniquely identify tab groups. To assign a tab to a `tabGroup`, you assign the `TabGroupLabel` to the `Tab.TabGroupLabels` array.", + "radioGroupTabs": { + "description": "A list of [Radio Group tabs][radioGroup].\n\nA Radio Group tab places a group of radio buttons on a document. The `radios` property is used to add and place the radio\nbuttons associated with the group. Only one radio button can be selected in a group. This value can be set.\n\n\n[radioGroup]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { - "type": "string" + "$ref": "#/definitions/radioGroup" } }, - "tabGroupLabelsMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `tabGroupLabels` property is editable." + "tabGroups": { + "description": "An array of `tabGroup` items that contain information about tab groups. To assign a tab to a `tabGroup`, you assign the `tabGroupLabel` to the `Tab.TabGroupLabels` array.", + "type": "array", + "items": { + "$ref": "#/definitions/tabGroup" + } }, - "tabId": { - "description": "The unique identifier for the tab.", + "textTabs": { + "description": "A list of\nText tabs.\n\nA text tab enables the recipient to enter free text. This value can be set.\n\nFind descriptions of all tab types in\nthe [EnvelopeRecipientTabs Resource][ert].\n\n[ert]: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n", + "type": "array", + "items": { + "$ref": "#/definitions/text" + } + } + }, + "x-ds-definition-name": "prefillTabs", + "description": "", + "x-ms-summary": "" + }, + "proofServiceResourceToken": { + "type": "object", + "properties": { + "proofBaseURI": { + "description": "Returns the available base URIs to request the [ID Evidence API](https://developers.docusign.com/docs/idevidence-api/).", "type": "string" }, - "tabIdMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `tabId` property is editable." - }, - "tabLabel": { - "description": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n", + "resourceToken": { + "description": "Token that can be used to access [ID Evidence API](https://developers.docusign.com/docs/idevidence-api/) endpoints.", "type": "string" - }, - "tabLabelMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `tabLabel` property is editable." - }, - "tabOrder": { - "description": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.", + } + }, + "x-ds-definition-name": "proofServiceResourceToken", + "description": "", + "x-ms-summary": "" + }, + "proofServiceViewLink": { + "type": "object", + "properties": { + "ViewLink": { + "description": "", "type": "string" + } + }, + "x-ds-definition-name": "proofServiceViewLink", + "description": "", + "x-ms-summary": "" + }, + "propertyMetadata": { + "type": "object", + "properties": { + "options": { + "description": "An array of option strings supported by this setting.", + "type": "array", + "items": { + "type": "string" + } }, - "tabOrderMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `tabOrder` property is editable." - }, - "tabType": { - "description": "Indicates the type of tab (for example, `signHere` or `initialHere`).", + "rights": { + "description": "Indicates whether the property is editable. Valid values are:\n\n- `editable`\n- `read_only`", "type": "string" - }, - "tabTypeMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `tabType` property is editable." - }, - "templateLocked": { - "description": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ", + } + }, + "x-ds-definition-name": "propertyMetadata", + "description": "Metadata about a property.", + "x-ms-summary": "Metadata about a property." + }, + "province": { + "type": "object", + "properties": { + "isoCode": { + "description": "", "type": "string" }, - "templateLockedMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `templateLocked` property is editable." - }, - "templateRequired": { - "description": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.", + "name": { + "description": "", "type": "string" - }, - "templateRequiredMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `templateRequired` property is editable." - }, - "tooltip": { - "description": "The text of a tooltip that appears when a user hovers over a form field or tab.", + } + }, + "x-ds-definition-name": "province", + "description": "", + "x-ms-summary": "" + }, + "provisioningInformation": { + "type": "object", + "properties": { + "defaultConnectionId": { + "description": "", "type": "string" }, - "toolTipMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `toolTip` property is editable." - }, - "underline": { - "description": "When set to **true**, the information in the tab is underlined.", + "defaultPlanId": { + "description": "", "type": "string" }, - "underlineMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `underline` property is editable." - }, - "value": { - "description": "Specifies the value of the tab. ", + "distributorCode": { + "description": "The code that identifies the billing plan groups and plans for the new account.", "type": "string" }, - "valueMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `value` property is editable." - }, - "width": { - "description": "The width of the tab in pixels.", + "distributorPassword": { + "description": "The password for the `distributorCode`.", "type": "string" }, - "widthMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `width` property is editable." - }, - "xPosition": { - "description": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n", + "passwordRuleText": { + "description": "", "type": "string" }, - "xPositionMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `xPosition` property is editable." - }, - "yPosition": { - "description": "This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.", + "planPromotionText": { + "description": "", "type": "string" }, - "yPositionMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `yPosition` property is editable." + "purchaseOrderOrPromAllowed": { + "description": "", + "type": "string" } }, - "x-ds-definition-name": "note", - "description": "A tab that displays additional information, in the form of a\nnote, for the recipient.\n", - "x-ms-summary": "A tab that displays additional information, in the form of a\nnote, for the recipient.\n" + "x-ds-definition-name": "provisioningInformation", + "description": "", + "x-ms-summary": "" }, - "notification": { - "description": "A complex element that specifies the notification settings for the envelope.", + "purchasedEnvelopesInformation": { "type": "object", "properties": { - "expirations": { - "$ref": "#/definitions/expirations", - "description": "A complex element that specifies the expiration settings for the envelope." + "amount": { + "description": "The total amount of the purchase.", + "type": "string" }, - "reminders": { - "$ref": "#/definitions/reminders", - "description": "A complex element that specifies reminder settings for the envelope" + "appName": { + "description": "The AppName of the client application.", + "type": "string" }, - "useAccountDefaults": { - "description": "When set to **true**, the account default notification settings are used for the envelope, overriding the reminders and expirations settings. When set to **false**, the reminders and expirations settings specified in this request are used.", + "currencyCode": { + "description": "Specifies the ISO currency code of the purchase. This is based on the ISO 4217 currency code information.", "type": "string" - } - }, - "x-ds-definition-name": "notification", - "x-ms-summary": "A complex element that specifies the notification settings for the envelope." - }, - "notificationDefaults": { - "type": "object", - "properties": { - "apiEmailNotifications": { - "$ref": "#/definitions/notificationDefaultSettings", - "description": "" }, - "emailNotifications": { - "$ref": "#/definitions/notificationDefaultSettings", - "description": "" - } - }, - "x-ds-definition-name": "notificationDefaults", - "description": "", - "x-ms-summary": "" - }, - "notificationDefaultSettings": { - "type": "object", - "properties": { - "senderEmailNotifications": { - "$ref": "#/definitions/senderEmailNotifications", - "description": " \nAn array of email notifications that sets the email the user receives when they are a sender. When the specific email notification is set to true, the user will receive those types of email notifications from DocuSign. \n\nThe user inherits the default account sender email notification settings when the user is created. The email notifications are:\n\n* envelopeComplete\n* changedSigner \n* senderEnvelopeDeclined \n* withdrawnConsent \n* recipientViewed \n* deliveryFailed \n " + "platform": { + "description": "The Platform of the client application", + "type": "string" }, - "signerEmailNotifications": { - "$ref": "#/definitions/signerEmailNotifications", - "description": "An array of email notifications that specifies the email the user receives when they are a sender. When the specific email notification is set to true, the user receives those types of email notifications from DocuSign. The user inherits the default account sender email notification settings when the user is created." + "productId": { + "description": "The Product ID from the AppStore.", + "type": "string" + }, + "quantity": { + "description": "The quantity of envelopes to add to the account.", + "type": "string" + }, + "receiptData": { + "description": "The encrypted Base64 encoded receipt data.", + "type": "string" + }, + "storeName": { + "description": "The name of the AppStore.", + "type": "string" + }, + "transactionId": { + "description": "Specifies the Transaction ID from the AppStore.", + "type": "string" } }, - "x-ds-definition-name": "notificationDefaultSettings", + "x-ds-definition-name": "purchasedEnvelopesInformation", "description": "", "x-ms-summary": "" }, - "number": { + "radio": { "type": "object", "properties": { + "anchorAllowWhiteSpaceInCharacters": { + "description": "", + "type": "string" + }, + "anchorAllowWhiteSpaceInCharactersMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "" + }, "anchorCaseSensitive": { - "description": "Reserved for DocuSign.\n", + "description": "This property controls how [anchor tabs][AnchorTabs] are placed. When **true**, the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false**.\n\nFor example, when set to **true**, if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When set to **false**, `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**.\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place", "type": "string" }, "anchorCaseSensitiveMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "description": "Metadata that indicates whether the `anchorCaseSensitive` property is editable." }, "anchorHorizontalAlignment": { - "description": "Reserved for DocuSign.\n\n", + "description": "This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are :\n\n- `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value.\n- `right`: Aligns the tab’s left side with the last character of the matching anchor word.\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place\n", "type": "string" }, "anchorHorizontalAlignmentMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "description": "Metadata that indicates whether the `anchorHorizontalAlignment` property is editable." }, "anchorIgnoreIfNotPresent": { "description": "When set to **true**, this tab is ignored if the `anchorString` is not found in the document.", @@ -38737,12 +49967,12 @@ "description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable." }, "anchorMatchWholeWord": { - "description": "Reserved for DocuSign.\n\n", + "description": "When set to **true**, the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false**.\n\nFor example, when set to **true**, if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When set to **false**, if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**.\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTab]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place\n", "type": "string" }, "anchorMatchWholeWordMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "description": "Metadata that indicates whether the `anchorMatchWholeWord` property is editable." }, "anchorString": { "description": "Specifies the string to find in the document and use as the basis for tab placement.", @@ -38761,7 +49991,7 @@ "description": "Reserved for DocuSign." }, "anchorUnits": { - "description": "Specifies the units of the X and Y offset. Units may be pixels, millimeters, centimeters, or inches.", + "description": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n", "type": "string" }, "anchorUnitsMetadata": { @@ -38769,7 +49999,7 @@ "description": "Metadata that indicates whether the `anchorUnits` property is editable." }, "anchorXOffset": { - "description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.", + "description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n", "type": "string" }, "anchorXOffsetMetadata": { @@ -38777,7 +50007,7 @@ "description": "Metadata that indicates whether the `anchorXOffset` property is editable." }, "anchorYOffset": { - "description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.", + "description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n", "type": "string" }, "anchorYOffsetMetadata": { @@ -38792,54 +50022,6 @@ "$ref": "#/definitions/propertyMetadata", "description": "Metadata that indicates whether the `bold` property is editable." }, - "concealValueOnDocument": { - "description": "When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender.\n\nWhen an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.", - "type": "string" - }, - "concealValueOnDocumentMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `concealValueOnDocument` property is editable." - }, - "conditionalParentLabel": { - "description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility.", - "type": "string" - }, - "conditionalParentLabelMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `conditionalParentLabel` property is editable." - }, - "conditionalParentValue": { - "description": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use \"on\" as the value to show that the parent tab is active.\n", - "type": "string" - }, - "conditionalParentValueMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `conditionalParentValue` property is editable." - }, - "customTabId": { - "description": "The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.", - "type": "string" - }, - "customTabIdMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `customTabId` property is editable." - }, - "disableAutoSize": { - "description": "When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes.", - "type": "string" - }, - "disableAutoSizeMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `disableAutoSize` property is editable." - }, - "documentId": { - "description": "Integer that identifies the document in the envelope.", - "type": "string" - }, - "documentIdMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `documentId` property is editable." - }, "errorDetails": { "$ref": "#/definitions/errorDetails", "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." @@ -38868,54 +50050,6 @@ "$ref": "#/definitions/propertyMetadata", "description": "Metadata that indicates whether the `fontSize` property is editable." }, - "formOrder": { - "description": "An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block.", - "type": "string" - }, - "formOrderMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `formOrder` property is editable." - }, - "formPageLabel": { - "description": "A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience.", - "type": "string" - }, - "formPageLabelMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `formPageLabel` property is editable." - }, - "formPageNumber": { - "description": "An integer specifying the order in which to present the guided form pages.", - "type": "string" - }, - "formPageNumberMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `fromPageNumber` property is editable." - }, - "formula": { - "description": "Contains the formula\nfor calculating the value of\nthis tab.\n\nUse a tab's `tabLabel`,\nenclosed in brackets,\nto refer to it.\n\nFor example,\nyou want to present the total cost\nof two items, tax included.\n\nThe cost of each item is stored\nin number tabs labeled Item1 and Item2.\nThe tax rate is in a number tab\nlabeled TaxRate.\n\nThe formula string for this property\nwould be:\n`([Item1] + [Item2]) * (1 + [TaxRate])`\n\nSee [Calculated Fields][calculatedfields]\nin the DocuSign Support Center\nto learn more about formulas.\n\nMaximum Length: 2000 characters\n\n[calculatedfields]: https://support.docusign.com/en/guides/ndse-user-guide-calculated-fields\n", - "type": "string" - }, - "formulaMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata indicating if the sender can edit the `formula` property." - }, - "height": { - "description": "The height of the tab in pixels.", - "type": "string" - }, - "heightMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `height` property is editable." - }, - "isPaymentAmount": { - "description": "When set to **true**, sets this as a payment tab. Can only be used with Text, Number, Formula, or List tabs. The value of the tab must be a number. ", - "type": "string" - }, - "isPaymentAmountMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `isPaymentAmount` property is editable." - }, "italic": { "description": "When set to **true**, the information in the tab is italic.", "type": "string" @@ -38924,10 +50058,6 @@ "$ref": "#/definitions/propertyMetadata", "description": "Metadata that indicates whether the `italic` property is editable." }, - "localePolicy": { - "$ref": "#/definitions/localePolicyTab", - "description": "Reserved for DocuSign." - }, "locked": { "description": "When set to **true**, the signer cannot change the data of the custom tab.", "type": "string" @@ -38936,66 +50066,14 @@ "$ref": "#/definitions/propertyMetadata", "description": "Metadata that indicates whether the `locked` property is editable." }, - "maxLength": { - "description": "An optional value that describes the maximum length of the property when the property is a string.", - "type": "string" - }, - "maxLengthMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `maxLength` property is editable." - }, - "mergeField": { - "$ref": "#/definitions/mergeField", - "description": "Contains the information necessary to map the tab to a field in SalesForce." - }, - "name": { - "description": "The name of the tab. For example, `Sign Here` or `Initial Here`.", - "type": "string" - }, - "nameMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `name` property is editable." - }, - "originalValue": { - "description": "The initial value of the tab when it was sent to the recipient. ", - "type": "string" - }, - "originalValueMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `originalValue` property is editable." - }, "pageNumber": { - "description": "The page number on which the tab is located. For supplemental documents, this value must be `1`.\n", + "description": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n", "type": "string" }, "pageNumberMetadata": { "$ref": "#/definitions/propertyMetadata", "description": "Metadata that indicates whether the `pageNumber` property is editable." }, - "recipientId": { - "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", - "type": "string" - }, - "recipientIdGuid": { - "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one.", - "type": "string" - }, - "recipientIdGuidMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `recipientIdGuid` property is editable." - }, - "recipientIdMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `recipientId` property is editable." - }, - "requireAll": { - "description": "When set to **true** and shared is true, information must be entered in this field to complete the envelope. ", - "type": "string" - }, - "requireAllMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `requireAll` property is editable." - }, "required": { "description": "When set to **true**, the signer is required to fill out this tab.", "type": "string" @@ -39004,128 +50082,45 @@ "$ref": "#/definitions/propertyMetadata", "description": "Metadata that indicates whether the `required` property is editable." }, - "requireInitialOnSharedChange": { - "description": "Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.", - "type": "string" - }, - "requireInitialOnSharedChangeMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `requireInitialOnSharedChange` property is editable." - }, - "senderRequired": { - "description": "When set to **true**, the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope.", - "type": "string" - }, - "senderRequiredMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `senderRequired` property is editable." - }, - "shared": { - "description": "When set to **true**, this custom tab is shared.", - "type": "string" - }, - "sharedMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `shared` property is editable." - }, - "status": { - "description": "The status of the tab. Possible values are:\n\n- `active`: The tab is active, but the recipient has not yet interacted with it.\n- `signed`: The recipient signed the tab.\n- `declined`: The recipient declined the envelope.\n- `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`).", - "type": "string" - }, - "statusMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `status` property is editable." - }, - "tabGroupLabels": { - "description": "An array of tab group labels that uniquely identify tab groups. To assign a tab to a `tabGroup`, you assign the `TabGroupLabel` to the `Tab.TabGroupLabels` array.", - "type": "array", - "items": { - "type": "string" - } - }, - "tabGroupLabelsMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `tabGroupLabels` property is editable." - }, - "tabId": { - "description": "The unique identifier for the tab.", - "type": "string" - }, - "tabIdMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `tabId` property is editable." - }, - "tabLabel": { - "description": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n", - "type": "string" - }, - "tabLabelMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `tabLabel` property is editable." - }, - "tabOrder": { - "description": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.", - "type": "string" - }, - "tabOrderMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `tabOrder` property is editable." - }, - "tabType": { - "description": "Indicates the type of tab (for example, `signHere` or `initialHere`).", - "type": "string" - }, - "tabTypeMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `tabType` property is editable." - }, - "templateLocked": { - "description": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ", - "type": "string" - }, - "templateLockedMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `templateLocked` property is editable." - }, - "templateRequired": { - "description": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.", + "selected": { + "description": "When set to **true**, the radio button is selected.", "type": "string" }, - "templateRequiredMetadata": { + "selectedMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `templateRequired` property is editable." + "description": "Metadata that indicates whether the `selected` property is editable." }, - "tooltip": { - "description": "The text of a tooltip that appears when a user hovers over a form field or tab.", + "status": { + "description": "Indicates the envelope status. Valid values are:\n\n* sent - The envelope is sent to the recipients. \n* created - The envelope is saved as a draft and can be modified and sent later.", "type": "string" }, - "toolTipMetadata": { + "statusMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `toolTip` property is editable." + "description": "Metadata that indicates whether the `status` property is editable." }, - "underline": { - "description": "When set to **true**, the information in the tab is underlined.", + "tabId": { + "description": "The unique identifier for the tab.", "type": "string" }, - "underlineMetadata": { + "tabIdMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `underline` property is editable." + "description": "Metadata that indicates whether the `tabId` property is editable." }, - "validationMessage": { - "description": "The message displayed if the custom tab fails input validation (either custom of embedded).", + "tabOrder": { + "description": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.", "type": "string" }, - "validationMessageMetadata": { + "tabOrderMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `validationMessage` property is editable." + "description": "Metadata that indicates whether the `tabOrder` property is editable." }, - "validationPattern": { - "description": "A regular expression used to validate input for the tab.", + "underline": { + "description": "When set to **true**, the information in the tab is underlined.", "type": "string" }, - "validationPatternMetadata": { + "underlineMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `validationPattern` property is editable." + "description": "Metadata that indicates whether the `underline` property is editable." }, "value": { "description": "Specifies the value of the tab. ", @@ -39135,14 +50130,6 @@ "$ref": "#/definitions/propertyMetadata", "description": "Metadata that indicates whether the `value` property is editable." }, - "width": { - "description": "The width of the tab in pixels.", - "type": "string" - }, - "widthMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `width` property is editable." - }, "xPosition": { "description": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n", "type": "string" @@ -39152,7 +50139,7 @@ "description": "Metadata that indicates whether the `xPosition` property is editable." }, "yPosition": { - "description": "This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.", + "description": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n", "type": "string" }, "yPositionMetadata": { @@ -39160,2309 +50147,2032 @@ "description": "Metadata that indicates whether the `yPosition` property is editable." } }, - "x-ds-definition-name": "number", - "description": "A tab that allows the recipient to enter numbers and decimal\n(.) points.\n", - "x-ms-summary": "A tab that allows the recipient to enter numbers and decimal\n(.) points.\n" - }, - "oauthAccess": { - "type": "object", - "properties": { - "access_token": { - "description": "Access token information.", - "type": "string" - }, - "data": { - "description": "A Base64-encoded representation of the attachment that is used to upload and download the file. File attachments may be up to 50 MB in size.", - "type": "array", - "items": { - "$ref": "#/definitions/nameValue" - } - }, - "expires_in": { - "description": "", - "type": "string" - }, - "refresh_token": { - "description": "", - "type": "string" - }, - "scope": { - "description": "Must be set to \"api\".", - "type": "string" - }, - "token_type": { - "description": "", - "type": "string" - } - }, - "x-ds-definition-name": "oauthAccess", - "description": "", - "x-ms-summary": "" + "x-ds-definition-name": "radio", + "description": "One of the selectable radio buttons\nin the `radios` property\nof a [`radioGroup`](https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/) tab.\n", + "x-ms-summary": "One of the selectable radio buttons\nin the `radios` property\nof a [`radioGroup`](https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/) tab.\n" }, - "page": { - "description": "Description of a page of a document.", + "radioGroup": { "type": "object", "properties": { - "dpi": { - "description": "The number of dots per inch used for the page image.", + "conditionalParentLabel": { + "description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility.", "type": "string" }, - "errorDetails": { - "$ref": "#/definitions/errorDetails", - "description": "If an error occurs, this property describes the error." - }, - "height": { - "description": "The height of the page in pixels.", - "type": "string" + "conditionalParentLabelMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `conditionalParentLabel` property is editable." }, - "imageBytes": { - "description": "The number of image bytes.", + "conditionalParentValue": { + "description": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use \"on\" as the value to show that the parent tab is active.\n", "type": "string" }, - "mimeType": { - "description": "The MIME type.", - "type": "string" + "conditionalParentValueMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `conditionalParentValue` property is editable." }, - "pageId": { - "description": "The unique ID of the page.", + "documentId": { + "description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.", "type": "string" }, - "sequence": { - "description": "The sequence of the page in the document, or page number.", - "type": "string" + "documentIdMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `documentId` property is editable." }, - "width": { - "description": "The width of the page in pixels.", - "type": "string" - } - }, - "x-ds-definition-name": "page", - "x-ms-summary": "Description of a page of a document." - }, - "pageImages": { - "type": "object", - "properties": { - "endPosition": { - "description": "The last position in the result set. ", + "groupName": { + "description": "The name of the group. The search_text provided in the call automatically performs a wild card search on group_name.", "type": "string" }, - "nextUri": { - "description": "The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. ", - "type": "string" + "groupNameMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `groupName` property is editable." }, - "pages": { - "description": "An array of page objects.", + "radios": { + "description": "Specifies the locations and status for radio buttons that are grouped together.", "type": "array", "items": { - "$ref": "#/definitions/page" + "$ref": "#/definitions/radio" } }, - "previousUri": { - "description": "The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. ", - "type": "string" - }, - "resultSetSize": { - "description": "The number of results returned in this response. Because you can filter which entries are included in the response, this value is always less than or equal to `totalSetSize`.", + "recipientId": { + "description": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.", "type": "string" }, - "startPosition": { - "description": "The starting position of the current result set.", + "recipientIdGuid": { + "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only.", "type": "string" }, - "totalSetSize": { - "description": "The total number of items in the search's result set. This value is always greater than or equal to the value of `resultSetSize`.", - "type": "string" - } - }, - "x-ds-definition-name": "pageImages", - "description": "", - "x-ms-summary": "" - }, - "pageRequest": { - "type": "object", - "properties": { - "password": { - "description": "The user's encrypted password hash.", - "type": "string" + "recipientIdGuidMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `recipientIdGuid` property is editable." }, - "rotate": { - "description": "Sets the direction the page image is rotated. The possible settings are: left or right", - "type": "string" - } - }, - "x-ds-definition-name": "pageRequest", - "description": "", - "x-ms-summary": "" - }, - "pageSize": { - "type": "object", - "properties": { - "pageHeight": { - "description": "", - "type": "string" + "recipientIdMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `recipientId` property is editable." }, - "pageWidth": { - "description": "", - "type": "string" - } - }, - "x-ds-definition-name": "pageSize", - "description": "", - "x-ms-summary": "" - }, - "pathExtendedElement": { - "type": "object", - "properties": { - "name": { - "description": "", + "requireAll": { + "description": "When set to **true** and shared is true, information must be entered in this field to complete the envelope. ", "type": "string" }, - "type": { - "description": "Type of user:\n- `type_owner`\n- `type_participant`", - "type": "string" + "requireAllMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `requireAll` property is editable." }, - "typeName": { - "description": "", + "requireInitialOnSharedChange": { + "description": "Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.", "type": "string" - } - }, - "x-ds-definition-name": "pathExtendedElement", - "description": "", - "x-ms-summary": "" - }, - "paymentDetails": { - "type": "object", - "properties": { - "allowedPaymentMethods": { - "description": "An array of accepted payment methods:\n\n* `CreditCard`\n* `ApplePay`\n* `AndroidPay`\n* `BankAccount`\n\nFor example, if you only accept credit cards and ACH transfers, you would set this property to:\n\n`'[\"BankAccount\", \"CreditCard\"]'`\n\nDo not specify `BankAccount` (ACH) if you are also using in-person signing.\n", - "type": "array", - "items": { - "type": "string" - } }, - "chargeId": { - "description": "The GUID set by the payment gateway (such as Stripe) that identifies a transaction. The `chargeId` is created when authorizing a payment and must be referenced when completing a payment.", - "type": "string" + "requireInitialOnSharedChangeMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `requireInitialOnSharedChange` property is editable." }, - "currencyCode": { - "description": "Specifies the three-letter\n[ISO 4217][ISO4217] currency code for the payment.\n\nSupported currencies are:\n\n* AUD Australian dollar\n* CAD Canadian dollar\n* EUR Euro\n* GBP Great Britain pound\n* USD United States dollar\n\nSpecifying any other ISO 4217 code for payments is an error.\n\n[ISO4217]: https://en.wikipedia.org/wiki/ISO_4217\n", + "shared": { + "description": "When set to **true**, this custom tab is shared.", "type": "string" }, - "currencyCodeMetadata": { + "sharedMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "" + "description": "Metadata that indicates whether the `shared` property is editable." }, - "gatewayAccountId": { - "description": "A GUID that identifies the payment gateway\nconnected to the sender's DocuSign account.\n\nThere is no public API\nfor connecting payment gateway accounts\nYou must connect and manage payment gateway accounts\nthrough the DocuSign Admin console\nand through your chosen payment gateway.\n\nYou can get the gateway account ID\nin the Payments section\nof the DocuSign Admin console.\n\n\n[paymentgateways]: https://support.docusign.com/en/guides/managing-payment-gateways\n", + "tabType": { + "description": "Indicates the type of tab (for example, `signHere` or `initialHere`).", "type": "string" }, - "gatewayAccountIdMetadata": { + "tabTypeMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "" - }, - "gatewayDisplayName": { - "description": "Display name of the gateway connected to sender's Docusign account.\n\nPossible values are: Stripe, Braintree, Authorize.Net.", - "type": "string" + "description": "Metadata that indicates whether the `tabType` property is editable." }, - "gatewayName": { - "description": "Name of the gateway connected to sender's DocuSign account.\n\nPossible values are:\n\n* `Stripe`\n* `Braintree`\n* `AuthorizeDotNet`", + "templateLocked": { + "description": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ", "type": "string" }, - "lineItems": { - "description": "A payment formula can have\none or more line items\nthat provide detail about\nindividual items in a payment request.\n\nThe list of line items\nare returned as metadata\nto the payment gateway.\n", - "type": "array", - "items": { - "$ref": "#/definitions/paymentLineItem" - } + "templateLockedMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `templateLocked` property is editable." }, - "paymentOption": { - "description": "", + "templateRequired": { + "description": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.", "type": "string" }, - "status": { - "description": "This read-only property describes the status of a payment.\n\n* `new`
\n This is a new payment request.\n The envelope has been created,\n but no payment authorizations have been made.\n\n* `auth_complete`
\n A recipient has entered their credit card information,\n but the envelope has not been completed.\n The card has not been charged.\n\n* `payment_complete`
\n The recipient's card has been charged.\n\n* `payment_capture_failed`
\n Final charge failed.\n This can happen when too much time\n passes between authorizing the payment\n and completing the document.\n", + "templateRequiredMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `templateRequired` property is editable." + }, + "tooltip": { + "description": "The text of a tooltip that appears when a user hovers over a form field or tab.", "type": "string" }, - "total": { - "$ref": "#/definitions/money", - "description": "This read-only property\nis a currency-formatted string\nthat represents the total\nof all the line items.\nThe total is available\nonly after the document is completed,\nwhich is when all recipients have paid and\nhave completed all required fields.\n" + "tooltipMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `tooltip` property is editable." } }, - "x-ds-definition-name": "paymentDetails", - "description": "When a formula tab\nhas a `paymentDetails` property,\nthe formula tab\nis a payment item.\nSee [Requesting Payments Along with Signatures][paymentguide]\nin the DocuSign Support Center\nto learn more about payments.\n\n[paymentguide]: https://support.docusign.com/en/guides/requesting-payments-along-with-signatures\n", - "x-ms-summary": "When a formula tab\nhas a `paymentDetails` property,\nthe formula tab\nis a payment item.\nSee [Requesting Payments Along with Signatures][paymentguide]\nin the DocuSign Support Center\nto learn more about payments.\n\n[paymentguide]: https://support.docusign.com/en/guides/requesting-payments-along-with-signatures\n" + "x-ds-definition-name": "radioGroup", + "description": "This group tab is used to place radio buttons on a document.\nThe `radios` property\ncontains a list of\n[`radio`](https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/)\nobjects associated with the group. Only one radio button can\nbe selected in a group.\n", + "x-ms-summary": "This group tab is used to place radio buttons on a document.\nThe `radios` property\ncontains a list of\n[`radio`](https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/)\nobjects associated with the group. Only one radio button can\nbe selected in a group.\n" }, - "paymentGatewayAccount": { + "recipientAdditionalNotification": { "type": "object", "properties": { - "config": { - "$ref": "#/definitions/paymentGatewayAccountSetting", - "description": "" + "phoneNumber": { + "$ref": "#/definitions/recipientPhoneNumber", + "description": "The phone number to receive the additional notifcation." }, - "displayName": { - "description": "", + "secondaryDeliveryMethod": { + "description": "The secondary delivery method. One of:\n\n- `email`\n- `fax`\n- `SMS`\n- `offline`\n", "type": "string" }, - "isEnabled": { - "description": "", - "type": "string" + "secondaryDeliveryMethodMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata about the delivery method." }, - "isLegacy": { - "description": "", + "secondaryDeliveryStatus": { + "description": "(Read-only) The status of the delivery.\n\nOne of:\n\n- `autoresponded`\n- `optedout`\n- `limitreached`\n", "type": "string" - }, - "lastModified": { - "description": "Utc date and time the comment was last updated (can only be done by creator.)", + } + }, + "x-ds-definition-name": "recipientAdditionalNotification", + "description": "Describes an additional notification method.", + "x-ms-summary": "Describes an additional notification method." + }, + "recipientAttachment": { + "type": "object", + "properties": { + "attachmentId": { + "description": "The unique identifier for the attachment.", "type": "string" }, - "paymentGateway": { - "description": "Payment gateway used by the connected gateway account.\nThis is the name used by the API.\nFor a human-readable version use `paymentGatewayDisplayName`.\n\nPossible values are:\n\n* `Stripe`\n* `Braintree`\n* `AuthorizeDotNet`", + "attachmentType": { + "description": "Specifies the type of the attachment for the recipient. Possible values are:\n\n- `.htm`\n- `.xml`", "type": "string" }, - "paymentGatewayAccountId": { - "description": "A GUID that identifies the payment gateway account. For a human-readable version use `displayName`.", + "data": { + "description": "A Base64-encoded representation of the attachment that is used to upload and download the file. File attachments may be up to 50 MB in size.", "type": "string" }, - "paymentGatewayDisplayName": { - "description": "Display name of the payment gateway used by the connected gateway account.\nThis is the human-readable version of `paymentGateway`.\n\nPossible values are:\n\n* Stripe\n* Braintree\n* Authorize.Net", + "label": { + "description": "An optional label for the attachment.", "type": "string" }, - "payPalLegacySettings": { - "$ref": "#/definitions/payPalLegacySettings", - "description": "" - }, - "supportedCurrencies": { - "description": "", - "type": "array", - "items": { - "type": "string" - } - }, - "supportedPaymentMethods": { - "description": "", - "type": "array", - "items": { - "type": "string" - } + "name": { + "description": "The name of the attachment.", + "type": "string" }, - "supportedPaymentMethodsWithOptions": { - "description": "", - "type": "array", - "items": { - "$ref": "#/definitions/paymentMethodWithOptions" - } + "remoteUrl": { + "description": "The URL of a previously staged chunked upload. Using a chunked upload enables you to stage a large, chunkable temp file. You then use the `remoteUrl` property to reference the chunked upload as the content in attachment and document-related requests. The `remoteUrl` property cannot be used for downloads.", + "type": "string" } }, - "x-ds-definition-name": "paymentGatewayAccount", + "x-ds-definition-name": "recipientAttachment", "description": "", "x-ms-summary": "" }, - "paymentGatewayAccountSetting": { + "recipientDomain": { "type": "object", "properties": { - "apiFields": { + "active": { "description": "", "type": "string" }, - "authorizationCode": { + "domainCode": { "description": "", "type": "string" }, - "credentialStatus": { + "domainName": { "description": "", "type": "string" }, - "merchantId": { + "recipientDomainId": { "description": "", "type": "string" } }, - "x-ds-definition-name": "paymentGatewayAccountSetting", + "x-ds-definition-name": "recipientDomain", "description": "", "x-ms-summary": "" }, - "paymentGatewayAccountsInfo": { - "type": "object", - "properties": { - "paymentGatewayAccounts": { - "description": "A list of payment gateway accounts.", - "type": "array", - "items": { - "$ref": "#/definitions/PaymentGatewayAccounts" - } - } - }, - "x-ds-definition-name": "paymentGatewayAccountsInfo", - "description": "Holds information about connected payment accounts.", - "x-ms-summary": "Holds information about connected payment accounts." - }, - "paymentLineItem": { + "recipientEmailNotification": { "type": "object", "properties": { - "amountReference": { - "description": "This is a the `tabLabel`\nthat specifies the amount paid\nfor the line items.\n\n", + "emailBody": { + "description": "The body of the email message.", "type": "string" }, - "description": { - "description": "A sender-defined description of the line item.\n", - "type": "string" + "emailBodyMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `emailBody` property can be edited." }, - "itemCode": { - "description": "This is the sender-defined\nSKU, inventory number, or other item code\nfor the line item.\n", + "emailSubject": { + "description": "The subject line for the email notification.", "type": "string" }, - "name": { - "description": "This is a sender-defined\nproduct name, service name,\nor other designation for the line item.\n", - "type": "string" - } - }, - "x-ds-definition-name": "paymentLineItem", - "description": "A line item describes details\nabout an individual line item\nin a payment request.\n\n", - "x-ms-summary": "A line item describes details\nabout an individual line item\nin a payment request.\n\n" - }, - "paymentMethodWithOptions": { - "type": "object", - "properties": { - "supportedOptions": { - "description": "", - "type": "array", - "items": { - "type": "string" - } + "emailSubjectMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `emailSubject` property can be edited." }, - "type": { - "description": "Type of user:\n- `type_owner`\n- `type_participant`", + "supportedLanguage": { + "description": "The language to use for the standard email format and signing view for a recipient.\n\nFor example, in the recipient's email notification, this setting affects elements such as the standard introductory text describing the request to sign. It also determines the language used for buttons and tabs in both the email notification and the signing experience.\n\n**Note**: This setting affects only DocuSign standard text. Any custom text that you enter for the `emailBody` and `emailSubject` of the notification is not translated, and appears exactly as you enter it.\n\n To retrieve the possible values, use the [Accounts::listSupportedLanguages][ListLang] method.\n\n[ListLang]: https://developers.docusign.com/docs/esign-rest-api/reference/Accounts/Accounts/listSupportedLanguages/\n", "type": "string" + }, + "supportedLanguageMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `supportedLanguage` property can be edited." } }, - "x-ds-definition-name": "paymentMethodWithOptions", + "x-ds-definition-name": "recipientEmailNotification", "description": "", "x-ms-summary": "" }, - "paymentProcessorInformation": { + "recipientEvent": { "type": "object", "properties": { - "address": { - "$ref": "#/definitions/addressInformation", - "description": "The user's address." - }, - "billingAgreementId": { - "description": "", + "includeDocuments": { + "description": "When set to **true**, the PDF documents are included in the message along with the updated XML. ", "type": "string" }, - "email": { - "description": "Filters returned user records by the specified email address.", + "recipientEventStatusCode": { + "description": "Send a webhook notification for the following recipient statuses: Sent, Delivered, Completed, Declined, AuthenticationFailed, and AutoResponded.", "type": "string" } }, - "x-ds-definition-name": "paymentProcessorInformation", + "x-ds-definition-name": "recipientEvent", "description": "", "x-ms-summary": "" }, - "payPalLegacySettings": { + "recipientFormData": { "type": "object", "properties": { - "currency": { - "description": "The three-letter\n[ISO 4217][ISO4217] currency code for the payment.\n\nFor example:\n\n* AUD Australian dollar\n* CAD Canadian dollar\n* EUR Euro\n* GBP Great Britain pound\n* USD United States dollar\n\nThis is a read-only property.\n\n[ISO4217]: https://en.wikipedia.org/wiki/ISO_4217\n", + "DeclinedTime": { + "description": "The date and time the recipient declined the envelope.", "type": "string" }, - "partner": { - "description": "", + "DeliveredTime": { + "description": "The date and time the recipient viewed the documents in the envelope in the DocuSign signing UI.", "type": "string" }, - "password": { - "description": "The user's encrypted password hash.", + "email": { + "description": "The recipient's email address.", "type": "string" }, - "userName": { - "description": "The name of the user.", + "formData": { + "description": "An array of form data objects.", + "type": "array", + "items": { + "$ref": "#/definitions/formDataItem" + } + }, + "name": { + "description": "The name of the recipient.", "type": "string" }, - "vendor": { - "description": "", + "recipientId": { + "description": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.", + "type": "string" + }, + "SentTime": { + "description": "The date and time the envelope was sent to the recipient.", + "type": "string" + }, + "SignedTime": { + "description": "The date and time the recipient signed the documents.", "type": "string" } }, - "x-ds-definition-name": "payPalLegacySettings", + "x-ds-definition-name": "recipientFormData", "description": "", "x-ms-summary": "" }, - "permissionProfile": { + "recipientGroup": { "type": "object", "properties": { - "modifiedByUsername": { - "description": "The username of the user who last modified the permission profile.", - "type": "string" - }, - "modifiedDateTime": { - "description": "The date and time when the permission profile was last modified.", - "type": "string" - }, - "permissionProfileId": { - "description": "The ID of the permission profile. Possible values include:\n\n- `2301416` (for the `DocuSign Viewer` profile)\n- `2301415` (for the `DocuSign Sender` profile)\n- `2301414` (for the `Account Administrator` profile)\n\nIn addition, any custom permission profiles associated with your account will have an automatically generated `permissionProfileId`.", + "groupMessage": { + "description": "The group message, typically a description of the group.", "type": "string" }, - "permissionProfileName": { - "description": "The name of the account permission profile. \n\nExample: `Account Administrator`", + "groupName": { + "description": "The name of the group", "type": "string" }, - "settings": { - "$ref": "#/definitions/accountRoleSettings", - "description": "This object specifies the permissions that are associated with the account permission profile." - }, - "userCount": { - "description": "The total number of users in the group associated with the account permission profile.", + "recipients": { + "description": "An array of recipient objects that provides details about the recipients of the envelope.", + "type": "array", + "items": { + "$ref": "#/definitions/recipientOption" + } + } + }, + "x-ds-definition-name": "recipientGroup", + "description": "Describes a group of recipients.", + "x-ms-summary": "Describes a group of recipients." + }, + "recipientIdentityInputOption": { + "type": "object", + "properties": { + "name": { + "description": "", "type": "string" }, - "users": { - "description": "A list of user objects containing information about the users who are associated with the account permission profile.", + "phoneNumberList": { + "description": "", "type": "array", "items": { - "$ref": "#/definitions/Users" + "$ref": "#/definitions/recipientIdentityPhoneNumber" } + }, + "valueType": { + "description": "", + "type": "string" } }, - "x-ds-definition-name": "permissionProfile", - "description": "This object defines the account permissions for a profile that you can apply to a group of users.", - "x-ms-summary": "This object defines the account permissions for a profile that you can apply to a group of users." + "x-ds-definition-name": "recipientIdentityInputOption", + "description": "", + "x-ms-summary": "" }, - "permissionProfileInformation": { + "recipientIdentityPhoneNumber": { "type": "object", "properties": { - "permissionProfiles": { - "description": "A complex type containing a collection of permission profiles.", - "type": "array", - "items": { - "$ref": "#/definitions/AccountPermissionProfiles" - } + "extension": { + "description": "", + "type": "string" + }, + "number": { + "description": "", + "type": "string" } }, - "x-ds-definition-name": "permissionProfileInformation", - "description": "Contains details about the permission profiles associated with an account.", - "x-ms-summary": "Contains details about the permission profiles associated with an account." + "x-ds-definition-name": "recipientIdentityPhoneNumber", + "description": "", + "x-ms-summary": "" }, - "planInformation": { - "description": "An object used to identify the features and attributes of the account being created.", + "recipientIdentityVerification": { "type": "object", "properties": { - "addOns": { - "description": "Reserved for DocuSign.", + "inputOptions": { + "description": "", "type": "array", "items": { - "$ref": "#/definitions/addOn" + "$ref": "#/definitions/recipientIdentityInputOption" } }, - "currencyCode": { - "description": "Specifies the ISO currency code for the account.", + "workflowId": { + "description": "ID of the Identity Verification worklow used to verify recipients' identity.\n\nThis ID must match one of the [workflowId](https://developers.docusign.com/docs/esign-rest-api/reference/accounts/identityverifications/list/) available to your account.", "type": "string" - }, - "freeTrialDaysOverride": { - "description": "Reserved for DocuSign use only.", + } + }, + "x-ds-definition-name": "recipientIdentityVerification", + "description": "Specifies ID Verification applied on an envelope by workflow ID.\nSee the [list](https://developers.docusign.com/docs/esign-rest-api/reference/Accounts/IdentityVerifications/list)\nmethod in the [IdentityVerifications](https://developers.docusign.com/docs/esign-rest-api/reference/Accounts/IdentityVerifications) resource\nfor more information on how to retrieve workflow IDs available for an account.\nThis can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods.", + "x-ms-summary": "Specifies ID Verification applied on an envelope by workflow ID.\nSee the [list](https://developers.docusign.com/docs/esign-rest-api/reference/Accounts/IdentityVerifications/list)\nmethod in the [IdentityVerifications](https://developers.docusign.com/docs/esign-rest-api/reference/Accounts/IdentityVerifications) resource\nfor more information on how to retrieve workflow IDs available for an account.\nThis can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods." + }, + "recipientNamesResponse": { + "type": "object", + "properties": { + "multipleUsers": { + "description": "When set to **true**, the email address is used by more than one user.", "type": "string" }, - "planFeatureSets": { - "description": "Reserved for DocuSign.", + "recipientNames": { + "description": "The names of the recipients associated with the email address.", "type": "array", "items": { - "$ref": "#/definitions/featureSet" + "type": "string" } }, - "planId": { - "description": "The DocuSign plan id for the account.", + "reservedRecipientEmail": { + "description": "When set to **true**, new names cannot be added to the email address.", "type": "string" - }, - "recipientDomains": { - "description": "", - "type": "array", - "items": { - "$ref": "#/definitions/recipientDomain" - } } }, - "x-ds-definition-name": "planInformation", - "x-ms-summary": "An object used to identify the features and attributes of the account being created." + "x-ds-definition-name": "recipientNamesResponse", + "description": "This response object contains a list of recipients.", + "x-ms-summary": "This response object contains a list of recipients." }, - "polyLine": { + "recipientOption": { "type": "object", "properties": { - "x1": { + "email": { "description": "", "type": "string" }, - "x2": { + "name": { "description": "", "type": "string" }, - "y1": { + "recipientLabel": { "description": "", "type": "string" }, - "y2": { - "description": "", + "roleName": { + "description": "Optional element. Specifies the role name associated with the recipient.

This property is required when you are working with template recipients.", + "type": "string" + }, + "signingGroupId": { + "description": "When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once).", "type": "string" } }, - "x-ds-definition-name": "polyLine", + "x-ds-definition-name": "recipientOption", "description": "", "x-ms-summary": "" }, - "polyLineOverlay": { + "recipientPhoneAuthentication": { + "description": "A complex type that contains the elements:\n\n* `recipMayProvideNumber`: A Boolean value that specifies whether the recipient can use the phone number of their choice.\n* `senderProvidedNumbers`: A list of phone numbers that the recipient can use.\n* `recordVoicePrint`: Reserved for DocuSign.\n* `validateRecipProvidedNumber`: Reserved for DocuSign.", "type": "object", "properties": { - "anchorCaseSensitive": { - "description": "Reserved for DocuSign.\n", + "recipMayProvideNumber": { + "description": "Boolean. When set to **true**, the recipient can supply a phone number their choice.", "type": "string" }, - "anchorCaseSensitiveMetadata": { + "recipMayProvideNumberMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "description": "Metadata that indicates whether the `recipMayProvideNumber` property can be edited." }, - "anchorHorizontalAlignment": { - "description": "Reserved for DocuSign.\n\n", + "recordVoicePrint": { + "description": "Reserved for DocuSign.", "type": "string" }, - "anchorHorizontalAlignmentMetadata": { + "recordVoicePrintMetadata": { "$ref": "#/definitions/propertyMetadata", "description": "Reserved for DocuSign." }, - "anchorIgnoreIfNotPresent": { - "description": "When set to **true**, this tab is ignored if the `anchorString` is not found in the document.", - "type": "string" + "senderProvidedNumbers": { + "description": "An array containing a list of phone numbers that the recipient can use for SMS text authentication. ", + "type": "array", + "items": { + "type": "string" + } }, - "anchorIgnoreIfNotPresentMetadata": { + "senderProvidedNumbersMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable." + "description": "Metadata that indicates whether the `senderProvidedNumbers` property can be edited." }, - "anchorMatchWholeWord": { - "description": "Reserved for DocuSign.\n\n", + "validateRecipProvidedNumber": { + "description": " Reserved for DocuSign.", "type": "string" }, - "anchorMatchWholeWordMetadata": { + "validateRecipProvidedNumberMetadata": { "$ref": "#/definitions/propertyMetadata", "description": "Reserved for DocuSign." - }, - "anchorString": { - "description": "Specifies the string to find in the document and use as the basis for tab placement.", + } + }, + "x-ds-definition-name": "recipientPhoneAuthentication", + "x-ms-summary": "A complex type that contains the elements:\n\n* `recipMayProvideNumber`: A Boolean value that specifies whether the recipient can use the phone number of their choice.\n* `senderProvidedNumbers`: A list of phone numbers that the recipient can use.\n* `recordVoicePrint`: Reserved for DocuSign.\n* `validateRecipProvidedNumber`: Reserved for DocuSign." + }, + "recipientPhoneNumber": { + "type": "object", + "properties": { + "countryCode": { + "description": "The numeric country calling code for `number`. For example, the country calling code for the US and Canada is `1`, for the UK: `44`,\n\nDo not include the `+` symbol.", "type": "string" }, - "anchorStringMetadata": { + "countryCodeMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `anchorString` property is editable." + "description": "Metadata that indicates if the `countryCode` property is editable." }, - "anchorTabProcessorVersion": { - "description": "Reserved for DocuSign.", + "number": { + "description": "The telephone number. Use only the digits `0`-`9`. Remove any non-numeric characters.\n\nDo not include the `countryCode`. For US, Canada, and other\n[North American Numbering Plan](https://en.wikipedia.org/wiki/North_American_Numbering_Plan) countries, do not include a leading `1` or `0`.", "type": "string" }, - "anchorTabProcessorVersionMetadata": { + "numberMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." - }, - "anchorUnits": { - "description": "Specifies the units of the X and Y offset. Units may be pixels, millimeters, centimeters, or inches.", + "description": "Metadata that indicates if the `number` property is editable." + } + }, + "x-ds-definition-name": "recipientPhoneNumber", + "description": "Describes the recipient phone number.", + "x-ms-summary": "Describes the recipient phone number." + }, + "recipientPreviewRequest": { + "type": "object", + "properties": { + "assertionId": { + "description": "A unique identifier of the authentication event executed by the client application.", "type": "string" }, - "anchorUnitsMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `anchorUnits` property is editable." - }, - "anchorXOffset": { - "description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.", + "authenticationInstant": { + "description": "A sender-generated value that indicates the date and time that the signer was authenticated.", "type": "string" }, - "anchorXOffsetMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `anchorXOffset` property is editable." + "authenticationMethod": { + "description": "Required. Choose a value that most closely matches the technique your application used to authenticate the recipient / signer. \n\nChoose a value from this list: \n* Biometric \n* Email\n* HTTPBasicAuth\n* Kerberos\n* KnowledgeBasedAuth\n* None\n* PaperDocuments\n* Password\n* RSASecureID\n* SingleSignOn_CASiteminder\n* SingleSignOn_InfoCard\n* SingleSignOn_MicrosoftActiveDirectory\n* SingleSignOn_Other\n* SingleSignOn_Passport\n* SingleSignOn_SAML\n* Smartcard\n* SSLMutualAuth\n* X509Certificate\n\nThis information is included in the Certificate of Completion.", + "type": "string" }, - "anchorYOffset": { - "description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.", + "pingFrequency": { + "description": "Only used if `pingUrl` is specified. This is the interval, in seconds, between pings on the `pingUrl`. The default is `300` seconds. Valid values are 60-1200 seconds.", "type": "string" }, - "anchorYOffsetMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `anchorYOffset` property is editable." + "pingUrl": { + "description": "The client URL that the DocuSign Signing experience should ping to indicate to the client that Signing is active. An HTTP GET call is executed against the client. The response from the client is ignored. The intent is for the client to reset its session timer when the request is received.", + "type": "string" }, - "conditionalParentLabel": { - "description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility.", + "recipientId": { + "description": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.", "type": "string" }, - "conditionalParentLabelMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `conditionalParentLabel` property is editable." + "returnUrl": { + "description": "The URL to which the sender should be redirected after viewing the preview.", + "type": "string" }, - "conditionalParentValue": { - "description": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use \"on\" as the value to show that the parent tab is active.\n", + "securityDomain": { + "description": "The domain in which the user authenticated.", "type": "string" }, - "conditionalParentValueMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `conditionalParentValue` property is editable." + "xFrameOptions": { + "description": "Specifies whether a browser should be allowed to render a page in a frame or IFrame. Setting this property ensures that your content is not embedded into unauthorized pages or frames.\n\nValid values are:\n\n- `deny`: The page cannot be displayed in a frame.\n- `same_origin`: The page can only be displayed in a frame on the same origin as the page itself.\n- `allow_from`: The page can only be displayed in a frame on the origin specified by the `xFrameOptionsAllowFromUrl` property.", + "type": "string" }, - "customTabId": { - "description": "The DocuSign-generated custom tab id for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.", + "xFrameOptionsAllowFromUrl": { + "description": "When the value of `xFrameOptions` is `allow_from`, this property specifies the origin on which the page is allowed to display in a frame. If the value of `xFrameOptions` is `allow_from`, you must include a value for this property.", + "type": "string" + } + }, + "x-ds-definition-name": "recipientPreviewRequest", + "description": "This request object contains the information necessary to create a recipient preview.", + "x-ms-summary": "This request object contains the information necessary to create a recipient preview." + }, + "recipientProofFile": { + "type": "object", + "properties": { + "isInProofFile": { + "description": "Indicates whether a proof file is available for this recipient.", "type": "string" + } + }, + "x-ds-definition-name": "recipientProofFile", + "description": "The proof file of the recipient. [ID Evidence](https://developers.docusign.com/idevidence-api) uses proof files to store the identification data that recipients submit when verifying their ID with [ID Verification](https://developers.docusign.com/docs/esign-rest-api/reference/Accounts/IdentityVerifications)", + "x-ms-summary": "The proof file of the recipient. [ID Evidence](https://developers.docusign.com/idevidence-api) uses proof files to store the identification data that recipients submit when verifying their ID with [ID Verification](https://developers.docusign.com/docs/esign-rest-api/reference/Accounts/IdentityVerifications)" + }, + "recipientRouting": { + "type": "object", + "properties": { + "rules": { + "$ref": "#/definitions/recipientRules", + "description": "The recipient routing rules." + } + }, + "x-ds-definition-name": "recipientRouting", + "description": "Describes the recipient routing rules.", + "x-ms-summary": "Describes the recipient routing rules." + }, + "recipientRules": { + "type": "object", + "properties": { + "conditionalRecipients": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/conditionalRecipientRule" + } + } + }, + "x-ds-definition-name": "recipientRules", + "description": "", + "x-ms-summary": "" + }, + "recipients": { + "description": "Specifies the envelope recipients.", + "type": "object", + "properties": { + "agents": { + "description": "A list of agent recipients assigned to the documents.", + "type": "array", + "items": { + "$ref": "#/definitions/agent" + } }, - "customTabIdMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `customTabId` property is editable." + "carbonCopies": { + "description": "A list of carbon copy recipients assigned to the documents.", + "type": "array", + "items": { + "$ref": "#/definitions/carbonCopy" + } }, - "documentId": { - "description": "Integer that identifies the document in the envelope.", + "certifiedDeliveries": { + "description": "A complex type containing information on a recipient the must receive the completed documents for the envelope to be completed, but the recipient does not need to sign, initial, date, or add information to any of the documents.", + "type": "array", + "items": { + "$ref": "#/definitions/certifiedDelivery" + } + }, + "currentRoutingOrder": { + "description": "The routing order of the current recipient. If this value equals a particular signer's routing order, it indicates that the envelope has been sent to that recipient, but he or she has not completed the required actions.", "type": "string" }, - "documentIdMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `documentId` property is editable." + "editors": { + "description": "A list of users who can edit the envelope.", + "type": "array", + "items": { + "$ref": "#/definitions/editor" + } }, "errorDetails": { "$ref": "#/definitions/errorDetails", "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." }, - "formOrder": { - "description": "An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block.", - "type": "string" - }, - "formOrderMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `formOrder` property is editable." + "inPersonSigners": { + "description": "Specifies a signer that is in the same physical location as a DocuSign user who will act as a Signing Host for the transaction. The recipient added is the Signing Host and new separate Signer Name field appears after Sign in person is selected.", + "type": "array", + "items": { + "$ref": "#/definitions/inPersonSigner" + } }, - "formPageLabel": { - "description": "A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience.", - "type": "string" + "intermediaries": { + "description": "Identifies a recipient that can, but is not required to, add name and email information for recipients at the same or subsequent level in the routing order (until subsequent Agents, Editors or Intermediaries recipient types are added).", + "type": "array", + "items": { + "$ref": "#/definitions/intermediary" + } }, - "formPageLabelMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `formPageLabel` property is editable." + "notaries": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/notaryRecipient" + } }, - "formPageNumber": { - "description": "An integer specifying the order in which to present the guided form pages.", + "recipientCount": { + "description": "The number of recipients in the envelope.", "type": "string" }, - "formPageNumberMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `fromPageNumber` property is editable." + "seals": { + "description": "A list of electronic seals to apply to documents.", + "type": "array", + "items": { + "$ref": "#/definitions/sealSign" + } }, - "graphicsContext": { - "$ref": "#/definitions/graphicsContext", - "description": "Contains details about the style used for the strike through graphic." + "signers": { + "description": "A list of signers on the envelope.", + "type": "array", + "items": { + "$ref": "#/definitions/signer" + } }, - "height": { - "description": "The height of the tab in pixels.", + "witnesses": { + "description": "A list of signers who act as witnesses on the envelope.", + "type": "array", + "items": { + "$ref": "#/definitions/witness" + } + } + }, + "x-ds-definition-name": "recipients", + "x-ms-summary": "Specifies the envelope recipients." + }, + "recipientSignatureInformation": { + "description": "Allows the sender to pre-specify the signature name, signature initials and signature font used in the signature stamp for the recipient.\n\nUsed only with recipient types In Person Signers and Signers.", + "type": "object", + "properties": { + "fontStyle": { + "description": "The font type to use for the signature if the signature is not drawn. The following font styles are supported. The quotes are to indicate that these values are strings, not `enums`.\n\n- `\"1_DocuSign\"`\n- `\"2_DocuSign\"`\n- `\"3_DocuSign\"`\n- `\"4_DocuSign\"`\n- `\"5_DocuSign\"`\n- `\"6_DocuSign\"`\n- `\"7_DocuSign\"`\n- `\"8_DocuSign\"`\n- `\"Mistral\"`\n- `\"Rage Italic\"`\n", "type": "string" }, - "heightMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `height` property is editable." - }, - "locked": { - "description": "When set to **true**, the signer cannot change the data of the custom tab.", + "signatureInitials": { + "description": "Specifies the user's signature in initials format.", "type": "string" }, - "lockedMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `locked` property is editable." + "signatureName": { + "description": "Specifies the user's signature name.", + "type": "string" + } + }, + "x-ds-definition-name": "recipientSignatureInformation", + "x-ms-summary": "Allows the sender to pre-specify the signature name, signature initials and signature font used in the signature stamp for the recipient.\n\nUsed only with recipient types In Person Signers and Signers." + }, + "recipientSignatureProvider": { + "type": "object", + "properties": { + "sealDocumentsWithTabsOnly": { + "description": "By default, electronic seals apply on all documents in an envelope. If any of the documents has a `signHere` tab, then a visual representation of the electronic seal will show up in the final document. If not, the electronic seal will be visible in the metadata but not in the content of the document.\n\nTo apply electronic seals on specific documents only, you must enable the `sealDocumentsWithTabsOnly` parameter. In this case, Electronic Seal applies only on documents that have `signHere` tabs set for the Electronic Seal recipient. Other documents won't be sealed. ", + "type": "string" }, - "mergeField": { - "$ref": "#/definitions/mergeField", - "description": "Contains the information necessary to map the tab to a field in SalesForce." + "sealName": { + "description": "Indicates the name of the electronic seal to apply on documents.\n", + "type": "string" }, - "overlayType": { - "description": "The type of overlay to use. The API currently supports only the `outline` overlay type.", + "signatureProviderName": { + "description": "The name of an Electronic or Standards Based Signature (digital signature) provider for the signer to use. For details, see [the current provider list](https://developers.docusign.com/esign-rest-api/guides/standards-based-signatures). You can also retrieve the list by using the [AccountSignatureProviders::List](https://developers.docusign.com/esign-rest-api/reference/Accounts/AccountSignatureProviders/list/) method.\n\nExample: `universalsignaturepen_default`\n\n", "type": "string" }, - "overlayTypeMetadata": { + "signatureProviderNameMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `overlayType` property is editable.\n" + "description": "Metadata that indicates whether the `signatureProviderName` property is editable.\n" }, - "pageNumber": { - "description": "The page number being accessed.", + "signatureProviderOptions": { + "$ref": "#/definitions/recipientSignatureProviderOptions", + "description": "Not applicable for this object." + } + }, + "x-ds-definition-name": "recipientSignatureProvider", + "description": "An Electronic or Standards Based Signature (digital signature) provider for the signer to use. [More information](https://developers.docusign.com/esign-rest-api/guides/standards-based-signatures).\n", + "x-ms-summary": "An Electronic or Standards Based Signature (digital signature) provider for the signer to use. [More information](https://developers.docusign.com/esign-rest-api/guides/standards-based-signatures).\n" + }, + "recipientSignatureProviderOptions": { + "type": "object", + "properties": { + "cpfNumber": { + "description": "Reserved for DocuSign.", "type": "string" }, - "pageNumberMetadata": { + "cpfNumberMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `pageNumber` property is editable." - }, - "polyLines": { - "description": "An array of `polyLine` objects that contain x- and y-coordinates representing the locations of the lines.", - "type": "array", - "items": { - "$ref": "#/definitions/polyLine" - } - }, - "recipientId": { - "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", - "type": "string" + "description": "Reserved for DocuSign." }, - "recipientIdGuid": { - "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one.", + "oneTimePassword": { + "description": "A pre-shared secret that the signer must enter to complete the signing process. Eg last six digits of the signer's government ID or Social Security number. Or a newly created pre-shared secret for the transaction. Note: some signature providers may require an exact (case-sensitive) match if alphabetic characters are included in the field.", "type": "string" }, - "recipientIdGuidMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `recipientIdGuid` property is editable." - }, - "recipientIdMetadata": { + "oneTimePasswordMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `recipientId` property is editable." + "description": "Metadata that indicates whether the `oneTimePassword` property is editable." }, - "shared": { - "description": "When set to **true**, indicates that the tab is shared.", + "signerRole": { + "description": "The role or capacity of the signing recipient. Examples: Manager, Approver, etc.", "type": "string" }, - "sharedMetadata": { + "signerRoleMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `shared` property is editable." + "description": "Metadata that indicates whether the `signerRole` property is editable." }, - "status": { - "description": "The status of the tab. Possible values are:\n\n- `active`: The tab is active, but the recipient has not yet interacted with it.\n- `signed`: The recipient signed the tab.\n- `declined`: The recipient declined the envelope.\n- `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`).", + "sms": { + "description": "The mobile phone number used to send the recipient an access code for the signing ceremony. Format: a string starting with +, then the country code followed by the full mobile phone number without any spaces or special characters. Omit leading zeroes before a city code. Examples: +14155551234, +97235551234, +33505551234.", "type": "string" }, - "statusMetadata": { + "smsMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `status` property is editable." - }, - "tabGroupLabels": { - "description": "An array of tab group labels that uniquely identify tab groups. To assign a tab to a `tabGroup`, you assign the `TabGroupLabel` to the `Tab.TabGroupLabels` array.", + "description": "Metadata that indicates whether the `sms` property is editable." + } + }, + "x-ds-definition-name": "recipientSignatureProviderOptions", + "description": "Option settings for the signature provider. Different providers require or use different options. [The current provider list and the options they require.](https://developers.docusign.com/esign-rest-api/guides/standards-based-signatures)", + "x-ms-summary": "Option settings for the signature provider. Different providers require or use different options. [The current provider list and the options they require.](https://developers.docusign.com/esign-rest-api/guides/standards-based-signatures)" + }, + "recipientSMSAuthentication": { + "description": "Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication.", + "type": "object", + "properties": { + "senderProvidedNumbers": { + "description": "An array containing a list of phone numbers that the recipient can use for SMS text authentication. ", "type": "array", "items": { "type": "string" } }, - "tabGroupLabelsMetadata": { + "senderProvidedNumbersMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `tabGroupLabels` property is editable." - }, - "tabId": { - "description": "The unique identifier for the tab.", + "description": "Metadata that indicates whether the `senderProvidedNumbers` property can be edited." + } + }, + "x-ds-definition-name": "recipientSMSAuthentication", + "x-ms-summary": "Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication." + }, + "recipientsUpdateSummary": { + "type": "object", + "properties": { + "recipientUpdateResults": { + "description": "An array of `recipientUpdateResults` objects that contain details about the recipients.", + "type": "array", + "items": { + "$ref": "#/definitions/recipientUpdateResponse" + } + } + }, + "x-ds-definition-name": "recipientsUpdateSummary", + "description": "This is the response that the API returns after you update recipients.", + "x-ms-summary": "This is the response that the API returns after you update recipients." + }, + "recipientUpdateResponse": { + "type": "object", + "properties": { + "combined": { + "description": "When you use the query parameter `combine_same_order_recipients` on the PUT Recipients call, the `recipientUpdateResponse` returns this property. When set to **true**, it indicates that the recipient has been combined or merged with a matching recipient. Recipient matching occurs as part of template matching, and is based on Recipient Role and Routing Order.", "type": "string" }, - "tabIdMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `tabId` property is editable." + "errorDetails": { + "$ref": "#/definitions/errorDetails", + "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." }, - "tabLabel": { - "description": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n", + "recipientId": { + "description": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.", "type": "string" }, - "tabOrder": { - "description": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.", + "recipientIdGuid": { + "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only.", "type": "string" }, - "tabOrderMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `tabOrder` property is editable." - }, - "tabType": { - "description": "Indicates the type of tab (for example, `signHere` or `initialHere`).", + "tabs": { + "$ref": "#/definitions/EnvelopeRecipientTabs", + "description": "All of the tabs associated with the recipient." + } + }, + "x-ds-definition-name": "recipientUpdateResponse", + "description": "The recipient details that are returned after you update the recipient.", + "x-ms-summary": "The recipient details that are returned after you update the recipient." + }, + "recipientViewRequest": { + "type": "object", + "properties": { + "assertionId": { + "description": "A unique identifier of the authentication event executed by the client application.", "type": "string" }, - "tabTypeMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `tabType` property is editable." + "authenticationInstant": { + "description": "A sender-generated value that indicates the date and time that the signer was authenticated.", + "type": "string" }, - "templateLocked": { - "description": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ", + "authenticationMethod": { + "description": "Required. Choose a value that most closely matches the technique your application used to authenticate the recipient / signer. \n\nChoose a value from this list: \n* Biometric \n* Email\n* HTTPBasicAuth\n* Kerberos\n* KnowledgeBasedAuth\n* None\n* PaperDocuments\n* Password\n* RSASecureID\n* SingleSignOn_CASiteminder\n* SingleSignOn_InfoCard\n* SingleSignOn_MicrosoftActiveDirectory\n* SingleSignOn_Other\n* SingleSignOn_Passport\n* SingleSignOn_SAML\n* Smartcard\n* SSLMutualAuth\n* X509Certificate\n\nThis information is included in the Certificate of Completion.", "type": "string" }, - "templateLockedMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `templateLocked` property is editable." + "clientUserId": { + "description": "A sender-created value. If provided, the recipient is treated as an embedded (captive) recipient or signer.\n\nUse your application's client ID (user ID) for the recipient. Doing so enables the details of your application's authentication of the recipient to be connected to the recipient's signature if the signature is disputed or repudiated.\n\nMaximum length: 100 characters.", + "type": "string" }, - "templateRequired": { - "description": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.", + "email": { + "description": "(Required) Specifies the email of the recipient. You can use either `email` and `userName` or `userId` to identify the recipient.", "type": "string" }, - "templateRequiredMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `templateRequired` property is editable." + "frameAncestors": { + "description": "", + "type": "array", + "items": { + "type": "string" + } }, - "tooltip": { - "description": "The text of a tooltip that appears when a user hovers over a form field or tab.", + "messageOrigins": { + "description": "", + "type": "array", + "items": { + "type": "string" + } + }, + "pingFrequency": { + "description": "Only used if `pingUrl` is specified. This is the interval, in seconds, between pings on the `pingUrl`. The default is `300` seconds. Valid values are 60-1200 seconds.", "type": "string" }, - "toolTipMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `toolTip` property is editable." + "pingUrl": { + "description": "The client URL that the DocuSign Signing experience should ping to indicate to the client that Signing is active. An HTTP GET call is executed against the client. The response from the client is ignored. The intent is for the client to reset its session timer when the request is received.", + "type": "string" + }, + "recipientId": { + "description": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.", + "type": "string" }, - "width": { - "description": "The width of the tab in pixels.", + "returnUrl": { + "description": "(Required) The URL to which the user should be redirected\nafter the signing session has ended.\nDocuSign redirects to the URL\nand includes an `event` query parameter\nthat can be used by your application.\n\nMaximum Length: 500 characters. If the `returnUrl` exceeds this limit, the user is redirected to a truncated URL.\n\nPossible `event` parameter values include: \n\n* `access_code_failed`: Recipient used incorrect access code.\n* `cancel`: Recipient canceled the signing operation,\n possibly by using the **Finish Later** option.\n* `decline`: Recipient declined to sign.\n* `exception`: A system error occurred during the signing process.\n* `fax_pending`: Recipient has a fax pending.\n* `id_check_failed`: Recipient failed an ID check.\n* `session_timeout`: The session timed out. An account can control this timeout by using the **Signer Session Timeout** option.\n* `signing_complete`: The recipient completed the signing ceremony.\n* `ttl_expired`: The Time To Live token for the envelope has expired.\n After being successfully invoked, these tokens expire\n after 5 minutes or if the envelope is voided.\n* `viewing_complete`: The recipient completed viewing an envelope\n that is in a read-only/terminal state,\n such as completed, declined, or voided.\n\nEnsure that you include `https://` in the URL to prevent the redirect from failing on certain browsers.\n", "type": "string" }, - "widthMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `width` property is editable." + "securityDomain": { + "description": "The domain in which the user authenticated.", + "type": "string" }, - "xPosition": { - "description": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n", + "userId": { + "description": "The user ID of the recipient. You can use either the user ID or email and user name to identify the recipient. \n\nIf `userId` is used and a `clientUserId` is provided, the value in the `userId` property must match a `recipientId` (which you can retrieve with a GET recipients call) for the envelope. \n\nIf a `userId` is used and a `clientUserId` is not provided, the `userId` must match the user ID of the authenticating user.", "type": "string" }, - "xPositionMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `xPosition` property is editable." + "userName": { + "description": "The username of the recipient. You can use either `email` and `userName` or `userId` to identify the recipient.", + "type": "string" }, - "yPosition": { - "description": "This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.", + "xFrameOptions": { + "description": "Specifies whether a browser should be allowed to render a page in a frame or IFrame. Setting this property ensures that your content is not embedded into unauthorized pages or frames.\n\nValid values are:\n\n- `deny`: The page cannot be displayed in a frame.\n- `same_origin`: The page can only be displayed in a frame on the same origin as the page itself.\n- `allow_from`: The page can only be displayed in a frame on the origin specified by the `xFrameOptionsAllowFromUrl` property.", "type": "string" }, - "yPositionMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `yPosition` property is editable." + "xFrameOptionsAllowFromUrl": { + "description": "When the value of `xFrameOptions` is `allow_from`, this property specifies the origin on which the page is allowed to display in a frame. If the value of `xFrameOptions` is `allow_from`, you must include a value for this property.", + "type": "string" } }, - "x-ds-definition-name": "polyLineOverlay", - "description": "This tab enables users to strike through the text of a document. The tab is implemented as a line represented as a pair of x and y coordinates.", - "x-ms-summary": "This tab enables users to strike through the text of a document. The tab is implemented as a line represented as a pair of x and y coordinates." + "x-ds-definition-name": "recipientViewRequest", + "description": "The request body for the EnvelopeViews::createRecipient and EnvelopeViews::createSharedRecipient methods.", + "x-ms-summary": "The request body for the EnvelopeViews::createRecipient and EnvelopeViews::createSharedRecipient methods." }, - "powerForm": { + "referralInformation": { + "description": "A complex type that contains the following information for entering referral and discount information. The following items are included in the referral information (all string content): enableSupport, includedSeats, saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, saleDiscountSeatPriceOverride, planStartMonth, referralCode, referrerName, advertisementId, publisherId, shopperId, promoCode, groupMemberId, idType, and industry\n\n**Note**: saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, and saleDiscountSeatPriceOverride are reserved for DoucSign use only.", "type": "object", "properties": { - "createdBy": { - "description": "", + "advertisementId": { + "description": "A complex type that contains the following information for entering referral and discount information. The following items are included in the referral information (all string content): enableSupport, includedSeats, saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, saleDiscountSeatPriceOverride, planStartMonth, referralCode, referrerName, advertisementId, publisherId, shopperId, promoCode, groupMemberId, idType, and industry.\n\n**Note**: saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, and saleDiscountSeatPriceOverride are reserved for DoucSign use only.\n", "type": "string" }, - "createdDateTime": { - "description": "The date and time the item was created.", + "enableSupport": { + "description": "When set to **true**, customer support is provided as part of the account plan.", "type": "string" }, - "emailBody": { - "description": "The body of the email message sent to the recipients. \n\nMaximum length: 10000 characters.", + "externalOrgId": { + "description": "An optional external id for the referral.", "type": "string" }, - "emailSubject": { - "description": "The subject line of the email message that is sent to all recipients.\n\nFor information about adding merge field information to the email subject, see [Template Email Subject Merge Fields](https://developers.docusign.com/esign-rest-api/reference/Templates/Templates/create#template-email-subject-merge-fields).\n", + "groupMemberId": { + "description": "", "type": "string" }, - "envelopes": { - "description": "An array containing PowerForm data.", - "type": "array", - "items": { - "$ref": "#/definitions/Envelopes" - } + "idType": { + "description": "", + "type": "string" }, - "errorDetails": { - "$ref": "#/definitions/errorDetails", - "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." + "includedSeats": { + "description": "The number of seats (users) included in the plan.", + "type": "string" }, - "instructions": { - "description": "", + "industry": { + "description": "The name of the industry associated with the referral. \n\nExample: `Accounting`", "type": "string" }, - "isActive": { + "planStartMonth": { "description": "", "type": "string" }, - "lastUsed": { + "promoCode": { "description": "", "type": "string" }, - "limitUseInterval": { + "publisherId": { "description": "", "type": "string" }, - "limitUseIntervalEnabled": { - "description": "When **true**, the `limitUseInterval` is enabled.", + "referralCode": { + "description": "", "type": "string" }, - "limitUseIntervalUnits": { - "description": "", + "referrerName": { + "description": "The name of the referrer.", "type": "string" }, - "maxUseEnabled": { - "description": "The maximum number of times that the PowerForm can be used. Setting this property can limit your account's exposure to excessive envelope usage. Each time a recipient clicks **Begin Signing** for a document, the number of uses remaining is reduced by one. If a recipient attempts to sign a PowerForm that has reached the maximum number of uses, an error message informs the recipient that the document is not available for signing.\n\n**Note**: A PowerForm Administrator can edit this number at any time after the PowerForm is created, even if it has reached a previous use limit.", + "saleDiscountAmount": { + "description": "Reserved for DocuSign.", "type": "string" }, - "name": { - "description": "", + "saleDiscountFixedAmount": { + "description": "Reserved for DocuSign.", "type": "string" }, - "powerFormId": { - "description": "The id of the PowerForm.", + "saleDiscountPercent": { + "description": "Reserved for DocuSign.", "type": "string" }, - "powerFormUrl": { - "description": "The URL for the PowerForm.", + "saleDiscountPeriods": { + "description": "Reserved for DocuSign.", "type": "string" }, - "recipients": { - "description": "An array of recipient objects that provides details about the recipients of the envelope.", - "type": "array", - "items": { - "$ref": "#/definitions/powerFormRecipient" - } + "saleDiscountSeatPriceOverride": { + "description": "Reserved for DocuSign.", + "type": "string" }, - "senderName": { + "shopperId": { "description": "", "type": "string" + } + }, + "x-ds-definition-name": "referralInformation", + "x-ms-summary": "A complex type that contains the following information for entering referral and discount information. The following items are included in the referral information (all string content): enableSupport, includedSeats, saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, saleDiscountSeatPriceOverride, planStartMonth, referralCode, referrerName, advertisementId, publisherId, shopperId, promoCode, groupMemberId, idType, and industry\n\n**Note**: saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, and saleDiscountSeatPriceOverride are reserved for DoucSign use only." + }, + "reminders": { + "description": "A complex element that specifies reminder settings for the envelope.", + "type": "object", + "properties": { + "reminderDelay": { + "description": "An integer specifying the number of days after the recipient receives the envelope that reminder emails are sent to the recipient.", + "type": "string" }, - "senderUserId": { - "description": "", + "reminderEnabled": { + "description": "When set to **true**, reminders are enabled.", "type": "string" }, - "signingMode": { + "reminderFrequency": { + "description": "An integer specifying the interval in days between reminder emails.", + "type": "string" + } + }, + "x-ds-definition-name": "reminders", + "x-ms-summary": "A complex element that specifies reminder settings for the envelope." + }, + "reportInProductCsvRunRequest": { + "type": "object", + "properties": { + "customFieldFilter": { "description": "", "type": "string" }, - "templateId": { - "description": "The ID of the template.", + "dateRangeCustomFromDate": { + "description": "", "type": "string" }, - "templateName": { + "dateRangeCustomToDate": { "description": "", "type": "string" }, - "timesUsed": { + "dateRangeFilter": { "description": "", "type": "string" }, - "uri": { - "description": "URI containing the user ID.", + "envelopeDateTypeFilter": { + "description": "", "type": "string" }, - "usesRemaining": { + "envelopeRecipientNameContainsFilter": { "description": "", "type": "string" - } - }, - "x-ds-definition-name": "powerForm", - "description": "", - "x-ms-summary": "" - }, - "powerFormFormDataEnvelope": { - "type": "object", - "properties": { - "envelopeId": { - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", + }, + "envelopeStatusFilter": { + "description": "", "type": "string" }, - "recipients": { - "description": "An array of recipient objects that provides details about the recipients of the envelope.", - "type": "array", - "items": { - "$ref": "#/definitions/powerFormFormDataRecipient" - } - } - }, - "x-ds-definition-name": "powerFormFormDataEnvelope", - "description": "", - "x-ms-summary": "" - }, - "powerFormFormDataRecipient": { - "type": "object", - "properties": { - "email": { - "description": "Filters returned user records by the specified email address.", + "envelopeSubjectContainsFilter": { + "description": "", "type": "string" }, - "formData": { + "fields": { "description": "", "type": "array", "items": { - "$ref": "#/definitions/nameValue" + "$ref": "#/definitions/reportInProductField" } }, - "name": { - "description": "The name of the recipient.", + "forDownload": { + "description": "", "type": "string" }, - "recipientId": { - "description": "The unique id for the recipient. It is used by the tab element to indicate which recipient is to sign the document.", - "type": "string" - } - }, - "x-ds-definition-name": "powerFormFormDataRecipient", - "description": "", - "x-ms-summary": "" - }, - "powerFormRecipient": { - "type": "object", - "properties": { - "accessCode": { - "description": "(Optional) The access code that the recipient must enter to access the PowerForm.\n\nMaximum Length: 50 characters. The code must also conform to the account's access code format setting.\n\nIf blank but the signer accessCode property is set in the envelope, then that value is used.\n\nIf blank and the signer accessCode property is not set, then the access code is not required.", + "isDashboard": { + "description": "", "type": "string" }, - "accessCodeLocked": { - "description": "When **true**, the `accessCode` property is locked and cannot be edited.", + "newLine": { + "description": "", "type": "string" }, - "accessCodeRequired": { - "description": "When **true**, the recipient must enter the `accessCode` to access the PowerForm.", + "overrideTimezoneKey": { + "description": "", "type": "string" }, - "email": { - "description": "The email address of the recipient.\n\n**Note**: For self-service documents where you do not know who the recipients are in advance, you can leave this property blank.", + "periodLengthFilter": { + "description": "", "type": "string" }, - "emailLocked": { - "description": "When **true**, the recipient's email address is locked and cannot be edited.", + "quote": { + "description": "", "type": "string" }, - "idCheckConfigurationName": { - "description": "The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting.\n\n**Example**: Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node.", + "reportCustomizedId": { + "description": "", "type": "string" }, - "idCheckRequired": { - "description": "Determines how authentication is configured for the account. Valid values are:\n\n- `always`: Authentication checks are performed on every envelope. \n- `never`: Authentication checks are not performed on any envelopes. \n- `optional:` Authentication is configurable per envelope.", + "reportDescription": { + "description": "", "type": "string" }, - "name": { - "description": "The name of the PowerForm recipient.\n\n**Note**: For self-service documents where you do not know who the recipients are in advance, you can leave this property blank.", + "reportId": { + "description": "", "type": "string" }, - "recipientType": { - "description": "The recipient type, as specified by the following values:\n- `agents`: Agent recipients can add name and email information for recipients that appear after the agent in routing order.\n- `carbonCopies`: Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date, or add information to any of the documents. This type of recipient can be used in any routing order.\n- `certifiedDeliveries`: Certified delivery recipients must receive the completed documents for the envelope to be completed. They don't need to sign, initial, date, or add information to any of the documents.\n- `editors`: Editors have the same management and access rights for the envelope as the sender. Editors can add name and email information, add or change the routing order, set authentication options, and can edit signature/initial tabs and data fields for the remaining recipients.\n- `inPersonSigners`: In-person recipients are DocuSign users who act as signing hosts in the same physical location as the signer.\n- `intermediaries`: Intermediary recipients can optionally add name and email information for recipients at the same or subsequent level in the routing order.\n- `seals`: Electronic seal recipients represent legal entities.\n- `signers`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope.\n- `witnesses`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope.", + "reportInvocationType": { + "description": "", "type": "string" }, - "roleName": { - "description": "The role associated with the recipient (for example, `Member`).\n\nThis property is required when you are working with template recipients and PowerForm recipients.", + "reportName": { + "description": "", "type": "string" }, - "routingOrder": { - "description": "Specifies the routing order of the recipient in the envelope. ", + "sentByFilter": { + "description": "", "type": "string" }, - "templateRequiresIdLookup": { - "description": "When **true**, the template used to create the PowerForm requires ID lookup for the recipient.", + "sentByIds": { + "description": "", "type": "string" }, - "userNameLocked": { - "description": "When **true**, the `userName` property for the recipient is locked and cannot be edited.", + "separator": { + "description": "", "type": "string" - } - }, - "x-ds-definition-name": "powerFormRecipient", - "description": "**Note**: For a self-service PowerForm on a website, you can specify the intended recipients generically (for example, use `Member` as the `Name`), and omit personal details such as `email`.", - "x-ms-summary": "**Note**: For a self-service PowerForm on a website, you can specify the intended recipients generically (for example, use `Member` as the `Name`), and omit personal details such as `email`." - }, - "powerFormSendersResponse": { - "type": "object", - "properties": { - "endPosition": { - "format": "int32", - "description": "The last position in the result set. ", - "type": "integer" }, - "nextUri": { - "description": "The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. ", + "sortDirection": { + "description": "", "type": "string" }, - "powerFormSenders": { - "description": "An array of `userInfo` objects containing information about users who have sent PowerForms.", - "type": "array", - "items": { - "$ref": "#/definitions/userInfo" - } - }, - "previousUri": { - "description": "The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. ", + "sortField": { + "description": "", "type": "string" }, - "resultSetSize": { - "format": "int32", - "description": "The number of results returned in this response. Because you can filter which entries are included in the response, this value is always less than or equal to `totalSetSize`.", - "type": "integer" - }, "startPosition": { - "format": "int32", - "description": "The starting position of the current result set.", - "type": "integer" - }, - "totalSetSize": { - "format": "int32", - "description": "The total number of items in the search's result set. This value is always greater than or equal to the value of `resultSetSize`.", - "type": "integer" - } - }, - "x-ds-definition-name": "powerFormSendersResponse", - "description": "This object includes information about the users who have sent PowerForms.", - "x-ms-summary": "This object includes information about the users who have sent PowerForms." - }, - "powerFormsFormDataResponse": { - "type": "object", - "properties": { - "envelopes": { - "description": "An array containing PowerForm data.", - "type": "array", - "items": { - "$ref": "#/definitions/PowerFormData" - } + "description": "The starting index position of the current result set.", + "type": "string" } }, - "x-ds-definition-name": "powerFormsFormDataResponse", + "x-ds-definition-name": "reportInProductCsvRunRequest", "description": "", "x-ms-summary": "" }, - "powerFormsRequest": { + "reportInProductField": { "type": "object", "properties": { - "powerForms": { - "description": "An array of PowerForm objects.", - "type": "array", - "items": { - "$ref": "#/definitions/PowerForms" - } + "displayOrder": { + "description": "The position on the page where the display section appears.", + "type": "string" + }, + "fieldVersion": { + "description": "", + "type": "string" + }, + "name": { + "description": "", + "type": "string" + }, + "selected": { + "description": "When set to **true**, the radio button is selected.", + "type": "string" } }, - "x-ds-definition-name": "powerFormsRequest", + "x-ds-definition-name": "reportInProductField", "description": "", "x-ms-summary": "" }, - "powerFormsResponse": { + "reportInProductGet": { "type": "object", "properties": { - "endPosition": { - "format": "int32", - "description": "The last position in the result set. ", - "type": "integer" + "customFieldFilter": { + "description": "", + "type": "string" }, - "nextUri": { - "description": "The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. ", + "dateRangeCustomFromDate": { + "description": "", "type": "string" }, - "powerForms": { - "description": "An array of PowerForm objects.", - "type": "array", - "items": { - "$ref": "#/definitions/PowerForms" - } + "dateRangeCustomToDate": { + "description": "", + "type": "string" }, - "previousUri": { - "description": "The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. ", + "dateRangeFilter": { + "description": "", "type": "string" }, - "resultSetSize": { - "format": "int32", - "description": "The number of results returned in this response. Because you can filter which entries are included in the response, this value is always less than or equal to `totalSetSize`.", - "type": "integer" + "displayOrder": { + "description": "The position on the page where the display section appears.", + "type": "string" }, - "startPosition": { - "format": "int32", - "description": "The starting position of the current result set.", - "type": "integer" + "envelopeDateTypeFilter": { + "description": "", + "type": "string" }, - "totalSetSize": { - "format": "int32", - "description": "The total number of items in the search's result set. This value is always greater than or equal to the value of `resultSetSize`.", - "type": "integer" - } - }, - "x-ds-definition-name": "powerFormsResponse", - "description": "", - "x-ms-summary": "" - }, - "propertyMetadata": { - "type": "object", - "properties": { - "options": { - "description": "An array of option strings supported by this setting.", + "envelopeRecipientNameContainsFilter": { + "description": "", + "type": "string" + }, + "envelopeStatusFilter": { + "description": "", + "type": "string" + }, + "envelopeSubjectContainsFilter": { + "description": "", + "type": "string" + }, + "fields": { + "description": "", "type": "array", "items": { - "type": "string" + "$ref": "#/definitions/reportInProductField" } }, - "rights": { - "description": "Indicates whether the property is editable. Valid values are:\n\n- `editable`\n- `read_only`", - "type": "string" - } - }, - "x-ds-definition-name": "propertyMetadata", - "description": "Metadata about a property.", - "x-ms-summary": "Metadata about a property." - }, - "province": { - "type": "object", - "properties": { - "isoCode": { + "lastScheduledExecutionDate": { "description": "", "type": "string" }, - "name": { + "lastScheduledExecutionSuccessDate": { "description": "", "type": "string" - } - }, - "x-ds-definition-name": "province", - "description": "", - "x-ms-summary": "" - }, - "provisioningInformation": { - "type": "object", - "properties": { - "defaultConnectionId": { + }, + "maxDownloadRows": { "description": "", "type": "string" }, - "defaultPlanId": { + "maxGridRows": { "description": "", "type": "string" }, - "distributorCode": { - "description": "The code that identifies the billing plan groups and plans for the new account.", + "maxScheduledRows": { + "description": "", "type": "string" }, - "distributorPassword": { - "description": "The password for the distributorCode.", + "periodLengthFilter": { + "description": "", "type": "string" }, - "passwordRuleText": { + "reportCustomizedId": { "description": "", "type": "string" }, - "planPromotionText": { + "reportDescription": { "description": "", "type": "string" }, - "purchaseOrderOrPromAllowed": { + "reportId": { "description": "", "type": "string" - } - }, - "x-ds-definition-name": "provisioningInformation", - "description": "", - "x-ms-summary": "" - }, - "purchasedEnvelopesInformation": { - "type": "object", - "properties": { - "amount": { - "description": "The total amount of the purchase.", + }, + "reportName": { + "description": "", "type": "string" }, - "appName": { - "description": "The AppName of the client application.", + "reportType": { + "description": "", "type": "string" }, - "currencyCode": { - "description": "The currency code for the account, based on the [ISO 4217 currency code](https://www.iso.org/iso-4217-currency-codes.html).", + "runUri": { + "description": "", "type": "string" }, - "platform": { - "description": "The Platform of the client application", + "saveUri": { + "description": "", "type": "string" }, - "productId": { - "description": "The Product ID from the AppStore.", + "scheduleId": { + "description": "", "type": "string" }, - "quantity": { - "description": "The quantity of envelopes to add to the account.", + "sentByDetails": { + "$ref": "#/definitions/reportInProductSentByDetails", + "description": "" + }, + "sentByFilter": { + "description": "", "type": "string" }, - "receiptData": { - "description": "The encrypted Base64 encoded receipt data.", + "sentByIds": { + "description": "", "type": "string" }, - "storeName": { - "description": "The name of the AppStore.", + "sortFieldDirection": { + "description": "", "type": "string" }, - "transactionId": { - "description": "Specifies the Transaction ID from the AppStore.", + "sortFieldName": { + "description": "", "type": "string" } }, - "x-ds-definition-name": "purchasedEnvelopesInformation", + "x-ds-definition-name": "reportInProductGet", "description": "", "x-ms-summary": "" }, - "radio": { + "reportInProductList": { "type": "object", "properties": { - "anchorCaseSensitive": { - "description": "Reserved for DocuSign.\n", - "type": "string" - }, - "anchorCaseSensitiveMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." - }, - "anchorHorizontalAlignment": { - "description": "Reserved for DocuSign.\n\n", - "type": "string" - }, - "anchorHorizontalAlignmentMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." - }, - "anchorIgnoreIfNotPresent": { - "description": "When set to **true**, this tab is ignored if the `anchorString` is not found in the document.", - "type": "string" - }, - "anchorIgnoreIfNotPresentMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable." - }, - "anchorMatchWholeWord": { - "description": "Reserved for DocuSign.\n\n", - "type": "string" - }, - "anchorMatchWholeWordMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." - }, - "anchorString": { - "description": "Specifies the string to find in the document and use as the basis for tab placement.", + "reports": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/reportInProductListItem" + } + } + }, + "x-ds-definition-name": "reportInProductList", + "description": "", + "x-ms-summary": "" + }, + "reportInProductListItem": { + "type": "object", + "properties": { + "getUri": { + "description": "", "type": "string" }, - "anchorStringMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `anchorString` property is editable." - }, - "anchorTabProcessorVersion": { - "description": "Reserved for DocuSign.", + "lastScheduledExecutionDate": { + "description": "", "type": "string" }, - "anchorTabProcessorVersionMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." - }, - "anchorUnits": { - "description": "Specifies the units of the X and Y offset. Units may be pixels, millimeters, centimeters, or inches.", + "lastScheduledExecutionSuccessDate": { + "description": "", "type": "string" }, - "anchorUnitsMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `anchorUnits` property is editable." - }, - "anchorXOffset": { - "description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.", + "reportCustomizedId": { + "description": "", "type": "string" }, - "anchorXOffsetMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `anchorXOffset` property is editable." - }, - "anchorYOffset": { - "description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.", + "reportDescription": { + "description": "", "type": "string" }, - "anchorYOffsetMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `anchorYOffset` property is editable." - }, - "bold": { - "description": "When set to **true**, the information in the tab is bold.", + "reportId": { + "description": "", "type": "string" }, - "boldMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `bold` property is editable." - }, - "errorDetails": { - "$ref": "#/definitions/errorDetails", - "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." - }, - "font": { - "description": "The font to be used for the tab value. Supported fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n", + "reportName": { + "description": "", "type": "string" }, - "fontColor": { - "description": "The font color to use for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n", + "reportType": { + "description": "", "type": "string" }, - "fontColorMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `fontColor` property is editable." - }, - "fontMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `font` property is editable." - }, - "fontSize": { - "description": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72", + "runUri": { + "description": "", "type": "string" }, - "fontSizeMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `fontSize` property is editable." + "saveUri": { + "description": "", + "type": "string" }, - "italic": { - "description": "When set to **true**, the information in the tab is italic.", + "scheduleCreateDate": { + "description": "", "type": "string" }, - "italicMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `italic` property is editable." + "scheduleEndDate": { + "description": "", + "type": "string" }, - "locked": { - "description": "When set to **true**, the signer cannot change the data of the custom tab.", + "scheduleId": { + "description": "", "type": "string" }, - "lockedMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `locked` property is editable." + "scheduleRenewDurationDays": { + "description": "", + "type": "string" + } + }, + "x-ds-definition-name": "reportInProductListItem", + "description": "", + "x-ms-summary": "" + }, + "reportInProductRunRequest": { + "type": "object", + "properties": { + "customFieldFilter": { + "description": "", + "type": "string" }, - "pageNumber": { - "description": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n", + "dateRangeCustomFromDate": { + "description": "", "type": "string" }, - "pageNumberMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `pageNumber` property is editable." + "dateRangeCustomToDate": { + "description": "", + "type": "string" }, - "required": { - "description": "When set to **true**, the signer is required to fill out this tab.", + "dateRangeFilter": { + "description": "", "type": "string" }, - "requiredMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `required` property is editable." + "envelopeDateTypeFilter": { + "description": "", + "type": "string" }, - "selected": { - "description": "When set to **true**, the radio button is selected.", + "envelopeRecipientNameContainsFilter": { + "description": "", "type": "string" }, - "selectedMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `selected` property is editable." + "envelopeStatusFilter": { + "description": "", + "type": "string" }, - "status": { - "description": "The status of the item.", + "envelopeSubjectContainsFilter": { + "description": "", "type": "string" }, - "statusMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `status` property is editable." + "fields": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/reportInProductField" + } }, - "tabId": { - "description": "The unique identifier for the tab.", + "forDownload": { + "description": "", "type": "string" }, - "tabIdMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `tabId` property is editable." + "isDashboard": { + "description": "", + "type": "string" }, - "tabOrder": { - "description": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.", + "periodLengthFilter": { + "description": "", "type": "string" }, - "tabOrderMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `tabOrder` property is editable." + "reportCustomizedId": { + "description": "", + "type": "string" }, - "underline": { - "description": "When set to **true**, the information in the tab is underlined.", + "reportDescription": { + "description": "", "type": "string" }, - "underlineMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `underline` property is editable." + "reportId": { + "description": "", + "type": "string" }, - "value": { - "description": "Specifies the value of the tab. ", + "reportInvocationType": { + "description": "", "type": "string" }, - "valueMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `value` property is editable." + "reportName": { + "description": "", + "type": "string" }, - "xPosition": { - "description": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n", + "sentByFilter": { + "description": "", "type": "string" }, - "xPositionMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `xPosition` property is editable." + "sentByIds": { + "description": "", + "type": "string" }, - "yPosition": { - "description": "This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.", + "sortDirection": { + "description": "", "type": "string" }, - "yPositionMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `yPosition` property is editable." + "sortField": { + "description": "", + "type": "string" + }, + "startPosition": { + "description": "The starting index position of the current result set.", + "type": "string" } }, - "x-ds-definition-name": "radio", - "description": "One of the selectable radio buttons\nin the `radios` property\nof a [`radioGroup`](https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/radioGroup) tab.\n", - "x-ms-summary": "One of the selectable radio buttons\nin the `radios` property\nof a [`radioGroup`](https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/radioGroup) tab.\n" + "x-ds-definition-name": "reportInProductRunRequest", + "description": "", + "x-ms-summary": "" }, - "radioGroup": { + "reportInProductRunResponse": { "type": "object", "properties": { - "conditionalParentLabel": { - "description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility.", + "endPosition": { + "description": "The last index position in the result set. ", "type": "string" }, - "conditionalParentLabelMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `conditionalParentLabel` property is editable." - }, - "conditionalParentValue": { - "description": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use \"on\" as the value to show that the parent tab is active.\n", + "exceededMaxResults": { + "description": "", "type": "string" }, - "conditionalParentValueMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `conditionalParentValue` property is editable." - }, - "documentId": { - "description": "Integer that identifies the document in the envelope.", + "lastWarehouseRefreshDateTime": { + "description": "", "type": "string" }, - "documentIdMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `documentId` property is editable." - }, - "groupName": { - "description": "The name of the group. The search_text provided in the call automatically performs a wild card search on group_name.", + "resultSetSize": { + "description": "The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`.", "type": "string" }, - "groupNameMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `groupName` property is editable." - }, - "radios": { - "description": "Specifies the locations and status for radio buttons that are grouped together.", + "rows": { + "description": "", "type": "array", "items": { - "$ref": "#/definitions/radio" + "$ref": "#/definitions/reportInProductRunResponseRow" } }, - "recipientId": { - "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", + "startPosition": { + "description": "The starting index position of the current result set.", "type": "string" }, - "recipientIdGuid": { - "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one.", + "totalSetSize": { + "description": "The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`.", + "type": "string" + } + }, + "x-ds-definition-name": "reportInProductRunResponse", + "description": "", + "x-ms-summary": "" + }, + "reportInProductRunResponseRow": { + "type": "object", + "properties": { + "envelopeId": { + "description": "The envelope ID of the envelope status that failed to post.", "type": "string" }, - "recipientIdGuidMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `recipientIdGuid` property is editable." + "fields": { + "$ref": "#/definitions/reportInProductRunResponseRowFields", + "description": "" + } + }, + "x-ds-definition-name": "reportInProductRunResponseRow", + "description": "", + "x-ms-summary": "" + }, + "reportInProductRunResponseRowFields": { + "type": "object", + "properties": { + "accessCodeRequired": { + "description": "", + "type": "string" }, - "recipientIdMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `recipientId` property is editable." + "accessCodesAttempted": { + "description": "", + "type": "string" }, - "requireAll": { - "description": "When set to **true** and shared is true, information must be entered in this field to complete the envelope. ", + "accessCodesFailed": { + "description": "", "type": "string" }, - "requireAllMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `requireAll` property is editable." + "accountId": { + "description": "The account ID associated with the envelope.", + "type": "string" }, - "requireInitialOnSharedChange": { - "description": "Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.", + "authenticationCategory": { + "description": "", "type": "string" }, - "requireInitialOnSharedChangeMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `requireInitialOnSharedChange` property is editable." + "authenticationSuccess": { + "description": "", + "type": "string" }, - "shared": { - "description": "When set to **true**, this custom tab is shared.", + "authenticationType": { + "description": "Indicates the type of authentication. Valid values are: \n\n- `PhoneAuth`\n- `STAN`\n- `ISCheck` \n- `OFAC`\n- `AccessCode`\n- `AgeVerify`\n- `SSOAuth`", "type": "string" }, - "sharedMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `shared` property is editable." + "averageTimeToCompleteSeconds": { + "description": "", + "type": "string" }, - "tabType": { - "description": "Indicates the type of tab (for example, `signHere` or `initialHere`).", + "avgCompleteSeconds": { + "description": "", "type": "string" }, - "tabTypeMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `tabType` property is editable." + "completed": { + "description": "", + "type": "string" }, - "templateLocked": { - "description": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ", + "completedTs": { + "description": "", "type": "string" }, - "templateLockedMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `templateLocked` property is editable." + "createdDate": { + "description": "The creation date of the account in UTC timedate format.", + "type": "string" }, - "templateRequired": { - "description": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.", + "customField": { + "description": "", "type": "string" }, - "templateRequiredMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `templateRequired` property is editable." + "declinedDate": { + "description": "", + "type": "string" }, - "tooltip": { - "description": "The text of a tooltip that appears when a user hovers over a form field or tab.", + "declinedReason": { + "description": "The reason the recipient declined the document. Read only.", "type": "string" }, - "tooltipMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `tooltip` property is editable." - } - }, - "x-ds-definition-name": "radioGroup", - "description": "This group tab is used to place radio buttons on a document.\nThe `radios` property\ncontains a list of\n[`radio`](https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/radio)\nobjects associated with the group. Only one radio button can\nbe selected in a group.\n", - "x-ms-summary": "This group tab is used to place radio buttons on a document.\nThe `radios` property\ncontains a list of\n[`radio`](https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/radio)\nobjects associated with the group. Only one radio button can\nbe selected in a group.\n" - }, - "recipientAttachment": { - "type": "object", - "properties": { - "attachmentId": { - "description": "The unique identifier for the attachment.", + "deliveredDate": { + "description": "", "type": "string" }, - "attachmentType": { - "description": "Specifies the type of the attachment for the recipient. Possible values are:\n\n- `.htm`\n- `.xml`", + "envelopeCount": { + "description": "", "type": "string" }, - "data": { - "description": "A Base64-encoded representation of the attachment that is used to upload and download the file. File attachments may be up to 50 MB in size.", + "envelopeCreator": { + "description": "", "type": "string" }, - "label": { - "description": "An optional label for the attachment.", + "envelopeId": { + "description": "The envelope ID of the envelope status that failed to post.", "type": "string" }, - "name": { - "description": "The name of the attachment.", + "envelopeInitialSendTs": { + "description": "", "type": "string" }, - "remoteUrl": { - "description": "The URL of a previously staged chunked upload. Using a chunked upload enables you to stage a large, chunkable temp file. You then use the `remoteUrl` property to reference the chunked upload as the content in attachment and document-related requests. The `remoteUrl` property cannot be used for downloads.", + "envelopesBilled": { + "description": "", "type": "string" - } - }, - "x-ds-definition-name": "recipientAttachment", - "description": "", - "x-ms-summary": "" - }, - "recipientDomain": { - "type": "object", - "properties": { - "active": { + }, + "envelopesCompleted": { "description": "", "type": "string" }, - "domainCode": { + "envelopesCompletedCount": { "description": "", "type": "string" }, - "domainName": { + "envelopesDeclined": { "description": "", "type": "string" }, - "recipientDomainId": { + "envelopesSent": { "description": "", "type": "string" - } - }, - "x-ds-definition-name": "recipientDomain", - "description": "", - "x-ms-summary": "" - }, - "recipientEmailNotification": { - "type": "object", - "properties": { - "emailBody": { - "description": "Not applicable for this object.", + }, + "envelopesSentCount": { + "description": "", "type": "string" }, - "emailBodyMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `emailBody` property can be edited." + "envelopesVoided": { + "description": "", + "type": "string" }, - "emailSubject": { - "description": "Not applicable for this object.", + "envelopeVoidedReason": { + "description": "", "type": "string" }, - "emailSubjectMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `emailSubject` property can be edited." + "eodDocumentDescription": { + "description": "", + "type": "string" }, - "supportedLanguage": { - "description": "Specifies the language used to localize Electronic Seals UI texts such as \"Sealed by\", etc. \n \nThe supported languages, with the language value shown in parenthesis, are: Arabic (ar), Bahasa Indonesia (id), Bahasa Melayu (ms) Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro),Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk), and Vietnamese (vi). \n \nThis parameter is optional. If not set, it defaults to the sender's language settings at the time of sealing. ", + "eodDocumentName": { + "description": "", "type": "string" }, - "supportedLanguageMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `supportedLanguage` property can be edited." - } - }, - "x-ds-definition-name": "recipientEmailNotification", - "description": "", - "x-ms-summary": "" - }, - "recipientEvent": { - "type": "object", - "properties": { - "includeDocuments": { - "description": "reserved", + "eodDocumentProfileId": { + "description": "", "type": "string" }, - "recipientEventStatusCode": { - "description": "Send a webhook notification for the following recipient statuses: Sent, Delivered, Completed, Declined, AuthenticationFailed, and AutoResponded.", + "eodTransactionId": { + "description": "", "type": "string" - } - }, - "x-ds-definition-name": "recipientEvent", - "description": "", - "x-ms-summary": "" - }, - "recipientFormData": { - "type": "object", - "properties": { - "DeclinedTime": { - "description": "The date and time the recipient declined the envelope.", + }, + "eodTransactionName": { + "description": "", "type": "string" }, - "DeliveredTime": { - "description": "The date and time the recipient viewed the documents in the envelope in the DocuSign signing UI.", + "eventDate": { + "description": "", "type": "string" }, - "email": { - "description": "The recipient's email address.", + "expirationDate": { + "description": "", "type": "string" }, - "formData": { - "description": "An array of form data objects.", - "type": "array", - "items": { - "$ref": "#/definitions/formDataItem" - } + "expiredTs": { + "description": "", + "type": "string" }, - "name": { - "description": "The name of the recipient.", + "failures": { + "description": "A list of Connect failure logs.", "type": "string" }, - "recipientId": { - "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", + "failureVendorCode": { + "description": "", "type": "string" }, - "SentTime": { - "description": "The date and time the envelope was sent to the recipient.", + "failureVendorReason": { + "description": "", "type": "string" }, - "SignedTime": { - "description": "The date and time the recipient signed the documents.", + "firstSendTs": { + "description": "", "type": "string" - } - }, - "x-ds-definition-name": "recipientFormData", - "description": "", - "x-ms-summary": "" - }, - "recipientIdentityVerification": { - "type": "object", - "properties": { - "workflowId": { - "description": "ID of the Identity Verification worklow used to verify recipients' identity.
This ID must match one of the [workflowId](https://developers.docusign.com/esign-rest-api/reference/Accounts/IdentityVerifications/list#accountIdentityVerificationWorkflow) available to your account.", + }, + "groupId": { + "description": "The ID of the group being accessed.", "type": "string" - } - }, - "x-ds-definition-name": "recipientIdentityVerification", - "description": "Specifies ID Verification applied on an envelope by workflow ID. See the [list](https://developers.docusign.com/esign-rest-api/reference/Accounts/IdentityVerifications/list) method in the [IdentityVerifications](https://developers.docusign.com/esign-rest-api/reference/Accounts/IdentityVerifications) resource for more information on how to retrieve workflow IDs available for an account. This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods. ", - "x-ms-summary": "Specifies ID Verification applied on an envelope by workflow ID. See the [list](https://developers.docusign.com/esign-rest-api/reference/Accounts/IdentityVerifications/list) method in the [IdentityVerifications](https://developers.docusign.com/esign-rest-api/reference/Accounts/IdentityVerifications) resource for more information on how to retrieve workflow IDs available for an account. This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods. " - }, - "recipientNamesResponse": { - "type": "object", - "properties": { - "multipleUsers": { - "description": "Indicates whether email address is used by more than one user.", + }, + "groupName": { + "description": "The name of the group. The search_text provided in the call automatically performs a wild card search on group_name.", "type": "string" }, - "recipientNames": { + "hoursToCompleteEnd": { "description": "", - "type": "array", - "items": { - "type": "string" - } + "type": "string" }, - "reservedRecipientEmail": { + "hoursToCompleteStart": { "description": "", "type": "string" - } - }, - "x-ds-definition-name": "recipientNamesResponse", - "description": "", - "x-ms-summary": "" - }, - "recipientPhoneAuthentication": { - "description": "A complex type that contains the elements:\n\n* `recipMayProvideNumber` - A Boolean value that specifies whether the recipient can use the phone number of their choice.\n* `senderProvidedNumbers` - A list of phone numbers that the recipient can use.\n* `recordVoicePrint` - Reserved for DocuSign.\n* `validateRecipProvidedNumber` - Reserved for DocuSign.", - "type": "object", - "properties": { - "recipMayProvideNumber": { - "description": "Boolean. When set to **true**, the recipient can supply a phone number their choice.", - "type": "string" }, - "recipMayProvideNumberMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `recipMayProvideNumber` property can be edited." + "idChecksAttempted": { + "description": "", + "type": "string" }, - "recordVoicePrint": { - "description": "Reserved for DocuSign.", + "idChecksFailed": { + "description": "", "type": "string" }, - "recordVoicePrintMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `recordVoicePrint` property can be edited." + "initialSendTs": { + "description": "", + "type": "string" }, - "senderProvidedNumbers": { - "description": "An array containing a list of phone numbers that the recipient can use for SMS text authentication. ", - "type": "array", - "items": { - "type": "string" - } + "ipAddress": { + "description": "", + "type": "string" }, - "senderProvidedNumbersMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `senderProvidedNumbers` property can be edited." + "lastActivity": { + "description": "", + "type": "string" }, - "validateRecipProvidedNumber": { - "description": " Reserved for DocuSign.", + "lastActivityDate": { + "description": "", "type": "string" }, - "validateRecipProvidedNumberMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `validateRecipProvidedNumber` property can be edited." - } - }, - "x-ds-definition-name": "recipientPhoneAuthentication", - "x-ms-summary": "A complex type that contains the elements:\n\n* `recipMayProvideNumber` - A Boolean value that specifies whether the recipient can use the phone number of their choice.\n* `senderProvidedNumbers` - A list of phone numbers that the recipient can use.\n* `recordVoicePrint` - Reserved for DocuSign.\n* `validateRecipProvidedNumber` - Reserved for DocuSign." - }, - "recipientPreviewRequest": { - "type": "object", - "properties": { - "assertionId": { - "description": "A unique identifier of the authentication event executed by the client application.", + "lastSentDate": { + "description": "", "type": "string" }, - "authenticationInstant": { - "description": "A sender generated value that indicates the date/time that the signer was authenticated.", + "notSigned": { + "description": "", "type": "string" }, - "authenticationMethod": { - "description": "Required. Choose a value that most closely matches the technique your application used to authenticate the recipient / signer. \n\nChoose a value from this list: \n* Biometric \n* Email\n* HTTPBasicAuth\n* Kerberos\n* KnowledgeBasedAuth\n* None\n* PaperDocuments\n* Password\n* RSASecureID\n* SingleSignOn_CASiteminder\n* SingleSignOn_InfoCard\n* SingleSignOn_MicrosoftActiveDirectory\n* SingleSignOn_Other\n* SingleSignOn_Passport\n* SingleSignOn_SAML\n* Smartcard\n* SSLMutualAuth\n* X509Certificate\n\nThis information is included in the Certificate of Completion.", + "numberOfAuthenticatedRecipients": { + "description": "", "type": "string" }, - "pingFrequency": { - "description": "Only used if pingUrl is specified. This is the interval, in seconds, between pings on the pingUrl. The default is 300 seconds. Valid values are 60-1200 seconds.", + "numberOfCompletedSignatures": { + "description": "", "type": "string" }, - "pingUrl": { - "description": "A client Url to be pinged by the DocuSign Signing experience to indicate to the client that Signing is active. An HTTP Get is executed against the client. The response from the client is ignored. The intent is for the client to reset it's session timer when the request is received.", + "numberOfDocuments": { + "description": "", "type": "string" }, - "recipientId": { - "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", + "numberOfPages": { + "description": "", "type": "string" }, - "returnUrl": { + "numberOfRecipients": { "description": "", "type": "string" }, - "securityDomain": { - "description": "The domain in which the user authenticated.", + "numberOfSends": { + "description": "", "type": "string" }, - "xFrameOptions": { + "numberOfSigners": { "description": "", "type": "string" }, - "xFrameOptionsAllowFromUrl": { + "numberOfTotalDocuments": { "description": "", "type": "string" - } - }, - "x-ds-definition-name": "recipientPreviewRequest", - "description": "", - "x-ms-summary": "" - }, - "recipients": { - "description": "", - "type": "object", - "properties": { - "agents": { - "description": "A list of agent recipients assigned to the documents.", - "type": "array", - "items": { - "$ref": "#/definitions/agent" - } }, - "carbonCopies": { - "description": "A list of carbon copy recipients assigned to the documents.", - "type": "array", - "items": { - "$ref": "#/definitions/carbonCopy" - } + "numberOfTotalPages": { + "description": "", + "type": "string" }, - "certifiedDeliveries": { - "description": "A complex type containing information on a recipient the must receive the completed documents for the envelope to be completed, but the recipient does not need to sign, initial, date, or add information to any of the documents.", - "type": "array", - "items": { - "$ref": "#/definitions/certifiedDelivery" - } + "numberOfTotalSigners": { + "description": "", + "type": "string" }, - "currentRoutingOrder": { - "description": "The routing order of the current recipient. If this value equals a particular signer's routing order, it indicates that the envelope has been sent to that recipient, but he or she has not completed the required actions.", + "numberOfUniqueSenders": { + "description": "", "type": "string" }, - "editors": { - "description": "A list of editors on the document.", - "type": "array", - "items": { - "$ref": "#/definitions/editor" - } + "numberTotalRecipients": { + "description": "", + "type": "string" }, - "errorDetails": { - "$ref": "#/definitions/errorDetails", - "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." + "periodEnd": { + "description": "", + "type": "string" }, - "inPersonSigners": { - "description": "Specifies a signer that is in the same physical location as a DocuSign user who will act as a Signing Host for the transaction. The recipient added is the Signing Host and new separate Signer Name field appears after Sign in person is selected.", - "type": "array", - "items": { - "$ref": "#/definitions/inPersonSigner" - } + "periodStart": { + "description": "", + "type": "string" }, - "intermediaries": { - "description": "Identifies a recipient that can, but is not required to, add name and email information for recipients at the same or subsequent level in the routing order (until subsequent Agents, Editors or Intermediaries recipient types are added).", - "type": "array", - "items": { - "$ref": "#/definitions/intermediary" - } + "phoneCallsAttempted": { + "description": "", + "type": "string" }, - "recipientCount": { - "description": "The list of recipient event statuses that will trigger Connect to send updates to the url. It can be a two-part list with:\n\n* recipientEventStatusCode - The recipient status, this can be Sent, Delivered, Completed, Declined, AuthenticationFailed, and AutoResponded.\n* includeDocuments - When set to **true**, the envelope time zone information is included in the message.", + "phoneCallsFailed": { + "description": "", "type": "string" }, - "seals": { - "description": "A list of electronic seals to apply to documents.", - "type": "array", - "items": { - "$ref": "#/definitions/sealSign" - } + "reasonForDeclining": { + "description": "", + "type": "string" }, - "signers": { - "description": "A list of signers on the envelope.", - "type": "array", - "items": { - "$ref": "#/definitions/signer" - } + "reasonForVoiding": { + "description": "", + "type": "string" }, - "witnesses": { - "description": "A list of signers who act as witnesses on the envelope.", - "type": "array", - "items": { - "$ref": "#/definitions/witness" - } - } - }, - "x-ds-definition-name": "recipients", - "x-ms-summary": "" - }, - "recipientSignatureInformation": { - "description": "Allows the sender to pre-specify the signature name, signature initials and signature font used in the signature stamp for the recipient.\n\nUsed only with recipient types In Person Signers and Signers.", - "type": "object", - "properties": { - "fontStyle": { - "description": "Specifies the font style for the user's signature.", + "reassignReason": { + "description": "", "type": "string" }, - "signatureInitials": { - "description": "Specifies the user's signature in initials format.", + "received": { + "description": "", "type": "string" }, - "signatureName": { - "description": "Specifies the user's signature name.", + "recipient": { + "description": "", "type": "string" - } - }, - "x-ds-definition-name": "recipientSignatureInformation", - "x-ms-summary": "Allows the sender to pre-specify the signature name, signature initials and signature font used in the signature stamp for the recipient.\n\nUsed only with recipient types In Person Signers and Signers." - }, - "recipientSignatureProvider": { - "type": "object", - "properties": { - "sealDocumentsWithTabsOnly": { - "description": "By default, electronic seals apply on all documents in an envelope. If any of the documents has a `signHere` tab, then a visual representation of the electronic seal will show up in the final document. If not, the electronic seal will be visible in the metadata but not in the content of the document.\n\nTo apply electronic seals on specific documents only, you must enable the `sealDocumentsWithTabsOnly` parameter. In this case, Electronic Seal applies only on documents that have `signHere` tabs set for the Electronic Seal recipient. Other documents won't be sealed. ", + }, + "recipientAction": { + "description": "", "type": "string" }, - "sealName": { - "description": "Indicates the name of the electronic seal to apply on documents.\n", + "recipientCompanyName": { + "description": "", "type": "string" }, - "signatureProviderName": { - "description": "The name of an Electronic or Standards Based Signature (digital signature) provider for the signer to use. [The current provider list.](https://developers.docusign.com/esign-rest-api/guides/standards-based-signatures)", + "recipientCountry": { + "description": "", "type": "string" }, - "signatureProviderNameMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `signatureProviderName` property is editable.\n" + "recipientEmail": { + "description": "", + "type": "string" }, - "signatureProviderOptions": { - "$ref": "#/definitions/recipientSignatureProviderOptions", - "description": "Not applicable for this object." - } - }, - "x-ds-definition-name": "recipientSignatureProvider", - "description": "An Electronic or Standards Based Signature (digital signature) provider for the signer to use. [More information](https://developers.docusign.com/esign-rest-api/guides/standards-based-signatures).\n", - "x-ms-summary": "An Electronic or Standards Based Signature (digital signature) provider for the signer to use. [More information](https://developers.docusign.com/esign-rest-api/guides/standards-based-signatures).\n" - }, - "recipientSignatureProviderOptions": { - "type": "object", - "properties": { - "cpfNumber": { - "description": "Reserved for DocuSign", + "recipientId": { + "description": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.", "type": "string" }, - "cpfNumberMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "" + "recipientName": { + "description": "", + "type": "string" }, - "oneTimePassword": { - "description": "A pre-shared secret that the signer must enter to complete the signing process. Eg last six digits of the signer's government ID or Social Security number. Or a newly created pre-shared secret for the transaction. Note: some signature providers may require an exact (case-sensitive) match if alphabetic characters are included in the field.", + "recipientTemplateRoleName": { + "description": "", "type": "string" }, - "oneTimePasswordMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "" + "recipientTitle": { + "description": "", + "type": "string" }, - "signerRole": { - "description": "The role or capacity of the signing recipient. Examples: Manager, Approver, etc.", + "recipientType": { + "description": "The recipient type, as specified by the following values:\n- `agent`: Agent recipients can add name and email information for recipients that appear after the agent in routing order.\n- `carbonCopy`: Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date, or add information to any of the documents. This type of recipient can be used in any routing order.\n- `certifiedDelivery`: Certified delivery recipients must receive the completed documents for the envelope to be completed. They don't need to sign, initial, date, or add information to any of the documents.\n- `editor`: Editors have the same management and access rights for the envelope as the sender. Editors can add name and email information, add or change the routing order, set authentication options, and can edit signature/initial tabs and data fields for the remaining recipients.\n- `inPersonSigner`: In-person recipients are DocuSign users who act as signing hosts in the same physical location as the signer.\n- `intermediaries`: Intermediary recipients can optionally add name and email information for recipients at the same or subsequent level in the routing order.\n- `seal`: Electronic seal recipients represent legal entities.\n- `signer`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope.\n- `witness`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope.", "type": "string" }, - "signerRoleMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "" + "recipientUserId": { + "description": "", + "type": "string" }, - "sms": { - "description": "The mobile phone number used to send the recipient an access code for the signing ceremony. Format: a string starting with +, then the country code followed by the full mobile phone number without any spaces or special characters. Omit leading zeroes before a city code. Examples: +14155551234, +97235551234, +33505551234.", + "remainingSignatures": { + "description": "The number of remaining signatures that need to be applied to this document.", "type": "string" }, - "smsMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "" - } - }, - "x-ds-definition-name": "recipientSignatureProviderOptions", - "description": "Option settings for the signature provider. Different providers require or use different options. [The current provider list and the options they require.](https://developers.docusign.com/esign-rest-api/guides/standards-based-signatures)", - "x-ms-summary": "Option settings for the signature provider. Different providers require or use different options. [The current provider list and the options they require.](https://developers.docusign.com/esign-rest-api/guides/standards-based-signatures)" - }, - "recipientSMSAuthentication": { - "description": "Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication.", - "type": "object", - "properties": { - "senderProvidedNumbers": { - "description": "An array containing a list of phone numbers that the recipient can use for SMS text authentication. ", - "type": "array", - "items": { - "type": "string" - } + "routingOrder": { + "description": "Specifies the routing order of the recipient in the envelope. ", + "type": "string" }, - "senderProvidedNumbersMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `senderProvidedNumbers` property can be edited." - } - }, - "x-ds-definition-name": "recipientSMSAuthentication", - "x-ms-summary": "Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication." - }, - "recipientsUpdateSummary": { - "type": "object", - "properties": { - "recipientUpdateResults": { - "description": "An array of `recipientUpdateResults` objects that contain details about the recipients.", - "type": "array", - "items": { - "$ref": "#/definitions/recipientUpdateResponse" - } - } - }, - "x-ds-definition-name": "recipientsUpdateSummary", - "description": "This is the response that the API returns after you update recipients.", - "x-ms-summary": "This is the response that the API returns after you update recipients." - }, - "recipientUpdateResponse": { - "type": "object", - "properties": { - "combined": { - "description": "When you use the query parameter `combine_same_order_recipients` on the PUT Recipients call, the `recipientUpdateResponse` returns this property. When set to **true**, it indicates that the recipient has been combined or merged with a matching recipient. Recipient matching occurs as part of template matching, and is based on Recipient Role and Routing Order.", + "senderAccountId": { + "description": "", "type": "string" }, - "errorDetails": { - "$ref": "#/definitions/errorDetails", - "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." + "senderCompanyName": { + "description": "", + "type": "string" }, - "recipientId": { - "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", + "senderCountry": { + "description": "", "type": "string" }, - "recipientIdGuid": { - "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one.", + "senderEmail": { + "description": "The sender's email address.", "type": "string" }, - "tabs": { - "$ref": "#/definitions/EnvelopeRecipientTabs", - "description": "All of the tabs associated with the recipient." - } - }, - "x-ds-definition-name": "recipientUpdateResponse", - "description": "The recipient details that are returned after you update the recipient.", - "x-ms-summary": "The recipient details that are returned after you update the recipient." - }, - "recipientViewRequest": { - "type": "object", - "properties": { - "assertionId": { - "description": "A unique identifier of the authentication event executed by the client application.", + "senderIPAddress": { + "description": "", "type": "string" }, - "authenticationInstant": { - "description": "A sender generated value that indicates the date/time that the signer was authenticated.", + "senderJobTitle": { + "description": "", "type": "string" }, - "authenticationMethod": { - "description": "Required. Choose a value that most closely matches the technique your application used to authenticate the recipient / signer. \n\nChoose a value from this list: \n* Biometric \n* Email\n* HTTPBasicAuth\n* Kerberos\n* KnowledgeBasedAuth\n* None\n* PaperDocuments\n* Password\n* RSASecureID\n* SingleSignOn_CASiteminder\n* SingleSignOn_InfoCard\n* SingleSignOn_MicrosoftActiveDirectory\n* SingleSignOn_Other\n* SingleSignOn_Passport\n* SingleSignOn_SAML\n* Smartcard\n* SSLMutualAuth\n* X509Certificate\n\nThis information is included in the Certificate of Completion.", + "senderName": { + "description": "The sender's name.", "type": "string" }, - "clientUserId": { - "description": "A sender created value. If provided, the recipient is treated as an embedded (captive) recipient or signer.\n\nUse your application's client ID (user ID) for the recipient. Doing so enables the details of your application's authentication of the recipient to be connected to the recipient's signature if the signature is disputed or repudiated.\n\nMaximum length: 100 characters.", + "senderUserId": { + "description": "The id of the sender.", "type": "string" }, - "email": { - "description": "Specifies the email of the recipient. You can use either email and userName or userId to identify the recipient.", + "signDate": { + "description": "", "type": "string" }, - "pingFrequency": { - "description": "Only used if pingUrl is specified. This is the interval, in seconds, between pings on the pingUrl. The default is 300 seconds. Valid values are 60-1200 seconds.", + "signed": { + "description": "", "type": "string" }, - "pingUrl": { - "description": "A client Url to be pinged by the DocuSign Signing experience to indicate to the client that Signing is active. An HTTP Get is executed against the client. The response from the client is ignored. The intent is for the client to reset it's session timer when the request is received.", + "signedDate": { + "description": "", "type": "string" }, - "recipientId": { - "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", + "signedOnMobile": { + "description": "", "type": "string" }, - "returnUrl": { - "description": "The URL that the recipient is redirected to\nafter the signing session has ended.\nDocuSign redirects to the URL\nand includes an `event` query parameter\nthat can be used by your application.\n\nPossible `event` parameter values include: \n\n* `access_code_failed`
\n Recipient used incorrect access code.\n* `cancel`
\n Recipient canceled the signing operation,\n possibly by using the **Finish Later** option.\n* `decline`
\n Recipient declined to sign.\n* `exception`
\n A system error occurred during the signing process.\n* `fax_pending`
\n Recipient has a fax pending.\n* `id_check_failed`
\n Recipient failed an ID check.\n* `session_timeout`
\n The session timed out.\n An account can control this timeout using the **Signer Session Timeout** option.\n* `signing_complete`
\n Recipient completed the signing ceremony.\n* `ttl_expired`
\n The Time To Live token for the envelope has expired.\n After being successfully invoked, these tokens expire\n after 5 minutes or if the envelope is voided.\n* `viewing_complete`
\n The recipient completed viewing an envelope\n that is in a read-only/terminal state\n such as completed, declined, or voided.\n\nBe sure to include `https://` in the URL or the redirect may fail on certain browsers.\n", + "signedOnPaper": { + "description": "", "type": "string" }, - "securityDomain": { - "description": "The domain in which the user authenticated.", + "signerList": { + "description": "", "type": "string" }, - "userId": { - "description": "Specifies the user ID of the recipient. You can use with user ID or email and user name to identify the recipient. \n\nIf userId is used and a clientUserId is provided, the value in the `userId` property must match a recipientId (which can be retrieved with a GET recipients call) for the envelope. \n\nIf a userId is used and a clientUserId is not provided, the userId must match the user ID of the authenticating user.", + "status": { + "description": "Indicates the envelope status. Valid values are:\n\n* sent - The envelope is sent to the recipients. \n* created - The envelope is saved as a draft and can be modified and sent later.", "type": "string" }, - "userName": { - "description": "Specifies the username of the recipient. You can use either email and userName or userId to identify the recipient.", + "statusChangedDate": { + "description": "", "type": "string" }, - "xFrameOptions": { + "statusChangedTs": { "description": "", "type": "string" }, - "xFrameOptionsAllowFromUrl": { + "subject": { "description": "", "type": "string" - } - }, - "x-ds-definition-name": "recipientViewRequest", - "description": "", - "x-ms-summary": "" - }, - "referralInformation": { - "description": "A complex type that contains the following information for entering referral and discount information. The following items are included in the referral information (all string content): enableSupport, includedSeats, saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, saleDiscountSeatPriceOverride, planStartMonth, referralCode, referrerName, advertisementId, publisherId, shopperId, promoCode, groupMemberId, idType, and industry \n\n###### Note: saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, and saleDiscountSeatPriceOverride are reserved for DoucSign use only.", - "type": "object", - "properties": { - "advertisementId": { - "description": "A complex type that contains the following information for entering referral and discount information. The following items are included in the referral information (all string content): enableSupport, includedSeats, saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, saleDiscountSeatPriceOverride, planStartMonth, referralCode, referrerName, advertisementId, publisherId, shopperId, promoCode, groupMemberId, idType, and industry.\n\n###### Note: saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, and saleDiscountSeatPriceOverride are reserved for DoucSign use only. \n", + }, + "successes": { + "description": "", "type": "string" }, - "enableSupport": { - "description": "When set to **true**, then customer support is provided as part of the account plan.", + "templatesCreated": { + "description": "", "type": "string" }, - "externalOrgId": { + "templatesCreatedCount": { "description": "", "type": "string" }, - "groupMemberId": { + "terminalStatusDate": { "description": "", "type": "string" }, - "idType": { + "timeToCompleteSeconds": { "description": "", "type": "string" }, - "includedSeats": { - "description": "The number of seats (users) included.", + "timeToDeliver": { + "description": "", "type": "string" }, - "industry": { + "totalDocuments": { "description": "", "type": "string" }, - "planStartMonth": { + "totalEnvelopes": { "description": "", "type": "string" }, - "promoCode": { + "totalPages": { "description": "", "type": "string" }, - "publisherId": { + "totalRecipients": { "description": "", "type": "string" }, - "referralCode": { + "totalSigners": { "description": "", "type": "string" }, - "referrerName": { + "uniqueSenders": { "description": "", "type": "string" }, - "saleDiscountAmount": { - "description": "Reserved for DocuSign use only.", + "userAccountEmail": { + "description": "", "type": "string" }, - "saleDiscountFixedAmount": { - "description": "Reserved for DocuSign use only.", + "userAccountName": { + "description": "", "type": "string" }, - "saleDiscountPercent": { - "description": "Reserved for DocuSign use only.", + "userAccountStatus": { + "description": "", "type": "string" }, - "saleDiscountPeriods": { - "description": "Reserved for DocuSign use only.", + "userCount": { + "description": "", "type": "string" }, - "saleDiscountSeatPriceOverride": { - "description": "Reserved for DocuSign use only.", + "userId": { + "description": "The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.\n", "type": "string" }, - "shopperId": { + "viewDate": { + "description": "", + "type": "string" + }, + "voidedTs": { "description": "", "type": "string" } }, - "x-ds-definition-name": "referralInformation", - "x-ms-summary": "A complex type that contains the following information for entering referral and discount information. The following items are included in the referral information (all string content): enableSupport, includedSeats, saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, saleDiscountSeatPriceOverride, planStartMonth, referralCode, referrerName, advertisementId, publisherId, shopperId, promoCode, groupMemberId, idType, and industry \n\n###### Note: saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, and saleDiscountSeatPriceOverride are reserved for DoucSign use only." + "x-ds-definition-name": "reportInProductRunResponseRowFields", + "description": "", + "x-ms-summary": "" }, - "reminders": { - "description": "A complex element that specifies reminder settings for the envelope.", + "reportInProductSaveResponse": { "type": "object", "properties": { - "reminderDelay": { - "description": "An integer specifying the number of days after the recipient receives the envelope that reminder emails are sent to the recipient.", - "type": "string" - }, - "reminderEnabled": { - "description": "When set to **true**, the envelope expires and is no longer available for signing after the specified number of days. When **false**, the account default setting is used. If the account does not have an expiration setting, the DocuSign default value of 120 days is used.", + "reportCustomizedId": { + "description": "", "type": "string" + } + }, + "x-ds-definition-name": "reportInProductSaveResponse", + "description": "", + "x-ms-summary": "" + }, + "reportInProductSentByDetails": { + "type": "object", + "properties": { + "groups": { + "description": "A collection group objects containing information about the groups.", + "type": "array", + "items": { + "$ref": "#/definitions/group" + } }, - "reminderFrequency": { - "description": "An integer specifying the interval in days between reminder emails.", - "type": "string" + "users": { + "description": "User management information.", + "type": "array", + "items": { + "$ref": "#/definitions/userInfo" + } } }, - "x-ds-definition-name": "reminders", - "x-ms-summary": "A complex element that specifies reminder settings for the envelope." + "x-ds-definition-name": "reportInProductSentByDetails", + "description": "", + "x-ms-summary": "" }, "resourceInformation": { "type": "object", @@ -41483,45 +52193,13 @@ "type": "object", "properties": { "returnUrl": { - "description": "Your app's return url that the user will be redirected to after sending the envelope or completing the sending/tagging view. Query parameters `envelopeId` and `event` will be added to the URL. The event parameter values: \n\n* `Send` (the user sent the envelope)\n* `Save` (the user saved the envelope, it is still a draft)\n* `Cancel` (the user canceled the sending transaction)\n* `Error` (there was an error during the send operation)\n* `SessionEnd` (the sending session ended before the user completed a different action)", + "description": "(Optional) The URL to which the user should be redirected after the sending session is complete.\n\nMaximum Length: 500 characters. If the `returnUrl` exceeds this limit, the user is redirected to a truncated URL.", "type": "string" } }, "x-ds-definition-name": "returnUrlRequest", - "description": "The request body for the EnvelopeViews: createSender method.", - "x-ms-summary": "The request body for the EnvelopeViews: createSender method." - }, - "revision": { - "type": "object", - "properties": { - "endData": { - "description": "", - "type": "string" - }, - "fieldName": { - "description": "", - "type": "string" - }, - "maxSignatureLength": { - "description": "", - "type": "string" - }, - "signatureProperties": { - "$ref": "#/definitions/signatureProperties", - "description": "" - }, - "signatureType": { - "description": "Specifies the type of signature.", - "type": "string" - }, - "startData": { - "description": "", - "type": "string" - } - }, - "x-ds-definition-name": "revision", - "description": "", - "x-ms-summary": "" + "description": "The request body for the EnvelopeViews::createSender method.", + "x-ms-summary": "The request body for the EnvelopeViews::createSender method." }, "seal": { "type": "object", @@ -41546,11 +52224,11 @@ "type": "object", "properties": { "sealDisplayName": { - "description": "", + "description": "The user-friendly display name for a seal.", "type": "string" }, "sealName": { - "description": "", + "description": "The name of a seal.", "type": "string" } }, @@ -41562,7 +52240,7 @@ "type": "object", "properties": { "accessCode": { - "description": "Not applicable", + "description": "Not applicable.", "type": "string" }, "accessCodeMetadata": { @@ -41570,34 +52248,38 @@ "description": "Not applicable." }, "addAccessCodeToEmail": { - "description": "Not applicable", + "description": "Not applicable.", + "type": "string" + }, + "allowSystemOverrideForLockedRecipient": { + "description": "", "type": "string" }, "clientUserId": { - "description": "Not applicable", + "description": "Not applicable.", "type": "string" }, "completedCount": { - "description": "Indicates the number of times that the recipient has been through a signing completion for the envelope.\n\nIf this number is greater than 0 for a signing group, only the user who previously completed may sign again.", + "description": "Not applicable.", "type": "string" }, "customFields": { - "description": "An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters.", + "description": "Not applicable.", "type": "array", "items": { "type": "string" } }, "declinedDateTime": { - "description": "Not applicable", + "description": "Not applicable.", "type": "string" }, "declinedReason": { - "description": "Not applicable", + "description": "Not applicable.", "type": "string" }, "deliveredDateTime": { - "description": "Not applicable", + "description": "Not applicable.", "type": "string" }, "deliveryMethod": { @@ -41608,8 +52290,16 @@ "$ref": "#/definitions/propertyMetadata", "description": "Reserved for DocuSign." }, + "designatorId": { + "description": "", + "type": "string" + }, + "designatorIdGuid": { + "description": "", + "type": "string" + }, "documentVisibility": { - "description": "Not applicable", + "description": "Not applicable.", "type": "array", "items": { "$ref": "#/definitions/documentVisibility" @@ -41617,10 +52307,10 @@ }, "emailNotification": { "$ref": "#/definitions/recipientEmailNotification", - "description": "Sets the language for electronic seals." + "description": "Not applicable." }, "embeddedRecipientStartURL": { - "description": "Specifies a sender-provided valid URL string for redirecting an embedded recipient. When this option is used, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the recipient clicks the document link in the email, the recipient is redirected through DocuSign to the specified URL to complete the required actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. \n\nIf set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation launched by a partner.\n\nIt is important to understand that in a typical embedded workflow, the authentication of an embedded recipient is the responsibility of the sending application. DocuSign expects that senders will follow their own processes for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process is initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process, bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient.\n\nIf the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: `envelopeId`, `recipientId`, `recipientName`, `recipientEmail`, and `customFields`. The `customFields` property must be set for the recipient or envelope. The merge fields are enclosed in double brackets. \n\n*Example*: \n\n`http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` ", + "description": "Not applicable.", "type": "string" }, "errorDetails": { @@ -41633,22 +52323,26 @@ }, "faxNumberMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `faxNumber` property is editable.\n" + "description": "Reserved for DocuSign." }, "idCheckConfigurationName": { - "description": "The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting.\n\n**Example**: Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node.", + "description": "Not applicable.", "type": "string" }, "idCheckConfigurationNameMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the `idCheckConfigurationName` property." + "description": "Not applicable." }, "idCheckInformationInput": { "$ref": "#/definitions/idCheckInformationInput", - "description": "Not applicable" + "description": "Not applicable." + }, + "identityVerification": { + "$ref": "#/definitions/recipientIdentityVerification", + "description": "Specifies the ID Verification workflow applied on an envelope by workflow ID.
See the [list](https://developers.docusign.com/docs/esign-rest-api/reference/Accounts/IdentityVerifications/list) method in the [IdentityVerifications](https://developers.docusign.com/docs/esign-rest-api/reference/Accounts/IdentityVerifications) resource for more information on how to retrieve workflow IDs available for an account.
This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods.
Note that ID Verification and ID Check are two distinct methods. ID Verification checks recipients' identity by verifying their ID while ID Check relies on data available on public records (such as current and former address)." }, "inheritEmailNotificationConfiguration": { - "description": "When set to **true** and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account. ", + "description": "Not applicable.", "type": "string" }, "lockedRecipientPhoneAuthEditable": { @@ -41660,23 +52354,23 @@ "type": "string" }, "name": { - "description": "The name of the recipient.", + "description": "Not applicable.", "type": "string" }, "note": { - "description": "Not applicable", + "description": "Not applicable.", "type": "string" }, "noteMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Not applicable" + "description": "Not applicable." }, "phoneAuthentication": { "$ref": "#/definitions/recipientPhoneAuthentication", - "description": "A complex type that contains the following elements:\n\n* `recipMayProvideNumber` - Boolean. When set to **true**, the recipient can use whatever phone number they choose.\n* `senderProvidedNumbers` - ArrayOfString. A list of phone numbers the recipient can use.\n* `recordVoicePrint` - Reserved.\n* `validateRecipProvidedNumber` - Reserved." + "description": "Not applicable." }, "recipientAttachments": { - "description": "Not applicable", + "description": "Not applicable.", "type": "array", "items": { "$ref": "#/definitions/recipientAttachment" @@ -41684,10 +52378,10 @@ }, "recipientAuthenticationStatus": { "$ref": "#/definitions/authenticationStatus", - "description": "Not applicable" + "description": "Not applicable." }, "recipientFeatureMetadata": { - "description": "Metadata about the features that are supported for the recipient type.", + "description": "Metadata about the features that are supported for the recipient type. Read only.", "type": "array", "items": { "$ref": "#/definitions/featureAvailableMetadata" @@ -41698,7 +52392,7 @@ "type": "string" }, "recipientIdGuid": { - "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one.", + "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only.", "type": "string" }, "recipientSignatureProviders": { @@ -41709,23 +52403,23 @@ } }, "recipientType": { - "description": "The recipient type, as specified by the following values:\n- `agents`: Agent recipients can add name and email information for recipients that appear after the agent in routing order.\n- `carbonCopies`: Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date, or add information to any of the documents. This type of recipient can be used in any routing order.\n- `certifiedDeliveries`: Certified delivery recipients must receive the completed documents for the envelope to be completed. They don't need to sign, initial, date, or add information to any of the documents.\n- `editors`: Editors have the same management and access rights for the envelope as the sender. Editors can add name and email information, add or change the routing order, set authentication options, and can edit signature/initial tabs and data fields for the remaining recipients.\n- `inPersonSigners`: In-person recipients are DocuSign users who act as signing hosts in the same physical location as the signer.\n- `intermediaries`: Intermediary recipients can optionally add name and email information for recipients at the same or subsequent level in the routing order.\n- `seals`: Electronic seal recipients represent legal entities.\n- `signers`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope.\n- `witnesses`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope.", + "description": "The recipient type, as specified by the following values:\n- `agent`: Agent recipients can add name and email information for recipients that appear after the agent in routing order.\n- `carbonCopy`: Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date, or add information to any of the documents. This type of recipient can be used in any routing order.\n- `certifiedDelivery`: Certified delivery recipients must receive the completed documents for the envelope to be completed. They don't need to sign, initial, date, or add information to any of the documents.\n- `editor`: Editors have the same management and access rights for the envelope as the sender. Editors can add name and email information, add or change the routing order, set authentication options, and can edit signature/initial tabs and data fields for the remaining recipients.\n- `inPersonSigner`: In-person recipients are DocuSign users who act as signing hosts in the same physical location as the signer.\n- `intermediaries`: Intermediary recipients can optionally add name and email information for recipients at the same or subsequent level in the routing order.\n- `seal`: Electronic seal recipients represent legal entities.\n- `signer`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope.\n- `witness`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope.", "type": "string" }, "recipientTypeMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the recipient type." + "description": "Metadata that indicates whether the `recipientType` property is editable. Read only." }, "requireIdLookup": { - "description": "Not applicable", + "description": "Not applicable.", "type": "string" }, "requireIdLookupMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Not applicable" + "description": "Not applicable." }, "roleName": { - "description": "Optional element. Specifies the role name associated with the recipient.

This is required when working with template recipients.", + "description": "Optional element. Specifies the role name associated with the recipient.

This property is required when you are working with template recipients.", "type": "string" }, "routingOrder": { @@ -41734,38 +52428,42 @@ }, "routingOrderMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the routing order for the recipient." + "description": "Metadata that indicates whether the `routingOrder` property is editable. Read only." }, "sentDateTime": { - "description": "Not applicable", + "description": "Not applicable.", "type": "string" }, "signedDateTime": { - "description": "Not applicable", + "description": "Not applicable.", "type": "string" }, "smsAuthentication": { "$ref": "#/definitions/recipientSMSAuthentication", - "description": "Not applicable" + "description": "Not applicable." }, "socialAuthentications": { - "description": " Lists the social ID type that can be used for recipient authentication.", + "description": "Deprecated.", "type": "array", "items": { "$ref": "#/definitions/socialAuthentication" } }, "status": { - "description": "The status of the item.", + "description": "The recipient's status. Read only. \n\nPossible values:\n\n- `autoresponded`: The recipient's email system auto-responded to the email from DocuSign. This status is used in the web console to inform senders about the bounced-back email. This recipient status is only used if **Send-on-behalf-of** is turned off for the account.\n- `completed`: The recipient has completed their actions (signing or other required actions if not a signer) for an envelope.\n- `created`: The recipient is in a draft state. This value is only associated with draft envelopes (envelopes that have a status of `created`).\n- `declined`: The recipient declined to sign the document(s) in the envelope.\n- `delivered`: The recipient has viewed the document(s) in an envelope through the DocuSign signing website. This is not an email delivery of the documents in an envelope.\n- `faxPending`: The recipient has finished signing and the system is waiting for a fax attachment from the recipient before completing their signing step.\n- `sent`: The recipient has been sent an email notification that it is their turn to sign an envelope.\n- `signed`: The recipient has completed (signed) all required tags in an envelope. This is a temporary state during processing, after which the recipient's status automatically switches to `completed`.", "type": "string" }, "statusCode": { - "description": "Reserved for DocuSign.", + "description": "The code associated with the recipient's status. Read only.", + "type": "string" + }, + "suppressEmails": { + "description": "Not applicable.", "type": "string" }, "tabs": { "$ref": "#/definitions/EnvelopeRecipientTabs", - "description": "A list of `signHere` tabs, which can be used to add a visual representation for an electronic seal in a document." + "description": "A list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients." }, "templateLocked": { "description": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ", @@ -41776,63 +52474,47 @@ "type": "string" }, "totalTabCount": { - "description": "Not applicable", + "description": "Not applicable.", "type": "string" }, "userId": { - "description": "Not applicable", + "description": "Not applicable.", "type": "string" } }, "x-ds-definition-name": "sealSign", - "description": "Specifies one or more electronic seals to apply on documents. \n\n```json\n\"recipients\": {\n \"seals\": [\n {\n \"recipientId\": \"1\",\n \"routingOrder\" : 1,\n \"recipientSignatureProviders\": [\n {\n \"sealName\": \"52e9d968-13be-42ca-a6fe-4682bc45c106\"\n }\n \t]\n \t}\n \t]\n\t},\n```\nFor more information on Electronic Seals , see https://support.docusign.com/en/guides/ndse-user-guide-apply-electronic-seals", - "x-ms-summary": "Specifies one or more electronic seals to apply on documents. \n\n```json\n\"recipients\": {\n \"seals\": [\n {\n \"recipientId\": \"1\",\n \"routingOrder\" : 1,\n \"recipientSignatureProviders\": [\n {\n \"sealName\": \"52e9d968-13be-42ca-a6fe-4682bc45c106\"\n }\n \t]\n \t}\n \t]\n\t},\n```\nFor more information on Electronic Seals , see https://support.docusign.com/en/guides/ndse-user-guide-apply-electronic-seals" + "description": "Specifies one or more electronic seals to apply on documents. An electronic seal recipient is a legal entity rather than an actual person. Electronic Seals can be used by organizations and governments to show evidence of origin and integrity of documents. Even though electronic seals can be represented by a tab in a document, they do not require user interaction and apply automatically in the order specified by the sender. The sender is therefore the person authorizing usage of the electronic seal in the flow.\n\nExample: \n\n```json\n\"recipients\": {\n \"seals\": [\n {\n \"recipientId\": \"1\",\n \"routingOrder\" : 1,\n \"recipientSignatureProviders\": [\n {\n \"sealName\": \"52e9d968-xxxx-xxxx-xxxx-4682bc45c106\"\n }\n \t]\n \t}\n \t]\n\t},\n .\n .\n .\n```\nFor more information about Electronic Seals, see [Apply Electronic Seals to Your Documents](https://support.docusign.com/en/guides/ndse-user-guide-apply-electronic-seals).\n", + "x-ms-summary": "Specifies one or more electronic seals to apply on documents. An electronic seal recipient is a legal entity rather than an actual person. Electronic Seals can be used by organizations and governments to show evidence of origin and integrity of documents. Even though electronic seals can be represented by a tab in a document, they do not require user interaction and apply automatically in the order specified by the sender. The sender is therefore the person authorizing usage of the electronic seal in the flow.\n\nExample: \n\n```json\n\"recipients\": {\n \"seals\": [\n {\n \"recipientId\": \"1\",\n \"routingOrder\" : 1,\n \"recipientSignatureProviders\": [\n {\n \"sealName\": \"52e9d968-xxxx-xxxx-xxxx-4682bc45c106\"\n }\n \t]\n \t}\n \t]\n\t},\n .\n .\n .\n```\nFor more information about Electronic Seals, see [Apply Electronic Seals to Your Documents](https://support.docusign.com/en/guides/ndse-user-guide-apply-electronic-seals).\n" }, "seatDiscount": { "type": "object", "properties": { "beginSeatCount": { - "description": "Reserved: TBD", + "description": "Reserved for DocuSign.", "type": "string" }, "discountPercent": { - "description": "", + "description": "The percent of the discount. \n\nExample: `\"0.00\"`", "type": "string" }, "endSeatCount": { - "description": "Reserved: TBD", + "description": "Reserved for DocuSign.", "type": "string" } }, "x-ds-definition-name": "seatDiscount", - "description": "", - "x-ms-summary": "" - }, - "sender": { - "type": "object", - "properties": { - "accountIdGuid": { - "description": "The GUID associated with the account ID.", - "type": "string" - }, - "companyName": { - "description": "The name of the user's company.", - "type": "string" - } - }, - "x-ds-definition-name": "sender", - "description": "", - "x-ms-summary": "" + "description": "This object contains information about a seat discount.", + "x-ms-summary": "This object contains information about a seat discount." }, "senderEmailNotifications": { "type": "object", "properties": { "changedSigner": { - "description": "When set to **true**, the sender receives notification if the signer changes.", + "description": "When set to **true**, the sender receives an email notification if the signer changes.", "type": "string" }, "commentsOnlyPrivateAndMention": { - "description": "When set to **true**, the user receives only comments in which that user name is mentioned.", + "description": "When set to **true**, the user receives only comments that mention their own user name.", "type": "string" }, "commentsReceiveAll": { @@ -41840,23 +52522,27 @@ "type": "string" }, "deliveryFailed": { - "description": "When set to **true**, the sender receives notification if the delivery of the envelope fails.", + "description": "When set to **true**, the sender receives an email notification if envelope delivery fails.", "type": "string" }, "envelopeComplete": { - "description": "When set to **true**, the user receives notification that the envelope has been completed.", + "description": "When set to **true**, the user receives an email notification when the envelope has been completed.", "type": "string" }, "offlineSigningFailed": { - "description": "When set to **true**, the user receives notification if the offline signing failed.", + "description": "When set to **true**, the user receives an email notification if offline signing failed.", + "type": "string" + }, + "powerformResponsesLimitNotificationEmail": { + "description": "", "type": "string" }, "purgeDocuments": { - "description": "When set to **true**, the user receives notification of document purges.", + "description": "When set to **true**, the user receives an email notification when a document purge occurs.", "type": "string" }, "recipientViewed": { - "description": "When set to **true**, the sender receives notification that the recipient viewed the enveloper.", + "description": "When set to **true**, the sender receives notification that a recipient viewed the envelope.", "type": "string" }, "senderEnvelopeDeclined": { @@ -41864,13 +52550,13 @@ "type": "string" }, "withdrawnConsent": { - "description": "When set to **true**, the user receives notification if consent is withdrawn.", + "description": "When set to **true**, the user receives an email notification if consent is withdrawn.", "type": "string" } }, "x-ds-definition-name": "senderEmailNotifications", - "description": "", - "x-ms-summary": "" + "description": "Contains the settings for the email notifications that senders receive about the envelopes that they send.", + "x-ms-summary": "Contains the settings for the email notifications that senders receive about the envelopes that they send." }, "serverTemplate": { "type": "object", @@ -41997,23 +52683,39 @@ "description": "Information about the shared item.", "x-ms-summary": "Information about the shared item." }, - "signatureDataInfo": { + "signatureGroup": { "type": "object", "properties": { - "documentSecurityStore": { - "$ref": "#/definitions/documentSecurityStore", - "description": "" + "groupId": { + "description": "The ID of the group being accessed.", + "type": "string" }, - "signatureData": { - "description": "", + "groupName": { + "description": "The name of the group. The search_text provided in the call automatically performs a wild card search on group_name.", "type": "string" }, - "signatureFieldName": { - "description": "", + "rights": { + "description": "Indicates whether the property is editable. Valid values are:\n\n- `editable`\n- `read_only`", + "type": "string" + } + }, + "x-ds-definition-name": "signatureGroup", + "description": "", + "x-ms-summary": "" + }, + "signatureGroupDef": { + "type": "object", + "properties": { + "groupId": { + "description": "The ID of the group being accessed.", + "type": "string" + }, + "rights": { + "description": "Indicates whether the property is editable. Valid values are:\n\n- `editable`\n- `read_only`", "type": "string" } }, - "x-ds-definition-name": "signatureDataInfo", + "x-ds-definition-name": "signatureGroupDef", "description": "", "x-ms-summary": "" }, @@ -42021,11 +52723,11 @@ "type": "object", "properties": { "filter": { - "description": "", + "description": "Specifies the preferred handler that should be used to validate the signature.", "type": "string" }, "subFilter": { - "description": "", + "description": "Indicates the format of the data that the stream contains.", "type": "string" } }, @@ -42037,34 +52739,78 @@ "type": "object", "properties": { "requiredSignatureProviderOptionIds": { - "description": "", + "description": "Reserved for DocuSign.", "type": "array", "items": { "type": "string" } }, "signerType": { - "description": "", + "description": "Reserved for DocuSign.", "type": "string" } }, "x-ds-definition-name": "signatureProviderRequiredOption", - "description": "", - "x-ms-summary": "" + "description": "Contains additional information that a specific signature provider requires.", + "x-ms-summary": "Contains additional information that a specific signature provider requires." }, "signatureType": { "type": "object", "properties": { "isDefault": { - "description": "Indicates if the signature type is the default type.", + "description": "When **true**, the signature type is the default type.", "type": "string" }, "type": { - "description": "Type of user:\n- `type_owner`\n- `type_participant`", + "description": "The type of signature. Valid values are:\n\n- `electronic`: Indicates an **electronic** signature that is used by common law countries such as the United States, United Kingdom, and Australia. This is the default signature type that DocuSign uses.\n- `universal`: Indicates a **digital** signature that is accepted by both common law and civil law countries. To use digital signatures, you must use the [DocuSign Signature Appliance](https://developers.docusign.com/dsa-api).\n\nFor more information, see [Standards Based Signatures](https://developers.docusign.com/esign-rest-api/guides/standards-based-signatures).", "type": "string" } }, "x-ds-definition-name": "signatureType", + "description": "This object contains information about the type of signature.", + "x-ms-summary": "This object contains information about the type of signature." + }, + "signatureUser": { + "type": "object", + "properties": { + "isDefault": { + "description": "Boolean that specifies whether the signature is the default signature for the user.", + "type": "string" + }, + "rights": { + "description": "Indicates whether the property is editable. Valid values are:\n\n- `editable`\n- `read_only`", + "type": "string" + }, + "userId": { + "description": "The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.\n", + "type": "string" + }, + "userName": { + "description": "The name of the user.", + "type": "string" + } + }, + "x-ds-definition-name": "signatureUser", + "description": "", + "x-ms-summary": "" + }, + "signatureUserDef": { + "type": "object", + "properties": { + "isDefault": { + "description": "Boolean that specifies whether the signature is the default signature for the user.", + "type": "string" + }, + "rights": { + "description": "Indicates whether the property is editable. Valid values are:\n\n- `editable`\n- `read_only`", + "type": "string" + }, + "userId": { + "description": "The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.\n", + "type": "string" + } + }, + "x-ds-definition-name": "signatureUserDef", "description": "", "x-ms-summary": "" }, @@ -42077,26 +52823,37 @@ }, "accessCodeMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the `accessCode` property." + "description": "Metadata that indicates whether the `accessCode` property is editable. Read only." }, "addAccessCodeToEmail": { - "description": "This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient.", + "description": "Optional. When set to **true**, the access code will be added to the email sent to the recipient. This nullifies the security measure of `accessCode` on the recipient.", "type": "string" }, + "additionalNotifications": { + "description": "An array of additional notification objects.", + "type": "array", + "items": { + "$ref": "#/definitions/recipientAdditionalNotification" + } + }, "agentCanEditEmail": { - "description": "Optional element. When set to true, the agents recipient associated with this recipient can change the recipient's pre-populated email address. This element is only active if enabled for the account.", + "description": "Optional element. When set to **true**, the agent recipient associated with this recipient can change the recipient's pre-populated email address. This element is only active if enabled for the account.", "type": "string" }, "agentCanEditName": { - "description": "Optional element. When set to **true**, the agents recipient associated with this recipient can change the recipient's pre-populated name. This element is only active if enabled for the account.", + "description": "Optional. When set to **true**, the agent recipient associated with this recipient can change the recipient's pre-populated name. This element is only active if enabled for the account.", + "type": "string" + }, + "allowSystemOverrideForLockedRecipient": { + "description": "", "type": "string" }, "autoNavigation": { - "description": "When **true**, auto navigation is set for the recipient.\n", + "description": "When set to **true**, autonavigation is set for the recipient.\n", "type": "string" }, "bulkRecipientsUri": { - "description": "Contains a URI for an endpoint that allows you to easily retrieve bulk recipient information.", + "description": "Reserved for DocuSign.", "type": "string" }, "canSignOffline": { @@ -42108,11 +52865,11 @@ "type": "string" }, "completedCount": { - "description": "Indicates the number of times that the recipient has been through a signing completion for the envelope.\n\nIf this number is greater than 0 for a signing group, only the user who previously completed may sign again.", + "description": "Indicates the number of times that the recipient has been through a signing completion for the envelope. If this number is greater than 0 for a signing group, only the user who previously completed may sign again. Read only.", "type": "string" }, "creationReason": { - "description": "Payment status for payment services.", + "description": "The reason why the item was created.", "type": "string" }, "customFields": { @@ -42123,11 +52880,11 @@ } }, "declinedDateTime": { - "description": "The date and time the recipient declined the document.", + "description": "The date and time the recipient declined the document. Read only.", "type": "string" }, "declinedReason": { - "description": "The reason the recipient declined the document.", + "description": "The reason the recipient declined the document. Read only.", "type": "string" }, "defaultRecipient": { @@ -42135,7 +52892,7 @@ "type": "string" }, "deliveredDateTime": { - "description": "The date and time that the envelope was delivered to the recipient.", + "description": "The date and time that the envelope was delivered to the recipient. Read only.", "type": "string" }, "deliveryMethod": { @@ -42146,27 +52903,35 @@ "$ref": "#/definitions/propertyMetadata", "description": "Reserved for DocuSign." }, + "designatorId": { + "description": "", + "type": "string" + }, + "designatorIdGuid": { + "description": "", + "type": "string" + }, "documentVisibility": { - "description": "A list of documentVisibility objects, which define a recipient's read/write access to a document.", + "description": "A list of `documentVisibility` objects. Each object in the list specifies whether a document in the envelope is visible to this recipient. For the envelope to use this functionality, Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true**.", "type": "array", "items": { "$ref": "#/definitions/documentVisibility" } }, "email": { - "description": "Recipient email ID to which notifications of the document to sign are sent. Maximum length: 100 characters. ", + "description": "The recipient's email address. The system sends notifications about the documents to sign to this address. Maximum length: 100 characters. ", "type": "string" }, "emailMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the signer can edit the recipient's email ID." + "description": "Metadata that indicates whether the `email` property is editable. Read only." }, "emailNotification": { "$ref": "#/definitions/recipientEmailNotification", - "description": "An optional complex type that sets a specific email subject and body for this recipient's notification email. \n\n**Note**: If you use this field to set a specific email notification for one recipient, you must also set the email notification for the other recipients. Using this field for one or more recipients negates the Envelope `Subject` and `EmailBlurb` property settings. " + "description": "An optional complex type that sets a specific email subject and body for this recipient's notification email. \n\n**Note**: You can set the `emailNotification` property separately for each recipient. If you set the value only for certain recipients, the other recipients will inherit the this value from the top-level `emailSubject` and `emailBlurb`. " }, "embeddedRecipientStartURL": { - "description": "Specifies a sender-provided valid URL string for redirecting an embedded recipient. When this option is used, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the recipient clicks the document link in the email, the recipient is redirected through DocuSign to the specified URL to complete the required actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. \n\nIf set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation launched by a partner.\n\nIt is important to understand that in a typical embedded workflow, the authentication of an embedded recipient is the responsibility of the sending application. DocuSign expects that senders will follow their own processes for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process is initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process, bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient.\n\nIf the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: `envelopeId`, `recipientId`, `recipientName`, `recipientEmail`, and `customFields`. The `customFields` property must be set for the recipient or envelope. The merge fields are enclosed in double brackets. \n\n*Example*: \n\n`http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` ", + "description": "Specifies a sender-provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. \n\nIf set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation launched by a partner.\n\nIt is important to understand that in a typical embedded workflow, the authentication of an embedded recipient is the responsibility of the sending application. DocuSign expects that senders will follow their own processes for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process is initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process, bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient.\n\nIf the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: `envelopeId`, `recipientId`, `recipientName`, `recipientEmail`, and `customFields`. The `customFields` property must be set for the recipient or envelope. The merge fields are enclosed in double brackets. \n\n*Example*: \n\n`http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` ", "type": "string" }, "errorDetails": { @@ -42186,7 +52951,7 @@ }, "faxNumberMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `faxNumber` property is editable.\n" + "description": "Reserved for DocuSign." }, "firstName": { "description": "The recipient's first name. Maximum Length: 50 characters.", @@ -42194,7 +52959,7 @@ }, "firstNameMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the recipient's first name." + "description": "Metadata that indicates whether the `firstame` property is editable. Read only." }, "fullName": { "description": "Reserved for DocuSign.", @@ -42205,12 +52970,12 @@ "description": "Reserved for DocuSign." }, "idCheckConfigurationName": { - "description": "The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting.\n\n**Example**: Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node.", + "description": "The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are:\n\n- `Phone Auth $`: The recipient must authenticate by using two-factor authentication (2FA). You provide the phone number to use for 2FA in the `phoneAuthentication` object.\n- `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object.\n- `ID Check $`: The recipient must answer detailed security questions. \n\n**Example**: Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node.", "type": "string" }, "idCheckConfigurationNameMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the `idCheckConfigurationName` property." + "description": "Metadata that indicates whether the `idCheckConfigurationName` property is editable. Read only." }, "idCheckInformationInput": { "$ref": "#/definitions/idCheckInformationInput", @@ -42218,7 +52983,7 @@ }, "identityVerification": { "$ref": "#/definitions/recipientIdentityVerification", - "description": "Specifies ID Verification applied on an envelope by workflow ID.
See the [list](https://developers.docusign.com/esign-rest-api/reference/Accounts/IdentityVerifications/list) method in the [IdentityVerifications](https://developers.docusign.com/esign-rest-api/reference/Accounts/IdentityVerifications) resource for more information on how to retrieve workflow IDs available for an account.
This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods.
Note that ID Verification and ID Check are two distinct methods. ID Verification checks recipients' identity by verifying their ID while ID Check relies on data available on public records (such as current and former address)." + "description": "Specifies the ID Verification workflow applied on an envelope by workflow ID.
See the [list](https://developers.docusign.com/docs/esign-rest-api/reference/Accounts/IdentityVerifications/list) method in the [IdentityVerifications](https://developers.docusign.com/docs/esign-rest-api/reference/Accounts/IdentityVerifications) resource for more information on how to retrieve workflow IDs available for an account.
This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods.
Note that ID Verification and ID Check are two distinct methods. ID Verification checks recipients' identity by verifying their ID while ID Check relies on data available on public records (such as current and former address)." }, "inheritEmailNotificationConfiguration": { "description": "When set to **true** and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account. ", @@ -42230,7 +52995,7 @@ }, "isBulkRecipientMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the `isBulkRecipient` property." + "description": "Reserved for DocuSign." }, "lastName": { "description": "The recipient's last name.", @@ -42238,7 +53003,7 @@ }, "lastNameMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the recipient's last name." + "description": "Metadata that indicates whether the `lastName` property is editable. Read only." }, "lockedRecipientPhoneAuthEditable": { "description": "Reserved for DocuSign.", @@ -42249,12 +53014,16 @@ "type": "string" }, "name": { - "description": "The full legal name of the recipient.", + "description": "The full legal name of the recipient. Maximum Length: 100 characters.\n\n**Note**: You must always set a value for this property in requests, even if `firstName` and `lastName` are set.", "type": "string" }, "nameMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the full legal name of the recipient." + "description": "Metadata that indicates whether the `name` property is editable. Read only." + }, + "notaryId": { + "description": "", + "type": "string" }, "note": { "description": "A note sent to the recipient in the signing email.\nThis note is unique to this recipient.\nIn the user interface,\nit appears near the upper left corner\nof the document\non the signing screen.\n\nMaximum Length: 1000 characters.\n", @@ -42262,11 +53031,15 @@ }, "noteMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metdata that indicates if the sender can edit the note sent to the recipient in the signing email." + "description": "Metadata that indicates whether the `note` property is editable. Read only." }, "phoneAuthentication": { "$ref": "#/definitions/recipientPhoneAuthentication", - "description": "A complex type that contains the following elements:\n\n* `recipMayProvideNumber` - Boolean. When set to **true**, the recipient can use whatever phone number they choose.\n* `senderProvidedNumbers` - ArrayOfString. A list of phone numbers the recipient can use.\n* `recordVoicePrint` - Reserved.\n* `validateRecipProvidedNumber` - Reserved." + "description": "When `idCheckConfigurationName` is set to `Phone Auth $`, you use this complex type to provide the recipient authentication method details. It contains the following elements:\n\n* `recipMayProvideNumber`: Boolean. When set to **true**, the recipient can use whatever phone number they choose.\n* `senderProvidedNumbers`: ArrayOfStrings. A list of phone numbers the recipient can use.\n* `recordVoicePrint`: Reserved for DocuSign.\n* `validateRecipProvidedNumber`: Reserved for DocuSign.\n\n" + }, + "proofFile": { + "$ref": "#/definitions/recipientProofFile", + "description": "The proof file of the recipient." }, "recipientAttachments": { "description": "Reserved for DocuSign.", @@ -42277,21 +53050,21 @@ }, "recipientAuthenticationStatus": { "$ref": "#/definitions/authenticationStatus", - "description": "Information about the recipient's authentication status." + "description": "Information about the recipient's authentication status. Read only." }, "recipientFeatureMetadata": { - "description": "Metadata about the features that are supported for the recipient type.", + "description": "Metadata about the features that are supported for the recipient type. Read only.", "type": "array", "items": { "$ref": "#/definitions/featureAvailableMetadata" } }, "recipientId": { - "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", + "description": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.", "type": "string" }, "recipientIdGuid": { - "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one.", + "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only.", "type": "string" }, "recipientSignatureProviders": { @@ -42302,16 +53075,16 @@ } }, "recipientSuppliesTabs": { - "description": "Specifies whether the recipient creates the tabs.", + "description": "When set to **true**, specifies that the recipient creates the tabs.", "type": "string" }, "recipientType": { - "description": "The recipient type, as specified by the following values:\n- `agents`: Agent recipients can add name and email information for recipients that appear after the agent in routing order.\n- `carbonCopies`: Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date, or add information to any of the documents. This type of recipient can be used in any routing order.\n- `certifiedDeliveries`: Certified delivery recipients must receive the completed documents for the envelope to be completed. They don't need to sign, initial, date, or add information to any of the documents.\n- `editors`: Editors have the same management and access rights for the envelope as the sender. Editors can add name and email information, add or change the routing order, set authentication options, and can edit signature/initial tabs and data fields for the remaining recipients.\n- `inPersonSigners`: In-person recipients are DocuSign users who act as signing hosts in the same physical location as the signer.\n- `intermediaries`: Intermediary recipients can optionally add name and email information for recipients at the same or subsequent level in the routing order.\n- `seals`: Electronic seal recipients represent legal entities.\n- `signers`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope.\n- `witnesses`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope.", + "description": "The recipient type, as specified by the following values:\n- `agent`: Agent recipients can add name and email information for recipients that appear after the agent in routing order.\n- `carbonCopy`: Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date, or add information to any of the documents. This type of recipient can be used in any routing order.\n- `certifiedDelivery`: Certified delivery recipients must receive the completed documents for the envelope to be completed. They don't need to sign, initial, date, or add information to any of the documents.\n- `editor`: Editors have the same management and access rights for the envelope as the sender. Editors can add name and email information, add or change the routing order, set authentication options, and can edit signature/initial tabs and data fields for the remaining recipients.\n- `inPersonSigner`: In-person recipients are DocuSign users who act as signing hosts in the same physical location as the signer.\n- `intermediaries`: Intermediary recipients can optionally add name and email information for recipients at the same or subsequent level in the routing order.\n- `seal`: Electronic seal recipients represent legal entities.\n- `signer`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope.\n- `witness`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope.", "type": "string" }, "recipientTypeMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the recipient type." + "description": "Metadata that indicates whether the `recipientType` property is editable. Read only." }, "requireIdLookup": { "description": "When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. ", @@ -42319,18 +53092,22 @@ }, "requireIdLookupMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `requireIdLookup` property is editable.\n" + "description": "Metadata that indicates whether the `requireIdLookup` property is editable. Read only." }, "requireSignerCertificate": { - "description": "By default, DocuSign signers create electronic signatures. This field can be used to require the signer to use a SAFE-BioPharma digital certificate for signing.\n\nThis parameter should only be used to select a SAFE-BioPharma certificate. New integrations should use the `recipientSignatureProviders` parameter for other types of digital certificates. \n\nSet this parameter to `safe` to use a SAFE-BioPharma certificate.\n\nThe signer must be enrolled in the SAFE program to sign with a SAFE certificate.", + "description": "Sets the type of signer certificate required for signing. If left blank, no certificate is required. Only one type of certificate can be set for a signer. The possible values are:\n\n* docusign_express – Requires a DocuSign Express certificate.\n* safe – Requires a SAFE-BioPharma certificate.\n* open_trust – Requires an OpenTrust certificate. \n\n**Important**: There are certain rules and restrictions that must be followed when requiring OpenTrust digital signatures. See [ML:OpenTrust Rules and Restrictions] for more information. \n ", "type": "string" }, "requireSignOnPaper": { "description": "When set to **true**, the signer must print, sign, and upload or fax the signed documents to DocuSign.", "type": "string" }, + "requireUploadSignature": { + "description": "When set to **true**, the signer is required to upload a new signature, even if they have a pre-adopted signature in their personal DocuSign account.", + "type": "string" + }, "roleName": { - "description": "Optional element. Specifies the role name associated with the recipient.

This is required when working with template recipients.", + "description": "Optional element. Specifies the role name associated with the recipient.

This property is required when you are working with template recipients.", "type": "string" }, "routingOrder": { @@ -42339,15 +53116,15 @@ }, "routingOrderMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the routing order for the recipient." + "description": "Metadata that indicates whether the `routingOrder` property is editable. Read only." }, "sentDateTime": { - "description": "The date and time the envelope was sent.", + "description": "The UTC DateTime when the envelope was sent. Read only.", "type": "string" }, "signatureInfo": { "$ref": "#/definitions/recipientSignatureInformation", - "description": "Allows the sender to pre-specify the signature name, signature initials and signature font used in the signature stamp for the recipient.\n\nUsed only with recipient types In Person Signers and Signers. \n " + "description": "Allows the sender to pre-specify the signature name, signature initials and signature font used in the signature stamp for the recipient.\n\nUsed only with recipient types In Person Signers and Signers." }, "signedDateTime": { "description": "Reserved for DocuSign.", @@ -42359,18 +53136,18 @@ }, "signInEachLocationMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `signInEachLocation` property is editable.\n" + "description": "Metadata that indicates whether the `signInEachLocation` property is editable. Read only." }, "signingGroupId": { - "description": "The id of the signing group of which the recipient is a member, if applicable.", + "description": "When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once).", "type": "string" }, "signingGroupIdMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the signing group id." + "description": "Metadata that indicates whether the `signingGroupId` property is editable. Read only." }, "signingGroupName": { - "description": "The display name for the signing group. \n\nMaximum Length: 100 characters. ", + "description": "Optional. The name of the signing group. \n\nMaximum Length: 100 characters. ", "type": "string" }, "signingGroupUsers": { @@ -42382,26 +53159,30 @@ }, "smsAuthentication": { "$ref": "#/definitions/recipientSMSAuthentication", - "description": "Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication. \n" + "description": "When `idCheckConfigurationName` is set to `SMS Auth $`, you use this complex type to provide the recipient authentication method details. It contains the element `senderProvidedNumbers`, which is an array of phone numbers that the recipient can use for SMS text authentication. \n\n" }, "socialAuthentications": { - "description": " Lists the social ID type that can be used for recipient authentication.", + "description": "Deprecated.", "type": "array", "items": { "$ref": "#/definitions/socialAuthentication" } }, "status": { - "description": "Recipient status.\n\n", + "description": "Specifies the status of the recipient at the time of the request. Read only. Possible values are:\n\n- `created`: The recipient is in a draft state. This is only associated with draft envelopes (envelopes with a created status).\n- `sent`: The recipient has been sent an email notification that it is their turn to sign an envelope.\n- `delivered`: The recipient has viewed the documents in an envelope through the DocuSign signing web site. This is not an email delivery of the documents in an envelope.\n- `signed`; The recipient has completed (performed all required interactions, such as signing or entering data) all required tags in an envelope. This is a temporary state during processing, after which the recipient is automatically moved to completed.\n- `declined`: The recipient declined to sign the documents in the envelope.\n- `completed`: The recipient has completed their actions (signing or other required actions if not a signer) for an envelope.\n- `faxpending`: The recipient has finished signing and the system is waiting a fax attachment by the recipient before completing their signing step.\n- `autoresponded`: The recipient's email system auto-responded to the email from DocuSign. This status is used by the DocuSign webapp (also known as the DocuSign console) to inform senders about the auto-responded email.\n", "type": "string" }, "statusCode": { "description": "Reserved for DocuSign.", "type": "string" }, + "suppressEmails": { + "description": "When set to **true**, email notifications are suppressed for the recipient, and they must access envelopes and documents from their DocuSign inbox.", + "type": "string" + }, "tabs": { "$ref": "#/definitions/EnvelopeRecipientTabs", - "description": "The tabs to assign to the recipient." + "description": "The tabs to assign to the recipient.\n[More information](https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/)." }, "templateLocked": { "description": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ", @@ -42412,7 +53193,7 @@ "type": "string" }, "totalTabCount": { - "description": "The total number of tabs in the documents.", + "description": "The total number of tabs in the documents. Read only.", "type": "string" }, "userId": { @@ -42421,27 +53202,35 @@ } }, "x-ds-definition-name": "signer", - "description": "A complex type containing information about the signer recipient.", - "x-ms-summary": "A complex type containing information about the signer recipient." + "description": "A complex type containing information about a signer recipient. A signer is a recipient who must take action on a document, such as sign, initial, date, or add data to form fields on a document.", + "x-ms-summary": "A complex type containing information about a signer recipient. A signer is a recipient who must take action on a document, such as sign, initial, date, or add data to form fields on a document." }, "signerAttachment": { "type": "object", "properties": { + "anchorAllowWhiteSpaceInCharacters": { + "description": "", + "type": "string" + }, + "anchorAllowWhiteSpaceInCharactersMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "" + }, "anchorCaseSensitive": { - "description": "Reserved for DocuSign.\n", + "description": "This property controls how [anchor tabs][AnchorTabs] are placed. When **true**, the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false**.\n\nFor example, when set to **true**, if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When set to **false**, `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**.\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place", "type": "string" }, "anchorCaseSensitiveMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "description": "Metadata that indicates whether the `anchorCaseSensitive` property is editable." }, "anchorHorizontalAlignment": { - "description": "Reserved for DocuSign.\n\n", + "description": "This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are :\n\n- `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value.\n- `right`: Aligns the tab’s left side with the last character of the matching anchor word.\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place\n", "type": "string" }, "anchorHorizontalAlignmentMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "description": "Metadata that indicates whether the `anchorHorizontalAlignment` property is editable." }, "anchorIgnoreIfNotPresent": { "description": "When set to **true**, this tab is ignored if the `anchorString` is not found in the document.", @@ -42452,12 +53241,12 @@ "description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable." }, "anchorMatchWholeWord": { - "description": "Reserved for DocuSign.\n\n", + "description": "When set to **true**, the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false**.\n\nFor example, when set to **true**, if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When set to **false**, if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**.\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTab]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place\n", "type": "string" }, "anchorMatchWholeWordMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "description": "Metadata that indicates whether the `anchorMatchWholeWord` property is editable." }, "anchorString": { "description": "Specifies the string to find in the document and use as the basis for tab placement.", @@ -42476,7 +53265,7 @@ "description": "Reserved for DocuSign." }, "anchorUnits": { - "description": "Specifies the units of the X and Y offset. Units may be pixels, millimeters, centimeters, or inches.", + "description": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n", "type": "string" }, "anchorUnitsMetadata": { @@ -42484,7 +53273,7 @@ "description": "Metadata that indicates whether the `anchorUnits` property is editable." }, "anchorXOffset": { - "description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.", + "description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n", "type": "string" }, "anchorXOffsetMetadata": { @@ -42492,7 +53281,7 @@ "description": "Metadata that indicates whether the `anchorXOffset` property is editable." }, "anchorYOffset": { - "description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.", + "description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n", "type": "string" }, "anchorYOffsetMetadata": { @@ -42516,7 +53305,7 @@ "description": "Metadata that indicates whether the `conditionalParentValue` property is editable." }, "customTabId": { - "description": "The DocuSign-generated custom tab id for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.", + "description": "The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.", "type": "string" }, "customTabIdMetadata": { @@ -42524,7 +53313,7 @@ "description": "Metadata that indicates whether the `customTabId` property is editable." }, "documentId": { - "description": "Integer that identifies the document in the envelope.", + "description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.", "type": "string" }, "documentIdMetadata": { @@ -42571,13 +53360,17 @@ "$ref": "#/definitions/mergeField", "description": "Contains the information necessary to map the tab to a field in SalesForce." }, + "mergeFieldXml": { + "description": "", + "type": "string" + }, "name": { "description": "The name of the tab. For example, `Sign Here` or `Initial Here`.", "type": "string" }, "nameMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `name` property is editable." + "description": "Metadata that indicates whether the `name` property is editable. Read only." }, "optional": { "description": "When set to **true**, the recipient does not need to complete this tab to complete the signing process.", @@ -42596,11 +53389,11 @@ "description": "Metadata that indicates whether the `pageNumber` property is editable." }, "recipientId": { - "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", + "description": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.", "type": "string" }, "recipientIdGuid": { - "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one.", + "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only.", "type": "string" }, "recipientIdGuidMetadata": { @@ -42619,6 +53412,10 @@ "$ref": "#/definitions/propertyMetadata", "description": "Metadata that indicates whether the `scaleValue` property is editable." }, + "smartContractInformation": { + "$ref": "#/definitions/smartContractInformation", + "description": "" + }, "status": { "description": "The status of the tab. Possible values are:\n\n- `active`: The tab is active, but the recipient has not yet interacted with it.\n- `signed`: The recipient signed the tab.\n- `declined`: The recipient declined the envelope.\n- `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`).\n", "type": "string" @@ -42647,7 +53444,7 @@ "description": "Metadata that indicates whether the `tabId` property is editable." }, "tabLabel": { - "description": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n", + "description": "The label associated with the tab. This value may be an empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum Length: 500 characters.\n", "type": "string" }, "tabLabelMetadata": { @@ -42703,7 +53500,7 @@ "description": "Metadata that indicates whether the `width` property is editable." }, "xPosition": { - "description": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n", + "description": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (+0, -24)\n", "type": "string" }, "xPositionMetadata": { @@ -42711,7 +53508,7 @@ "description": "Metadata that indicates whether the `xPosition` property is editable." }, "yPosition": { - "description": "This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.", + "description": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (+0, -24)\n", "type": "string" }, "yPositionMetadata": { @@ -42740,7 +53537,7 @@ "type": "string" }, "commentsOnlyPrivateAndMention": { - "description": "When set to **true**, the user receives only comments in which that user name is mentioned.", + "description": "When set to **true**, the user receives only comments that mention their own user name.", "type": "string" }, "commentsReceiveAll": { @@ -42756,7 +53553,7 @@ "type": "string" }, "envelopeComplete": { - "description": "When set to **true**, the user receives notification that the envelope has been completed.", + "description": "When set to **true**, the user receives an email notification when the envelope has been completed.", "type": "string" }, "envelopeCorrected": { @@ -42776,11 +53573,11 @@ "type": "string" }, "offlineSigningFailed": { - "description": "When set to **true**, the user receives notification if the offline signing failed.", + "description": "When set to **true**, the user receives an email notification if offline signing failed.", "type": "string" }, "purgeDocuments": { - "description": "When set to **true**, the user receives notification of document purges.", + "description": "When set to **true**, the user receives an email notification when a document purge occurs.", "type": "string" }, "reassignedSigner": { @@ -42795,112 +53592,32 @@ "x-ds-definition-name": "signerEmailNotifications", "x-ms-summary": "An array of email notifications that specifies the email the user receives when they are a sender. When the specific email notification is set to true, the user receives those types of email notifications from DocuSign. The user inherits the default account sender email notification settings when the user is created." }, - "signHashDocument": { + "signHere": { "type": "object", "properties": { - "data": { - "description": "A Base64-encoded representation of the attachment that is used to upload and download the file. File attachments may be up to 50 MB in size.", - "type": "string" - }, - "documentId": { - "description": "Integer that identifies the document in the envelope.", - "type": "string" - }, - "format": { - "description": "", - "type": "string" - }, - "name": { + "anchorAllowWhiteSpaceInCharacters": { "description": "", "type": "string" }, - "remainingSignatures": { - "format": "int64", - "description": "", - "type": "integer" - }, - "revisions": { - "description": "", - "type": "array", - "items": { - "$ref": "#/definitions/revision" - } - }, - "signatureProperties": { - "$ref": "#/definitions/signatureProperties", + "anchorAllowWhiteSpaceInCharactersMetadata": { + "$ref": "#/definitions/propertyMetadata", "description": "" }, - "signatureType": { - "description": "Specifies the type of signature.", - "type": "string" - } - }, - "x-ds-definition-name": "signHashDocument", - "description": "", - "x-ms-summary": "" - }, - "signHashSessionInfoResponse": { - "type": "object", - "properties": { - "documents": { - "description": "Complex element contains the details on the documents in the envelope.", - "type": "array", - "items": { - "$ref": "#/definitions/signHashDocument" - } - }, - "envelopeId": { - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", - "type": "string" - }, - "language": { - "description": "Specifies the language for the Certificate of Completion in the response. The supported languages are: Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Dutch (nl), English US (en), French (fr), German (de), Italian (it), Japanese (ja), Korean (ko), Portuguese (pt), Portuguese (Brazil) (pt_BR), Russian (ru), Spanish (es). ", - "type": "string" - }, - "redirectionUrl": { - "description": "", - "type": "string" - }, - "remainingSignatureRequests": { - "format": "int64", - "description": "", - "type": "integer" - }, - "seal": { - "$ref": "#/definitions/seal", - "description": "Set of information related to the electronic seal used by the Trust Service Provider (TSP)" - }, - "sender": { - "$ref": "#/definitions/sender", - "description": "Information about the sender of the envelope." - }, - "user": { - "$ref": "#/definitions/user", - "description": "" - } - }, - "x-ds-definition-name": "signHashSessionInfoResponse", - "description": "", - "x-ms-summary": "" - }, - "signHere": { - "type": "object", - "properties": { "anchorCaseSensitive": { - "description": "Reserved for DocuSign.\n", + "description": "This property controls how [anchor tabs][AnchorTabs] are placed. When **true**, the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false**.\n\nFor example, when set to **true**, if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When set to **false**, `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**.\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place", "type": "string" }, "anchorCaseSensitiveMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "description": "Metadata that indicates whether the `anchorCaseSensitive` property is editable." }, "anchorHorizontalAlignment": { - "description": "Reserved for DocuSign.\n\n", + "description": "This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are :\n\n- `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value.\n- `right`: Aligns the tab’s left side with the last character of the matching anchor word.\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place\n", "type": "string" }, "anchorHorizontalAlignmentMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "description": "Metadata that indicates whether the `anchorHorizontalAlignment` property is editable." }, "anchorIgnoreIfNotPresent": { "description": "When set to **true**, this tab is ignored if the `anchorString` is not found in the document.", @@ -42911,12 +53628,12 @@ "description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable." }, "anchorMatchWholeWord": { - "description": "Reserved for DocuSign.\n\n", + "description": "When set to **true**, the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false**.\n\nFor example, when set to **true**, if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When set to **false**, if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**.\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTab]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place\n", "type": "string" }, "anchorMatchWholeWordMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "description": "Metadata that indicates whether the `anchorMatchWholeWord` property is editable." }, "anchorString": { "description": "Specifies the string to find in the document and use as the basis for tab placement.", @@ -42935,7 +53652,7 @@ "description": "Reserved for DocuSign." }, "anchorUnits": { - "description": "Specifies the units of the X and Y offset. Units may be pixels, millimeters, centimeters, or inches.", + "description": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n", "type": "string" }, "anchorUnitsMetadata": { @@ -42943,7 +53660,7 @@ "description": "Metadata that indicates whether the `anchorUnits` property is editable." }, "anchorXOffset": { - "description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.", + "description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n", "type": "string" }, "anchorXOffsetMetadata": { @@ -42951,7 +53668,7 @@ "description": "Metadata that indicates whether the `anchorXOffset` property is editable." }, "anchorYOffset": { - "description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.", + "description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n", "type": "string" }, "anchorYOffsetMetadata": { @@ -42975,7 +53692,7 @@ "description": "Metadata that indicates whether the `conditionalParentValue` property is editable." }, "customTabId": { - "description": "The DocuSign-generated custom tab id for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.", + "description": "The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.", "type": "string" }, "customTabIdMetadata": { @@ -43019,7 +53736,7 @@ "description": "Metadata that indicates whether the `fromPageNumber` property is editable." }, "height": { - "description": "The height of the tab in pixels.", + "description": "Not applicable to Sign Here tab.", "type": "string" }, "heightMetadata": { @@ -43034,13 +53751,17 @@ "$ref": "#/definitions/mergeField", "description": "Contains the information necessary to map the tab to a field in SalesForce." }, + "mergeFieldXml": { + "description": "", + "type": "string" + }, "name": { "description": "The name of the tab. For example, `Sign Here` or `Initial Here`.", "type": "string" }, "nameMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `name` property is editable." + "description": "Metadata that indicates whether the `name` property is editable. Read only." }, "optional": { "description": "When set to **true**, the recipient does not need to complete this tab to complete the signing process.", @@ -43059,11 +53780,11 @@ "description": "Metadata that indicates whether the `pageNumber` property is editable." }, "recipientId": { - "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", + "description": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.", "type": "string" }, "recipientIdGuid": { - "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one.", + "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only.", "type": "string" }, "recipientIdGuidMetadata": { @@ -43075,15 +53796,23 @@ "description": "Metadata that indicates whether the `recipientId` property is editable." }, "scaleValue": { - "description": "Sets the size of the tab. This field accepts values from `0.5` to `1.0`, where `1.0` represents full size and `0.5` is 50% of full size.", + "description": "Scales the size of the tab. This field accepts values from 0.5 to 2.0, where 0.5 is half the normal size, 1.0 is normal size, and 2.0 is twice the normal size.", "type": "string" }, "scaleValueMetadata": { "$ref": "#/definitions/propertyMetadata", "description": "Metadata that indicates whether the `scaleValue` property is editable." }, + "smartContractInformation": { + "$ref": "#/definitions/smartContractInformation", + "description": "" + }, + "stamp": { + "$ref": "#/definitions/stamp", + "description": "" + }, "stampType": { - "description": "If the recipient signs by using a personal stamp that is representative of their signature, this property specifies the stamp type.", + "description": "The type of stamp. Valid values are:\n\n- `signature`: A signature image. This is the default value.\n- `stamp`: A stamp image.\n- null", "type": "string" }, "stampTypeMetadata": { @@ -43118,7 +53847,7 @@ "description": "Metadata that indicates whether the `tabId` property is editable." }, "tabLabel": { - "description": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n", + "description": "The label associated with the tab. This value may be an empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum Length: 500 characters.\n", "type": "string" }, "tabLabelMetadata": { @@ -43166,7 +53895,7 @@ "description": "Metadata that indicates whether the `toolTip` property is editable." }, "width": { - "description": "The width of the tab in pixels.", + "description": "Not applicable to Sign Here tab.", "type": "string" }, "widthMetadata": { @@ -43174,7 +53903,7 @@ "description": "Metadata that indicates whether the `width` property is editable." }, "xPosition": { - "description": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n", + "description": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (+1, -7)\n", "type": "string" }, "xPositionMetadata": { @@ -43182,7 +53911,7 @@ "description": "Metadata that indicates whether the `xPosition` property is editable." }, "yPosition": { - "description": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired.\nMay be zero.\n\n
\n

\nThe `signHere` tab appears 21 points *lower*\nthan the value you provide here.\nTo align the tab as expected,\nsubtract 21 from the expected y-value.\n

\n

\nSee [Sign Here Tab Alignment](https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/#sign-here-tab-alignment)\n

\n
\n", + "description": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (+1, -7)\n", "type": "string" }, "yPositionMetadata": { @@ -43198,11 +53927,11 @@ "type": "object", "properties": { "created": { - "description": "The UTC DateTime when the workspace user authorization was created.", + "description": "The UTC DateTime when the signing group was created. Read only.", "type": "string" }, "createdBy": { - "description": "", + "description": "The name of the user who created the signing group.", "type": "string" }, "errorDetails": { @@ -43210,7 +53939,7 @@ "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." }, "groupEmail": { - "description": "", + "description": "The email address for the signing group. You can use a group email address to email all of the group members at the same time.", "type": "string" }, "groupName": { @@ -43218,19 +53947,19 @@ "type": "string" }, "groupType": { - "description": "The group type. Potential values for POST and PUT requests include:\n\n- `adminstrators`\n- `everyone`\n- `customGroup`\n\n", + "description": "The group type. Possible values include:\n\n- `adminstrators`\n- `everyone`\n- `customGroup`\n- `sharedSigningGroup`\n\n", "type": "string" }, "modified": { - "description": "", + "description": "The UTC DateTime when the signing group was last modified. Read only.", "type": "string" }, "modifiedBy": { - "description": "User ID (GUID) of the user who last modified this user record.", + "description": "The user id (GUID) of the user who last modified this user record.", "type": "string" }, "signingGroupId": { - "description": "The id of the signing group of which the recipient is a member, if applicable.", + "description": "When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once).", "type": "string" }, "users": { @@ -43242,8 +53971,8 @@ } }, "x-ds-definition-name": "signingGroup", - "description": "", - "x-ms-summary": "" + "description": "Contains details about a signing group. Signing groups enable you to send an envelope to a predefined group of recipients and have any one member of the group sign your documents. When you send an envelope to a signing group, anyone in the group can open it and sign it with their own signature.", + "x-ms-summary": "Contains details about a signing group. Signing groups enable you to send an envelope to a predefined group of recipients and have any one member of the group sign your documents. When you send an envelope to a signing group, anyone in the group can open it and sign it with their own signature." }, "signingGroupInformation": { "type": "object", @@ -43252,7 +53981,7 @@ "description": "A collection group objects containing information about the groups.", "type": "array", "items": { - "$ref": "#/definitions/SigningGroups" + "$ref": "#/definitions/signingGroup" } } }, @@ -43264,7 +53993,7 @@ "type": "object", "properties": { "email": { - "description": "Filters returned user records by the specified email address.", + "description": "", "type": "string" }, "errorDetails": { @@ -43295,48 +54024,48 @@ "description": "", "x-ms-summary": "" }, - "signSessionInfoRequest": { + "smartContractInformation": { "type": "object", "properties": { - "certificate": { - "description": "When set to **false**, the envelope signing certificate is removed from the download.", - "type": "string" - }, - "maxSignatureLength": { - "description": "", - "type": "string" - }, - "returnFormat": { + "code": { "description": "", "type": "string" }, - "signingLocation": { - "description": "Specifies the physical location where the signing takes place. It can have two enumeration values; `inPerson` and `online`. The default value is `online`.", + "uri": { + "description": "A URI containing the user ID.", "type": "string" } }, - "x-ds-definition-name": "signSessionInfoRequest", + "x-ds-definition-name": "smartContractInformation", "description": "", "x-ms-summary": "" }, "smartSection": { "type": "object", "properties": { + "anchorAllowWhiteSpaceInCharacters": { + "description": "", + "type": "string" + }, + "anchorAllowWhiteSpaceInCharactersMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "" + }, "anchorCaseSensitive": { - "description": "Reserved for DocuSign.\n", + "description": "This property controls how [anchor tabs][AnchorTabs] are placed. When **true**, the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false**.\n\nFor example, when set to **true**, if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When set to **false**, `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**.\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place", "type": "string" }, "anchorCaseSensitiveMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "description": "Metadata that indicates whether the `anchorCaseSensitive` property is editable." }, "anchorHorizontalAlignment": { - "description": "Reserved for DocuSign.\n\n", + "description": "This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are :\n\n- `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value.\n- `right`: Aligns the tab’s left side with the last character of the matching anchor word.\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place\n", "type": "string" }, "anchorHorizontalAlignmentMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "description": "Metadata that indicates whether the `anchorHorizontalAlignment` property is editable." }, "anchorIgnoreIfNotPresent": { "description": "When set to **true**, this tab is ignored if the `anchorString` is not found in the document.", @@ -43347,12 +54076,12 @@ "description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable." }, "anchorMatchWholeWord": { - "description": "Reserved for DocuSign.\n\n", + "description": "When set to **true**, the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false**.\n\nFor example, when set to **true**, if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When set to **false**, if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**.\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTab]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place\n", "type": "string" }, "anchorMatchWholeWordMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "description": "Metadata that indicates whether the `anchorMatchWholeWord` property is editable." }, "anchorString": { "description": "Specifies the string to find in the document and use as the basis for tab placement.", @@ -43371,7 +54100,7 @@ "description": "Reserved for DocuSign." }, "anchorUnits": { - "description": "Specifies the units of the X and Y offset. Units may be pixels, millimeters, centimeters, or inches.", + "description": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n", "type": "string" }, "anchorUnitsMetadata": { @@ -43379,7 +54108,7 @@ "description": "Metadata that indicates whether the `anchorUnits` property is editable." }, "anchorXOffset": { - "description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.", + "description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n", "type": "string" }, "anchorXOffsetMetadata": { @@ -43387,7 +54116,7 @@ "description": "Metadata that indicates whether the `anchorXOffset` property is editable." }, "anchorYOffset": { - "description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.", + "description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n", "type": "string" }, "anchorYOffsetMetadata": { @@ -43415,7 +54144,7 @@ "description": "Metadata that indicates whether the `conditionalParentValue` property is editable." }, "customTabId": { - "description": "The DocuSign-generated custom tab id for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.", + "description": "The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.", "type": "string" }, "customTabIdMetadata": { @@ -43427,7 +54156,7 @@ "description": "This object defines how the HTML section inside the `startAnchor` and `endAnchor` displays." }, "documentId": { - "description": "Integer that identifies the document in the envelope.", + "description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.", "type": "string" }, "documentIdMetadata": { @@ -43440,7 +54169,7 @@ }, "endPosition": { "$ref": "#/definitions/smartSectionAnchorPosition", - "description": "The last position in the result set. " + "description": "The last index position in the result set. " }, "errorDetails": { "$ref": "#/definitions/errorDetails", @@ -43490,6 +54219,10 @@ "$ref": "#/definitions/mergeField", "description": "Contains the information necessary to map the tab to a field in SalesForce." }, + "mergeFieldXml": { + "description": "", + "type": "string" + }, "overlayType": { "description": "The type of overlay to draw on the document. The following overlay types are supported:\n\n- `line`\n- `outline`\n", "type": "string" @@ -43499,7 +54232,7 @@ "description": "Metadata that indicates whether the `overlayType` property is editable." }, "pageNumber": { - "description": "The page number being accessed.", + "description": "Specifies the page number on which the tab is located.", "type": "string" }, "pageNumberMetadata": { @@ -43507,11 +54240,11 @@ "description": "Metadata that indicates whether the `pageNumber` property is editable." }, "recipientId": { - "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", + "description": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.", "type": "string" }, "recipientIdGuid": { - "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one.", + "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only.", "type": "string" }, "recipientIdGuidMetadata": { @@ -43531,20 +54264,24 @@ "type": "boolean" }, "shared": { - "description": "When **true**, the tab is shared.", + "description": "When set to **true**, this custom tab is shared.", "type": "string" }, "sharedMetadata": { "$ref": "#/definitions/propertyMetadata", "description": "Metadata that indicates whether the `shared` property is editable." }, + "smartContractInformation": { + "$ref": "#/definitions/smartContractInformation", + "description": "" + }, "startAnchor": { "description": "Specifies the beginning of the area in the HTML where the display settings will be applied. If you do not specify a start anchor, the beginning of the document will be used by default.\n\n**Note**: A start anchor, an end anchor, or both are required.", "type": "string" }, "startPosition": { "$ref": "#/definitions/smartSectionAnchorPosition", - "description": "The starting position of the current result set." + "description": "The starting index position of the current result set." }, "status": { "description": "The status of the tab. Possible values are:\n\n- `active`: The tab is active, but the recipient has not yet interacted with it.\n- `signed`: The recipient signed the tab.\n- `declined`: The recipient declined the envelope.\n- `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`).", @@ -43574,7 +54311,7 @@ "description": "Metadata that indicates whether the `tabId` property is editable." }, "tabLabel": { - "description": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n", + "description": "The label associated with the tab. This value may be an empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum Length: 500 characters.\n", "type": "string" }, "tabOrder": { @@ -43634,7 +54371,7 @@ "description": "Metadata that indicates whether the `xPosition` property is editable." }, "yPosition": { - "description": "This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.", + "description": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n", "type": "string" }, "yPositionMetadata": { @@ -43651,7 +54388,7 @@ "properties": { "pageNumber": { "format": "int32", - "description": "The page number being accessed.", + "description": "Specifies the page number on which the tab is located.", "type": "integer" }, "xPosition": { @@ -43661,7 +54398,7 @@ }, "yPosition": { "format": "double", - "description": "This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.", + "description": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n", "type": "number" } }, @@ -43758,6 +54495,10 @@ "description": "The label for the display section when it is expanded from a collapsed state. This label displays only on the first opening and is only valid with the value of the `display` property is `collapsed`.", "type": "string" }, + "preLabel": { + "description": "Enables you to add descriptive text that appears before a collapsed section or continue button.", + "type": "string" + }, "scrollToTopWhenOpened": { "description": "When **true** and the section is expanded, the position of the section close is scrolled to the top of the screen. This property is only valid when the value of the `display` property is `collapsed`.", "type": "boolean" @@ -43775,7 +54516,7 @@ "type": "object", "properties": { "email": { - "description": "Filters returned user records by the specified email address.", + "description": "The users email address.", "type": "string" }, "errorDetails": { @@ -43791,7 +54532,7 @@ "type": "string" }, "userName": { - "description": "The name of the user.", + "description": "The full user name for the account.", "type": "string" } }, @@ -43814,21 +54555,29 @@ "ssn": { "type": "object", "properties": { + "anchorAllowWhiteSpaceInCharacters": { + "description": "", + "type": "string" + }, + "anchorAllowWhiteSpaceInCharactersMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "" + }, "anchorCaseSensitive": { - "description": "Reserved for DocuSign.\n", + "description": "This property controls how [anchor tabs][AnchorTabs] are placed. When **true**, the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false**.\n\nFor example, when set to **true**, if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When set to **false**, `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**.\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place", "type": "string" }, "anchorCaseSensitiveMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "description": "Metadata that indicates whether the `anchorCaseSensitive` property is editable." }, "anchorHorizontalAlignment": { - "description": "Reserved for DocuSign.\n\n", + "description": "This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are :\n\n- `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value.\n- `right`: Aligns the tab’s left side with the last character of the matching anchor word.\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place\n", "type": "string" }, "anchorHorizontalAlignmentMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "description": "Metadata that indicates whether the `anchorHorizontalAlignment` property is editable." }, "anchorIgnoreIfNotPresent": { "description": "When set to **true**, this tab is ignored if the `anchorString` is not found in the document.", @@ -43839,12 +54588,12 @@ "description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable." }, "anchorMatchWholeWord": { - "description": "Reserved for DocuSign.\n\n", + "description": "When set to **true**, the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false**.\n\nFor example, when set to **true**, if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When set to **false**, if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**.\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTab]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place\n", "type": "string" }, "anchorMatchWholeWordMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "description": "Metadata that indicates whether the `anchorMatchWholeWord` property is editable." }, "anchorString": { "description": "Specifies the string to find in the document and use as the basis for tab placement.", @@ -43863,7 +54612,7 @@ "description": "Reserved for DocuSign." }, "anchorUnits": { - "description": "Specifies the units of the X and Y offset. Units may be pixels, millimeters, centimeters, or inches.", + "description": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n", "type": "string" }, "anchorUnitsMetadata": { @@ -43871,7 +54620,7 @@ "description": "Metadata that indicates whether the `anchorUnits` property is editable." }, "anchorXOffset": { - "description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.", + "description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n", "type": "string" }, "anchorXOffsetMetadata": { @@ -43879,7 +54628,7 @@ "description": "Metadata that indicates whether the `anchorXOffset` property is editable." }, "anchorYOffset": { - "description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.", + "description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n", "type": "string" }, "anchorYOffsetMetadata": { @@ -43895,7 +54644,7 @@ "description": "Metadata that indicates whether the `bold` property is editable." }, "concealValueOnDocument": { - "description": "When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender.\n\nWhen an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.", + "description": "When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender.\n\nWhen an envelope is completed the information is only available to the sender through the Form Data link in the DocuSign Console. The information on the downloaded document remains masked by asterisks.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.", "type": "string" }, "concealValueOnDocumentMetadata": { @@ -43919,7 +54668,7 @@ "description": "Metadata that indicates whether the `conditionalParentValue` property is editable." }, "customTabId": { - "description": "The DocuSign-generated custom tab id for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.", + "description": "The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.", "type": "string" }, "customTabIdMetadata": { @@ -43935,7 +54684,7 @@ "description": "Metadata that indicates whether the `disableAutoSize` property is editable." }, "documentId": { - "description": "Integer that identifies the document in the envelope.", + "description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.", "type": "string" }, "documentIdMetadata": { @@ -44034,13 +54783,17 @@ "$ref": "#/definitions/mergeField", "description": "Contains the information necessary to map the tab to a field in SalesForce." }, + "mergeFieldXml": { + "description": "", + "type": "string" + }, "name": { "description": "The name of the tab. For example, `Sign Here` or `Initial Here`.", "type": "string" }, "nameMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `name` property is editable." + "description": "Metadata that indicates whether the `name` property is editable. Read only." }, "originalValue": { "description": "The initial value of the tab when it was sent to the recipient. ", @@ -44059,11 +54812,11 @@ "description": "Metadata that indicates whether the `pageNumber` property is editable." }, "recipientId": { - "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", + "description": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.", "type": "string" }, "recipientIdGuid": { - "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one.", + "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only.", "type": "string" }, "recipientIdGuidMetadata": { @@ -44114,6 +54867,10 @@ "$ref": "#/definitions/propertyMetadata", "description": "Metadata that indicates whether the `shared` property is editable." }, + "smartContractInformation": { + "$ref": "#/definitions/smartContractInformation", + "description": "" + }, "status": { "description": "The status of the tab. Possible values are:\n\n- `active`: The tab is active, but the recipient has not yet interacted with it.\n- `signed`: The recipient signed the tab.\n- `declined`: The recipient declined the envelope.\n- `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`).\n", "type": "string" @@ -44142,7 +54899,7 @@ "description": "Metadata that indicates whether the `tabId` property is editable." }, "tabLabel": { - "description": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n", + "description": "The label associated with the tab. This value may be an empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum Length: 500 characters.\n", "type": "string" }, "tabLabelMetadata": { @@ -44230,7 +54987,7 @@ "description": "Metadata that indicates whether the `width` property is editable." }, "xPosition": { - "description": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n", + "description": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n", "type": "string" }, "xPositionMetadata": { @@ -44238,7 +54995,7 @@ "description": "Metadata that indicates whether the `xPosition` property is editable." }, "yPosition": { - "description": "This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.", + "description": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n", "type": "string" }, "yPositionMetadata": { @@ -44286,11 +55043,83 @@ "description": "", "x-ms-summary": "" }, + "stamp": { + "type": "object", + "properties": { + "adoptedDateTime": { + "description": "The UTC date and time when the user adopted the signature.", + "type": "string" + }, + "createdDateTime": { + "description": "The UTC DateTime when the item was created.", + "type": "string" + }, + "customField": { + "description": "", + "type": "string" + }, + "dateStampProperties": { + "$ref": "#/definitions/dateStampProperties", + "description": "Specifies the area in which a date stamp is placed. This parameter uses pixel positioning to draw a rectangle at the center of the stamp area. The stamp is superimposed on top of this central area.\n\nThis property contains the following information about the central rectangle:\n\n- `DateAreaX`: The X axis position of the top-left corner.\n- `DateAreaY`: The Y axis position of the top-left corner.\n- `DateAreaWidth`: The width of the rectangle.\n- `DateAreaHeight`: The height of the rectangle." + }, + "disallowUserResizeStamp": { + "description": "When set to **true**, users may not resize the stamp.", + "type": "string" + }, + "errorDetails": { + "$ref": "#/definitions/errorDetails", + "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." + }, + "externalID": { + "description": "Optionally specify an external identifier for the user's signature.", + "type": "string" + }, + "imageBase64": { + "description": "", + "type": "string" + }, + "imageType": { + "description": "Specificies the type of image. Valid values are:\n\n- `signature_image`\n- `initials_image`", + "type": "string" + }, + "lastModifiedDateTime": { + "description": "The date and time that the item was last modified.", + "type": "string" + }, + "phoneticName": { + "description": "The phonetic spelling of the `signatureName`.", + "type": "string" + }, + "signatureName": { + "description": "Specifies the user's signature name.", + "type": "string" + }, + "stampFormat": { + "description": "The format of a stamp. Valid values are:\n\n- `NameHanko`: The stamp represents only the signer's name.\n- `NameDateHanko`: The stamp represents the signer's name and the date. ", + "type": "string" + }, + "stampImageUri": { + "description": "The URI for retrieving the image of the user's stamp.", + "type": "string" + }, + "stampSizeMM": { + "description": "The physical height of the stamp image (in millimeters) that the stamp vendor recommends for displaying the image in PDF documents.", + "type": "string" + }, + "status": { + "description": "Indicates the envelope status. Valid values are:\n\n* sent - The envelope is sent to the recipients. \n* created - The envelope is saved as a draft and can be modified and sent later.", + "type": "string" + } + }, + "x-ds-definition-name": "stamp", + "description": "", + "x-ms-summary": "" + }, "supportedLanguages": { "type": "object", "properties": { "languages": { - "description": "", + "description": "A list of languages that you can use for a recipient's language setting. These are the languages that you can set for the standard email format and signing view for each recipient.\n\nFor example, in the recipient's email notification, this setting affects elements such as the standard introductory text describing the request to sign. It also determines the language used for buttons and tabs in both the email notification and the signing experience.\n\n**Note**: Setting a language for a recipient affects only the DocuSign standard text. Any custom text that you enter for the `emailBody` and `emailSubject` of the notification is not translated, and appears exactly as you enter it.\n\nExample:\n\n```\n{\n \"languages\": [\n {\n \"name\": \"Arabic (ar)\",\n \"value\": \"ar\"\n },\n {\n \"name\": \"Bulgarian (bg)\",\n \"value\": \"bg\"\n },\n .\n .\n .\n}\n```", "type": "array", "items": { "$ref": "#/definitions/nameValue" @@ -44298,14 +55127,14 @@ } }, "x-ds-definition-name": "supportedLanguages", - "description": "", - "x-ms-summary": "" + "description": "A list of supported languages.", + "x-ms-summary": "A list of supported languages." }, "tabAccountSettings": { "type": "object", "properties": { "allowTabOrder": { - "description": "Boolean that specifies whether the order for tabs used in signing can be set for the account.", + "description": "When set to **true**, account users can set a tab order for the signing process.\n\n**Note**: Only Admin users can change this setting.", "type": "string" }, "allowTabOrderMetadata": { @@ -44313,7 +55142,7 @@ "description": "Metadata that indicates whether the `allowTabOrder` property is editable.\n" }, "approveDeclineTabsEnabled": { - "description": "Boolean that specifies whether the approve and decline fields for use in the tagger and when sending envelopes are enabled.", + "description": "When **true**, approve and decline tabs are enabled.", "type": "string" }, "approveDeclineTabsMetadata": { @@ -44321,7 +55150,7 @@ "description": "Metadata that indicates whether the `approveDeclineTabs` property is editable.\n" }, "calculatedFieldsEnabled": { - "description": "Boolean that specifies whether calculated fields are enabled for the account.", + "description": "When **true**, [calculated fields](https://support.docusign.com/en/guides/ndse-user-guide-calculated-fields) are enabled for tabs.", "type": "string" }, "calculatedFieldsMetadata": { @@ -44329,15 +55158,15 @@ "description": "Metadata that indicates whether the `calculatedFields` property is editable.\n" }, "checkboxTabsEnabled": { - "description": "Boolean that specifies whether the checkbox field can be used in the tagger and for sending envelopes.", + "description": "When **true**, checkbox tabs are enabled.", "type": "string" }, "checkBoxTabsMetadata": { "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `checkboxTabsEnabled` property is editable." + "description": "Metadata that indicates whether the `checkBoxTabs` property is editable." }, "dataFieldRegexEnabled": { - "description": "Boolean that specifies whether the account can add regular expression (RegEx) field validation to a text field during sending, which will constrict what data the signer can enter.", + "description": "When **true**, regular expressions are enabled for tabs that contain data fields.", "type": "string" }, "dataFieldRegexMetadata": { @@ -44345,23 +55174,31 @@ "description": "Metadata that indicates whether the `dataFieldRegex` property is editable.\n" }, "dataFieldSizeEnabled": { - "description": "Boolean that specifies whether the account enables a sender to change the data field size during sending.", + "description": "When **true**, setting character limits for input fields is enabled.", "type": "string" }, "dataFieldSizeMetadata": { "$ref": "#/definitions/settingsMetadata", "description": "Metadata that indicates whether the `dataFieldSize` property is editable.\n" }, + "drawTabsEnabled": { + "description": "", + "type": "string" + }, + "drawTabsMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "" + }, "firstLastEmailTabsEnabled": { - "description": "Boolean that specifies whether an account can use the first, last, and email tags when sending an envelope.", + "description": "Reserved for DocuSign.", "type": "string" }, "firstLastEmailTabsMetadata": { "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `firstLastEmailTabs` property is editable.\n" + "description": "Reserved for DocuSign." }, "listTabsEnabled": { - "description": "Boolean that specifies whether the account can use the list field in the tagger and when sending envelopes.", + "description": "When **true**, list tabs are enabled.", "type": "string" }, "listTabsMetadata": { @@ -44369,15 +55206,23 @@ "description": "Metadata that indicates whether the `listTabs` property is editable.\n" }, "noteTabsEnabled": { - "description": "Boolean that specifies whether the account can use the note field in the tagger and when sending envelopes.", + "description": "When **true**, note tabs are enabled.", "type": "string" }, "noteTabsMetadata": { "$ref": "#/definitions/settingsMetadata", "description": "Metadata that indicates whether the `noteTabs` property is editable.\n" }, + "prefillTabsEnabled": { + "description": "", + "type": "string" + }, + "prefillTabsMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "" + }, "radioTabsEnabled": { - "description": "Boolean that specifies whether the account can use the radio button field in the tagger and when sending envelopes.", + "description": "When **true**, radio button tabs are enabled.", "type": "string" }, "radioTabsMetadata": { @@ -44385,7 +55230,7 @@ "description": "Metadata that indicates whether the `radioTabs` property is editable.\n" }, "savingCustomTabsEnabled": { - "description": "Boolean that specifies whether an account can create and save custom tabs.", + "description": "When **true**, saving custom tabs is enabled.", "type": "string" }, "savingCustomTabsMetadata": { @@ -44393,15 +55238,15 @@ "description": "Metadata that indicates whether the `savingCustomTabs` property is editable.\n" }, "senderToChangeTabAssignmentsEnabled": { - "description": "Boolean that specifies whether a sender can change the recipient to which an existing tag is assigned.", + "description": "Reserved for DocuSign.", "type": "string" }, "senderToChangeTabAssignmentsMetadata": { "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `senderToChangeTabAssignments` property is editable.\n" + "description": "Reserved for DocuSign." }, "sharedCustomTabsEnabled": { - "description": "Boolean that specifies whether an account member can share custom tabs to other members of the account.", + "description": "When **true**, shared custom tabs are enabled.", "type": "string" }, "sharedCustomTabsMetadata": { @@ -44409,7 +55254,7 @@ "description": "Metadata that indicates whether the `sharedCustomTabs` property is editable.\n" }, "tabDataLabelEnabled": { - "description": "Boolean that specifies whether an account admin can change the default (generated) name for a field.", + "description": "When set to **true**, [data\nlabels](https://support.docusign.com/en/videos/Data-Labels) are enabled.\n\n**Note**: Only Admin users can change this setting.\n", "type": "string" }, "tabDataLabelMetadata": { @@ -44417,15 +55262,15 @@ "description": "Metadata that indicates whether the `tabDataLabel` property is editable.\n" }, "tabLocationEnabled": { - "description": "Boolean that specifies whether an account admin can change the location of a tab by editing x,y props for a field.", + "description": "Reserved for DocuSign.", "type": "string" }, "tabLocationMetadata": { "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `tabLocation` property is editable.\n" + "description": "Reserved for DocuSign." }, "tabLockingEnabled": { - "description": "Boolean that specifies whether an account admin can lock the properties of a field.", + "description": "When set to **true**, tab locking is enabled.\n\n**Note**: Only Admin users can change this setting.\n", "type": "string" }, "tabLockingMetadata": { @@ -44433,15 +55278,15 @@ "description": "Metadata that indicates whether the `tabLocking` property is editable.\n" }, "tabScaleEnabled": { - "description": "Boolean that specifies whether an account admin can scale the size of a field.", + "description": "Reserved for DocuSign.", "type": "string" }, "tabScaleMetadata": { "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `tabScale` property is editable.\n" + "description": "Reserved for DocuSign." }, "tabTextFormattingEnabled": { - "description": "Boolean that specifies whether an account admin can change the text formatting (font, font size, bold, etc) of a field.", + "description": "When set to **true**, text formatting (such as font type, font size,\nfont color, bold, italic, and underline) is enabled for tabs that\nsupport formatting.\n\n**Note**: Only Admin users can change this setting.\n", "type": "string" }, "tabTextFormattingMetadata": { @@ -44449,7 +55294,7 @@ "description": "Metadata that indicates whether the `tabTextFormatting` property is editable.\n" }, "textTabsEnabled": { - "description": "Boolean that specifies whether the text field can be used in the tagger and for sending envelopes.", + "description": "When **true**, text tabs are enabled.", "type": "string" }, "textTabsMetadata": { @@ -44464,21 +55309,29 @@ "tabGroup": { "type": "object", "properties": { + "anchorAllowWhiteSpaceInCharacters": { + "description": "", + "type": "string" + }, + "anchorAllowWhiteSpaceInCharactersMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "" + }, "anchorCaseSensitive": { - "description": "Reserved for DocuSign.\n", + "description": "This property controls how [anchor tabs][AnchorTabs] are placed. When **true**, the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false**.\n\nFor example, when set to **true**, if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When set to **false**, `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**.\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place", "type": "string" }, "anchorCaseSensitiveMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "description": "Metadata that indicates whether the `anchorCaseSensitive` property is editable." }, "anchorHorizontalAlignment": { - "description": "Reserved for DocuSign.\n\n", + "description": "This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are :\n\n- `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value.\n- `right`: Aligns the tab’s left side with the last character of the matching anchor word.\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place\n", "type": "string" }, "anchorHorizontalAlignmentMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "description": "Metadata that indicates whether the `anchorHorizontalAlignment` property is editable." }, "anchorIgnoreIfNotPresent": { "description": "When set to **true**, this tab is ignored if the `anchorString` is not found in the document.", @@ -44489,12 +55342,12 @@ "description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable." }, "anchorMatchWholeWord": { - "description": "Reserved for DocuSign.\n\n", + "description": "When set to **true**, the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false**.\n\nFor example, when set to **true**, if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When set to **false**, if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**.\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTab]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place\n", "type": "string" }, "anchorMatchWholeWordMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "description": "Metadata that indicates whether the `anchorMatchWholeWord` property is editable." }, "anchorString": { "description": "Specifies the string to find in the document and use as the basis for tab placement.", @@ -44513,7 +55366,7 @@ "description": "Reserved for DocuSign." }, "anchorUnits": { - "description": "Specifies the units of the X and Y offset. Units may be pixels, millimeters, centimeters, or inches.", + "description": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n", "type": "string" }, "anchorUnitsMetadata": { @@ -44521,7 +55374,7 @@ "description": "Metadata that indicates whether the `anchorUnits` property is editable." }, "anchorXOffset": { - "description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.", + "description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n", "type": "string" }, "anchorXOffsetMetadata": { @@ -44529,7 +55382,7 @@ "description": "Metadata that indicates whether the `anchorXOffset` property is editable." }, "anchorYOffset": { - "description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.", + "description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n", "type": "string" }, "anchorYOffsetMetadata": { @@ -44553,7 +55406,7 @@ "description": "Metadata that indicates whether the `conditionalParentValue` property is editable." }, "customTabId": { - "description": "The DocuSign-generated custom tab id for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.", + "description": "The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.", "type": "string" }, "customTabIdMetadata": { @@ -44561,7 +55414,7 @@ "description": "Metadata that indicates whether the `customTabId` property is editable." }, "documentId": { - "description": "Integer that identifies the document in the envelope.", + "description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.", "type": "string" }, "documentIdMetadata": { @@ -44605,7 +55458,7 @@ "description": "Metadata that indicates whether the `groupLabel` property is editable." }, "groupRule": { - "description": "The rule that is selected by default when a user is adding validation for a tab group in the UI.", + "description": "Specifies how `maximumAllowed` and `minimumRequired`\nare interpreted when selecting tabs in a `tabGroup`.\n\nPossible values are:\n\n- `SelectAtLeast`\n- `SelectAtMost`\n- `SelectExactly`\n- `SelectARange`\n\n", "type": "string" }, "groupRuleMetadata": { @@ -44632,6 +55485,10 @@ "$ref": "#/definitions/mergeField", "description": "Contains the information necessary to map the tab to a field in SalesForce." }, + "mergeFieldXml": { + "description": "", + "type": "string" + }, "minimumRequired": { "description": "The minimum number of of tabs within the `tabGroup` that should be checked, populated, or signed. This property is used for validation.", "type": "string" @@ -44641,7 +55498,7 @@ "description": "Metadata that indicates whether the `minimumRequired` property is editable." }, "pageNumber": { - "description": "The page number being accessed.", + "description": "Specifies the page number on which the tab is located.", "type": "string" }, "pageNumberMetadata": { @@ -44649,11 +55506,11 @@ "description": "Metadata that indicates whether the `pageNumber` property is editable." }, "recipientId": { - "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", + "description": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.", "type": "string" }, "recipientIdGuid": { - "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one.", + "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only.", "type": "string" }, "recipientIdGuidMetadata": { @@ -44664,6 +55521,10 @@ "$ref": "#/definitions/propertyMetadata", "description": "Metadata that indicates whether the `recipientId` property is editable." }, + "smartContractInformation": { + "$ref": "#/definitions/smartContractInformation", + "description": "" + }, "status": { "description": "The status of the tab. Possible values are:\n\n- `active`: The tab is active, but the recipient has not yet interacted with it.\n- `signed`: The recipient signed the tab.\n- `declined`: The recipient declined the envelope.\n- `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`).", "type": "string" @@ -44764,7 +55625,7 @@ "description": "Metadata that indicates whether the `xPosition` property is editable." }, "yPosition": { - "description": "This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.", + "description": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n", "type": "string" }, "yPositionMetadata": { @@ -44784,11 +55645,11 @@ "type": "string" }, "anchorCaseSensitive": { - "description": "Reserved for DocuSign.\n", + "description": "This property controls how [anchor tabs][AnchorTabs] are placed. When **true**, the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false**.\n\nFor example, when set to **true**, if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When set to **false**, `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**.\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place", "type": "string" }, "anchorHorizontalAlignment": { - "description": "Reserved for DocuSign.\n\n", + "description": "This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are :\n\n- `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value.\n- `right`: Aligns the tab’s left side with the last character of the matching anchor word.\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place\n", "type": "string" }, "anchorIgnoreIfNotPresent": { @@ -44796,27 +55657,31 @@ "type": "string" }, "anchorMatchWholeWord": { - "description": "Reserved for DocuSign.\n\n", + "description": "When set to **true**, the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false**.\n\nFor example, when set to **true**, if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When set to **false**, if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**.\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTab]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place\n", "type": "string" }, "anchorUnits": { - "description": "Specifies the units of the X and Y offset. Units may be pixels, millimeters, centimeters, or inches.", + "description": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n", "type": "string" }, "anchorXOffset": { - "description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.", + "description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n", "type": "string" }, "anchorYOffset": { - "description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.", + "description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n", "type": "string" }, "bold": { "description": "When set to **true**, the information in the tab is bold.", "type": "string" }, + "collaborative": { + "description": "", + "type": "string" + }, "concealValueOnDocument": { - "description": "When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender.\n\nWhen an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.", + "description": "When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender.\n\nWhen an envelope is completed the information is only available to the sender through the Form Data link in the DocuSign Console. The information on the downloaded document remains masked by asterisks.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.", "type": "string" }, "createdByDisplayName": { @@ -44828,7 +55693,7 @@ "type": "string" }, "customTabId": { - "description": "The DocuSign-generated custom tab id for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.", + "description": "The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.", "type": "string" }, "disableAutoSize": { @@ -44868,14 +55733,14 @@ "type": "string" }, "items": { - "description": "", + "description": "If the tab is a list, this represents the values that are possible for the tab.", "type": "array", "items": { "type": "string" } }, "lastModified": { - "description": "Utc date and time the comment was last updated (can only be done by creator.)", + "description": "The UTC DateTime this object was last modified. This is in ISO8601 format.", "type": "string" }, "lastModifiedByDisplayName": { @@ -44891,7 +55756,7 @@ "type": "string" }, "maximumLength": { - "description": "", + "description": "The maximum number of entry characters supported by the custom tab.", "type": "string" }, "mergeField": { @@ -44903,21 +55768,29 @@ "type": "string" }, "paymentItemCode": { - "description": "", + "description": "If the custom tab is for a payment request, this is the external code for the item associated with the charge. For example, this might be your product id.\n\nExample: `SHAK1`\n\nMaximum Length: 100 characters.", "type": "string" }, "paymentItemDescription": { - "description": "", + "description": "If the custom tab is for a payment request, this is the description of the item associated with the charge.\n\nExample: `The Danish play by Shakespeare`\n\nMaximum Length: 100 characters.", "type": "string" }, "paymentItemName": { - "description": "", + "description": "If the custom tab is for a payment request, this is the name of the item associated with the charge.\n\nMaximum Length: 100 characters.\n\nExample: `Hamlet`", + "type": "string" + }, + "requireAll": { + "description": "When set to **true** and shared is true, information must be entered in this field to complete the envelope. ", "type": "string" }, "required": { "description": "When set to **true**, the signer is required to fill out this tab.", "type": "string" }, + "requireInitialOnSharedChange": { + "description": "Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.", + "type": "string" + }, "scaleValue": { "description": "Sets the size of the tab. This field accepts values from `0.5` to `1.0`, where `1.0` represents full size and `0.5` is 50% of full size.", "type": "string" @@ -44927,11 +55800,11 @@ "type": "string" }, "shared": { - "description": "When **true**, the tab is shared.", + "description": "When set to **true**, this custom tab is shared.", "type": "string" }, "stampType": { - "description": "If the recipient signs by using a personal stamp that is representative of their signature, this property specifies the stamp type.", + "description": "The type of stamp. Valid values are:\n\n- `signature`: A signature image. This is the default value.\n- `stamp`: A stamp image.\n- null", "type": "string" }, "stampTypeMetadata": { @@ -44939,11 +55812,11 @@ "description": "Metadata that indicates whether the `stampType` property is editable." }, "tabLabel": { - "description": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n", + "description": "The label associated with the tab. This value may be an empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum Length: 500 characters.\n", "type": "string" }, "type": { - "description": "Type of user:\n- `type_owner`\n- `type_participant`", + "description": "The type of this tab. Values are: Approve, CheckBox, Company, Date, DateSigned,\tDecline, Email,\tEmailAddress, EnvelopeId, FirstName, Formula, FullName,\tInitialHere, InitialHereOptional, LastName, List, Note, Number,\tRadio, SignerAttachment, SignHere, SignHereOptional, Ssn, Text, Title, Zip5, or Zip5Dash4.", "type": "string" }, "underline": { @@ -44971,10 +55844,10 @@ "type": "object", "properties": { "tabs": { - "description": "A list of `signHere` tabs, which can be used to add a visual representation for an electronic seal in a document.", + "description": "A list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients.", "type": "array", "items": { - "$ref": "#/definitions/CustomTabs" + "$ref": "#/definitions/tabMetadata" } } }, @@ -44986,14 +55859,14 @@ "type": "object", "properties": { "approveTabs": { - "description": "A list of\n[Approve tabs][approve].\n\nAn Approve tab enables\nthe recipient to approve documents without\nplacing a signature or initials on the document. If the\nrecipient clicks the tab during the signing process, the\nrecipient is considered to have signed the document. No\ninformation is shown on the document of the approval, but it\nis recorded as a signature in the envelope history.\nThe value of an approve tab can't be set.\n\n[approve]:\t\t https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/approve\n", + "description": "A list of\n[Approve tabs][approve].\n\nAn Approve tab enables\nthe recipient to approve documents without\nplacing a signature or initials on the document. If the\nrecipient clicks the tab during the signing process, the\nrecipient is considered to have signed the document. No\ninformation is shown on the document of the approval, but it\nis recorded as a signature in the envelope history.\nThe value of an approve tab can't be set.\n\n[approve]:\t\t https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { "$ref": "#/definitions/approve" } }, "checkboxTabs": { - "description": "A list of\n[Checkbox tabs][checkbox].\n\n\nA Checkbox tab enables the recipient to select a yes/no (on/off) option. This value can be set.\n\n\n[checkbox]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/checkbox\n", + "description": "A list of\n[Checkbox tabs][checkbox].\n\n\nA Checkbox tab enables the recipient to select a yes/no (on/off) option. This value can be set.\n\n\n[checkbox]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { "$ref": "#/definitions/checkbox" @@ -45006,118 +55879,174 @@ "$ref": "#/definitions/commentThread" } }, + "commissionCountyTabs": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/commissionCounty" + } + }, + "commissionExpirationTabs": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/commissionExpiration" + } + }, + "commissionNumberTabs": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/commissionNumber" + } + }, + "commissionStateTabs": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/commissionState" + } + }, "companyTabs": { - "description": "A list of \n[Company tabs][company].\n\n\nA Company tab displays a field for the name of the recipient's company. This value can't be set.\n\n\n\n[company]: https://developers.docusign.com/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/company \n", + "description": "A list of\n[Company tabs][company].\n\n\nA Company tab displays a field for the name of the recipient's company. This value can't be set.\n\n\n\n[company]: https://developers.docusign.com/docs/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/company\n", "type": "array", "items": { "$ref": "#/definitions/company" } }, + "currencyTabs": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/currency" + } + }, "dateSignedTabs": { - "description": "A list of \n[Date Signed tabs][dateSigned].\n\n\nA Date Signed tab displays the date that the recipient signed the document. This value can't be set.\n\n[dateSigned]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/dateSigned \n", + "description": "A list of\n[Date Signed tabs][dateSigned].\n\n\nA Date Signed tab displays the date that the recipient signed the document. This value can't be set.\n\n[dateSigned]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { "$ref": "#/definitions/dateSigned" } }, "dateTabs": { - "description": "A list of \n[Date tabs][date].\n\nA Date tab enables the recipient to enter a date. This value can't be set. The tooltip for this tab recommends the date format MM/DD/YYYY, but this format is not enforced. The system retains the format that the recipient enters.\n\n**Note**: If you need to enforce a specific date format, we recommend that you use a Text tab with a validation pattern and validation message.\n\n\n[date]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/date \n", + "description": "A list of\n[Date tabs][date].\n\nA Date tab enables the recipient to enter a date. This value can't be set. The tooltip for this tab recommends the date format MM/DD/YYYY, but this format is not enforced. The system retains the format that the recipient enters.\n\n**Note**: If you need to enforce a specific date format, we recommend that you use a Text tab with a validation pattern and validation message.\n\n\n[date]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { "$ref": "#/definitions/date" } }, "declineTabs": { - "description": "A list of \n[Decline tabs][decline].\n\nA Decline tab enables the recipient to decline the envelope. If the recipient clicks the tab during the signing process, the envelope is voided. The value of this tab can't be set.\n\n\n[decline]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/decline \n", + "description": "A list of\n[Decline tabs][decline].\n\nA Decline tab enables the recipient to decline the envelope. If the recipient clicks the tab during the signing process, the envelope is voided. The value of this tab can't be set.\n\n\n[decline]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { "$ref": "#/definitions/decline" } }, + "drawTabs": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/draw" + } + }, "emailAddressTabs": { - "description": "A list of \n[Email Address tabs][emailAddress].\n\nAn Email Address tab displays the recipient's email as entered in the recipient information. This value can't be set.\n\n\n[emailAddress]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/emailAddress \n", + "description": "A list of\n[Email Address tabs][emailAddress].\n\nAn Email Address tab displays the recipient's email as entered in the recipient information. This value can't be set.\n\n\n[emailAddress]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { "$ref": "#/definitions/emailAddress" } }, "emailTabs": { - "description": "A list of \n[Email tabs][email].\n\nAn Email tab enables the recipient to enter an email address.\nThis is a one-line field that checks that a valid email\naddress is entered. It uses the same parameters as a Text\ntab, with the validation message and pattern set for email\ninformation. This value can be set.\n\nWhen getting information that includes\nthis tab type, the original value of the tab when the\nassociated envelope was sent is included in the response.\n\n[email]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/email \n", + "description": "A list of\n[Email tabs][email].\n\nAn Email tab enables the recipient to enter an email address.\nThis is a one-line field that checks that a valid email\naddress is entered. It uses the same parameters as a Text\ntab, with the validation message and pattern set for email\ninformation. This value can be set.\n\nWhen getting information that includes\nthis tab type, the original value of the tab when the\nassociated envelope was sent is included in the response.\n\n[email]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { "$ref": "#/definitions/email" } }, "envelopeIdTabs": { - "description": "A list of \n[Envelope ID tabs][envelopeId].\n\nAn Envelope ID tab displays the envelope ID. Recipients cannot enter or change the information in this tab. This value can't be set.\n\n\n[envelopeId]: https://developers.docusign.com/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/envelopeId \n", + "description": "A list of\n[Envelope ID tabs][envelopeId].\n\nAn Envelope ID tab displays the envelope ID. Recipients cannot enter or change the information in this tab. This value can't be set.\n\n\n[envelopeId]: https://developers.docusign.com/docs/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/envelopeId\n", "type": "array", "items": { "$ref": "#/definitions/envelopeId" } }, "firstNameTabs": { - "description": "A list of \n[First Name tabs][firstName].\n\nA First Name tab displays the recipient's first name. The system automatically populates this field by splitting the name in the recipient information on spaces. This value can't be set.\n\n\n[firstName]: https://developers.docusign.com/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/firstName \n", + "description": "A list of\n[First Name tabs][firstName].\n\nA First Name tab displays the recipient's first name. The system automatically populates this field by splitting the name in the recipient information on spaces. This value can't be set.\n\n\n[firstName]: https://developers.docusign.com/docs/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/firstName\n", "type": "array", "items": { "$ref": "#/definitions/firstName" } }, "formulaTabs": { - "description": "A list of [Formula tabs][formulaTab].\n\nThe value of a Formula tab is calculated from the values of other number or date tabs in the document. When the recipient completes the underlying fields, the Formula tab calculates and displays the result. This value can be set.\n\nThe `formula` property of the tab contains the references to the underlying tabs. To learn more about formulas, see [Calculated Fields][calculatedfields].\n\nIf a Formula tab contains a `paymentDetails` property, the tab is considered a payment item. To learn more about payments, see [Requesting Payments Along with Signatures][paymentguide].\n\n[calculatedfields]: https://support.docusign.com/en/guides/ndse-user-guide-calculated-fields\n[paymentguide]: https://support.docusign.com/en/guides/requesting-payments-along-with-signatures\n[formulaTab]:\t \thttps://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/formulaTab\n", + "description": "A list of [Formula tabs][formulaTab].\n\nThe value of a Formula tab is calculated from the values of other number or date tabs in the document. When the recipient completes the underlying fields, the Formula tab calculates and displays the result. This value can be set.\n\nThe `formula` property of the tab contains the references to the underlying tabs. To learn more about formulas, see [Calculated Fields][calculatedfields].\n\nIf a Formula tab contains a `paymentDetails` property, the tab is considered a payment item. To learn more about payments, see [Requesting Payments Along with Signatures][paymentguide].\n\n[calculatedfields]: https://support.docusign.com/en/guides/ndse-user-guide-calculated-fields\n[paymentguide]: https://support.docusign.com/en/guides/requesting-payments-along-with-signatures\n[formulaTab]:\t \thttps://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { "$ref": "#/definitions/formulaTab" } }, "fullNameTabs": { - "description": "A list of \n[Full Name tabs][fullName].\n\nA Full Name tab displays the recipient's full name. This value can't be set.\n\n\n[fullName]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/fullName \n", + "description": "A list of\n[Full Name tabs][fullName].\n\nA Full Name tab displays the recipient's full name. This value can't be set.\n\n\n[fullName]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { "$ref": "#/definitions/fullName" } }, "initialHereTabs": { - "description": "A list of \n[Initial Here tabs][initialHere].\n\nThis type of tab enables the recipient to initial the document. May be optional. This value can't be set.\n\n[initialHere]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/initialHere \n", + "description": "A list of\n[Initial Here tabs][initialHere].\n\nThis type of tab enables the recipient to initial the document. May be optional. This value can't be set.\n\n[initialHere]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { "$ref": "#/definitions/initialHere" } }, "lastNameTabs": { - "description": "A list of \n[Last Name tabs][lastName].\n\nA Last Name tab displays the recipient's last name. The system automatically populates this field by splitting the name in the recipient information on spaces. This value can't be set.\n\n\n[lastName]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/lastName \n", + "description": "A list of\n[Last Name tabs][lastName].\n\nA Last Name tab displays the recipient's last name. The system automatically populates this field by splitting the name in the recipient information on spaces. This value can't be set.\n\n\n[lastName]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { "$ref": "#/definitions/lastName" } }, "listTabs": { - "description": "A list of [List tabs][list].\n\nA List tab enables the recipient to choose from a list of options. You specify the options in the `listItems` property. This value can't be set.\n\n\n\n[list]: https://developers.docusign.com/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/list \n", + "description": "An array of List tabs.\n\nA List tab enables the recipient to choose from a list of options. You specify the options in the `listItems` property. This value can't be set.\n\nFind descriptions of all tab types in\nthe [EnvelopeRecipientTabs Resource][ert].\n\n[ert]: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n", "type": "array", "items": { "$ref": "#/definitions/list" } }, "notarizeTabs": { - "description": "A list of [Notarize tabs][notarize].\n\nA Notarize tab alerts notary recipients that they must take action on the page. This value can be set.\n\n**Note**: Only one notarize tab can appear on a page.\n\n[notarize]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/notarize \n", + "description": "A list of [Notarize tabs][notarize].\n\nA Notarize tab alerts notary recipients that they must take action on the page. This value can be set.\n\n**Note**: Only one notarize tab can appear on a page.\n\n[notarize]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { "$ref": "#/definitions/notarize" } }, + "notarySealTabs": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/notarySeal" + } + }, "noteTabs": { - "description": "A list of \n[Note tabs][note].\n\nA Note tab displays additional information to the recipient in the form of a note. This value can be set.\n\n[note]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/note \n", + "description": "A list of\n[Note tabs][note].\n\nA Note tab displays additional information to the recipient in the form of a note. This value can be set.\n\n[note]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { "$ref": "#/definitions/note" } }, "numberTabs": { - "description": "A list of \n[Number tabs][number].\n\nA Number tab enables the recipient to enter numbers and decimal points (.). This value can be set.\n\n\n\n[number]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/number \n", + "description": "A list of\n[Number tabs][number].\n\nA Number tab enables the recipient to enter numbers and decimal points (.). This value can be set.\n\n\n\n[number]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { "$ref": "#/definitions/number" } }, + "phoneNumberTabs": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/phoneNumber" + } + }, "polyLineOverlayTabs": { "description": "This type of tab enables the recipient to strike through document text. This value can't be set. ", "type": "array", @@ -45125,22 +56054,26 @@ "$ref": "#/definitions/polyLineOverlay" } }, + "prefillTabs": { + "$ref": "#/definitions/prefillTabs", + "description": "" + }, "radioGroupTabs": { - "description": "A list of [Radio Group tabs][radioGroup].\n\nA Radio Group tab places a group of radio buttons on a document. The `radios` property is used to add and place the radio\nbuttons associated with the group. Only one radio button can be selected in a group. This value can be set.\n\n\n[radioGroup]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/radioGroup \n", + "description": "A list of [Radio Group tabs][radioGroup].\n\nA Radio Group tab places a group of radio buttons on a document. The `radios` property is used to add and place the radio\nbuttons associated with the group. Only one radio button can be selected in a group. This value can be set.\n\n\n[radioGroup]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { "$ref": "#/definitions/radioGroup" } }, "signerAttachmentTabs": { - "description": "A list of \n[Signer Attachment tabs][signerAttachment].\n\nThis type of tab enables the recipient to attach supporting documents to an envelope. This value can't be set.\n\n\n[signerAttachment]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/signerAttachment \n", + "description": "A list of\n[Signer Attachment tabs][signerAttachment].\n\nThis type of tab enables the recipient to attach supporting documents to an envelope. This value can't be set.\n\n\n[signerAttachment]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { "$ref": "#/definitions/signerAttachment" } }, "signHereTabs": { - "description": "A list of \n[Sign Here tabs][signHere].\n\nThis type of tab enables the recipient to sign a document. May be optional. This value can't be set.\n\n[signHere]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/signHere \n", + "description": "A list of\n[Sign Here tabs][signHere].\n\nThis type of tab enables the recipient to sign a document. May be optional. This value can't be set.\n\n[signHere]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { "$ref": "#/definitions/signHere" @@ -45154,7 +56087,7 @@ } }, "ssnTabs": { - "description": "A list of \n[SSN tabs][ssn].\n\nAn SSN tab contains a one-line field that enables the recipient to enter a Social Security Number (SSN) with or without\ndashes. It uses the same parameters as a Text tab, with the validation message and pattern set for SSN information. This value can be set.\n\n\n[ssn]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/ssn \n", + "description": "A list of\n[SSN tabs][ssn].\n\nAn SSN tab contains a one-line field that enables the recipient to enter a Social Security Number (SSN) with or without\ndashes. It uses the same parameters as a Text tab, with the validation message and pattern set for SSN information. This value can be set.\n\n\n[ssn]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { "$ref": "#/definitions/ssn" @@ -45168,28 +56101,28 @@ } }, "textTabs": { - "description": "A list of \n[Text tabs][text].\n\nA text tab enables the recipient to enter free text. This value can be set.\n\n[text]: https://developers.docusign.com/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/text \n", + "description": "A list of\nText tabs.\n\nA text tab enables the recipient to enter free text. This value can be set.\n\nFind descriptions of all tab types in\nthe [EnvelopeRecipientTabs Resource][ert].\n\n[ert]: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n", "type": "array", "items": { "$ref": "#/definitions/text" } }, "titleTabs": { - "description": "A list of \n[Title tabs][title].\n\nA Title tab displays the recipient's title. This value can't be set.\n\n\n[title]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/title \n", + "description": "A list of\n[Title tabs][title].\n\nA Title tab displays the recipient's title. This value can't be set.\n\n\n[title]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { "$ref": "#/definitions/title" } }, "viewTabs": { - "description": "A list of \n[View tabs][view].\n\nA View tab is used with an Approve tab to handle supplemental documents. This value can be set.\n\n[view]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/view \n", + "description": "A list of\n[View tabs][view].\n\nA View tab is used with an Approve tab to handle supplemental documents. This value can be set.\n\n[view]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { "$ref": "#/definitions/view" } }, "zipTabs": { - "description": "A list of \n[Zip tabs][zip].\n\nA Zip tab enables the recipient to enter a ZIP code. The ZIP code can be five digits or nine digits ( in ZIP+4 format), and can be entered with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for ZIP code information. This value can be set.\n\n\n[zip]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/zip\n", + "description": "A list of\n[Zip tabs][zip].\n\nA Zip tab enables the recipient to enter a ZIP code. The ZIP code can be five digits or nine digits ( in ZIP+4 format), and can be entered with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for ZIP code information. This value can be set.\n\n\n[zip]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { "$ref": "#/definitions/zip" @@ -45197,8 +56130,8 @@ } }, "x-ds-definition-name": "tabs", - "description": "", - "x-ms-summary": "" + "description": "Tabs indicate to recipients where they should sign, initial, or enter data on a document. They are represented graphically as symbols on documents at the time of signing. Tabs can also display data to the recipients.", + "x-ms-summary": "Tabs indicate to recipients where they should sign, initial, or enter data on a document. They are represented graphically as symbols on documents at the time of signing. Tabs can also display data to the recipients." }, "templateCustomFields": { "type": "object", @@ -45233,7 +56166,7 @@ } }, "templateId": { - "description": "The ID of the template.", + "description": "The unique identifier of the template. If this is not provided, DocuSign will generate a value. ", "type": "string" } }, @@ -45344,7 +56277,7 @@ "type": "string" }, "editors": { - "description": "A list of editors on the document.", + "description": "A list of users who can edit the envelope.", "type": "array", "items": { "$ref": "#/definitions/editor" @@ -45368,6 +56301,13 @@ "$ref": "#/definitions/intermediary" } }, + "notaries": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/notaryRecipient" + } + }, "recipientCount": { "description": "The list of recipient event statuses that will trigger Connect to send updates to the url. It can be a two-part list with:\n\n* recipientEventStatusCode - The recipient status, this can be Sent, Delivered, Completed, Declined, AuthenticationFailed, and AutoResponded.\n* includeDocuments - When set to **true**, the envelope time zone information is included in the message.", "type": "string" @@ -45419,10 +56359,10 @@ }, "emailNotification": { "$ref": "#/definitions/recipientEmailNotification", - "description": "An optional complex type that sets a specific email subject and body for this recipient's notification email. \n\n**Note**: If you use this field to set a specific email notification for one recipient, you must also set the email notification for the other recipients. Using this field for one or more recipients negates the Envelope `Subject` and `EmailBlurb` property settings. " + "description": "An optional complex type that sets a specific email subject and body for this recipient's notification email. \n\n**Note**: You can set the `emailNotification` property separately for each recipient. If you set the value only for certain recipients, the other recipients will inherit the this value from the top-level `emailSubject` and `emailBlurb`. " }, "embeddedRecipientStartURL": { - "description": "Specifies a sender-provided valid URL string for redirecting an embedded recipient. When this option is used, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the recipient clicks the document link in the email, the recipient is redirected through DocuSign to the specified URL to complete the required actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. \n\nIf set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation launched by a partner.\n\nIt is important to understand that in a typical embedded workflow, the authentication of an embedded recipient is the responsibility of the sending application. DocuSign expects that senders will follow their own processes for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process is initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process, bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient.\n\nIf the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: `envelopeId`, `recipientId`, `recipientName`, `recipientEmail`, and `customFields`. The `customFields` property must be set for the recipient or envelope. The merge fields are enclosed in double brackets. \n\n*Example*: \n\n`http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` ", + "description": "Specifies a sender-provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. \n\nIf set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation launched by a partner.\n\nIt is important to understand that in a typical embedded workflow, the authentication of an embedded recipient is the responsibility of the sending application. DocuSign expects that senders will follow their own processes for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process is initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process, bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient.\n\nIf the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: `envelopeId`, `recipientId`, `recipientName`, `recipientEmail`, and `customFields`. The `customFields` property must be set for the recipient or envelope. The merge fields are enclosed in double brackets. \n\n*Example*: \n\n`http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` ", "type": "string" }, "inPersonSignerName": { @@ -45441,7 +56381,7 @@ } }, "roleName": { - "description": "Optional element. Specifies the role name associated with the recipient.

This is required when working with template recipients.", + "description": "Optional element. Specifies the role name associated with the recipient.

This property is required when you are working with template recipients.", "type": "string" }, "routingOrder": { @@ -45449,12 +56389,12 @@ "type": "string" }, "signingGroupId": { - "description": "The id of the signing group of which the recipient is a member, if applicable.", + "description": "When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once).", "type": "string" }, "tabs": { "$ref": "#/definitions/EnvelopeRecipientTabs", - "description": "A list of `signHere` tabs, which can be used to add a visual representation for an electronic seal in a document." + "description": "A list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients." } }, "x-ds-definition-name": "templateRole", @@ -45477,7 +56417,7 @@ "type": "string" }, "shared": { - "description": "How the template is shared. One of:\n\n- `not_shared`\n- `shared_to`\n- `shared_from`\n- `shared_to_and_from`\n", + "description": "How the template is shared. One of:\n\n- `not_shared`\n- `shared_to`\n", "type": "string" }, "sharedGroups": { @@ -45539,7 +56479,7 @@ "description": "" }, "uri": { - "description": "URI containing the user ID.", + "description": "A URI containing the user ID.", "type": "string" } }, @@ -45551,14 +56491,14 @@ "type": "object", "properties": { "approveTabs": { - "description": "A list of\n[Approve tabs][approve].\n\nAn Approve tab enables\nthe recipient to approve documents without\nplacing a signature or initials on the document. If the\nrecipient clicks the tab during the signing process, the\nrecipient is considered to have signed the document. No\ninformation is shown on the document of the approval, but it\nis recorded as a signature in the envelope history.\nThe value of an approve tab can't be set.\n\n[approve]:\t\t https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/approve\n", + "description": "A list of\n[Approve tabs][approve].\n\nAn Approve tab enables\nthe recipient to approve documents without\nplacing a signature or initials on the document. If the\nrecipient clicks the tab during the signing process, the\nrecipient is considered to have signed the document. No\ninformation is shown on the document of the approval, but it\nis recorded as a signature in the envelope history.\nThe value of an approve tab can't be set.\n\n[approve]:\t\t https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { "$ref": "#/definitions/approve" } }, "checkboxTabs": { - "description": "A list of\n[Checkbox tabs][checkbox].\n\n\nA Checkbox tab enables the recipient to select a yes/no (on/off) option. This value can be set.\n\n\n[checkbox]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/checkbox\n", + "description": "A list of\n[Checkbox tabs][checkbox].\n\n\nA Checkbox tab enables the recipient to select a yes/no (on/off) option. This value can be set.\n\n\n[checkbox]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { "$ref": "#/definitions/checkbox" @@ -45571,118 +56511,174 @@ "$ref": "#/definitions/commentThread" } }, + "commissionCountyTabs": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/commissionCounty" + } + }, + "commissionExpirationTabs": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/commissionExpiration" + } + }, + "commissionNumberTabs": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/commissionNumber" + } + }, + "commissionStateTabs": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/commissionState" + } + }, "companyTabs": { - "description": "A list of \n[Company tabs][company].\n\n\nA Company tab displays a field for the name of the recipient's company. This value can't be set.\n\n\n\n[company]: https://developers.docusign.com/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/company \n", + "description": "A list of\n[Company tabs][company].\n\n\nA Company tab displays a field for the name of the recipient's company. This value can't be set.\n\n\n\n[company]: https://developers.docusign.com/docs/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/company\n", "type": "array", "items": { "$ref": "#/definitions/company" } }, + "currencyTabs": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/currency" + } + }, "dateSignedTabs": { - "description": "A list of \n[Date Signed tabs][dateSigned].\n\n\nA Date Signed tab displays the date that the recipient signed the document. This value can't be set.\n\n[dateSigned]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/dateSigned \n", + "description": "A list of\n[Date Signed tabs][dateSigned].\n\n\nA Date Signed tab displays the date that the recipient signed the document. This value can't be set.\n\n[dateSigned]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { "$ref": "#/definitions/dateSigned" } }, "dateTabs": { - "description": "A list of \n[Date tabs][date].\n\nA Date tab enables the recipient to enter a date. This value can't be set. The tooltip for this tab recommends the date format MM/DD/YYYY, but this format is not enforced. The system retains the format that the recipient enters.\n\n**Note**: If you need to enforce a specific date format, we recommend that you use a Text tab with a validation pattern and validation message.\n\n\n[date]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/date \n", + "description": "A list of\n[Date tabs][date].\n\nA Date tab enables the recipient to enter a date. This value can't be set. The tooltip for this tab recommends the date format MM/DD/YYYY, but this format is not enforced. The system retains the format that the recipient enters.\n\n**Note**: If you need to enforce a specific date format, we recommend that you use a Text tab with a validation pattern and validation message.\n\n\n[date]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { "$ref": "#/definitions/date" } }, "declineTabs": { - "description": "A list of \n[Decline tabs][decline].\n\nA Decline tab enables the recipient to decline the envelope. If the recipient clicks the tab during the signing process, the envelope is voided. The value of this tab can't be set.\n\n\n[decline]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/decline \n", + "description": "A list of\n[Decline tabs][decline].\n\nA Decline tab enables the recipient to decline the envelope. If the recipient clicks the tab during the signing process, the envelope is voided. The value of this tab can't be set.\n\n\n[decline]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { "$ref": "#/definitions/decline" } }, + "drawTabs": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/draw" + } + }, "emailAddressTabs": { - "description": "A list of \n[Email Address tabs][emailAddress].\n\nAn Email Address tab displays the recipient's email as entered in the recipient information. This value can't be set.\n\n\n[emailAddress]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/emailAddress \n", + "description": "A list of\n[Email Address tabs][emailAddress].\n\nAn Email Address tab displays the recipient's email as entered in the recipient information. This value can't be set.\n\n\n[emailAddress]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { "$ref": "#/definitions/emailAddress" } }, "emailTabs": { - "description": "A list of \n[Email tabs][email].\n\nAn Email tab enables the recipient to enter an email address.\nThis is a one-line field that checks that a valid email\naddress is entered. It uses the same parameters as a Text\ntab, with the validation message and pattern set for email\ninformation. This value can be set.\n\nWhen getting information that includes\nthis tab type, the original value of the tab when the\nassociated envelope was sent is included in the response.\n\n[email]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/email \n", + "description": "A list of\n[Email tabs][email].\n\nAn Email tab enables the recipient to enter an email address.\nThis is a one-line field that checks that a valid email\naddress is entered. It uses the same parameters as a Text\ntab, with the validation message and pattern set for email\ninformation. This value can be set.\n\nWhen getting information that includes\nthis tab type, the original value of the tab when the\nassociated envelope was sent is included in the response.\n\n[email]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { "$ref": "#/definitions/email" } }, "envelopeIdTabs": { - "description": "A list of \n[Envelope ID tabs][envelopeId].\n\nAn Envelope ID tab displays the envelope ID. Recipients cannot enter or change the information in this tab. This value can't be set.\n\n\n[envelopeId]: https://developers.docusign.com/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/envelopeId \n", + "description": "A list of\n[Envelope ID tabs][envelopeId].\n\nAn Envelope ID tab displays the envelope ID. Recipients cannot enter or change the information in this tab. This value can't be set.\n\n\n[envelopeId]: https://developers.docusign.com/docs/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/envelopeId\n", "type": "array", "items": { "$ref": "#/definitions/envelopeId" } }, "firstNameTabs": { - "description": "A list of \n[First Name tabs][firstName].\n\nA First Name tab displays the recipient's first name. The system automatically populates this field by splitting the name in the recipient information on spaces. This value can't be set.\n\n\n[firstName]: https://developers.docusign.com/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/firstName \n", + "description": "A list of\n[First Name tabs][firstName].\n\nA First Name tab displays the recipient's first name. The system automatically populates this field by splitting the name in the recipient information on spaces. This value can't be set.\n\n\n[firstName]: https://developers.docusign.com/docs/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/firstName\n", "type": "array", "items": { "$ref": "#/definitions/firstName" } }, "formulaTabs": { - "description": "A list of [Formula tabs][formulaTab].\n\nThe value of a Formula tab is calculated from the values of other number or date tabs in the document. When the recipient completes the underlying fields, the Formula tab calculates and displays the result. This value can be set.\n\nThe `formula` property of the tab contains the references to the underlying tabs. To learn more about formulas, see [Calculated Fields][calculatedfields].\n\nIf a Formula tab contains a `paymentDetails` property, the tab is considered a payment item. To learn more about payments, see [Requesting Payments Along with Signatures][paymentguide].\n\n[calculatedfields]: https://support.docusign.com/en/guides/ndse-user-guide-calculated-fields\n[paymentguide]: https://support.docusign.com/en/guides/requesting-payments-along-with-signatures\n[formulaTab]:\t \thttps://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/formulaTab\n", + "description": "A list of [Formula tabs][formulaTab].\n\nThe value of a Formula tab is calculated from the values of other number or date tabs in the document. When the recipient completes the underlying fields, the Formula tab calculates and displays the result. This value can be set.\n\nThe `formula` property of the tab contains the references to the underlying tabs. To learn more about formulas, see [Calculated Fields][calculatedfields].\n\nIf a Formula tab contains a `paymentDetails` property, the tab is considered a payment item. To learn more about payments, see [Requesting Payments Along with Signatures][paymentguide].\n\n[calculatedfields]: https://support.docusign.com/en/guides/ndse-user-guide-calculated-fields\n[paymentguide]: https://support.docusign.com/en/guides/requesting-payments-along-with-signatures\n[formulaTab]:\t \thttps://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { "$ref": "#/definitions/formulaTab" } }, "fullNameTabs": { - "description": "A list of \n[Full Name tabs][fullName].\n\nA Full Name tab displays the recipient's full name. This value can't be set.\n\n\n[fullName]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/fullName \n", + "description": "A list of\n[Full Name tabs][fullName].\n\nA Full Name tab displays the recipient's full name. This value can't be set.\n\n\n[fullName]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { "$ref": "#/definitions/fullName" } }, "initialHereTabs": { - "description": "A list of \n[Initial Here tabs][initialHere].\n\nThis type of tab enables the recipient to initial the document. May be optional. This value can't be set.\n\n[initialHere]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/initialHere \n", + "description": "A list of\n[Initial Here tabs][initialHere].\n\nThis type of tab enables the recipient to initial the document. May be optional. This value can't be set.\n\n[initialHere]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { "$ref": "#/definitions/initialHere" } }, "lastNameTabs": { - "description": "A list of \n[Last Name tabs][lastName].\n\nA Last Name tab displays the recipient's last name. The system automatically populates this field by splitting the name in the recipient information on spaces. This value can't be set.\n\n\n[lastName]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/lastName \n", + "description": "A list of\n[Last Name tabs][lastName].\n\nA Last Name tab displays the recipient's last name. The system automatically populates this field by splitting the name in the recipient information on spaces. This value can't be set.\n\n\n[lastName]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { "$ref": "#/definitions/lastName" } }, "listTabs": { - "description": "A list of [List tabs][list].\n\nA List tab enables the recipient to choose from a list of options. You specify the options in the `listItems` property. This value can't be set.\n\n\n\n[list]: https://developers.docusign.com/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/list \n", + "description": "An array of List tabs.\n\nA List tab enables the recipient to choose from a list of options. You specify the options in the `listItems` property. This value can't be set.\n\nFind descriptions of all tab types in\nthe [EnvelopeRecipientTabs Resource][ert].\n\n[ert]: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n", "type": "array", "items": { "$ref": "#/definitions/list" } }, "notarizeTabs": { - "description": "A list of [Notarize tabs][notarize].\n\nA Notarize tab alerts notary recipients that they must take action on the page. This value can be set.\n\n**Note**: Only one notarize tab can appear on a page.\n\n[notarize]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/notarize \n", + "description": "A list of [Notarize tabs][notarize].\n\nA Notarize tab alerts notary recipients that they must take action on the page. This value can be set.\n\n**Note**: Only one notarize tab can appear on a page.\n\n[notarize]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { "$ref": "#/definitions/notarize" } }, + "notarySealTabs": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/notarySeal" + } + }, "noteTabs": { - "description": "A list of \n[Note tabs][note].\n\nA Note tab displays additional information to the recipient in the form of a note. This value can be set.\n\n[note]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/note \n", + "description": "A list of\n[Note tabs][note].\n\nA Note tab displays additional information to the recipient in the form of a note. This value can be set.\n\n[note]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { "$ref": "#/definitions/note" } }, "numberTabs": { - "description": "A list of \n[Number tabs][number].\n\nA Number tab enables the recipient to enter numbers and decimal points (.). This value can be set.\n\n\n\n[number]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/number \n", + "description": "A list of\n[Number tabs][number].\n\nA Number tab enables the recipient to enter numbers and decimal points (.). This value can be set.\n\n\n\n[number]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { "$ref": "#/definitions/number" } }, + "phoneNumberTabs": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/phoneNumber" + } + }, "polyLineOverlayTabs": { "description": "This type of tab enables the recipient to strike through document text. This value can't be set. ", "type": "array", @@ -45690,22 +56686,26 @@ "$ref": "#/definitions/polyLineOverlay" } }, + "prefillTabs": { + "$ref": "#/definitions/prefillTabs", + "description": "" + }, "radioGroupTabs": { - "description": "A list of [Radio Group tabs][radioGroup].\n\nA Radio Group tab places a group of radio buttons on a document. The `radios` property is used to add and place the radio\nbuttons associated with the group. Only one radio button can be selected in a group. This value can be set.\n\n\n[radioGroup]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/radioGroup \n", + "description": "A list of [Radio Group tabs][radioGroup].\n\nA Radio Group tab places a group of radio buttons on a document. The `radios` property is used to add and place the radio\nbuttons associated with the group. Only one radio button can be selected in a group. This value can be set.\n\n\n[radioGroup]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { "$ref": "#/definitions/radioGroup" } }, "signerAttachmentTabs": { - "description": "A list of \n[Signer Attachment tabs][signerAttachment].\n\nThis type of tab enables the recipient to attach supporting documents to an envelope. This value can't be set.\n\n\n[signerAttachment]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/signerAttachment \n", + "description": "A list of\n[Signer Attachment tabs][signerAttachment].\n\nThis type of tab enables the recipient to attach supporting documents to an envelope. This value can't be set.\n\n\n[signerAttachment]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { "$ref": "#/definitions/signerAttachment" } }, "signHereTabs": { - "description": "A list of \n[Sign Here tabs][signHere].\n\nThis type of tab enables the recipient to sign a document. May be optional. This value can't be set.\n\n[signHere]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/signHere \n", + "description": "A list of\n[Sign Here tabs][signHere].\n\nThis type of tab enables the recipient to sign a document. May be optional. This value can't be set.\n\n[signHere]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { "$ref": "#/definitions/signHere" @@ -45719,7 +56719,7 @@ } }, "ssnTabs": { - "description": "A list of \n[SSN tabs][ssn].\n\nAn SSN tab contains a one-line field that enables the recipient to enter a Social Security Number (SSN) with or without\ndashes. It uses the same parameters as a Text tab, with the validation message and pattern set for SSN information. This value can be set.\n\n\n[ssn]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/ssn \n", + "description": "A list of\n[SSN tabs][ssn].\n\nAn SSN tab contains a one-line field that enables the recipient to enter a Social Security Number (SSN) with or without\ndashes. It uses the same parameters as a Text tab, with the validation message and pattern set for SSN information. This value can be set.\n\n\n[ssn]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { "$ref": "#/definitions/ssn" @@ -45733,28 +56733,28 @@ } }, "textTabs": { - "description": "A list of \n[Text tabs][text].\n\nA text tab enables the recipient to enter free text. This value can be set.\n\n[text]: https://developers.docusign.com/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/text \n", + "description": "A list of\nText tabs.\n\nA text tab enables the recipient to enter free text. This value can be set.\n\nFind descriptions of all tab types in\nthe [EnvelopeRecipientTabs Resource][ert].\n\n[ert]: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n", "type": "array", "items": { "$ref": "#/definitions/text" } }, "titleTabs": { - "description": "A list of \n[Title tabs][title].\n\nA Title tab displays the recipient's title. This value can't be set.\n\n\n[title]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/title \n", + "description": "A list of\n[Title tabs][title].\n\nA Title tab displays the recipient's title. This value can't be set.\n\n\n[title]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { "$ref": "#/definitions/title" } }, "viewTabs": { - "description": "A list of \n[View tabs][view].\n\nA View tab is used with an Approve tab to handle supplemental documents. This value can be set.\n\n[view]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/view \n", + "description": "A list of\n[View tabs][view].\n\nA View tab is used with an Approve tab to handle supplemental documents. This value can be set.\n\n[view]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { "$ref": "#/definitions/view" } }, "zipTabs": { - "description": "A list of \n[Zip tabs][zip].\n\nA Zip tab enables the recipient to enter a ZIP code. The ZIP code can be five digits or nine digits ( in ZIP+4 format), and can be entered with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for ZIP code information. This value can be set.\n\n\n[zip]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/zip\n", + "description": "A list of\n[Zip tabs][zip].\n\nA Zip tab enables the recipient to enter a ZIP code. The ZIP code can be five digits or nine digits ( in ZIP+4 format), and can be entered with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for ZIP code information. This value can be set.\n\n\n[zip]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { "$ref": "#/definitions/zip" @@ -45770,7 +56770,7 @@ "properties": { "bulkEnvelopeStatus": { "$ref": "#/definitions/bulkEnvelopeStatus", - "description": "" + "description": "An object that describes the status of the bulk send envelopes." }, "envelopeId": { "description": "The envelope ID of the envelope status that failed to post.", @@ -45821,21 +56821,29 @@ "text": { "type": "object", "properties": { + "anchorAllowWhiteSpaceInCharacters": { + "description": "", + "type": "string" + }, + "anchorAllowWhiteSpaceInCharactersMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "" + }, "anchorCaseSensitive": { - "description": "Reserved for DocuSign.\n", + "description": "This property controls how [anchor tabs][AnchorTabs] are placed. When **true**, the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false**.\n\nFor example, when set to **true**, if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When set to **false**, `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**.\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place", "type": "string" }, "anchorCaseSensitiveMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "description": "Metadata that indicates whether the `anchorCaseSensitive` property is editable." }, "anchorHorizontalAlignment": { - "description": "Reserved for DocuSign.\n\n", + "description": "This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are :\n\n- `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value.\n- `right`: Aligns the tab’s left side with the last character of the matching anchor word.\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place\n", "type": "string" }, "anchorHorizontalAlignmentMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "description": "Metadata that indicates whether the `anchorHorizontalAlignment` property is editable." }, "anchorIgnoreIfNotPresent": { "description": "When set to **true**, this tab is ignored if the `anchorString` is not found in the document.", @@ -45846,12 +56854,12 @@ "description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable." }, "anchorMatchWholeWord": { - "description": "Reserved for DocuSign.\n\n", + "description": "When set to **true**, the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false**.\n\nFor example, when set to **true**, if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When set to **false**, if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**.\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTab]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place\n", "type": "string" }, "anchorMatchWholeWordMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "description": "Metadata that indicates whether the `anchorMatchWholeWord` property is editable." }, "anchorString": { "description": "Specifies the string to find in the document and use as the basis for tab placement.", @@ -45870,7 +56878,7 @@ "description": "Reserved for DocuSign." }, "anchorUnits": { - "description": "Specifies the units of the X and Y offset. Units may be pixels, millimeters, centimeters, or inches.", + "description": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n", "type": "string" }, "anchorUnitsMetadata": { @@ -45878,7 +56886,7 @@ "description": "Metadata that indicates whether the `anchorUnits` property is editable." }, "anchorXOffset": { - "description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.", + "description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n", "type": "string" }, "anchorXOffsetMetadata": { @@ -45886,7 +56894,7 @@ "description": "Metadata that indicates whether the `anchorXOffset` property is editable." }, "anchorYOffset": { - "description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.", + "description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n", "type": "string" }, "anchorYOffsetMetadata": { @@ -45902,7 +56910,7 @@ "description": "Metadata that indicates whether the `bold` property is editable." }, "concealValueOnDocument": { - "description": "When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender.\n\nWhen an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.", + "description": "When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender.\n\nWhen an envelope is completed the information is only available to the sender through the Form Data link in the DocuSign Console. The information on the downloaded document remains masked by asterisks.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.", "type": "string" }, "concealValueOnDocumentMetadata": { @@ -45926,7 +56934,7 @@ "description": "Metadata that indicates whether the `conditionalParentValue` property is editable." }, "customTabId": { - "description": "The DocuSign-generated custom tab id for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.", + "description": "The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.", "type": "string" }, "customTabIdMetadata": { @@ -45942,7 +56950,7 @@ "description": "Metadata that indicates whether the `disableAutoSize` property is editable." }, "documentId": { - "description": "Integer that identifies the document in the envelope.", + "description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.", "type": "string" }, "documentIdMetadata": { @@ -46017,14 +57025,6 @@ "$ref": "#/definitions/propertyMetadata", "description": "Metadata that indicates whether the `height` property is editable." }, - "isPaymentAmount": { - "description": "When set to **true**, sets this as a payment tab. Can only be used with Text, Number, Formula, or List tabs. The value of the tab must be a number. ", - "type": "string" - }, - "isPaymentAmountMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `isPaymentAmount` property is editable." - }, "italic": { "description": "When set to **true**, the information in the tab is italic.", "type": "string" @@ -46057,13 +57057,17 @@ "$ref": "#/definitions/mergeField", "description": "Contains the information necessary to map the tab to a field in SalesForce." }, + "mergeFieldXml": { + "description": "", + "type": "string" + }, "name": { "description": "The name of the tab. For example, `Sign Here` or `Initial Here`.", "type": "string" }, "nameMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `name` property is editable." + "description": "Metadata that indicates whether the `name` property is editable. Read only." }, "originalValue": { "description": "The initial value of the tab when it was sent to the recipient. ", @@ -46082,11 +57086,11 @@ "description": "Metadata that indicates whether the `pageNumber` property is editable." }, "recipientId": { - "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", + "description": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.", "type": "string" }, "recipientIdGuid": { - "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one.", + "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only.", "type": "string" }, "recipientIdGuidMetadata": { @@ -46137,6 +57141,10 @@ "$ref": "#/definitions/propertyMetadata", "description": "Metadata that indicates whether the `shared` property is editable." }, + "smartContractInformation": { + "$ref": "#/definitions/smartContractInformation", + "description": "" + }, "status": { "description": "The status of the tab. Possible values are:\n\n- `active`: The tab is active, but the recipient has not yet interacted with it.\n- `signed`: The recipient signed the tab.\n- `declined`: The recipient declined the envelope.\n- `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`).", "type": "string" @@ -46165,7 +57173,7 @@ "description": "Metadata that indicates whether the `tabId` property is editable." }, "tabLabel": { - "description": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n", + "description": "The label associated with the tab. This value may be an empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum Length: 500 characters.\n", "type": "string" }, "tabLabelMetadata": { @@ -46253,7 +57261,7 @@ "description": "Metadata that indicates whether the `width` property is editable." }, "xPosition": { - "description": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n", + "description": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n", "type": "string" }, "xPositionMetadata": { @@ -46261,7 +57269,7 @@ "description": "Metadata that indicates whether the `xPosition` property is editable." }, "yPosition": { - "description": "This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.", + "description": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n", "type": "string" }, "yPositionMetadata": { @@ -46277,7 +57285,7 @@ "type": "object", "properties": { "configurationType": { - "description": "If merge fields are being used, specifies the type of the merge field. The only supported value is **salesforce**.", + "description": "If you are using merge fields, this property specifies the type of the merge field. The only supported value is `salesforce`.", "type": "string" }, "errorDetails": { @@ -46285,7 +57293,7 @@ "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." }, "fieldId": { - "description": "An ID used to specify a custom field.", + "description": "The id of the custom field.", "type": "string" }, "name": { @@ -46293,60 +57301,48 @@ "type": "string" }, "required": { - "description": "When set to **true**, the signer is required to fill out this tab.", + "description": "When set to **true**, senders are required to enter or select information for the field before they can send the envelope.", "type": "string" }, "show": { - "description": "A boolean indicating if the value should be displayed. If this value is set to **true**, the custom field is displayed at the top of the certificate of completion. If this value is left blank/ or set to **false**, then it does not appear in the certificate of completion. ", + "description": "When set to **true**, the field displays in the **Envelope Custom Fields** section when a user creates or sends an envelope.", "type": "string" }, "value": { - "description": "The value of the custom field.", + "description": "The value of the custom field. The user who creates or sends the envelope provides this value. Maximum length: 100 characters.", "type": "string" } }, "x-ds-definition-name": "textCustomField", - "description": "", - "x-ms-summary": "" + "description": "This object represents a free text custom field where envelope creators and senders can enter custom data.", + "x-ms-summary": "This object represents a free text custom field where envelope creators and senders can enter custom data." }, - "timeStampField": { + "title": { "type": "object", "properties": { - "documentSecurityStore": { - "$ref": "#/definitions/documentSecurityStore", - "description": "" - }, - "maxTimeStampSignatureLength": { + "anchorAllowWhiteSpaceInCharacters": { "description": "", "type": "string" }, - "timeStampFieldName": { - "description": "", - "type": "string" - } - }, - "x-ds-definition-name": "timeStampField", - "description": "", - "x-ms-summary": "" - }, - "title": { - "type": "object", - "properties": { + "anchorAllowWhiteSpaceInCharactersMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "" + }, "anchorCaseSensitive": { - "description": "Reserved for DocuSign.\n", + "description": "This property controls how [anchor tabs][AnchorTabs] are placed. When **true**, the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false**.\n\nFor example, when set to **true**, if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When set to **false**, `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**.\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place", "type": "string" }, "anchorCaseSensitiveMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "description": "Metadata that indicates whether the `anchorCaseSensitive` property is editable." }, "anchorHorizontalAlignment": { - "description": "Reserved for DocuSign.\n\n", + "description": "This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are :\n\n- `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value.\n- `right`: Aligns the tab’s left side with the last character of the matching anchor word.\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place\n", "type": "string" }, "anchorHorizontalAlignmentMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "description": "Metadata that indicates whether the `anchorHorizontalAlignment` property is editable." }, "anchorIgnoreIfNotPresent": { "description": "When set to **true**, this tab is ignored if the `anchorString` is not found in the document.", @@ -46357,12 +57353,12 @@ "description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable." }, "anchorMatchWholeWord": { - "description": "Reserved for DocuSign.\n\n", + "description": "When set to **true**, the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false**.\n\nFor example, when set to **true**, if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When set to **false**, if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**.\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTab]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place\n", "type": "string" }, "anchorMatchWholeWordMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "description": "Metadata that indicates whether the `anchorMatchWholeWord` property is editable." }, "anchorString": { "description": "Specifies the string to find in the document and use as the basis for tab placement.", @@ -46381,7 +57377,7 @@ "description": "Reserved for DocuSign." }, "anchorUnits": { - "description": "Specifies the units of the X and Y offset. Units may be pixels, millimeters, centimeters, or inches.", + "description": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n", "type": "string" }, "anchorUnitsMetadata": { @@ -46389,7 +57385,7 @@ "description": "Metadata that indicates whether the `anchorUnits` property is editable." }, "anchorXOffset": { - "description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.", + "description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n", "type": "string" }, "anchorXOffsetMetadata": { @@ -46397,7 +57393,7 @@ "description": "Metadata that indicates whether the `anchorXOffset` property is editable." }, "anchorYOffset": { - "description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.", + "description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n", "type": "string" }, "anchorYOffsetMetadata": { @@ -46413,7 +57409,7 @@ "description": "Metadata that indicates whether the `bold` property is editable." }, "concealValueOnDocument": { - "description": "When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender.\n\nWhen an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.", + "description": "When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender.\n\nWhen an envelope is completed the information is only available to the sender through the Form Data link in the DocuSign Console. The information on the downloaded document remains masked by asterisks.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.", "type": "string" }, "concealValueOnDocumentMetadata": { @@ -46453,7 +57449,7 @@ "description": "Metadata that indicates whether the `disableAutoSize` property is editable." }, "documentId": { - "description": "Integer that identifies the document in the envelope.", + "description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.", "type": "string" }, "documentIdMetadata": { @@ -46552,13 +57548,17 @@ "$ref": "#/definitions/mergeField", "description": "Contains the information necessary to map the tab to a field in SalesForce." }, + "mergeFieldXml": { + "description": "", + "type": "string" + }, "name": { "description": "The name of the tab. For example, `Sign Here` or `Initial Here`.", "type": "string" }, "nameMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `name` property is editable." + "description": "Metadata that indicates whether the `name` property is editable. Read only." }, "originalValue": { "description": "The initial value of the tab when it was sent to the recipient. ", @@ -46577,11 +57577,11 @@ "description": "Metadata that indicates whether the `pageNumber` property is editable." }, "recipientId": { - "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", + "description": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.", "type": "string" }, "recipientIdGuid": { - "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one.", + "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only.", "type": "string" }, "recipientIdGuidMetadata": { @@ -46600,6 +57600,10 @@ "$ref": "#/definitions/propertyMetadata", "description": "Metadata that indicates whether the `required` property is editable." }, + "smartContractInformation": { + "$ref": "#/definitions/smartContractInformation", + "description": "" + }, "status": { "description": "The status of the tab. Possible values are:\n\n- `active`: The tab is active, but the recipient has not yet interacted with it.\n- `signed`: The recipient signed the tab.\n- `declined`: The recipient declined the envelope.\n- `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`).\n", "type": "string" @@ -46628,7 +57632,7 @@ "description": "Metadata that indicates whether the `tabId` property is editable." }, "tabLabel": { - "description": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n", + "description": "The label associated with the tab. This value may be an empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum Length: 500 characters.\n", "type": "string" }, "tabLabelMetadata": { @@ -46700,7 +57704,7 @@ "description": "Metadata that indicates whether the `width` property is editable." }, "xPosition": { - "description": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n", + "description": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n", "type": "string" }, "xPositionMetadata": { @@ -46708,7 +57712,7 @@ "description": "Metadata that indicates whether the `xPosition` property is editable." }, "yPosition": { - "description": "This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.", + "description": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n", "type": "string" }, "yPositionMetadata": { @@ -46720,101 +57724,6 @@ "description": "A tab that displays the recipient's title.\n", "x-ms-summary": "A tab that displays the recipient's title.\n" }, - "tspHealthCheckRequest": { - "type": "object", - "properties": { - "appVersion": { - "description": "", - "type": "string" - }, - "description": { - "description": "A sender-defined description of the line item.\n", - "type": "string" - }, - "error": { - "description": "Server error for the Connect post failure.", - "type": "string" - }, - "status": { - "description": "The status of the item.", - "type": "string" - }, - "statusDescription": { - "description": "", - "type": "array", - "items": { - "$ref": "#/definitions/tspHealthCheckStatusDescription" - } - } - }, - "x-ds-definition-name": "tspHealthCheckRequest", - "description": "", - "x-ms-summary": "" - }, - "tspHealthCheckStatusDescription": { - "type": "object", - "properties": { - "description": { - "description": "A sender-defined description of the line item.\n", - "type": "string" - }, - "error": { - "description": "Server error for the Connect post failure.", - "type": "string" - }, - "hostname": { - "description": "", - "type": "string" - }, - "responseSeconds": { - "description": "", - "type": "string" - }, - "status": { - "description": "The status of the item.", - "type": "string" - }, - "type": { - "description": "Type of user:\n- `type_owner`\n- `type_participant`", - "type": "string" - } - }, - "x-ds-definition-name": "tspHealthCheckStatusDescription", - "description": "", - "x-ms-summary": "" - }, - "updateTransactionRequest": { - "type": "object", - "properties": { - "code": { - "description": "", - "type": "string" - }, - "message": { - "description": "", - "type": "string" - }, - "state": { - "description": "The state or province associated with the address.", - "type": "string" - } - }, - "x-ds-definition-name": "updateTransactionRequest", - "description": "", - "x-ms-summary": "" - }, - "updateTransactionResponse": { - "type": "object", - "properties": { - "redirectionUrl": { - "description": "", - "type": "string" - } - }, - "x-ds-definition-name": "updateTransactionResponse", - "description": "", - "x-ms-summary": "" - }, "usageHistory": { "description": "A complex element consisting of: \n\n* lastSentDateTime - the date and time the user last sent an envelope. \n* lastSignedDateTime - the date and time the user last signed an envelope.\n* sentCount - the number of envelopes the user has sent.\n* signedCount - the number of envelopes the user has signed.", "type": "object", @@ -46839,44 +57748,6 @@ "x-ds-definition-name": "usageHistory", "x-ms-summary": "A complex element consisting of: \n\n* lastSentDateTime - the date and time the user last sent an envelope. \n* lastSignedDateTime - the date and time the user last signed an envelope.\n* sentCount - the number of envelopes the user has sent.\n* signedCount - the number of envelopes the user has signed." }, - "user": { - "type": "object", - "properties": { - "cellPhoneNumber": { - "description": "", - "type": "string" - }, - "countryCode": { - "description": "The three-letter code for the user's country.", - "type": "string" - }, - "credentials": { - "description": "", - "type": "array", - "items": { - "$ref": "#/definitions/credential" - } - }, - "displayName": { - "description": "", - "type": "string" - }, - "email": { - "description": "Filters returned user records by the specified email address.", - "type": "string" - }, - "externalClaims": { - "description": "", - "type": "array", - "items": { - "$ref": "#/definitions/externalClaim" - } - } - }, - "x-ds-definition-name": "user", - "description": "", - "x-ms-summary": "" - }, "userAccountManagementGranularInformation": { "type": "object", "properties": { @@ -46904,6 +57775,14 @@ "$ref": "#/definitions/settingsMetadata", "description": "Metadata that indicates whether the `canManageAdmins` property is editable.\n" }, + "canManageEnvelopeTransfer": { + "description": "", + "type": "string" + }, + "canManageEnvelopeTransferMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "" + }, "canManageReporting": { "description": "**True** if the user can manage reporting.", "type": "string" @@ -46935,6 +57814,10 @@ "canManageUsersMetadata": { "$ref": "#/definitions/settingsMetadata", "description": "Metadata that indicates whether the `canManageUsers` property is editable.\n" + }, + "canViewUsers": { + "description": "", + "type": "string" } }, "x-ds-definition-name": "userAccountManagementGranularInformation", @@ -46945,11 +57828,11 @@ "type": "object", "properties": { "accountId": { - "description": "The external account number (int) or account ID GUID.", + "description": "The account ID associated with the envelope.", "type": "string" }, "accountName": { - "description": "The name of the account associated with the current workspace user.", + "description": "The name on the account.", "type": "string" }, "activationAccessCode": { @@ -46957,7 +57840,7 @@ "type": "string" }, "email": { - "description": "Filters returned user records by the specified email address.", + "description": "The user's email address.", "type": "string" }, "errorDetails": { @@ -46965,7 +57848,7 @@ "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." }, "loginStatus": { - "description": "Boolean value that indicates whether the user is currently logged in or not.", + "description": "When set to **true**, indicates that the user is logged in. This is a read-only property.", "type": "string" }, "membershipId": { @@ -46973,11 +57856,11 @@ "type": "string" }, "sendActivationEmail": { - "description": "When set to **true**, specifies that an activation email be sent to the user.", + "description": "When set to **true**, specifies that an activation email will be sent to the user.", "type": "string" }, "uri": { - "description": "URI containing the user ID.", + "description": "A URI containing the user ID.", "type": "string" }, "userId": { @@ -47016,34 +57899,6 @@ "description": "", "x-ms-summary": "" }, - "userInfoResponse": { - "type": "object", - "properties": { - "envelopeId": { - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", - "type": "string" - }, - "language": { - "description": "Specifies the language for the Certificate of Completion in the response. The supported languages are: Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Dutch (nl), English US (en), French (fr), German (de), Italian (it), Japanese (ja), Korean (ko), Portuguese (pt), Portuguese (Brazil) (pt_BR), Russian (ru), Spanish (es). ", - "type": "string" - }, - "seal": { - "$ref": "#/definitions/seal", - "description": "Set of information related to the electronic seal used by the Trust Service Provider (TSP)." - }, - "sender": { - "$ref": "#/definitions/sender", - "description": "Information about the sender of the envelope." - }, - "user": { - "$ref": "#/definitions/user", - "description": "" - } - }, - "x-ds-definition-name": "userInfoResponse", - "description": "", - "x-ms-summary": "" - }, "userInformation": { "type": "object", "properties": { @@ -47067,7 +57922,7 @@ "type": "string" }, "createdDateTime": { - "description": "The date and time the item was created.", + "description": "The UTC DateTime when the item was created.", "type": "string" }, "customSettings": { @@ -47082,7 +57937,7 @@ "type": "string" }, "email": { - "description": "Filters returned user records by the specified email address.", + "description": "The user's email address.", "type": "string" }, "enableConnectForUser": { @@ -47102,18 +57957,22 @@ "description": "A complex element containing up to four Question/Answer pairs for forgotten password information." }, "groupList": { - "description": "A list of the group information for groups to add the user to.\nUse [UserGroups::listGroups](https://developers.docusign.com/esign-rest-api/reference/UserGroups/Groups/list) to get information about groups.\n\nWhen setting a user's group, only the `groupId` is required.\n", + "description": "A list of the group information for groups to add the user to.\nUse [UserGroups::listGroups](https://developers.docusign.com/docs/esign-rest-api/reference/UserGroups/Groups/list) to get information about groups.\n\nWhen setting a user's group, only the `groupId` is required.\n", "type": "array", "items": { "$ref": "#/definitions/group" } }, + "hasRemoteNotary": { + "description": "", + "type": "boolean" + }, "homeAddress": { "$ref": "#/definitions/addressInformation", "description": "Specifies the email for the signing host. It is a Required element for In Person Signers recipient Type. \nMaximum Length: 100 characters." }, "initialsImageUri": { - "description": "Contains the URI for an endpoint that you can use to retrieve the initials image.", + "description": "The URI for retrieving the image of the user's initials.", "type": "string" }, "isAdmin": { @@ -47121,7 +57980,7 @@ "type": "string" }, "isNAREnabled": { - "description": "", + "description": "When set to **true**, National Association of Realtors (NAR) signature logos are enabled for the user.", "type": "string" }, "jobTitle": { @@ -47133,7 +57992,7 @@ "type": "string" }, "lastName": { - "description": "", + "description": "The user's last name. \nMaximum Length: 50 characters.", "type": "string" }, "loginStatus": { @@ -47165,7 +58024,7 @@ "type": "string" }, "sendActivationEmail": { - "description": "When set to **true**, specifies that an activation email be sent to the user.", + "description": "When set to **true**, specifies that an activation email will be sent to the user.", "type": "string" }, "sendActivationOnInvalidLogin": { @@ -47189,7 +58048,7 @@ "type": "string" }, "uri": { - "description": "URI containing the user ID.", + "description": "A URI containing the user ID.", "type": "string" }, "userAddedToAccountDateTime": { @@ -47210,7 +58069,7 @@ }, "userSettings": { "$ref": "#/definitions/userSettingsInformation", - "description": "The collection of settings representing the actions a user can perform. See [userSettingsInformation](https://developers.docusign.com/esign-rest-api/reference/Users/Users/get#userSettingsInformation) for available settings." + "description": "The collection of settings representing the actions a user can perform. See [userSettingsInformation](https://developers.docusign.com/docs/esign-rest-api/reference/users/users/get/#userSettingsInformation) for available settings." }, "userStatus": { "description": "Status of the user's account. One of:\n\n- `ActivationRequired`\n- `ActivationSent`\n- `Active`\n- `Closed`\n- `Disabled`\n", @@ -47226,14 +58085,14 @@ } }, "x-ds-definition-name": "userInformation", - "description": "", - "x-ms-summary": "" + "description": "User information.", + "x-ms-summary": "User information." }, "userInformationList": { "type": "object", "properties": { "endPosition": { - "description": "The last position in the result set. ", + "description": "The last index position in the result set. ", "type": "string" }, "nextUri": { @@ -47245,28 +58104,28 @@ "type": "string" }, "resultSetSize": { - "description": "The number of results returned in this response. Because you can filter which entries are included in the response, this value is always less than or equal to `totalSetSize`.", + "description": "The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`.", "type": "string" }, "startPosition": { - "description": "The starting position of the current result set.", + "description": "The starting index position of the current result set.", "type": "string" }, "totalSetSize": { - "description": "The total number of items in the search's result set. This value is always greater than or equal to the value of `resultSetSize`.", + "description": "The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`.", "type": "string" }, "users": { "description": "User management information.", "type": "array", "items": { - "$ref": "#/definitions/Users" + "$ref": "#/definitions/userInformation" } } }, "x-ds-definition-name": "userInformationList", - "description": "", - "x-ms-summary": "" + "description": "Contains a list of account users.", + "x-ms-summary": "Contains a list of account users." }, "userPasswordInformation": { "type": "object", @@ -47296,8 +58155,8 @@ "type": "object", "properties": { "passwordRules": { - "$ref": "#/definitions/AccountPasswordRules", - "description": "" + "$ref": "#/definitions/accountPasswordRules", + "description": "Contains details about the password rules for the user." }, "userId": { "description": "The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.\n", @@ -47305,8 +58164,8 @@ } }, "x-ds-definition-name": "userPasswordRules", - "description": "", - "x-ms-summary": "" + "description": "Contains details about the password rules for a user.", + "x-ms-summary": "Contains details about the password rules for a user." }, "userProfile": { "type": "object", @@ -47355,7 +58214,7 @@ "description": "A complex element consisting of: \n\n- `lastSentDateTime`: The date and time the user last sent an envelope. \n- `lastSignedDateTime`: The date and time the user last signed an envelope.\n- `sentCount`: The number of envelopes the user has sent.\n- `signedCount`: The number of envelopes the user has signed. \n" }, "userDetails": { - "$ref": "#/definitions/Users", + "$ref": "#/definitions/userInformation", "description": "" }, "userProfileLastModifiedDate": { @@ -47382,8 +58241,12 @@ "$ref": "#/definitions/settingsMetadata", "description": "Reserved for DocuSign." }, + "allowAutoTagging": { + "description": "When set to **true**, the API returns suggested tabs for documents for this user.", + "type": "string" + }, "allowEnvelopeTransferTo": { - "description": "Boolean value that indicates whether the user can participate in envelope transfers on the account.", + "description": "When set to **true**, this user can participate in envelope transfers on the account.", "type": "string" }, "allowEnvelopeTransferToMetadata": { @@ -47391,23 +58254,23 @@ "description": "Reserved for DocuSign." }, "allowEsealRecipients": { - "description": "", + "description": "When set to **true**, this user can create [electronic seal recipients][eseal].\n\n[eseal]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipients/#seal-recipient", "type": "string" }, "allowEsealRecipientsMetadata": { "$ref": "#/definitions/settingsMetadata", - "description": "" + "description": "Metadata about the `allowEsealRecipientsMetadata` property." }, "allowPowerFormsAdminToAccessAllPowerFormEnvelope": { - "description": "", + "description": "When set to **true** and this user is an administrator, they can view all of the envelopes generated from PowerForms. The default value is **false**.", "type": "string" }, "allowPowerFormsAdminToAccessAllPowerFormEnvelopeMetadata": { "$ref": "#/definitions/settingsMetadata", - "description": "" + "description": "Metadata about the `allowPowerFormsAdminToAccessAllPowerFormEnvelopeMetadata` property." }, "allowRecipientLanguageSelection": { - "description": "When true, this user can set the language used in the standard email format for a recipient when creating an envelope.", + "description": "When set to **true**, this user can set the language used in the standard email format for a recipient when creating an envelope.", "type": "string" }, "allowRecipientLanguageSelectionMetadata": { @@ -47415,7 +58278,7 @@ "description": "Metadata for allowRecipientLanguageSelection." }, "allowSendOnBehalfOf": { - "description": "When **true**, this user can send envelopes \"on behalf of\" other users through the API.", + "description": "When set to **true**, this user can send envelopes \"on behalf of\" other users through the API.", "type": "string" }, "allowSendOnBehalfOfMetadata": { @@ -47431,7 +58294,7 @@ "description": "Metadata that indicates whether the `allowSupplementalDocuments` property is editable." }, "anchorTagVersionedPlacementEnabled": { - "description": "Valid values are:\n\n- `system_default`\n- `off`\n- `on`\n", + "description": "Reserved for DocuSign.\n", "type": "string" }, "apiAccountWideAccess": { @@ -47448,7 +58311,7 @@ }, "apiCanExportACMetadata": { "$ref": "#/definitions/settingsMetadata", - "description": "" + "description": "Metadata about the `apiCanExportACMetadata` property." }, "bulkSend": { "description": "When **true**, this user can use the bulk send feature for the account.", @@ -47472,15 +58335,15 @@ }, "canEditSharedAddressbookMetadata": { "$ref": "#/definitions/settingsMetadata", - "description": "" + "description": "Metadata about the `canEditSharedAddressbookMetadata` property." }, "canLockEnvelopes": { - "description": "", + "description": "When set to **true**, this user can lock envelopes.", "type": "string" }, "canLockEnvelopesMetadata": { "$ref": "#/definitions/settingsMetadata", - "description": "" + "description": "Metadata about the `canLockEnvelopes` property." }, "canManageAccount": { "description": "When **true**, this user is an administrator for the account.", @@ -47488,7 +58351,7 @@ }, "canManageAccountMetadata": { "$ref": "#/definitions/settingsMetadata", - "description": "" + "description": "Metadata about the `canManageAccountMetadata` property." }, "canManageDistributor": { "description": "Reserved for DocuSign.", @@ -47496,7 +58359,7 @@ }, "canManageDistributorMetadata": { "$ref": "#/definitions/settingsMetadata", - "description": "" + "description": "Metadata about the `canManageDistributor` property." }, "canManageTemplates": { "description": "When **true**, this user can manage templates for the account.", @@ -47504,7 +58367,7 @@ }, "canManageTemplatesMetadata": { "$ref": "#/definitions/settingsMetadata", - "description": "" + "description": "Metadata about the `canManageTemplates` property." }, "canSendAPIRequests": { "description": "When **true**, this user can send API requests on the account.", @@ -47512,7 +58375,7 @@ }, "canSendAPIRequestsMetadata": { "$ref": "#/definitions/settingsMetadata", - "description": "" + "description": "Metadata about the `canSendAPIRequests` property." }, "canSendEnvelope": { "description": "When **true**, this user can send envelopes on the account.", @@ -47520,7 +58383,7 @@ }, "canSendEnvelopeMetadata": { "$ref": "#/definitions/settingsMetadata", - "description": "" + "description": "Metadata about the `canSendEnvelope` property." }, "canSignEnvelope": { "description": "When **true**, this user can sign envelopes.", @@ -47528,15 +58391,23 @@ }, "canSignEnvelopeMetadata": { "$ref": "#/definitions/settingsMetadata", - "description": "" + "description": "Metadata about the `canSignEnvelope` property." }, "canUseScratchpad": { - "description": "", + "description": "When set to **true**, this user can use a scratchpad to edit information.", "type": "string" }, "canUseScratchpadMetadata": { "$ref": "#/definitions/settingsMetadata", - "description": "" + "description": "Metadata about the `canUseScratchpad` property." + }, + "canUseSmartContracts": { + "description": "Reserved for DocuSign.", + "type": "string" + }, + "canUseSmartContractsMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Reserved for DocuSign." }, "disableDocumentUpload": { "description": "When **true**, this user is prohibited from uploading documents during sending.", @@ -47563,7 +58434,7 @@ "description": "Metadata that indicates whether the `enableDSPro` property is editable.\n" }, "enableSequentialSigningAPI": { - "description": "When **true**, the account can define the routing\norder of recipients for envelopes sent using the DocuSign API.\n", + "description": "When set to **true**, the account can define the routing\norder of recipients for envelopes sent by using the eSignature API.\n\n**Note**: Only SysAdmin users can change this setting.", "type": "string" }, "enableSequentialSigningAPIMetadata": { @@ -47571,7 +58442,7 @@ "description": "Metadata that indicates whether the `enableSequentialSigningAPI` property is editable.\n" }, "enableSequentialSigningUI": { - "description": "When **true**, the account can define the routing order\nof recipients for envelopes sent using the DocuSign application.\n", + "description": "When set to **true**, the account can define the routing order\nof recipients for envelopes sent by using the DocuSign application.\n\n**Note**: Only SysAdmin users can change this setting.\n", "type": "string" }, "enableSequentialSigningUIMetadata": { @@ -47587,7 +58458,7 @@ "description": "Metadata that indicates whether the `enableSignerAttachments` property is editable.\n" }, "enableSignOnPaperOverride": { - "description": "When **true**, this user can override the Sign on Paper account setting, which specifies whether signers can sign documents on paper as an option to signing electronically.", + "description": "When set to **true**, a user can override the default default account setting for the Sign on Paper option, which specifies whether signers can sign documents on paper as an option to signing electronically.\n\n**Note**: Only Admin users can change this setting.", "type": "string" }, "enableSignOnPaperOverrideMetadata": { @@ -47600,10 +58471,10 @@ }, "enableTransactionPointMetadata": { "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `enableTransactionPoint` property is editable.\n" + "description": "Reserved for DocuSign." }, "enableVaulting": { - "description": "When true, Vaulting is enabled for the account. ", + "description": "When set to **true**, Vaulting is enabled for the account.", "type": "string" }, "enableVaultingMetadata": { @@ -47611,36 +58482,44 @@ "description": "Metadata that indicates whether the `enableVaulting` property is editable.\n" }, "expressSendOnly": { - "description": "", + "description": "When set to **false**, this user can apply tabs to documents during the sending experience.", "type": "string" }, "locale": { - "description": "The user's locale code:\n- `zh_CN`\n- `zh_TW`\n- `nl`\n- `en`\n- `fr`\n- `de`\n- `it`\n- `ja`\n- `ko`\n- `pt`\n- `pt_BR`\n- `ru`\n- `es`", + "description": "The user's locale code. Valid values are:\n- `zh_CN`\n- `zh_TW`\n- `nl`\n- `en`\n- `fr`\n- `de`\n- `it`\n- `ja`\n- `ko`\n- `pt`\n- `pt_BR`\n- `ru`\n- `es`", "type": "string" }, "localeMetadata": { "$ref": "#/definitions/settingsMetadata", - "description": "" + "description": "Metadata about the `locale` property." }, "localePolicy": { "$ref": "#/definitions/localePolicy", "description": "Reserved for DocuSign." }, + "manageClickwrapsMode": { + "description": "When set to **true**, this user can create and manage [Clickwraps](https://developers.docusign.com/click-api).", + "type": "string" + }, + "manageClickwrapsModeMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata about the `manageClickwrapsMode` property." + }, "modifiedBy": { - "description": "User ID (GUID) of the user who last modified this user record.", + "description": "The user id (GUID) of the user who last modified this user record.", "type": "string" }, "modifiedByMetadata": { "$ref": "#/definitions/settingsMetadata", - "description": "" + "description": "Metadata about the `modifiedBy` property." }, "modifiedDate": { - "description": "Most recent date on which this user record was modified.", + "description": "The date on which this user record was last modified.", "type": "string" }, "modifiedDateMetadata": { "$ref": "#/definitions/settingsMetadata", - "description": "" + "description": "Metadata about the `modifiedDate` property." }, "modifiedPage": { "description": "Note referencing the page that modified this user record.", @@ -47648,7 +58527,7 @@ }, "modifiedPageMetadata": { "$ref": "#/definitions/settingsMetadata", - "description": "" + "description": "Metadata about the `modifiedPage` property." }, "newSendUI": { "description": "Reserved for DocuSign.", @@ -47656,7 +58535,7 @@ }, "newSendUIMetadata": { "$ref": "#/definitions/settingsMetadata", - "description": "" + "description": "Metadata about the `newSendUI` property." }, "powerFormMode": { "description": "Indicates the Power Form mode setting for the user:\n- `none`\n- `admin`\n- `user`", @@ -47664,7 +58543,7 @@ }, "powerFormModeMetadata": { "$ref": "#/definitions/settingsMetadata", - "description": "" + "description": "Metadata about the `powerFormMode` property." }, "recipientViewedNotification": { "description": "When **true**, this user receives notifications when envelopes are viewed.", @@ -47672,17 +58551,17 @@ }, "recipientViewedNotificationMetadata": { "$ref": "#/definitions/settingsMetadata", - "description": "" + "description": "Metadata about the `recipientViewedNotification` property." }, "sealIdentifiers": { - "description": "", + "description": "Information about the seals associated with this user.", "type": "array", "items": { "$ref": "#/definitions/sealIdentifier" } }, "selfSignedRecipientEmailDocument": { - "description": "Valid values are:\n\n- `include_pdf`\n- `include_link`\n", + "description": "Sets how self-signed documents are presented to the email recipients.\nValid values are:\n\n- `include_pdf`: A PDF of the completed document is attached to the email.\n- `include_link`: A secure link to the self-signed documents is included\n in the email.\n\n**Note**: Only Admin users can change this setting.\n", "type": "string" }, "selfSignedRecipientEmailDocumentMetadata": { @@ -47710,7 +58589,7 @@ "description": "Metadata that indicates whether the `supplementalDocumentsMustAccept` property is editable.\n" }, "supplementalDocumentsMustRead": { - "description": "When **true**, this user must read supplemental documents.", + "description": "When **true**, this user must both view and accept supplemental documents.", "type": "string" }, "supplementalDocumentsMustReadMetadata": { @@ -47726,28 +58605,28 @@ "description": "Metadata that indicates whether the `supplementalDocumentsMustView` property is editable.\n" }, "templateActiveCreation": { - "description": "", + "description": "When set to **true**, a new template is created each time the user sends an envelope.", "type": "string" }, "templateActiveCreationMetadata": { "$ref": "#/definitions/settingsMetadata", - "description": "" + "description": "Metadata about the `templateActiveCreation` property." }, "templateApplyNotify": { - "description": "", + "description": "When set to **true**, the system notifies this user before applying a matching template.", "type": "string" }, "templateApplyNotifyMetadata": { "$ref": "#/definitions/settingsMetadata", - "description": "" + "description": "Metadata about the `templateApplyNotify` property." }, "templateAutoMatching": { - "description": "", + "description": "When set to **true**, the system automatically applies a matching template to a document if only one template matches. If there are multiple matches, it displays a list of matches to select from.", "type": "string" }, "templateAutoMatchingMetadata": { "$ref": "#/definitions/settingsMetadata", - "description": "" + "description": "Metadata about the `templateAutoMatching` property." }, "templateMatchingSensitivity": { "description": "Percentage used when matching templates.", @@ -47755,7 +58634,7 @@ }, "templateMatchingSensitivityMetadata": { "$ref": "#/definitions/settingsMetadata", - "description": "" + "description": "Metadata about the `tempalteMatchingSensitivity` property." }, "templatePageLevelMatching": { "description": "When **true**, users see template matching functionality.", @@ -47763,7 +58642,7 @@ }, "templatePageLevelMatchingMetadata": { "$ref": "#/definitions/settingsMetadata", - "description": "" + "description": "Metadata about the `templatePageLevelMatching` property." }, "timezoneDST": { "description": "When true, daylight savings time is in effect for this user's time zone.", @@ -47771,15 +58650,15 @@ }, "timezoneDSTMetadata": { "$ref": "#/definitions/settingsMetadata", - "description": "" + "description": "Metadata about the `timezoneDST` property." }, "timezoneMask": { - "description": "", + "description": "The custom DateTime format setting for this user.", "type": "string" }, "timezoneMaskMetadata": { "$ref": "#/definitions/settingsMetadata", - "description": "" + "description": "Metadata about the `timezoneMask` property." }, "timezoneOffset": { "description": "The timezone offset for the user. Valid values:\n- `tz_01_afghanistan`\n- `tz_02_alaskan`\n- `tz_03_arab`\n- `tz_04_arabian`\n- `tz_05_arabic`\n- `tz_06_argentina`\n- `tz_07_atlantic`\n- `tz_08_aus_central`\n- `tz_09_aus_eastern`\n- `tz_10_azerbaijan`\n- `tz_11_azores`\n- `tz_12_bangladesh`\n- `tz_13_canada_central`\n- `tz_14_cape_verde`\n- `tz_15_caucasus`\n- `tz_16_central_australia`\n- `tz_17_central_america`\n- `tz_18_central_asia`\n- `tz_19_central_brazilian`\n- `tz_20_central_europe`\n- `tz_21_central_european`\n- `tz_22_central_pacific`\n- `tz_23_central`\n- `tz_24_central_mexico`\n- `tz_25_china`\n- `tz_26_dateline`\n- `tz_27_east_africa`\n- `tz_28_east_australia`\n- `tz_29_east_europe`\n- `tz_30_east_south_america`\n- `tz_31_eastern`\n- `tz_32_egypt`\n- `tz_33_ekaterinburg`\n- `tz_34_fiji`\n- `tz_35_fli`\n- `tz_36_georgian`\n- `tz_37_gmt`\n- `tz_38_greenland`\n- `tz_39_greenwich`\n- `tz_40_gtb`\n- `tz_41_hawaiian`\n- `tz_42_india`\n- `tz_43_iran`\n- `tz_44_israel`\n- `tz_45_jordan`\n- `tz_46_kaliningrad`\n- `tz_47_kamchatka`\n- `tz_48_korea`\n- `tz_49_magadan`\n- `tz_50_mauritius`\n- `tz_51_mid_atlantic`\n- `tz_52_middle_east`\n- `tz_53_montevideo`\n- `tz_54_morocco`\n- `tz_55_mountain`\n- `tz_56_mountain_mexico`\n- `tz_57_myanmar`\n- `tz_58_north_central_asia`\n- `tz_59_namibia`\n- `tz_60_nepal`\n- `tz_61_new_zealand`\n- `tz_62_new_foundland`\n- `tz_63_north_asia_east`\n- `tz_64_north_asia`\n- `tz_65_pacific_sa`\n- `tz_66_pacific`\n- `tz_67_pacific_mexico`\n- `tz_68_pakistan`\n- `tz_69_paraguay`\n- `tz_70_romance`\n- `tz_71_russian`\n- `tz_72_sa_eastern`\n- `tz_73_sa_pacific`\n- `tz_74_sa_western`\n- `tz_75_samoa`\n- `tz_76_se_asia`\n- `tz_77_singapore`\n- `tz_78_south_africa`\n- `tz_79_sriLanka`\n- `tz_80_syria`\n- `tz_81_taipei`\n- `tz_82_tasmania`\n- `tz_83_tokyo`\n- `tz_84_tonga`\n- `tz_85_turkey`\n- `tz_86_ulaanbaatar`\n- `tz_87_us_eastern`\n- `tz_88_us_mountain`\n- `tz_89_venezuela`\n- `tz_90_vladivostok`\n- `tz_91_west_australia`\n- `tz_92_west_central_africa`\n- `tz_93_west_europe`\n- `tz_94_west_asia`\n- `tz_95_west_pacific`\n- `tz_96_yakutsk`", @@ -47787,7 +58666,7 @@ }, "timezoneOffsetMetadata": { "$ref": "#/definitions/settingsMetadata", - "description": "" + "description": "Metadata about the `timezoneOffset` property." }, "timezoneSendingPref": { "description": "Reserved for DocuSign.", @@ -47795,7 +58674,7 @@ }, "timezoneSendingPrefMetadata": { "$ref": "#/definitions/settingsMetadata", - "description": "" + "description": "Reserved for DocuSign." }, "timezoneSigningPref": { "description": "Reserved for DocuSign.", @@ -47803,7 +58682,7 @@ }, "timezoneSigningPrefMetadata": { "$ref": "#/definitions/settingsMetadata", - "description": "" + "description": "Reserved for DocuSign." }, "transactionPointSiteNameURL": { "description": "Reserved for DocuSign.", @@ -47811,7 +58690,7 @@ }, "transactionPointSiteNameURLMetadata": { "$ref": "#/definitions/settingsMetadata", - "description": "" + "description": "Reserved for DocuSign." }, "transactionPointUserName": { "description": "Reserved for DocuSign.", @@ -47819,7 +58698,7 @@ }, "transactionPointUserNameMetadata": { "$ref": "#/definitions/settingsMetadata", - "description": "" + "description": "Reserved for DocuSign." }, "vaultingMode": { "description": "Indicates the specified Vaulting mode:\n- `none`\n- `estored`\n- `electronic_original`", @@ -47827,12 +58706,12 @@ }, "vaultingModeMetadata": { "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `vaultingMode` property is editable.\n" + "description": "Metadata about the `vaultingMode` property." } }, "x-ds-definition-name": "userSettingsInformation", - "description": "Data that describes settings for a user. Some elements of this object have a `metadata` property, which includes the following:\n- `rights`: The calling users permissions to edit this setting (can be `editable` or `read_only`)\n- `uiHint`: Internally used to build UIs (can be `available` or `hidden`)\n- `options`: The values supported for this setting (not all settings have this element)", - "x-ms-summary": "Data that describes settings for a user. Some elements of this object have a `metadata` property, which includes the following:\n- `rights`: The calling users permissions to edit this setting (can be `editable` or `read_only`)\n- `uiHint`: Internally used to build UIs (can be `available` or `hidden`)\n- `options`: The values supported for this setting (not all settings have this element)" + "description": "Properties that configure the settings for a user. Some elements of this object have a `metadata` property, which includes the following:\n- `rights`: The calling users permissions to edit this setting (can be `editable` or `read_only`)\n- `uiHint`: Internally used to build UIs (can be `available` or `hidden`)\n- `options`: The values supported for this setting (not all settings have this element)", + "x-ms-summary": "Properties that configure the settings for a user. Some elements of this object have a `metadata` property, which includes the following:\n- `rights`: The calling users permissions to edit this setting (can be `editable` or `read_only`)\n- `uiHint`: Internally used to build UIs (can be `available` or `hidden`)\n- `options`: The values supported for this setting (not all settings have this element)" }, "userSharedItem": { "type": "object", @@ -47858,11 +58737,11 @@ "type": "object", "properties": { "adoptedDateTime": { - "description": "The date and time on which the user adopted the signature.", + "description": "The date and time the user adopted their signature.", "type": "string" }, "createdDateTime": { - "description": "The date and time the item was created.", + "description": "The UTC DateTime when the item was created.", "type": "string" }, "customField": { @@ -47874,7 +58753,7 @@ "description": "Specifies the area in which a date stamp is placed. This parameter uses pixel positioning to draw a rectangle at the center of the stamp area. The stamp is superimposed on top of this central area.\n\nThis property contains the following information about the central rectangle:\n\n- `DateAreaX`: The X axis position of the top-left corner.\n- `DateAreaY`: The Y axis position of the top-left corner.\n- `DateAreaWidth`: The width of the rectangle.\n- `DateAreaHeight`: The height of the rectangle." }, "disallowUserResizeStamp": { - "description": "When set to **true**, the user cannot resize the stamp.", + "description": "When set to **true**, users may not resize the stamp.", "type": "string" }, "errorDetails": { @@ -47886,11 +58765,11 @@ "type": "string" }, "imageBase64": { - "description": "", + "description": "A Base64-encoded representation of the signature image.", "type": "string" }, "imageType": { - "description": "The type of image. Valid values are: \n\n- `signature_image` \n- `initials_image`", + "description": "Specificies the type of image. Valid values are:\n\n- `signature_image`\n- `initials_image`", "type": "string" }, "initials150ImageId": { @@ -47898,7 +58777,7 @@ "type": "string" }, "initialsImageUri": { - "description": "Contains the URI for an endpoint that you can use to retrieve the initials image.", + "description": "The URI for retrieving the image of the user's initials.", "type": "string" }, "isDefault": { @@ -47906,7 +58785,7 @@ "type": "string" }, "lastModifiedDateTime": { - "description": "The date and time the item was last modified.", + "description": "The date and time that the item was last modified.", "type": "string" }, "nrdsId": { @@ -47930,11 +58809,11 @@ "type": "string" }, "signatureFont": { - "description": "", + "description": "The font type for the signature, if the signature is not drawn. The supported font types are:\n\n\"7_DocuSign\", \"1_DocuSign\", \"6_DocuSign\", \"8_DocuSign\", \"3_DocuSign\", \"Mistral\", \"4_DocuSign\", \"2_DocuSign\", \"5_DocuSign\", \"Rage Italic\"\n", "type": "string" }, "signatureId": { - "description": "The ID of the signature being accessed.", + "description": "Specifies the signature ID associated with the signature name. You can use the signature ID in the URI in place of the signature name, and the value stored in the `signatureName` property in the body is used. This allows the use of special characters (such as \"&\", \"<\", \">\") in a the signature name. Note that with each update to signatures, the returned signature ID might change, so the caller will need to trigger off the signature name to get the new signature ID.", "type": "string" }, "signatureImageUri": { @@ -47942,7 +58821,7 @@ "type": "string" }, "signatureInitials": { - "description": "Specifies the user's signature in initials format.", + "description": " The initials associated with the signature.", "type": "string" }, "signatureName": { @@ -47958,11 +58837,11 @@ "type": "string" }, "stampFormat": { - "description": "The format of the stamp. Valid values are:\n\n- `NameHanko`: The stamp represents only the signer's name.\n- `NameDateHanko`: The stamp represents the signer's name and the date. ", + "description": "The format of a stamp. Valid values are:\n\n- `NameHanko`: The stamp represents only the signer's name.\n- `NameDateHanko`: The stamp represents the signer's name and the date. ", "type": "string" }, "stampImageUri": { - "description": "The URL for retrieving the image of the user's stamp.", + "description": "The URI for retrieving the image of the user's stamp.", "type": "string" }, "stampSizeMM": { @@ -47970,7 +58849,11 @@ "type": "string" }, "stampType": { - "description": "If the recipient signs by using a personal stamp that is representative of their signature, this property specifies the stamp type.", + "description": "The type of stamp. Valid values are:\n\n- `signature`: A signature image. This is the default value.\n- `stamp`: A stamp image.\n- null", + "type": "string" + }, + "status": { + "description": "Indicates the envelope status. Valid values are:\n\n* sent - The envelope is sent to the recipients. \n* created - The envelope is saved as a draft and can be modified and sent later.", "type": "string" } }, @@ -47986,7 +58869,7 @@ "description": "Specifies the area in which a date stamp is placed. This parameter uses pixel positioning to draw a rectangle at the center of the stamp area. The stamp is superimposed on top of this central area.\n\nThis property contains the following information about the central rectangle:\n\n- `DateAreaX`: The X axis position of the top-left corner.\n- `DateAreaY`: The Y axis position of the top-left corner.\n- `DateAreaWidth`: The width of the rectangle.\n- `DateAreaHeight`: The height of the rectangle." }, "disallowUserResizeStamp": { - "description": "When set to **true**, the user cannot resize the stamp.", + "description": "When set to **true**, users may not resize the stamp.", "type": "string" }, "externalID": { @@ -47994,7 +58877,7 @@ "type": "string" }, "imageType": { - "description": "The type of image. Valid values are: \n\n- `signature_image` \n- `initials_image`", + "description": "Specificies the type of image. Valid values are:\n\n- `signature_image`\n- `initials_image`", "type": "string" }, "isDefault": { @@ -48014,7 +58897,7 @@ "type": "string" }, "signatureFont": { - "description": "", + "description": "The font type to use for the signature if the signature is not drawn. The following font styles are supported. The quotes are to indicate that these values are strings, not `enums`.\n\n- `\"1_DocuSign\"`\n- `\"2_DocuSign\"`\n- `\"3_DocuSign\"`\n- `\"4_DocuSign\"`\n- `\"5_DocuSign\"`\n- `\"6_DocuSign\"`\n- `\"7_DocuSign\"`\n- `\"8_DocuSign\"`\n- `\"Mistral\"`\n- `\"Rage Italic\"`\n", "type": "string" }, "signatureId": { @@ -48030,7 +58913,7 @@ "type": "string" }, "stampFormat": { - "description": "The format of the stamp. Valid values are:\n\n- `NameHanko`: The stamp represents only the signer's name.\n- `NameDateHanko`: The stamp represents the signer's name and the date. ", + "description": "The format of a stamp. Valid values are:\n\n- `NameHanko`: The stamp represents only the signer's name.\n- `NameDateHanko`: The stamp represents the signer's name and the date. ", "type": "string" }, "stampSizeMM": { @@ -48046,10 +58929,10 @@ "type": "object", "properties": { "userSignatures": { - "description": "A list of `UserSignatures` objects, each of which defines a user's digital signature.", + "description": "An array of `userSignature` objects.", "type": "array", "items": { - "$ref": "#/definitions/UserSignatures" + "$ref": "#/definitions/userSignature" } } }, @@ -48061,10 +58944,10 @@ "type": "object", "properties": { "socialAccountInformation": { - "description": "Contains properties that map a DocuSign user to a social account (Facebook, Yahoo, etc.)", + "description": "Contains properties that map a DocuSign user to a social account such as Facebook or Yahoo.", "type": "array", "items": { - "$ref": "#/definitions/UserSocialAccountLogins" + "$ref": "#/definitions/socialAccountInformation" } }, "userId": { @@ -48080,7 +58963,7 @@ "type": "object", "properties": { "endPosition": { - "description": "The last position in the result set. ", + "description": "The last index position in the result set. ", "type": "string" }, "nextUri": { @@ -48092,15 +58975,15 @@ "type": "string" }, "resultSetSize": { - "description": "The number of results returned in this response. Because you can filter which entries are included in the response, this value is always less than or equal to `totalSetSize`.", + "description": "The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`.", "type": "string" }, "startPosition": { - "description": "The starting position of the current result set.", + "description": "The starting index position of the current result set.", "type": "string" }, "totalSetSize": { - "description": "The total number of items in the search's result set. This value is always greater than or equal to the value of `resultSetSize`.", + "description": "The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`.", "type": "string" }, "users": { @@ -48118,21 +59001,29 @@ "view": { "type": "object", "properties": { + "anchorAllowWhiteSpaceInCharacters": { + "description": "", + "type": "string" + }, + "anchorAllowWhiteSpaceInCharactersMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "" + }, "anchorCaseSensitive": { - "description": "Reserved for DocuSign.\n", + "description": "This property controls how [anchor tabs][AnchorTabs] are placed. When **true**, the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false**.\n\nFor example, when set to **true**, if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When set to **false**, `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**.\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place", "type": "string" }, "anchorCaseSensitiveMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "description": "Metadata that indicates whether the `anchorCaseSensitive` property is editable." }, "anchorHorizontalAlignment": { - "description": "Reserved for DocuSign.\n\n", + "description": "This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are :\n\n- `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value.\n- `right`: Aligns the tab’s left side with the last character of the matching anchor word.\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place\n", "type": "string" }, "anchorHorizontalAlignmentMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "description": "Metadata that indicates whether the `anchorHorizontalAlignment` property is editable." }, "anchorIgnoreIfNotPresent": { "description": "When set to **true**, this tab is ignored if the `anchorString` is not found in the document.", @@ -48143,12 +59034,12 @@ "description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable." }, "anchorMatchWholeWord": { - "description": "Reserved for DocuSign.\n\n", + "description": "When set to **true**, the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false**.\n\nFor example, when set to **true**, if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When set to **false**, if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**.\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTab]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place\n", "type": "string" }, "anchorMatchWholeWordMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "description": "Metadata that indicates whether the `anchorMatchWholeWord` property is editable." }, "anchorString": { "description": "Specifies the string to find in the document and use as the basis for tab placement.", @@ -48167,7 +59058,7 @@ "description": "Reserved for DocuSign." }, "anchorUnits": { - "description": "Specifies the units of the X and Y offset. Units may be pixels, millimeters, centimeters, or inches.", + "description": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n", "type": "string" }, "anchorUnitsMetadata": { @@ -48175,7 +59066,7 @@ "description": "Metadata that indicates whether the `anchorUnits` property is editable." }, "anchorXOffset": { - "description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.", + "description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n", "type": "string" }, "anchorXOffsetMetadata": { @@ -48183,7 +59074,7 @@ "description": "Metadata that indicates whether the `anchorXOffset` property is editable." }, "anchorYOffset": { - "description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.", + "description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n", "type": "string" }, "anchorYOffsetMetadata": { @@ -48223,7 +59114,7 @@ "description": "Metadata that indicates whether the `conditionalParentValue` property is editable." }, "customTabId": { - "description": "The DocuSign-generated custom tab id for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.", + "description": "The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.", "type": "string" }, "customTabIdMetadata": { @@ -48231,7 +59122,7 @@ "description": "Metadata that indicates whether the `customTabId` property is editable." }, "documentId": { - "description": "Integer that identifies the document in the envelope.", + "description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.", "type": "string" }, "documentIdMetadata": { @@ -48314,6 +59205,10 @@ "$ref": "#/definitions/mergeField", "description": "Contains the information necessary to map the tab to a field in SalesForce." }, + "mergeFieldXml": { + "description": "", + "type": "string" + }, "pageNumber": { "description": "The page number on which the tab is located. For supplemental documents, this value must be `1`.", "type": "string" @@ -48327,7 +59222,7 @@ "type": "string" }, "recipientIdGuid": { - "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one.", + "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only.", "type": "string" }, "recipientIdGuidMetadata": { @@ -48350,6 +59245,10 @@ "description": "When set to **true**, the recipient must read through the document.", "type": "string" }, + "smartContractInformation": { + "$ref": "#/definitions/smartContractInformation", + "description": "" + }, "status": { "description": "The status of the tab. Possible values are:\n\n- `active`: The tab is active, but the recipient has not yet interacted with it.\n- `signed`: The recipient signed the tab.\n- `declined`: The recipient declined the envelope.\n- `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`).", "type": "string" @@ -48378,7 +59277,7 @@ "description": "Metadata that indicates whether the `tabId` property is editable." }, "tabLabel": { - "description": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n", + "description": "The label associated with the tab. This value may be an empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum Length: 500 characters.\n", "type": "string" }, "tabLabelMetadata": { @@ -48442,7 +59341,7 @@ "description": "Metadata that indicates whether the `width` property is editable." }, "xPosition": { - "description": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n", + "description": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\n", "type": "string" }, "xPositionMetadata": { @@ -48450,7 +59349,7 @@ "description": "Metadata that indicates whether the `xPosition` property is editable." }, "yPosition": { - "description": "This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.", + "description": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\n", "type": "string" }, "yPositionMetadata": { @@ -48466,7 +59365,7 @@ "type": "object", "properties": { "url": { - "description": "The endpoint to which webhook notification messages are sent via an HTTP/S POST request. For the DocuSign production platform, the url must start with https. For the demo platform, either http or https is ok.", + "description": "URL to the Review ID page.", "type": "string" } }, @@ -48527,26 +59426,37 @@ }, "accessCodeMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the `accessCode` property." + "description": "Metadata that indicates whether the `accessCode` property is editable. Read only." }, "addAccessCodeToEmail": { - "description": "This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient.", + "description": "Optional. When set to **true**, the access code will be added to the email sent to the recipient. This nullifies the security measure of `accessCode` on the recipient.", "type": "string" }, + "additionalNotifications": { + "description": "An array of additional notification objects.", + "type": "array", + "items": { + "$ref": "#/definitions/recipientAdditionalNotification" + } + }, "agentCanEditEmail": { - "description": "When set to **true**, the agent can edit the email address of the recipient.", + "description": "Optional element. When set to **true**, the agents recipient associated with this recipient can change the recipient's pre-populated email address. This element is only active if enabled for the account.", "type": "string" }, "agentCanEditName": { - "description": "When set to **true**, the agent can edit the name of the recipient.", + "description": "Optional element. When set to **true**, the agents recipient associated with this recipient can change the recipient's pre-populated name. This element is only active if enabled for the account.", + "type": "string" + }, + "allowSystemOverrideForLockedRecipient": { + "description": "", "type": "string" }, "autoNavigation": { - "description": "When **true**, auto navigation is set for the recipient.\n", + "description": "When set to **true**, autonavigation is set for the recipient.\n", "type": "string" }, "bulkRecipientsUri": { - "description": "Contains a URI for an endpoint that allows you to easily retrieve bulk recipient information.", + "description": "Reserved for DocuSign.", "type": "string" }, "canSignOffline": { @@ -48558,11 +59468,11 @@ "type": "string" }, "completedCount": { - "description": "Indicates the number of times that the recipient has been through a signing completion for the envelope.\n\nIf this number is greater than 0 for a signing group, only the user who previously completed may sign again.", + "description": "Indicates the number of times that the recipient has been through a signing completion for the envelope. If this number is greater than 0 for a signing group, only the user who previously completed may sign again. Read only.", "type": "string" }, "creationReason": { - "description": "Payment status for payment services.", + "description": "The reason why the recipient was created (for example, `sender`). Read only.", "type": "string" }, "customFields": { @@ -48573,11 +59483,11 @@ } }, "declinedDateTime": { - "description": "The date and time the recipient declined the document.", + "description": "The date and time the recipient declined the document. Read only.", "type": "string" }, "declinedReason": { - "description": "The reason the recipient declined the document.", + "description": "The reason the recipient declined the document. Read only.", "type": "string" }, "defaultRecipient": { @@ -48585,7 +59495,7 @@ "type": "string" }, "deliveredDateTime": { - "description": "The date and time that the envelope was delivered to the recipient.", + "description": "The date and time that the envelope was delivered to the recipient. Read only.", "type": "string" }, "deliveryMethod": { @@ -48596,27 +59506,35 @@ "$ref": "#/definitions/propertyMetadata", "description": "Reserved for DocuSign." }, + "designatorId": { + "description": "", + "type": "string" + }, + "designatorIdGuid": { + "description": "", + "type": "string" + }, "documentVisibility": { - "description": "A list of documentVisibility objects, which define a recipient's read/write access to a document.", + "description": "A list of `documentVisibility` objects. Each object in the list specifies whether a document in the envelope is visible to this recipient. For the envelope to use this functionality, Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true**.", "type": "array", "items": { "$ref": "#/definitions/documentVisibility" } }, "email": { - "description": "The email id of the recipient.", + "description": "The recipient's email address.", "type": "string" }, "emailMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the email address of the witness." + "description": "Metadata that indicates whether the `email` property is editable. Read only." }, "emailNotification": { "$ref": "#/definitions/recipientEmailNotification", - "description": "An optional complex type that sets a specific email subject and body for this recipient's notification email. \n\n**Note**: If you use this field to set a specific email notification for one recipient, you must also set the email notification for the other recipients. Using this field for one or more recipients negates the Envelope `Subject` and `EmailBlurb` property settings. " + "description": "An optional complex type that sets a specific email subject and body for this recipient's notification email. \n\n**Note**: You can set the `emailNotification` property separately for each recipient. If you set the value only for certain recipients, the other recipients will inherit the this value from the top-level `emailSubject` and `emailBlurb`. " }, "embeddedRecipientStartURL": { - "description": "Specifies a sender-provided valid URL string for redirecting an embedded recipient. When this option is used, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the recipient clicks the document link in the email, the recipient is redirected through DocuSign to the specified URL to complete the required actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. \n\nIf set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation launched by a partner.\n\nIt is important to understand that in a typical embedded workflow, the authentication of an embedded recipient is the responsibility of the sending application. DocuSign expects that senders will follow their own processes for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process is initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process, bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient.\n\nIf the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: `envelopeId`, `recipientId`, `recipientName`, `recipientEmail`, and `customFields`. The `customFields` property must be set for the recipient or envelope. The merge fields are enclosed in double brackets. \n\n*Example*: \n\n`http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` ", + "description": "Specifies a sender-provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. \n\nIf set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation launched by a partner.\n\nIt is important to understand that in a typical embedded workflow, the authentication of an embedded recipient is the responsibility of the sending application. DocuSign expects that senders will follow their own processes for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process is initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process, bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient.\n\nIf the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: `envelopeId`, `recipientId`, `recipientName`, `recipientEmail`, and `customFields`. The `customFields` property must be set for the recipient or envelope. The merge fields are enclosed in double brackets. \n\n*Example*: \n\n`http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` ", "type": "string" }, "errorDetails": { @@ -48639,12 +59557,12 @@ "description": "Reserved for DocuSign." }, "firstName": { - "description": "The witness's first name. Maximum Length: 50 characters.", + "description": "The recipient's first name. Maximum Length: 50 characters.", "type": "string" }, "firstNameMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the witness's first name.\n" + "description": "Metadata that indicates whether the `firstame` property is editable. Read only." }, "fullName": { "description": "Reserved for DocuSign.", @@ -48655,12 +59573,12 @@ "description": "Reserved for DocuSign." }, "idCheckConfigurationName": { - "description": "The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting.\n\n**Example**: Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node.", + "description": "The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are:\n\n- `Phone Auth $`: The recipient must authenticate by using two-factor authentication (2FA). You provide the phone number to use for 2FA in the `phoneAuthentication` object.\n- `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object.\n- `ID Check $`: The recipient must answer detailed security questions. \n\n**Example**: Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node.", "type": "string" }, "idCheckConfigurationNameMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the `idCheckConfigurationName` property." + "description": "Metadata that indicates whether the `idCheckConfigurationName` property is editable. Read only." }, "idCheckInformationInput": { "$ref": "#/definitions/idCheckInformationInput", @@ -48668,27 +59586,27 @@ }, "identityVerification": { "$ref": "#/definitions/recipientIdentityVerification", - "description": "Specifies ID Verification applied on an envelope by workflow ID.
See the [list](https://developers.docusign.com/esign-rest-api/reference/Accounts/IdentityVerifications/list) method in the [IdentityVerifications](https://developers.docusign.com/esign-rest-api/reference/Accounts/IdentityVerifications) resource for more information on how to retrieve workflow IDs available for an account.
This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods.
Note that ID Verification and ID Check are two distinct methods. ID Verification checks recipients' identity by verifying their ID while ID Check relies on data available on public records (such as current and former address)." + "description": "Specifies the ID Verification workflow applied on an envelope by workflow ID.
See the [list](https://developers.docusign.com/docs/esign-rest-api/reference/Accounts/IdentityVerifications/list) method in the [IdentityVerifications](https://developers.docusign.com/docs/esign-rest-api/reference/Accounts/IdentityVerifications) resource for more information on how to retrieve workflow IDs available for an account.
This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods.
Note that ID Verification and ID Check are two distinct methods. ID Verification checks recipients' identity by verifying their ID while ID Check relies on data available on public records (such as current and former address)." }, "inheritEmailNotificationConfiguration": { "description": "When set to **true** and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account. ", "type": "string" }, "isBulkRecipient": { - "description": "When set to **true**, this signer is a bulk recipient and the recipient information is contained in a bulk recipient file. \n\nNote that when this is true the email and name for the recipient becomes bulk@recipient.com and \"Bulk Recipient\". These fields can not be changed for the bulk recipient. \n", + "description": "Reserved for DocuSign.\n", "type": "string" }, "isBulkRecipientMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the `isBulkRecipient` property." + "description": "Reserved for DocuSign." }, "lastName": { - "description": "The witness's last name.", + "description": "The recipient's last name.", "type": "string" }, "lastNameMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the witness's last name." + "description": "Metadata that indicates whether the `lastName` property is editable. Read only." }, "lockedRecipientPhoneAuthEditable": { "description": "Reserved for DocuSign.", @@ -48699,12 +59617,16 @@ "type": "string" }, "name": { - "description": "The full legal name of the witness.", + "description": "The full legal name of the recipient. Maximum Length: 100 characters.\n\n**Note**: You must always set a value for this property in requests, even if `firstName` and `lastName` are set.", "type": "string" }, "nameMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the full legal name of the witness." + "description": "Metadata that indicates whether the `name` property is editable. Read only." + }, + "notaryId": { + "description": "", + "type": "string" }, "note": { "description": "A note sent to the recipient in the signing email.\nThis note is unique to this recipient.\nIn the user interface,\nit appears near the upper left corner\nof the document\non the signing screen.\n\nMaximum Length: 1000 characters.\n", @@ -48712,15 +59634,19 @@ }, "noteMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the note to the recipient." + "description": "Metadata that indicates whether the `note` property is editable. Read only." }, "offlineAttributes": { "$ref": "#/definitions/offlineAttributes", - "description": "Reserved for DocuSign use. " + "description": "Reserved for DocuSign." }, "phoneAuthentication": { "$ref": "#/definitions/recipientPhoneAuthentication", - "description": "A complex type that contains the following elements:\n\n* `recipMayProvideNumber` - Boolean. When set to **true**, the recipient can use whatever phone number they choose.\n* `senderProvidedNumbers` - ArrayOfString. A list of phone numbers the recipient can use.\n* `recordVoicePrint` - Reserved.\n* `validateRecipProvidedNumber` - Reserved." + "description": "When `idCheckConfigurationName` is set to `Phone Auth $`, you use this complex type to provide the recipient authentication method details. It contains the following elements:\n\n* `recipMayProvideNumber`: Boolean. When set to **true**, the recipient can use whatever phone number they choose.\n* `senderProvidedNumbers`: ArrayOfStrings. A list of phone numbers the recipient can use.\n* `recordVoicePrint`: Reserved for DocuSign.\n* `validateRecipProvidedNumber`: Reserved for DocuSign.\n\n" + }, + "proofFile": { + "$ref": "#/definitions/recipientProofFile", + "description": "The proof file of the recipient." }, "recipientAttachments": { "description": "Reserved for DocuSign.", @@ -48731,21 +59657,21 @@ }, "recipientAuthenticationStatus": { "$ref": "#/definitions/authenticationStatus", - "description": "Information about the recipient's authentication status." + "description": "Information about the recipient's authentication status. Read only." }, "recipientFeatureMetadata": { - "description": "Metadata about the features that are supported for the recipient type.", + "description": "Metadata about the features that are supported for the recipient type. Read only.", "type": "array", "items": { "$ref": "#/definitions/featureAvailableMetadata" } }, "recipientId": { - "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", + "description": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.", "type": "string" }, "recipientIdGuid": { - "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one.", + "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only.", "type": "string" }, "recipientSignatureProviders": { @@ -48756,16 +59682,16 @@ } }, "recipientSuppliesTabs": { - "description": "Specifies whether the recipient creates the tabs.", + "description": "When set to **true**, specifies that the recipient creates the tabs.", "type": "string" }, "recipientType": { - "description": "The recipient type, as specified by the following values:\n- `agents`: Agent recipients can add name and email information for recipients that appear after the agent in routing order.\n- `carbonCopies`: Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date, or add information to any of the documents. This type of recipient can be used in any routing order.\n- `certifiedDeliveries`: Certified delivery recipients must receive the completed documents for the envelope to be completed. They don't need to sign, initial, date, or add information to any of the documents.\n- `editors`: Editors have the same management and access rights for the envelope as the sender. Editors can add name and email information, add or change the routing order, set authentication options, and can edit signature/initial tabs and data fields for the remaining recipients.\n- `inPersonSigners`: In-person recipients are DocuSign users who act as signing hosts in the same physical location as the signer.\n- `intermediaries`: Intermediary recipients can optionally add name and email information for recipients at the same or subsequent level in the routing order.\n- `seals`: Electronic seal recipients represent legal entities.\n- `signers`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope.\n- `witnesses`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope.", + "description": "The recipient type, as specified by the following values:\n- `agent`: Agent recipients can add name and email information for recipients that appear after the agent in routing order.\n- `carbonCopy`: Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date, or add information to any of the documents. This type of recipient can be used in any routing order.\n- `certifiedDelivery`: Certified delivery recipients must receive the completed documents for the envelope to be completed. They don't need to sign, initial, date, or add information to any of the documents.\n- `editor`: Editors have the same management and access rights for the envelope as the sender. Editors can add name and email information, add or change the routing order, set authentication options, and can edit signature/initial tabs and data fields for the remaining recipients.\n- `inPersonSigner`: In-person recipients are DocuSign users who act as signing hosts in the same physical location as the signer.\n- `intermediaries`: Intermediary recipients can optionally add name and email information for recipients at the same or subsequent level in the routing order.\n- `seal`: Electronic seal recipients represent legal entities.\n- `signer`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope.\n- `witness`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope.", "type": "string" }, "recipientTypeMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the recipient type." + "description": "Metadata that indicates whether the `recipientType` property is editable. Read only." }, "requireIdLookup": { "description": "When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. ", @@ -48773,7 +59699,7 @@ }, "requireIdLookupMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the `requireIdLookup` property." + "description": "Metadata that indicates whether the `requireIdLookup` property is editable. Read only." }, "requireSignerCertificate": { "description": "By default, DocuSign signers create electronic signatures. This field can be used to require the signer to use a SAFE-BioPharma digital certificate for signing.\n\nThis parameter should only be used to select a SAFE-BioPharma certificate. New integrations should use the `recipientSignatureProviders` parameter for other types of digital certificates. \n\nSet this parameter to `safe` to use a SAFE-BioPharma certificate.\n\nThe signer must be enrolled in the SAFE program to sign with a SAFE certificate.", @@ -48783,8 +59709,12 @@ "description": "When set to **true**, the signer must print, sign, and upload or fax the signed documents to DocuSign.", "type": "string" }, + "requireUploadSignature": { + "description": "When set to **true**, the signer is required to upload a new signature, even if they have a pre-adopted signature in their personal DocuSign account.", + "type": "string" + }, "roleName": { - "description": "Optional element. Specifies the role name associated with the recipient.

This is required when working with template recipients.", + "description": "Optional element. Specifies the role name associated with the recipient.

This property is required when you are working with template recipients.", "type": "string" }, "routingOrder": { @@ -48793,15 +59723,15 @@ }, "routingOrderMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the routing order for the recipient." + "description": "Metadata that indicates whether the `routingOrder` property is editable. Read only." }, "sentDateTime": { - "description": "The date and time the envelope was sent.", + "description": "The UTC DateTime when the envelope was sent. Read only.", "type": "string" }, "signatureInfo": { "$ref": "#/definitions/recipientSignatureInformation", - "description": "Allows the sender to pre-specify the signature name, signature initials and signature font used in the signature stamp for the recipient.\n\nUsed only with recipient types In Person Signers and Signers. \n " + "description": "Allows the sender to pre-specify the signature name, signature initials and signature font used in the signature stamp for the recipient.\n\nUsed only with recipient types In Person Signers and Signers." }, "signedDateTime": { "description": "Reserved for DocuSign.", @@ -48813,18 +59743,18 @@ }, "signInEachLocationMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `signInEachLocation` property is editable.\n" + "description": "Metadata that indicates whether the `signInEachLocation` property is editable. Read only." }, "signingGroupId": { - "description": "The id of the signing group of which the recipient is a member, if applicable.", + "description": "When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once).", "type": "string" }, "signingGroupIdMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the signing group id." + "description": "Metadata that indicates whether the `signingGroupId` property is editable. Read only." }, "signingGroupName": { - "description": "The display name for the signing group. \n\nMaximum Length: 100 characters. ", + "description": "Optional. The name of the signing group. \n\nMaximum Length: 100 characters. ", "type": "string" }, "signingGroupUsers": { @@ -48836,26 +59766,30 @@ }, "smsAuthentication": { "$ref": "#/definitions/recipientSMSAuthentication", - "description": "Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication. \n" + "description": "When `idCheckConfigurationName` is set to `SMS Auth $`, you use this complex type to provide the recipient authentication method details. It contains the element `senderProvidedNumbers`, which is an array of phone numbers that the recipient can use for SMS text authentication. \n\n" }, "socialAuthentications": { - "description": " Lists the social ID type that can be used for recipient authentication.", + "description": "Deprecated.", "type": "array", "items": { "$ref": "#/definitions/socialAuthentication" } }, "status": { - "description": "The status of the item.", + "description": "The recipient's status. Read only. \n\nPossible values:\n\n- `autoresponded`: The recipient's email system auto-responded to the email from DocuSign. This status is used in the web console to inform senders about the bounced-back email. This recipient status is only used if **Send-on-behalf-of** is turned off for the account.\n- `completed`: The recipient has completed their actions (signing or other required actions if not a signer) for an envelope.\n- `created`: The recipient is in a draft state. This value is only associated with draft envelopes (envelopes that have a status of `created`).\n- `declined`: The recipient declined to sign the document(s) in the envelope.\n- `delivered`: The recipient has viewed the document(s) in an envelope through the DocuSign signing website. This is not an email delivery of the documents in an envelope.\n- `faxPending`: The recipient has finished signing and the system is waiting for a fax attachment from the recipient before completing their signing step.\n- `sent`: The recipient has been sent an email notification that it is their turn to sign an envelope.\n- `signed`: The recipient has completed (signed) all required tags in an envelope. This is a temporary state during processing, after which the recipient's status automatically switches to `completed`.", "type": "string" }, "statusCode": { - "description": "Reserved for DocuSign.", + "description": "The code associated with the recipient's status. Read only.", + "type": "string" + }, + "suppressEmails": { + "description": "When set to **true**, email notifications are suppressed for the recipient, and they must access envelopes and documents from their DocuSign inbox.", "type": "string" }, "tabs": { "$ref": "#/definitions/EnvelopeRecipientTabs", - "description": "A list of `signHere` tabs, which can be used to add a visual representation for an electronic seal in a document." + "description": "A list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients." }, "templateLocked": { "description": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ", @@ -48866,7 +59800,7 @@ "type": "string" }, "totalTabCount": { - "description": "The total number of tabs in the documents.", + "description": "The total number of tabs in the documents. Read only.", "type": "string" }, "userId": { @@ -48874,24 +59808,87 @@ "type": "string" }, "witnessFor": { - "description": "The signer whose signature the witness is witnessing.", + "description": "The person or party for whom the recipient is a witness.", "type": "string" }, "witnessForGuid": { - "description": "The GUID for the witness.", + "description": "The GUID of the person or party for whom the recipient is a witness.", "type": "string" } }, "x-ds-definition-name": "witness", - "description": "A complex type containing information about a witness signer recipient.", - "x-ms-summary": "A complex type containing information about a witness signer recipient." + "description": "A complex type containing information about a witness recipient. Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope.", + "x-ms-summary": "A complex type containing information about a witness recipient. Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope." + }, + "workflow": { + "type": "object", + "properties": { + "currentWorkflowStepId": { + "description": "The `workflowStepId` of the current step.\nThis is not an index into the `workflowSteps` array in this object.\nSee the `workflowStep` object.", + "type": "string" + }, + "workflowStatus": { + "description": "The status of the workflow:\n\n- `paused` if the workflow is paused\n- `in_progress` if the workflow is in progress", + "type": "string" + }, + "workflowSteps": { + "description": "An array of workflow steps.", + "type": "array", + "items": { + "$ref": "#/definitions/workflowStep" + } + } + }, + "x-ds-definition-name": "workflow", + "description": "Describes the workflow for an envelope.", + "x-ms-summary": "Describes the workflow for an envelope." + }, + "workflowStep": { + "type": "object", + "properties": { + "action": { + "description": "Indicates the action to perform.\n\n- `pause_before`: The workflow should pause before the trigger described by `triggerOnItem` is reached.\n\n\n", + "type": "string" + }, + "completedDate": { + "description": "The timestamp of when the workflow step transitioned to `completed` status.", + "type": "string" + }, + "itemId": { + "description": "The unique ID of the item being triggered.", + "type": "string" + }, + "recipientRouting": { + "$ref": "#/definitions/recipientRouting", + "description": "The rules for recipient routing." + }, + "status": { + "description": "The status of the step. One of:\n\n- `inactive`\n- `in_progress`\n- `paused`\n- `pending`\n- `completed`\n\nThis is a read-only property.", + "type": "string" + }, + "triggeredDate": { + "description": "The timestamp of when the workflow step transitioned to `in_progress` status.", + "type": "string" + }, + "triggerOnItem": { + "description": "The type of item that triggers this workflow step. Currently, only `routing_order`, is the only supported value.", + "type": "string" + }, + "workflowStepId": { + "description": "A unique identifier for this workflow step.\nThis value is available from the `currentWorkflowStepId` property of the `workflow` object,", + "type": "string" + } + }, + "x-ds-definition-name": "workflowStep", + "description": "Describes a single step in a workflow.", + "x-ms-summary": "Describes a single step in a workflow." }, "workspace": { - "description": "", + "description": "A DocuSign workspace is a collaboration area for sharing files and data.", "type": "object", "properties": { "billableAccountId": { - "description": "", + "description": "The id of the account to bill.", "type": "string" }, "callerInformation": { @@ -48904,7 +59901,7 @@ }, "createdByInformation": { "$ref": "#/definitions/workspaceUser", - "description": "" + "description": "Details about the user who created the workspace." }, "lastModified": { "description": "Utc date and time the comment was last updated (can only be done by creator.)", @@ -48912,18 +59909,18 @@ }, "lastModifiedByInformation": { "$ref": "#/definitions/workspaceUser", - "description": "" + "description": "Details about the user who last modified the workspace." }, "settings": { "$ref": "#/definitions/workspaceSettings", - "description": "" + "description": "Information about the settings for the workspace." }, "status": { - "description": "The status of the item.", + "description": "Indicates the envelope status. Valid values are:\n\n* sent - The envelope is sent to the recipients. \n* created - The envelope is saved as a draft and can be modified and sent later.", "type": "string" }, "workspaceBaseUrl": { - "description": "The relative URL that may be used to access the workspace.", + "description": "The relative URL for accessing the workspace.", "type": "string" }, "workspaceDescription": { @@ -48931,7 +59928,7 @@ "type": "string" }, "workspaceId": { - "description": "Specifies the workspace ID GUID.", + "description": "The id of the workspace, always populated.", "type": "string" }, "workspaceName": { @@ -48939,49 +59936,49 @@ "type": "string" }, "workspaceUri": { - "description": "The relative URI that may be used to access the workspace.", + "description": "The relative URI for accessing the workspace.", "type": "string" } }, "x-ds-definition-name": "workspace", - "x-ms-summary": "" + "x-ms-summary": "A DocuSign workspace is a collaboration area for sharing files and data." }, "workspaceFolderContents": { - "description": "Provides properties that describe the contents of a workspace folder.", + "description": "This object's properties describe the contents of a workspace folder.", "type": "object", "properties": { "endPosition": { - "description": "The last position in the result set. ", + "description": "The last index position in the result set. ", "type": "string" }, "folder": { - "$ref": "#/definitions/WorkspaceItems", - "description": "The query value can be a folder name or folder ID. The response will only return templates in the specified folder." + "$ref": "#/definitions/workspaceItem", + "description": "The folder from which to return items. You can enter either the folder name or folder ID." }, "items": { - "description": "", + "description": "A list of workspace items.", "type": "array", "items": { - "$ref": "#/definitions/WorkspaceItems" + "$ref": "#/definitions/workspaceItem" } }, "parentFolders": { "description": "", "type": "array", "items": { - "$ref": "#/definitions/WorkspaceItems" + "$ref": "#/definitions/workspaceItem" } }, "resultSetSize": { - "description": "The number of results returned in this response. Because you can filter which entries are included in the response, this value is always less than or equal to `totalSetSize`.", + "description": "The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`.", "type": "string" }, "startPosition": { - "description": "The starting position of the current result set.", + "description": "The starting index position of the current result set.", "type": "string" }, "totalSetSize": { - "description": "The total number of items in the search's result set. This value is always greater than or equal to the value of `resultSetSize`.", + "description": "The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`.", "type": "string" }, "workspaceId": { @@ -48990,10 +59987,10 @@ } }, "x-ds-definition-name": "workspaceFolderContents", - "x-ms-summary": "Provides properties that describe the contents of a workspace folder." + "x-ms-summary": "This object's properties describe the contents of a workspace folder." }, "workspaceItem": { - "description": "", + "description": "This object represents an item in a workspace, which can be either a file or folder.", "type": "object", "properties": { "callerAuthorization": { @@ -49001,31 +59998,31 @@ "description": "" }, "contentType": { - "description": "", + "description": "If the item is a file, this property specifies the content type of the file.", "type": "string" }, "created": { - "description": "The UTC DateTime when the workspace user authorization was created.", + "description": "The UTC DateTime when the workspace item was created.", "type": "string" }, "createdById": { - "description": "", + "description": "The id of the user who created the workspace item.", "type": "string" }, "createdByInformation": { "$ref": "#/definitions/workspaceUser", - "description": "" + "description": "Details about the user who created the workspace item." }, "extension": { - "description": "", + "description": "The file extension of a file item.", "type": "string" }, "fileSize": { - "description": "", + "description": "The size of the file in bytes.", "type": "string" }, "fileUri": { - "description": "", + "description": "The URI for retrieving the file.", "type": "string" }, "id": { @@ -49033,43 +60030,43 @@ "type": "string" }, "isPublic": { - "description": " If true, this supersedes need for bit mask permission with workspaceUserAuthorization", + "description": " When **true**, the item is public.", "type": "string" }, "lastModified": { - "description": "Utc date and time the comment was last updated (can only be done by creator.)", + "description": "The UTC date and time that the comment was last updated.\n\n**Note**: This can only be done by the creator.", "type": "string" }, "lastModifiedById": { - "description": "", + "description": "The id of the user who last modified the item.", "type": "string" }, "lastModifiedByInformation": { "$ref": "#/definitions/workspaceUser", - "description": "" + "description": "Details about the user who last modified the workspace item." }, "name": { - "description": "", + "description": "The name of the file or folder.", "type": "string" }, "pageCount": { - "description": "An integer value specifying the number of document pages in the template. ", + "description": "The number of pages in a file.", "type": "string" }, "parentFolderId": { - "description": "", + "description": "The id of the parent folder, or the special value `root` for the root folder.", "type": "string" }, "parentFolderUri": { - "description": "", + "description": "The URI of the parent folder.", "type": "string" }, "sha256": { - "description": "", + "description": "A 64-byte, Secure Hash Algorithm 256 (SHA256) checksum that the caller computes across the entirety of the original content of a file. DocuSign compares this value to its own computation. If the two values are not equal, the original content and received content are not the same and the upload is refused.", "type": "string" }, "thumbHeight": { - "description": "", + "description": "The height of the thumbnail image.", "type": "string" }, "thumbnail": { @@ -49077,15 +60074,15 @@ "description": "" }, "thumbWidth": { - "description": "", + "description": "The width of the thumbnail image.", "type": "string" }, "type": { - "description": "Type of user:\n- `type_owner`\n- `type_participant`", + "description": "The type of the workspace item. Valid values are file, folder.", "type": "string" }, "uri": { - "description": "URI containing the user ID.", + "description": "A URI containing the user ID.", "type": "string" }, "userAuthorization": { @@ -49094,80 +60091,80 @@ } }, "x-ds-definition-name": "workspaceItem", - "x-ms-summary": "" + "x-ms-summary": "This object represents an item in a workspace, which can be either a file or folder." }, "workspaceItemList": { - "description": "Provides properties that describe the items contained in a workspace.", + "description": "An array of objects that describe the items in a workspace.", "type": "object", "properties": { "items": { - "description": "", + "description": "A list of workspace items.", "type": "array", "items": { - "$ref": "#/definitions/WorkspaceItems" + "$ref": "#/definitions/workspaceItem" } } }, "x-ds-definition-name": "workspaceItemList", - "x-ms-summary": "Provides properties that describe the items contained in a workspace." + "x-ms-summary": "An array of objects that describe the items in a workspace." }, "workspaceList": { - "description": "Provides properties that describe the workspaces avaialble.", + "description": "This object contains a list of available workspaces.", "type": "object", "properties": { "endPosition": { - "description": "The last position in the result set. ", + "description": "The last index position in the result set. ", "type": "string" }, "resultSetSize": { - "description": "The number of results returned in this response. Because you can filter which entries are included in the response, this value is always less than or equal to `totalSetSize`.", + "description": "The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`.", "type": "string" }, "startPosition": { - "description": "The starting position of the current result set.", + "description": "The starting index position of the current result set.", "type": "string" }, "totalSetSize": { - "description": "The total number of items in the search's result set. This value is always greater than or equal to the value of `resultSetSize`.", + "description": "The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`.", "type": "string" }, "workspaces": { "description": "A list of workspaces.", "type": "array", "items": { - "$ref": "#/definitions/Workspaces" + "$ref": "#/definitions/workspace" } } }, "x-ds-definition-name": "workspaceList", - "x-ms-summary": "Provides properties that describe the workspaces avaialble." + "x-ms-summary": "This object contains a list of available workspaces." }, "workspaceSettings": { "type": "object", "properties": { "commentsAllowed": { - "description": "", + "description": "When **true**, commenting on the documents in the workspace is allowed.", "type": "string" } }, "x-ds-definition-name": "workspaceSettings", - "description": "", - "x-ms-summary": "" + "description": "This object provides information about the settings for the workspace.", + "x-ms-summary": "This object provides information about the settings for the workspace." }, "workspaceUser": { - "description": "A workspaceUser representing the user. This property is only returned in response to user specific GET call. ", + "description": "This object represents the workspace user. This property is only returned in response to user specific GET call. ", "type": "object", "properties": { "accountId": { - "description": "The account ID associated with the envelope.", + "description": "The account ID associated with the workspace user.", "type": "string" }, "accountName": { - "description": "The name of the account associated with the current workspace user.", + "description": "The name of the account that the workspace user belongs to.", "type": "string" }, "activeSince": { - "description": "", + "description": "The UTC DateTime when the user joined the workspace.", "type": "string" }, "created": { @@ -49175,11 +60172,11 @@ "type": "string" }, "createdById": { - "description": "", + "description": "The id of the user who created this workspace user.", "type": "string" }, "email": { - "description": "Filters returned user records by the specified email address.", + "description": "The workspace user's email address.", "type": "string" }, "errorDetails": { @@ -49187,19 +60184,19 @@ "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." }, "invitationEmailBlurb": { - "description": "", + "description": "The text of the workspace invitation email message sent to the user.", "type": "string" }, "invitationEmailSubject": { - "description": "", + "description": "The subject line of the workspace invitation email message sent to the user.", "type": "string" }, "lastModified": { - "description": "Utc date and time the comment was last updated (can only be done by creator.)", + "description": "The UTC DateTime that the workspace user was last modified.", "type": "string" }, "lastModifiedById": { - "description": "", + "description": "The id of the user who last modified the workspace user.", "type": "string" }, "status": { @@ -49207,55 +60204,55 @@ "type": "string" }, "type": { - "description": "Type of user:\n- `type_owner`\n- `type_participant`", + "description": "Type of the user. Valid values: type_owner, type_participant.", "type": "string" }, "userId": { - "description": "The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.\n", + "description": "The id of the workspace user.", "type": "string" }, "userName": { - "description": "The name of the user.", + "description": "The name of workspace user.", "type": "string" }, "workspaceId": { - "description": "Specifies the workspace ID GUID.", + "description": "The id of the workspace.", "type": "string" }, "workspaceUserBaseUrl": { - "description": "The relative URI that may be used to access a workspace user.", + "description": "The URL for accessing the workspace user.", "type": "string" }, "workspaceUserId": { - "description": "", + "description": "The id of the workspace user.", "type": "string" }, "workspaceUserUri": { - "description": "", + "description": "The URI for accessing the workspace user.", "type": "string" } }, "x-ds-definition-name": "workspaceUser", - "x-ms-summary": "A workspaceUser representing the user. This property is only returned in response to user specific GET call. " + "x-ms-summary": "This object represents the workspace user. This property is only returned in response to user specific GET call. " }, "workspaceUserAuthorization": { "description": "Provides properties that describe user authorization to a workspace.", "type": "object", "properties": { "canDelete": { - "description": "", + "description": "When set to **true**, the workspace user can delete items from the workspace.", "type": "string" }, "canMove": { - "description": "", + "description": "When set to **true**, the workspace user can move the items in the workspace.", "type": "string" }, "canTransact": { - "description": "", + "description": "When set to **true**, the workspace user can create transactions from the workspace.", "type": "string" }, "canView": { - "description": "", + "description": "When set to **true**, the workspace user can view the items in the workspace.", "type": "string" }, "created": { @@ -49263,7 +60260,7 @@ "type": "string" }, "createdById": { - "description": "", + "description": "The id of the user who created the workspace user authorization. ", "type": "string" }, "errorDetails": { @@ -49271,20 +60268,20 @@ "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." }, "modified": { - "description": "", + "description": "The UTC DateTime when the workspace user authorization was last modified.", "type": "string" }, "modifiedById": { - "description": "", + "description": "The id of the user who last modified the workspace user authorization.", "type": "string" }, "workspaceUserId": { - "description": "", + "description": "The id of the workspace user.", "type": "string" }, "workspaceUserInformation": { "$ref": "#/definitions/workspaceUser", - "description": "" + "description": "An object that provides details about the workspace user." } }, "x-ds-definition-name": "workspaceUserAuthorization", @@ -49293,21 +60290,29 @@ "zip": { "type": "object", "properties": { + "anchorAllowWhiteSpaceInCharacters": { + "description": "", + "type": "string" + }, + "anchorAllowWhiteSpaceInCharactersMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "" + }, "anchorCaseSensitive": { - "description": "Reserved for DocuSign.\n", + "description": "This property controls how [anchor tabs][AnchorTabs] are placed. When **true**, the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false**.\n\nFor example, when set to **true**, if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When set to **false**, `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**.\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place", "type": "string" }, "anchorCaseSensitiveMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "description": "Metadata that indicates whether the `anchorCaseSensitive` property is editable." }, "anchorHorizontalAlignment": { - "description": "Reserved for DocuSign.\n\n", + "description": "This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are :\n\n- `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value.\n- `right`: Aligns the tab’s left side with the last character of the matching anchor word.\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place\n", "type": "string" }, "anchorHorizontalAlignmentMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "description": "Metadata that indicates whether the `anchorHorizontalAlignment` property is editable." }, "anchorIgnoreIfNotPresent": { "description": "When set to **true**, this tab is ignored if the `anchorString` is not found in the document.", @@ -49318,12 +60323,12 @@ "description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable." }, "anchorMatchWholeWord": { - "description": "Reserved for DocuSign.\n\n", + "description": "When set to **true**, the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false**.\n\nFor example, when set to **true**, if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When set to **false**, if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**.\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTab]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place\n", "type": "string" }, "anchorMatchWholeWordMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Reserved for DocuSign." + "description": "Metadata that indicates whether the `anchorMatchWholeWord` property is editable." }, "anchorString": { "description": "Specifies the string to find in the document and use as the basis for tab placement.", @@ -49342,7 +60347,7 @@ "description": "Reserved for DocuSign." }, "anchorUnits": { - "description": "Specifies the units of the X and Y offset. Units may be pixels, millimeters, centimeters, or inches.", + "description": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n", "type": "string" }, "anchorUnitsMetadata": { @@ -49350,7 +60355,7 @@ "description": "Metadata that indicates whether the `anchorUnits` property is editable." }, "anchorXOffset": { - "description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.", + "description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n", "type": "string" }, "anchorXOffsetMetadata": { @@ -49358,7 +60363,7 @@ "description": "Metadata that indicates whether the `anchorXOffset` property is editable." }, "anchorYOffset": { - "description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.", + "description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n", "type": "string" }, "anchorYOffsetMetadata": { @@ -49374,7 +60379,7 @@ "description": "Metadata that indicates whether the `bold` property is editable." }, "concealValueOnDocument": { - "description": "When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender.\n\nWhen an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.", + "description": "When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender.\n\nWhen an envelope is completed the information is only available to the sender through the Form Data link in the DocuSign Console. The information on the downloaded document remains masked by asterisks.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.", "type": "string" }, "concealValueOnDocumentMetadata": { @@ -49398,7 +60403,7 @@ "description": "Metadata that indicates whether the `conditionalParentValue` property is editable." }, "customTabId": { - "description": "The DocuSign-generated custom tab id for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.", + "description": "The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.", "type": "string" }, "customTabIdMetadata": { @@ -49414,7 +60419,7 @@ "description": "Metadata that indicates whether the `disableAutoSize` property is editable." }, "documentId": { - "description": "Integer that identifies the document in the envelope.", + "description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.", "type": "string" }, "documentIdMetadata": { @@ -49513,13 +60518,17 @@ "$ref": "#/definitions/mergeField", "description": "Contains the information necessary to map the tab to a field in SalesForce." }, + "mergeFieldXml": { + "description": "", + "type": "string" + }, "name": { "description": "The name of the tab. For example, `Sign Here` or `Initial Here`.", "type": "string" }, "nameMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `name` property is editable." + "description": "Metadata that indicates whether the `name` property is editable. Read only." }, "originalValue": { "description": "The initial value of the tab when it was sent to the recipient. ", @@ -49538,11 +60547,11 @@ "description": "Metadata that indicates whether the `pageNumber` property is editable." }, "recipientId": { - "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", + "description": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.", "type": "string" }, "recipientIdGuid": { - "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one.", + "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only.", "type": "string" }, "recipientIdGuidMetadata": { @@ -49593,6 +60602,10 @@ "$ref": "#/definitions/propertyMetadata", "description": "Metadata that indicates whether the `shared` property is editable." }, + "smartContractInformation": { + "$ref": "#/definitions/smartContractInformation", + "description": "" + }, "status": { "description": "The status of the tab. Possible values are:\n\n- `active`: The tab is active, but the recipient has not yet interacted with it.\n- `signed`: The recipient signed the tab.\n- `declined`: The recipient declined the envelope.\n- `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`).\n", "type": "string" @@ -49621,7 +60634,7 @@ "description": "Metadata that indicates whether the `tabId` property is editable." }, "tabLabel": { - "description": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n", + "description": "The label associated with the tab. This value may be an empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum Length: 500 characters.\n", "type": "string" }, "tabLabelMetadata": { @@ -49717,7 +60730,7 @@ "description": "Metadata that indicates whether the `width` property is editable." }, "xPosition": { - "description": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n", + "description": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n", "type": "string" }, "xPositionMetadata": { @@ -49725,7 +60738,7 @@ "description": "Metadata that indicates whether the `xPosition` property is editable." }, "yPosition": { - "description": "This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.", + "description": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n", "type": "string" }, "yPositionMetadata": { @@ -49766,11 +60779,11 @@ "type": "object", "properties": { "accountEsignId": { - "description": "A GUID identifying the account associated with the consumer disclosure", + "description": "The GUID of the account associated with the consumer disclosure.", "type": "string" }, "allowCDWithdraw": { - "description": "Indicates whether the customer can withdraw their acceptance of the consumer disclosure.", + "description": "When set to **true**, indicates that the customer can withdraw their consent to the consumer disclosure when they decline to sign documents. If these recipients sign documents sent to them from your account in the future, they will be required to agree to the terms in the disclosure. The default value is **false**.\n**Note**: Only Admin users can change this setting.", "type": "string" }, "allowCDWithdrawMetadata": { @@ -49778,67 +60791,67 @@ "description": "Metadata that indicates whether the `allowCDWithdraw` property is editable.\n" }, "changeEmail": { - "description": "", + "description": "If the customer needs to change their email address, this is the email address to which they should the change request.\n\nMaximum length: 100 characters.", "type": "string" }, "changeEmailOther": { - "description": "", + "description": "Other information about the requirements for the user to change their email address.\n\nMaximum length: 255 characters.\n\nExample: \n\n`We do not require any other information from you to change your email address.`", "type": "string" }, "companyName": { - "description": "The name of the company associated with the consumer disclosure.", + "description": "Specifies the company name used in the disclosure. The default value is the account name.\n\nHowever, if your account uses signing brands that specify a company name, you can substitute the brand's company name by setting the `useBrand` property to **true**. Whenever an envelope is sent from the account that uses a signing brand with a specified `companyName`, that value is used in email notifications and in the signing experience.\n\n**Note**: This substitution only works if you use the default legal disclosure or if you apply the `companyName` to the merge fields in a custom ERSD. You must also set the value of the `useBrand` property to **true**.", "type": "string" }, "companyPhone": { - "description": "The phone number of the company associated with the consumer disclosure.", + "description": "The phone number of the company associated with the consumer disclosure, as a free-formatted string.", "type": "string" }, "copyCostPerPage": { - "description": "", + "description": "The cost per page if the customer requests paper copies.\n\nExample: \n\n`0.0000`", "type": "string" }, "copyFeeCollectionMethod": { - "description": "Specifies the fee collection method for cases in which the customer requires paper copies of the document.\n\nMaximum Length: 255 characters", + "description": "Specifies the fee collection method for cases in which the customer requires paper copies of the document.\n\nMaximum length: 255 characters.\n\nExample: \n\n`We will bill you for any fees at that time, if any.`", "type": "string" }, "copyRequestEmail": { - "description": "", + "description": "The email address to which the customer should send a request for copies of a document.\n\nMaximum length: 100 characters.", "type": "string" }, "custom": { - "description": "", + "description": "When set to **true**, indicates that the consumer disclosure is a custom disclosure. The default is **false**.", "type": "string" }, "enableEsign": { - "description": "", + "description": "When set to **true** (default), indicates that eSign is enabled.", "type": "string" }, "esignAgreement": { - "description": "The Electronic Record and Signature Disclosure text. The disclosure text includes the html formatting.", + "description": "The final, assembled text of the Electronic Record and Signature Disclosure that includes the appropriate `companyName` and other specifics. It also includes the HTML tags used for formatting.", "type": "string" }, "esignText": { - "description": "", + "description": "The template for the Electronic Record and Signature Disclosure, which contains placeholders for information such as the `companyName`. It also includes the HTML tags used for formatting.\n\n**Note**: If you are switching to or updating a custom disclosure, you can edit both the text and the HTML formatting.", "type": "string" }, "languageCode": { - "description": "", + "description": "The code for the language version of the disclosure. The following languages are supported:\n\n- Arabic (`ar`)\n- Bulgarian (`bg`)\n- Czech (`cs`)\n- Chinese Simplified (`zh_CN`)\n- Chinese Traditional (`zh_TW`)\n- Croatian (`hr`)\n- Danish (`da`)\n- Dutch (`nl`)\n- English US (`en`)\n- English UK (`en_GB`)\n- Estonian (`et`)\n- Farsi (`fa`)\n- Finnish (`fi`)\n- French (`fr`)\n- French Canadian (`fr_CA`)\n- German (`de`)\n- Greek (`el`)\n- Hebrew (`he`)\n- Hindi (`hi`)\n- Hungarian (`hu`)\n- Bahasa Indonesian (`id`)\n- Italian (`it`)\n- Japanese (`ja`)\n- Korean (`ko`)\n- Latvian (`lv`)\n- Lithuanian (`lt`)\n- Bahasa Melayu (`ms`)\n- Norwegian (`no`)\n- Polish (`pl`)\n- Portuguese (`pt`)\n- Portuguese Brazil (`pt_BR`)\n- Romanian (`ro`)\n- Russian (`ru`)\n- Serbian (`sr`)\n- Slovak (`sk`)\n- Slovenian (`sl`)\n- Spanish (`es`)\n- Spanish Latin America (`es_MX`)\n- Swedish (`sv`)\n- Thai (`th`)\n- Turkish (`tr`)\n- Ukrainian (`uk`) \n- Vietnamese (`vi`)\n\nAdditionally, you can automatically detect the browser language being used by the viewer and display the disclosure in that language by setting the value to `browser`.", "type": "string" }, "mustAgreeToEsign": { - "description": "", + "description": "When set to **true**, the recipient must agree to the consumer disclosure. The value of this property is read only. It is calculated based on the account setting `consumerDisclosureFrequency` and the user's actions.", "type": "string" }, "pdfId": { - "description": "**Deprecated**\n\nThe `€œpdfId` property in the consumer_disclosure PUT request is deprecated. For security reasons going forward, any value provided in the request packet must be ignored. ", + "description": "**Deprecated**. \n\nThe `pdfId` property in the consumer_disclosure PUT request is deprecated. For security reasons going forward, any value provided in the request packet must be ignored. ", "type": "string" }, "useBrand": { - "description": "", + "description": "When set to **true**, specifies that the company name in the signing brand is used for the disclosure. Whenever an envelope is sent from the account that uses a signing brand with a specified company name, that value is used in email notifications and in the signing experience. \n\nWhen set to **false** (default), or if the signing brand does not specify a company name, the account name is used instead.\n\n**Note**: This substitution only works if you use the default legal disclosure or if you apply the `companyName` to the merge fields in a custom ERSD. ", "type": "string" }, "useConsumerDisclosureWithinAccount": { - "description": "Boolean that specifies whether recipients in the same account as the sender must agree to eSign an Electronic Record and Signature Disclosure Statement.", + "description": "When set to **true**, specifies that recipients in the same account as the sender must agree to eSign an Electronic Record and Signature Disclosure Statement.", "type": "string" }, "useConsumerDisclosureWithinAccountMetadata": { @@ -49854,15 +60867,15 @@ "type": "string" }, "withdrawByEmail": { - "description": "Indicates whether the customer can withdraw consent by email.", + "description": "When set to **true** (default), indicates that the customer can withdraw consent by email.", "type": "string" }, "withdrawByMail": { - "description": "Indicates whether the customer can withdraw consent by postal mail.", + "description": "When set to **true**, indicates that the customer can withdraw consent by postal mail. The default is **false**.", "type": "string" }, "withdrawByPhone": { - "description": "Indicates whether the customer can withdraw consent by phone.", + "description": "When set to **true**, indicates that the customer can withdraw consent by phone. The default is **false**.", "type": "string" }, "withdrawCity": { @@ -49870,7 +60883,7 @@ "type": "string" }, "withdrawConsequences": { - "description": "Indicates the consequences of withdrawing consent.", + "description": "Text indicating the consequences of withdrawing consent.\n\nMaximum length: 255 characters.", "type": "string" }, "withdrawEmail": { @@ -49878,11 +60891,11 @@ "type": "string" }, "withdrawOther": { - "description": "Indicates other information need to withdraw consent.\n\nMaximum length: 255 characters.", + "description": "Contains any other information needed to withdraw consent.\n\nMaximum length: 255 characters.\n\nExample:\n\n`We do not need any other information from you to withdraw consent.`", "type": "string" }, "withdrawPhone": { - "description": "Contains the phone number which a customer can call to register consent withdrawal notification.\n\nMaximum length: 20 characters. ", + "description": "Contains the phone number that a customer can call to register consent withdrawal notification as a free-formatted string.\n\nMaximum length: 20 characters. ", "type": "string" }, "withdrawPostalCode": { @@ -49890,18 +60903,18 @@ "type": "string" }, "withdrawState": { - "description": "Contains the state of the postal address to which a customer can send a consent withdrawal notification.", + "description": "Contains the state of the postal address to which a customer can send a consent withdrawal notification.\n\nExample: `PA`", "type": "string" } }, "x-ds-definition-name": "consumerDisclosure", - "description": "Account consumer disclosures", + "description": "Details about account consumer disclosures.", "x-ds-category": "Accounts", "x-ds-order": "20", - "x-ms-summary": "Account consumer disclosures" + "x-ms-summary": "Details about account consumer disclosures." }, "AccountCustomFields": { - "description": "Custom Fields", + "description": "An `accountCustomField` is an envelope custom field that you set at the account level. Applying custom fields enables account administators to group and manage envelopes. ", "type": "object", "properties": { "listCustomFields": { @@ -49922,51 +60935,10 @@ "x-ds-definition-name": "customFields", "x-ds-category": "Accounts", "x-ds-order": "30", - "x-ms-summary": "Custom Fields" - }, - "EnvelopeBulkRecipients": { - "type": "object", - "properties": { - "bulkRecipients": { - "description": "A complex type containing information about the bulk recipients in the response.", - "type": "array", - "items": { - "$ref": "#/definitions/bulkRecipient" - } - }, - "endPosition": { - "description": "The last position in the result set. ", - "type": "string" - }, - "nextUri": { - "description": "The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. ", - "type": "string" - }, - "previousUri": { - "description": "The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. ", - "type": "string" - }, - "resultSetSize": { - "description": "The number of results returned in this response. Because you can filter which entries are included in the response, this value is always less than or equal to `totalSetSize`.", - "type": "string" - }, - "startPosition": { - "description": "The starting position of the current result set.", - "type": "string" - }, - "totalSetSize": { - "description": "The total number of items in the search's result set. This value is always greater than or equal to the value of `resultSetSize`.", - "type": "string" - } - }, - "x-ds-definition-name": "bulkRecipientsResponse", - "description": "Envelope bulk recipients", - "x-ds-category": "BulkEnvelopes", - "x-ds-order": "20", - "x-ms-summary": "Envelope bulk recipients" + "x-ms-summary": "An `accountCustomField` is an envelope custom field that you set at the account level. Applying custom fields enables account administators to group and manage envelopes. " }, "EnvelopeCustomFields": { - "description": "Envelope custom fields", + "description": "An envelope custom field enables you to collect custom data about envelopes on a per-envelope basis. You can then use the custom data for sorting, organizing, searching, and other downstream processes. For example, you can use custom fields to copy envelopes or data to multiple areas in Salesforce. eOriginal customers can eVault their documents from the web app on a per-envelope basis by setting an envelope custom field with a name like \"eVault with eOriginal?\" to \"Yes\" or \"No\".\n\nWhen a user creates an envelope, the envelope custom fields display in the **Envelope Settings** section of the DocuSign console. Envelope recipients do not see the envelope custom fields. For more information, see [Envelope Custom Fields](https://support.docusign.com/en/guides/ndse-admin-guide-document-labels).", "type": "object", "properties": { "listCustomFields": { @@ -49987,7 +60959,7 @@ "x-ds-definition-name": "customFields", "x-ds-category": "Envelopes", "x-ds-order": "70", - "x-ms-summary": "Envelope custom fields" + "x-ms-summary": "An envelope custom field enables you to collect custom data about envelopes on a per-envelope basis. You can then use the custom data for sorting, organizing, searching, and other downstream processes. For example, you can use custom fields to copy envelopes or data to multiple areas in Salesforce. eOriginal customers can eVault their documents from the web app on a per-envelope basis by setting an envelope custom field with a name like \"eVault with eOriginal?\" to \"Yes\" or \"No\".\n\nWhen a user creates an envelope, the envelope custom fields display in the **Envelope Settings** section of the DocuSign console. Envelope recipients do not see the envelope custom fields. For more information, see [Envelope Custom Fields](https://support.docusign.com/en/guides/ndse-admin-guide-document-labels)." }, "EnvelopeDocumentFields": { "type": "object", @@ -50014,11 +60986,11 @@ "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." }, "lockDurationInSeconds": { - "description": "Sets the time, in seconds, until the lock expires when there is no activity on the envelope.\n\nThe default value is 300 seconds. The maximum value is 1,800 seconds.\n\nThe lock duration can be extended.\n", + "description": "\nThe number of seconds until the lock expires when there is no activity on the envelope.\n\nThe default value is 300 seconds. The maximum value is 1,800 seconds.\n\nThe lock duration can be extended.\n", "type": "string" }, "lockedByApp": { - "description": "The friendly name of the application that is locking the envelope or template. It appears in error messages to the user when lock conflicts occur.", + "description": "The human-readable name of the application that is locking the envelope or template. This value displays to the user in error messages when lock conflicts occur.", "type": "string" }, "lockedByUser": { @@ -50038,15 +61010,15 @@ "type": "string" }, "useScratchPad": { - "description": "Indicates whether a scratchpad is used for editing information.\n ", + "description": "When set to **true**, a scratchpad is used to edit information.\n ", "type": "string" } }, "x-ds-definition-name": "lockInformation", - "description": "Envelope locks", + "description": "This section provides information about envelope locks.", "x-ds-category": "Envelopes", "x-ds-order": "80", - "x-ms-summary": "Envelope locks" + "x-ms-summary": "This section provides information about envelope locks." }, "EnvelopeRecipients": { "description": "Envelope recipients", @@ -50078,7 +61050,7 @@ "type": "string" }, "editors": { - "description": "A list of editors on the document.", + "description": "A list of users who can edit the envelope.", "type": "array", "items": { "$ref": "#/definitions/editor" @@ -50102,49 +61074,336 @@ "$ref": "#/definitions/intermediary" } }, + "notaries": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/notaryRecipient" + } + }, "recipientCount": { - "description": "The list of recipient event statuses that will trigger Connect to send updates to the url. It can be a two-part list with:\n\n* recipientEventStatusCode - The recipient status, this can be Sent, Delivered, Completed, Declined, AuthenticationFailed, and AutoResponded.\n* includeDocuments - When set to **true**, the envelope time zone information is included in the message.", + "description": "The number of recipients in the envelope.", "type": "string" }, - "seals": { - "description": "A list of electronic seals to apply to documents.", + "seals": { + "description": "A list of electronic seals to apply to documents.", + "type": "array", + "items": { + "$ref": "#/definitions/sealSign" + } + }, + "signers": { + "description": "A list of signers on the envelope.", + "type": "array", + "items": { + "$ref": "#/definitions/signer" + } + }, + "witnesses": { + "description": "A list of signers who act as witnesses on the envelope.", + "type": "array", + "items": { + "$ref": "#/definitions/witness" + } + } + }, + "x-ds-definition-name": "recipients", + "x-ds-category": "Envelopes", + "x-ds-order": "20", + "x-ms-summary": "Envelope recipients" + }, + "EnvelopeRecipientTabs": { + "type": "object", + "properties": { + "approveTabs": { + "description": "A list of\n[Approve tabs][approve].\n\nAn Approve tab enables\nthe recipient to approve documents without\nplacing a signature or initials on the document. If the\nrecipient clicks the tab during the signing process, the\nrecipient is considered to have signed the document. No\ninformation is shown on the document of the approval, but it\nis recorded as a signature in the envelope history.\nThe value of an approve tab can't be set.\n\n[approve]:\t\t https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", + "type": "array", + "items": { + "$ref": "#/definitions/approve" + } + }, + "checkboxTabs": { + "description": "A list of\n[Checkbox tabs][checkbox].\n\n\nA Checkbox tab enables the recipient to select a yes/no (on/off) option. This value can be set.\n\n\n[checkbox]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", + "type": "array", + "items": { + "$ref": "#/definitions/checkbox" + } + }, + "commentThreadTabs": { + "description": "An array of tabs that represents a collection of comments in a comment thread. For example, if a recipient has questions about the content of a document, they can add a comment to the document and control who else can see the comment. This value can't be set.", + "type": "array", + "items": { + "$ref": "#/definitions/commentThread" + } + }, + "commissionCountyTabs": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/commissionCounty" + } + }, + "commissionExpirationTabs": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/commissionExpiration" + } + }, + "commissionNumberTabs": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/commissionNumber" + } + }, + "commissionStateTabs": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/commissionState" + } + }, + "companyTabs": { + "description": "A list of\n[Company tabs][company].\n\n\nA Company tab displays a field for the name of the recipient's company. This value can't be set.\n\n\n\n[company]: https://developers.docusign.com/docs/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/company\n", + "type": "array", + "items": { + "$ref": "#/definitions/company" + } + }, + "currencyTabs": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/currency" + } + }, + "dateSignedTabs": { + "description": "A list of\n[Date Signed tabs][dateSigned].\n\n\nA Date Signed tab displays the date that the recipient signed the document. This value can't be set.\n\n[dateSigned]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", + "type": "array", + "items": { + "$ref": "#/definitions/dateSigned" + } + }, + "dateTabs": { + "description": "A list of\n[Date tabs][date].\n\nA Date tab enables the recipient to enter a date. This value can't be set. The tooltip for this tab recommends the date format MM/DD/YYYY, but this format is not enforced. The system retains the format that the recipient enters.\n\n**Note**: If you need to enforce a specific date format, we recommend that you use a Text tab with a validation pattern and validation message.\n\n\n[date]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", + "type": "array", + "items": { + "$ref": "#/definitions/date" + } + }, + "declineTabs": { + "description": "A list of\n[Decline tabs][decline].\n\nA Decline tab enables the recipient to decline the envelope. If the recipient clicks the tab during the signing process, the envelope is voided. The value of this tab can't be set.\n\n\n[decline]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", + "type": "array", + "items": { + "$ref": "#/definitions/decline" + } + }, + "drawTabs": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/draw" + } + }, + "emailAddressTabs": { + "description": "A list of\n[Email Address tabs][emailAddress].\n\nAn Email Address tab displays the recipient's email as entered in the recipient information. This value can't be set.\n\n\n[emailAddress]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", + "type": "array", + "items": { + "$ref": "#/definitions/emailAddress" + } + }, + "emailTabs": { + "description": "A list of\n[Email tabs][email].\n\nAn Email tab enables the recipient to enter an email address.\nThis is a one-line field that checks that a valid email\naddress is entered. It uses the same parameters as a Text\ntab, with the validation message and pattern set for email\ninformation. This value can be set.\n\nWhen getting information that includes\nthis tab type, the original value of the tab when the\nassociated envelope was sent is included in the response.\n\n[email]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", + "type": "array", + "items": { + "$ref": "#/definitions/email" + } + }, + "envelopeIdTabs": { + "description": "A list of\n[Envelope ID tabs][envelopeId].\n\nAn Envelope ID tab displays the envelope ID. Recipients cannot enter or change the information in this tab. This value can't be set.\n\n\n[envelopeId]: https://developers.docusign.com/docs/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/envelopeId\n", + "type": "array", + "items": { + "$ref": "#/definitions/envelopeId" + } + }, + "firstNameTabs": { + "description": "A list of\n[First Name tabs][firstName].\n\nA First Name tab displays the recipient's first name. The system automatically populates this field by splitting the name in the recipient information on spaces. This value can't be set.\n\n\n[firstName]: https://developers.docusign.com/docs/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/firstName\n", + "type": "array", + "items": { + "$ref": "#/definitions/firstName" + } + }, + "formulaTabs": { + "description": "A list of [Formula tabs][formulaTab].\n\nThe value of a Formula tab is calculated from the values of other number or date tabs in the document. When the recipient completes the underlying fields, the Formula tab calculates and displays the result. This value can be set.\n\nThe `formula` property of the tab contains the references to the underlying tabs. To learn more about formulas, see [Calculated Fields][calculatedfields].\n\nIf a Formula tab contains a `paymentDetails` property, the tab is considered a payment item. To learn more about payments, see [Requesting Payments Along with Signatures][paymentguide].\n\n[calculatedfields]: https://support.docusign.com/en/guides/ndse-user-guide-calculated-fields\n[paymentguide]: https://support.docusign.com/en/guides/requesting-payments-along-with-signatures\n[formulaTab]:\t \thttps://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", + "type": "array", + "items": { + "$ref": "#/definitions/formulaTab" + } + }, + "fullNameTabs": { + "description": "A list of\n[Full Name tabs][fullName].\n\nA Full Name tab displays the recipient's full name. This value can't be set.\n\n\n[fullName]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", + "type": "array", + "items": { + "$ref": "#/definitions/fullName" + } + }, + "initialHereTabs": { + "description": "A list of\n[Initial Here tabs][initialHere].\n\nThis type of tab enables the recipient to initial the document. May be optional. This value can't be set.\n\n[initialHere]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", + "type": "array", + "items": { + "$ref": "#/definitions/initialHere" + } + }, + "lastNameTabs": { + "description": "A list of\n[Last Name tabs][lastName].\n\nA Last Name tab displays the recipient's last name. The system automatically populates this field by splitting the name in the recipient information on spaces. This value can't be set.\n\n\n[lastName]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", + "type": "array", + "items": { + "$ref": "#/definitions/lastName" + } + }, + "listTabs": { + "description": "An array of List tabs.\n\nA List tab enables the recipient to choose from a list of options. You specify the options in the `listItems` property. This value can't be set.\n\nFind descriptions of all tab types in\nthe [EnvelopeRecipientTabs Resource][ert].\n\n[ert]: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n", + "type": "array", + "items": { + "$ref": "#/definitions/list" + } + }, + "notarizeTabs": { + "description": "A list of [Notarize tabs][notarize].\n\nA Notarize tab alerts notary recipients that they must take action on the page. This value can be set.\n\n**Note**: Only one notarize tab can appear on a page.\n\n[notarize]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", + "type": "array", + "items": { + "$ref": "#/definitions/notarize" + } + }, + "notarySealTabs": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/notarySeal" + } + }, + "noteTabs": { + "description": "A list of\n[Note tabs][note].\n\nA Note tab displays additional information to the recipient in the form of a note. This value can be set.\n\n[note]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", + "type": "array", + "items": { + "$ref": "#/definitions/note" + } + }, + "numberTabs": { + "description": "A list of\n[Number tabs][number].\n\nA Number tab enables the recipient to enter numbers and decimal points (.). This value can be set.\n\n\n\n[number]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", + "type": "array", + "items": { + "$ref": "#/definitions/number" + } + }, + "phoneNumberTabs": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/phoneNumber" + } + }, + "polyLineOverlayTabs": { + "description": "This type of tab enables the recipient to strike through document text. This value can't be set. ", + "type": "array", + "items": { + "$ref": "#/definitions/polyLineOverlay" + } + }, + "prefillTabs": { + "$ref": "#/definitions/prefillTabs", + "description": "" + }, + "radioGroupTabs": { + "description": "A list of [Radio Group tabs][radioGroup].\n\nA Radio Group tab places a group of radio buttons on a document. The `radios` property is used to add and place the radio\nbuttons associated with the group. Only one radio button can be selected in a group. This value can be set.\n\n\n[radioGroup]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", + "type": "array", + "items": { + "$ref": "#/definitions/radioGroup" + } + }, + "signerAttachmentTabs": { + "description": "A list of\n[Signer Attachment tabs][signerAttachment].\n\nThis type of tab enables the recipient to attach supporting documents to an envelope. This value can't be set.\n\n\n[signerAttachment]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", + "type": "array", + "items": { + "$ref": "#/definitions/signerAttachment" + } + }, + "signHereTabs": { + "description": "A list of\n[Sign Here tabs][signHere].\n\nThis type of tab enables the recipient to sign a document. May be optional. This value can't be set.\n\n[signHere]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", + "type": "array", + "items": { + "$ref": "#/definitions/signHere" + } + }, + "smartSectionTabs": { + "description": "A list of [Smart Section](https://www.docusign.com/blog/dsdev-deep-dive-responsive-smart-sections/) tabs.\n\nSmart Section tabs enhance responsive signing on mobile devices by enabling collapsible sections, page breaks, custom formatting options, and other advanced functionality.\n\n**Note**: Smart Sections are a premium feature. Responsive signing must also be enabled for your account.", + "type": "array", + "items": { + "$ref": "#/definitions/smartSection" + } + }, + "ssnTabs": { + "description": "A list of\n[SSN tabs][ssn].\n\nAn SSN tab contains a one-line field that enables the recipient to enter a Social Security Number (SSN) with or without\ndashes. It uses the same parameters as a Text tab, with the validation message and pattern set for SSN information. This value can be set.\n\n\n[ssn]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", + "type": "array", + "items": { + "$ref": "#/definitions/ssn" + } + }, + "tabGroups": { + "description": "An array of `tabGroup` items that contain information about tab groups. To assign a tab to a `tabGroup`, you assign the `tabGroupLabel` to the `Tab.TabGroupLabels` array.", + "type": "array", + "items": { + "$ref": "#/definitions/tabGroup" + } + }, + "textTabs": { + "description": "A list of\nText tabs.\n\nA text tab enables the recipient to enter free text. This value can be set.\n\nFind descriptions of all tab types in\nthe [EnvelopeRecipientTabs Resource][ert].\n\n[ert]: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n", + "type": "array", + "items": { + "$ref": "#/definitions/text" + } + }, + "titleTabs": { + "description": "A list of\n[Title tabs][title].\n\nA Title tab displays the recipient's title. This value can't be set.\n\n\n[title]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { - "$ref": "#/definitions/sealSign" + "$ref": "#/definitions/title" } }, - "signers": { - "description": "A list of signers on the envelope.", + "viewTabs": { + "description": "A list of\n[View tabs][view].\n\nA View tab is used with an Approve tab to handle supplemental documents. This value can be set.\n\n[view]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { - "$ref": "#/definitions/signer" + "$ref": "#/definitions/view" } }, - "witnesses": { - "description": "A list of signers who act as witnesses on the envelope.", + "zipTabs": { + "description": "A list of\n[Zip tabs][zip].\n\nA Zip tab enables the recipient to enter a ZIP code. The ZIP code can be five digits or nine digits ( in ZIP+4 format), and can be entered with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for ZIP code information. This value can be set.\n\n\n[zip]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { - "$ref": "#/definitions/witness" + "$ref": "#/definitions/zip" } } }, - "x-ds-definition-name": "recipients", + "x-ds-definition-name": "tabs", + "description": "All of the tabs associated with a recipient. Each property is a list of a type of tab.\n", "x-ds-category": "Envelopes", - "x-ds-order": "20", - "x-ms-summary": "Envelope recipients" + "x-ds-order": "50", + "x-ms-summary": "All of the tabs associated with a recipient. Each property is a list of a type of tab.\n" }, - "EnvelopeRecipientTabs": { + "EnvelopeDocumentTabs": { "type": "object", "properties": { "approveTabs": { - "description": "A list of\n[Approve tabs][approve].\n\nAn Approve tab enables\nthe recipient to approve documents without\nplacing a signature or initials on the document. If the\nrecipient clicks the tab during the signing process, the\nrecipient is considered to have signed the document. No\ninformation is shown on the document of the approval, but it\nis recorded as a signature in the envelope history.\nThe value of an approve tab can't be set.\n\n[approve]:\t\t https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/approve\n", + "description": "A list of\n[Approve tabs][approve].\n\nAn Approve tab enables\nthe recipient to approve documents without\nplacing a signature or initials on the document. If the\nrecipient clicks the tab during the signing process, the\nrecipient is considered to have signed the document. No\ninformation is shown on the document of the approval, but it\nis recorded as a signature in the envelope history.\nThe value of an approve tab can't be set.\n\n[approve]:\t\t https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { "$ref": "#/definitions/approve" } }, "checkboxTabs": { - "description": "A list of\n[Checkbox tabs][checkbox].\n\n\nA Checkbox tab enables the recipient to select a yes/no (on/off) option. This value can be set.\n\n\n[checkbox]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/checkbox\n", + "description": "A list of\n[Checkbox tabs][checkbox].\n\n\nA Checkbox tab enables the recipient to select a yes/no (on/off) option. This value can be set.\n\n\n[checkbox]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { "$ref": "#/definitions/checkbox" @@ -50157,118 +61416,174 @@ "$ref": "#/definitions/commentThread" } }, + "commissionCountyTabs": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/commissionCounty" + } + }, + "commissionExpirationTabs": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/commissionExpiration" + } + }, + "commissionNumberTabs": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/commissionNumber" + } + }, + "commissionStateTabs": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/commissionState" + } + }, "companyTabs": { - "description": "A list of \n[Company tabs][company].\n\n\nA Company tab displays a field for the name of the recipient's company. This value can't be set.\n\n\n\n[company]: https://developers.docusign.com/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/company \n", + "description": "A list of\n[Company tabs][company].\n\n\nA Company tab displays a field for the name of the recipient's company. This value can't be set.\n\n\n\n[company]: https://developers.docusign.com/docs/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/company\n", "type": "array", "items": { "$ref": "#/definitions/company" } }, + "currencyTabs": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/currency" + } + }, "dateSignedTabs": { - "description": "A list of \n[Date Signed tabs][dateSigned].\n\n\nA Date Signed tab displays the date that the recipient signed the document. This value can't be set.\n\n[dateSigned]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/dateSigned \n", + "description": "A list of\n[Date Signed tabs][dateSigned].\n\n\nA Date Signed tab displays the date that the recipient signed the document. This value can't be set.\n\n[dateSigned]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { "$ref": "#/definitions/dateSigned" } }, "dateTabs": { - "description": "A list of \n[Date tabs][date].\n\nA Date tab enables the recipient to enter a date. This value can't be set. The tooltip for this tab recommends the date format MM/DD/YYYY, but this format is not enforced. The system retains the format that the recipient enters.\n\n**Note**: If you need to enforce a specific date format, we recommend that you use a Text tab with a validation pattern and validation message.\n\n\n[date]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/date \n", + "description": "A list of\n[Date tabs][date].\n\nA Date tab enables the recipient to enter a date. This value can't be set. The tooltip for this tab recommends the date format MM/DD/YYYY, but this format is not enforced. The system retains the format that the recipient enters.\n\n**Note**: If you need to enforce a specific date format, we recommend that you use a Text tab with a validation pattern and validation message.\n\n\n[date]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { "$ref": "#/definitions/date" } }, "declineTabs": { - "description": "A list of \n[Decline tabs][decline].\n\nA Decline tab enables the recipient to decline the envelope. If the recipient clicks the tab during the signing process, the envelope is voided. The value of this tab can't be set.\n\n\n[decline]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/decline \n", + "description": "A list of\n[Decline tabs][decline].\n\nA Decline tab enables the recipient to decline the envelope. If the recipient clicks the tab during the signing process, the envelope is voided. The value of this tab can't be set.\n\n\n[decline]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { "$ref": "#/definitions/decline" } }, + "drawTabs": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/draw" + } + }, "emailAddressTabs": { - "description": "A list of \n[Email Address tabs][emailAddress].\n\nAn Email Address tab displays the recipient's email as entered in the recipient information. This value can't be set.\n\n\n[emailAddress]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/emailAddress \n", + "description": "A list of\n[Email Address tabs][emailAddress].\n\nAn Email Address tab displays the recipient's email as entered in the recipient information. This value can't be set.\n\n\n[emailAddress]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { "$ref": "#/definitions/emailAddress" } }, "emailTabs": { - "description": "A list of \n[Email tabs][email].\n\nAn Email tab enables the recipient to enter an email address.\nThis is a one-line field that checks that a valid email\naddress is entered. It uses the same parameters as a Text\ntab, with the validation message and pattern set for email\ninformation. This value can be set.\n\nWhen getting information that includes\nthis tab type, the original value of the tab when the\nassociated envelope was sent is included in the response.\n\n[email]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/email \n", + "description": "A list of\n[Email tabs][email].\n\nAn Email tab enables the recipient to enter an email address.\nThis is a one-line field that checks that a valid email\naddress is entered. It uses the same parameters as a Text\ntab, with the validation message and pattern set for email\ninformation. This value can be set.\n\nWhen getting information that includes\nthis tab type, the original value of the tab when the\nassociated envelope was sent is included in the response.\n\n[email]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { "$ref": "#/definitions/email" } }, "envelopeIdTabs": { - "description": "A list of \n[Envelope ID tabs][envelopeId].\n\nAn Envelope ID tab displays the envelope ID. Recipients cannot enter or change the information in this tab. This value can't be set.\n\n\n[envelopeId]: https://developers.docusign.com/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/envelopeId \n", + "description": "A list of\n[Envelope ID tabs][envelopeId].\n\nAn Envelope ID tab displays the envelope ID. Recipients cannot enter or change the information in this tab. This value can't be set.\n\n\n[envelopeId]: https://developers.docusign.com/docs/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/envelopeId\n", "type": "array", "items": { "$ref": "#/definitions/envelopeId" } }, "firstNameTabs": { - "description": "A list of \n[First Name tabs][firstName].\n\nA First Name tab displays the recipient's first name. The system automatically populates this field by splitting the name in the recipient information on spaces. This value can't be set.\n\n\n[firstName]: https://developers.docusign.com/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/firstName \n", + "description": "A list of\n[First Name tabs][firstName].\n\nA First Name tab displays the recipient's first name. The system automatically populates this field by splitting the name in the recipient information on spaces. This value can't be set.\n\n\n[firstName]: https://developers.docusign.com/docs/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/firstName\n", "type": "array", "items": { "$ref": "#/definitions/firstName" } }, "formulaTabs": { - "description": "A list of [Formula tabs][formulaTab].\n\nThe value of a Formula tab is calculated from the values of other number or date tabs in the document. When the recipient completes the underlying fields, the Formula tab calculates and displays the result. This value can be set.\n\nThe `formula` property of the tab contains the references to the underlying tabs. To learn more about formulas, see [Calculated Fields][calculatedfields].\n\nIf a Formula tab contains a `paymentDetails` property, the tab is considered a payment item. To learn more about payments, see [Requesting Payments Along with Signatures][paymentguide].\n\n[calculatedfields]: https://support.docusign.com/en/guides/ndse-user-guide-calculated-fields\n[paymentguide]: https://support.docusign.com/en/guides/requesting-payments-along-with-signatures\n[formulaTab]:\t \thttps://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/formulaTab\n", + "description": "A list of [Formula tabs][formulaTab].\n\nThe value of a Formula tab is calculated from the values of other number or date tabs in the document. When the recipient completes the underlying fields, the Formula tab calculates and displays the result. This value can be set.\n\nThe `formula` property of the tab contains the references to the underlying tabs. To learn more about formulas, see [Calculated Fields][calculatedfields].\n\nIf a Formula tab contains a `paymentDetails` property, the tab is considered a payment item. To learn more about payments, see [Requesting Payments Along with Signatures][paymentguide].\n\n[calculatedfields]: https://support.docusign.com/en/guides/ndse-user-guide-calculated-fields\n[paymentguide]: https://support.docusign.com/en/guides/requesting-payments-along-with-signatures\n[formulaTab]:\t \thttps://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { "$ref": "#/definitions/formulaTab" } }, "fullNameTabs": { - "description": "A list of \n[Full Name tabs][fullName].\n\nA Full Name tab displays the recipient's full name. This value can't be set.\n\n\n[fullName]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/fullName \n", + "description": "A list of\n[Full Name tabs][fullName].\n\nA Full Name tab displays the recipient's full name. This value can't be set.\n\n\n[fullName]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { "$ref": "#/definitions/fullName" } }, "initialHereTabs": { - "description": "A list of \n[Initial Here tabs][initialHere].\n\nThis type of tab enables the recipient to initial the document. May be optional. This value can't be set.\n\n[initialHere]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/initialHere \n", + "description": "A list of\n[Initial Here tabs][initialHere].\n\nThis type of tab enables the recipient to initial the document. May be optional. This value can't be set.\n\n[initialHere]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { "$ref": "#/definitions/initialHere" } }, "lastNameTabs": { - "description": "A list of \n[Last Name tabs][lastName].\n\nA Last Name tab displays the recipient's last name. The system automatically populates this field by splitting the name in the recipient information on spaces. This value can't be set.\n\n\n[lastName]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/lastName \n", + "description": "A list of\n[Last Name tabs][lastName].\n\nA Last Name tab displays the recipient's last name. The system automatically populates this field by splitting the name in the recipient information on spaces. This value can't be set.\n\n\n[lastName]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { "$ref": "#/definitions/lastName" } }, "listTabs": { - "description": "A list of [List tabs][list].\n\nA List tab enables the recipient to choose from a list of options. You specify the options in the `listItems` property. This value can't be set.\n\n\n\n[list]: https://developers.docusign.com/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/list \n", + "description": "An array of List tabs.\n\nA List tab enables the recipient to choose from a list of options. You specify the options in the `listItems` property. This value can't be set.\n\nFind descriptions of all tab types in\nthe [EnvelopeRecipientTabs Resource][ert].\n\n[ert]: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n", "type": "array", "items": { "$ref": "#/definitions/list" } }, "notarizeTabs": { - "description": "A list of [Notarize tabs][notarize].\n\nA Notarize tab alerts notary recipients that they must take action on the page. This value can be set.\n\n**Note**: Only one notarize tab can appear on a page.\n\n[notarize]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/notarize \n", + "description": "A list of [Notarize tabs][notarize].\n\nA Notarize tab alerts notary recipients that they must take action on the page. This value can be set.\n\n**Note**: Only one notarize tab can appear on a page.\n\n[notarize]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { "$ref": "#/definitions/notarize" } }, + "notarySealTabs": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/notarySeal" + } + }, "noteTabs": { - "description": "A list of \n[Note tabs][note].\n\nA Note tab displays additional information to the recipient in the form of a note. This value can be set.\n\n[note]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/note \n", + "description": "A list of\n[Note tabs][note].\n\nA Note tab displays additional information to the recipient in the form of a note. This value can be set.\n\n[note]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { "$ref": "#/definitions/note" } }, "numberTabs": { - "description": "A list of \n[Number tabs][number].\n\nA Number tab enables the recipient to enter numbers and decimal points (.). This value can be set.\n\n\n\n[number]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/number \n", + "description": "A list of\n[Number tabs][number].\n\nA Number tab enables the recipient to enter numbers and decimal points (.). This value can be set.\n\n\n\n[number]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { "$ref": "#/definitions/number" } }, + "phoneNumberTabs": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/phoneNumber" + } + }, "polyLineOverlayTabs": { "description": "This type of tab enables the recipient to strike through document text. This value can't be set. ", "type": "array", @@ -50276,22 +61591,26 @@ "$ref": "#/definitions/polyLineOverlay" } }, + "prefillTabs": { + "$ref": "#/definitions/prefillTabs", + "description": "" + }, "radioGroupTabs": { - "description": "A list of [Radio Group tabs][radioGroup].\n\nA Radio Group tab places a group of radio buttons on a document. The `radios` property is used to add and place the radio\nbuttons associated with the group. Only one radio button can be selected in a group. This value can be set.\n\n\n[radioGroup]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/radioGroup \n", + "description": "A list of [Radio Group tabs][radioGroup].\n\nA Radio Group tab places a group of radio buttons on a document. The `radios` property is used to add and place the radio\nbuttons associated with the group. Only one radio button can be selected in a group. This value can be set.\n\n\n[radioGroup]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { "$ref": "#/definitions/radioGroup" } }, "signerAttachmentTabs": { - "description": "A list of \n[Signer Attachment tabs][signerAttachment].\n\nThis type of tab enables the recipient to attach supporting documents to an envelope. This value can't be set.\n\n\n[signerAttachment]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/signerAttachment \n", + "description": "A list of\n[Signer Attachment tabs][signerAttachment].\n\nThis type of tab enables the recipient to attach supporting documents to an envelope. This value can't be set.\n\n\n[signerAttachment]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { "$ref": "#/definitions/signerAttachment" } }, "signHereTabs": { - "description": "A list of \n[Sign Here tabs][signHere].\n\nThis type of tab enables the recipient to sign a document. May be optional. This value can't be set.\n\n[signHere]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/signHere \n", + "description": "A list of\n[Sign Here tabs][signHere].\n\nThis type of tab enables the recipient to sign a document. May be optional. This value can't be set.\n\n[signHere]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { "$ref": "#/definitions/signHere" @@ -50305,7 +61624,7 @@ } }, "ssnTabs": { - "description": "A list of \n[SSN tabs][ssn].\n\nAn SSN tab contains a one-line field that enables the recipient to enter a Social Security Number (SSN) with or without\ndashes. It uses the same parameters as a Text tab, with the validation message and pattern set for SSN information. This value can be set.\n\n\n[ssn]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/ssn \n", + "description": "A list of\n[SSN tabs][ssn].\n\nAn SSN tab contains a one-line field that enables the recipient to enter a Social Security Number (SSN) with or without\ndashes. It uses the same parameters as a Text tab, with the validation message and pattern set for SSN information. This value can be set.\n\n\n[ssn]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { "$ref": "#/definitions/ssn" @@ -50319,28 +61638,28 @@ } }, "textTabs": { - "description": "A list of \n[Text tabs][text].\n\nA text tab enables the recipient to enter free text. This value can be set.\n\n[text]: https://developers.docusign.com/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/text \n", + "description": "A list of\nText tabs.\n\nA text tab enables the recipient to enter free text. This value can be set.\n\nFind descriptions of all tab types in\nthe [EnvelopeRecipientTabs Resource][ert].\n\n[ert]: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n", "type": "array", "items": { "$ref": "#/definitions/text" } }, "titleTabs": { - "description": "A list of \n[Title tabs][title].\n\nA Title tab displays the recipient's title. This value can't be set.\n\n\n[title]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/title \n", + "description": "A list of\n[Title tabs][title].\n\nA Title tab displays the recipient's title. This value can't be set.\n\n\n[title]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { "$ref": "#/definitions/title" } }, "viewTabs": { - "description": "A list of \n[View tabs][view].\n\nA View tab is used with an Approve tab to handle supplemental documents. This value can be set.\n\n[view]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/view \n", + "description": "A list of\n[View tabs][view].\n\nA View tab is used with an Approve tab to handle supplemental documents. This value can be set.\n\n[view]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { "$ref": "#/definitions/view" } }, "zipTabs": { - "description": "A list of \n[Zip tabs][zip].\n\nA Zip tab enables the recipient to enter a ZIP code. The ZIP code can be five digits or nine digits ( in ZIP+4 format), and can be entered with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for ZIP code information. This value can be set.\n\n\n[zip]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/zip\n", + "description": "A list of\n[Zip tabs][zip].\n\nA Zip tab enables the recipient to enter a ZIP code. The ZIP code can be five digits or nine digits ( in ZIP+4 format), and can be entered with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for ZIP code information. This value can be set.\n\n\n[zip]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { "$ref": "#/definitions/zip" @@ -50348,23 +61667,23 @@ } }, "x-ds-definition-name": "tabs", - "description": "All of the tabs associated with a recipient. Each property is a list of a type of tab.\n", + "description": "Envelope Document Tabs resource ", "x-ds-category": "Envelopes", "x-ds-order": "50", - "x-ms-summary": "All of the tabs associated with a recipient. Each property is a list of a type of tab.\n" + "x-ms-summary": "Envelope Document Tabs resource " }, - "EnvelopeDocumentTabs": { + "TemplateDocumentTabs": { "type": "object", "properties": { "approveTabs": { - "description": "A list of\n[Approve tabs][approve].\n\nAn Approve tab enables\nthe recipient to approve documents without\nplacing a signature or initials on the document. If the\nrecipient clicks the tab during the signing process, the\nrecipient is considered to have signed the document. No\ninformation is shown on the document of the approval, but it\nis recorded as a signature in the envelope history.\nThe value of an approve tab can't be set.\n\n[approve]:\t\t https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/approve\n", + "description": "A list of\n[Approve tabs][approve].\n\nAn Approve tab enables\nthe recipient to approve documents without\nplacing a signature or initials on the document. If the\nrecipient clicks the tab during the signing process, the\nrecipient is considered to have signed the document. No\ninformation is shown on the document of the approval, but it\nis recorded as a signature in the envelope history.\nThe value of an approve tab can't be set.\n\n[approve]:\t\t https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { "$ref": "#/definitions/approve" } }, "checkboxTabs": { - "description": "A list of\n[Checkbox tabs][checkbox].\n\n\nA Checkbox tab enables the recipient to select a yes/no (on/off) option. This value can be set.\n\n\n[checkbox]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/checkbox\n", + "description": "A list of\n[Checkbox tabs][checkbox].\n\n\nA Checkbox tab enables the recipient to select a yes/no (on/off) option. This value can be set.\n\n\n[checkbox]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { "$ref": "#/definitions/checkbox" @@ -50377,118 +61696,174 @@ "$ref": "#/definitions/commentThread" } }, + "commissionCountyTabs": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/commissionCounty" + } + }, + "commissionExpirationTabs": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/commissionExpiration" + } + }, + "commissionNumberTabs": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/commissionNumber" + } + }, + "commissionStateTabs": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/commissionState" + } + }, "companyTabs": { - "description": "A list of \n[Company tabs][company].\n\n\nA Company tab displays a field for the name of the recipient's company. This value can't be set.\n\n\n\n[company]: https://developers.docusign.com/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/company \n", + "description": "A list of\n[Company tabs][company].\n\n\nA Company tab displays a field for the name of the recipient's company. This value can't be set.\n\n\n\n[company]: https://developers.docusign.com/docs/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/company\n", "type": "array", "items": { "$ref": "#/definitions/company" } }, + "currencyTabs": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/currency" + } + }, "dateSignedTabs": { - "description": "A list of \n[Date Signed tabs][dateSigned].\n\n\nA Date Signed tab displays the date that the recipient signed the document. This value can't be set.\n\n[dateSigned]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/dateSigned \n", + "description": "A list of\n[Date Signed tabs][dateSigned].\n\n\nA Date Signed tab displays the date that the recipient signed the document. This value can't be set.\n\n[dateSigned]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { "$ref": "#/definitions/dateSigned" } }, "dateTabs": { - "description": "A list of \n[Date tabs][date].\n\nA Date tab enables the recipient to enter a date. This value can't be set. The tooltip for this tab recommends the date format MM/DD/YYYY, but this format is not enforced. The system retains the format that the recipient enters.\n\n**Note**: If you need to enforce a specific date format, we recommend that you use a Text tab with a validation pattern and validation message.\n\n\n[date]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/date \n", + "description": "A list of\n[Date tabs][date].\n\nA Date tab enables the recipient to enter a date. This value can't be set. The tooltip for this tab recommends the date format MM/DD/YYYY, but this format is not enforced. The system retains the format that the recipient enters.\n\n**Note**: If you need to enforce a specific date format, we recommend that you use a Text tab with a validation pattern and validation message.\n\n\n[date]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { "$ref": "#/definitions/date" } }, "declineTabs": { - "description": "A list of \n[Decline tabs][decline].\n\nA Decline tab enables the recipient to decline the envelope. If the recipient clicks the tab during the signing process, the envelope is voided. The value of this tab can't be set.\n\n\n[decline]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/decline \n", + "description": "A list of\n[Decline tabs][decline].\n\nA Decline tab enables the recipient to decline the envelope. If the recipient clicks the tab during the signing process, the envelope is voided. The value of this tab can't be set.\n\n\n[decline]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { "$ref": "#/definitions/decline" } }, + "drawTabs": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/draw" + } + }, "emailAddressTabs": { - "description": "A list of \n[Email Address tabs][emailAddress].\n\nAn Email Address tab displays the recipient's email as entered in the recipient information. This value can't be set.\n\n\n[emailAddress]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/emailAddress \n", + "description": "A list of\n[Email Address tabs][emailAddress].\n\nAn Email Address tab displays the recipient's email as entered in the recipient information. This value can't be set.\n\n\n[emailAddress]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { "$ref": "#/definitions/emailAddress" } }, "emailTabs": { - "description": "A list of \n[Email tabs][email].\n\nAn Email tab enables the recipient to enter an email address.\nThis is a one-line field that checks that a valid email\naddress is entered. It uses the same parameters as a Text\ntab, with the validation message and pattern set for email\ninformation. This value can be set.\n\nWhen getting information that includes\nthis tab type, the original value of the tab when the\nassociated envelope was sent is included in the response.\n\n[email]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/email \n", + "description": "A list of\n[Email tabs][email].\n\nAn Email tab enables the recipient to enter an email address.\nThis is a one-line field that checks that a valid email\naddress is entered. It uses the same parameters as a Text\ntab, with the validation message and pattern set for email\ninformation. This value can be set.\n\nWhen getting information that includes\nthis tab type, the original value of the tab when the\nassociated envelope was sent is included in the response.\n\n[email]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { "$ref": "#/definitions/email" } }, "envelopeIdTabs": { - "description": "A list of \n[Envelope ID tabs][envelopeId].\n\nAn Envelope ID tab displays the envelope ID. Recipients cannot enter or change the information in this tab. This value can't be set.\n\n\n[envelopeId]: https://developers.docusign.com/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/envelopeId \n", + "description": "A list of\n[Envelope ID tabs][envelopeId].\n\nAn Envelope ID tab displays the envelope ID. Recipients cannot enter or change the information in this tab. This value can't be set.\n\n\n[envelopeId]: https://developers.docusign.com/docs/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/envelopeId\n", "type": "array", "items": { "$ref": "#/definitions/envelopeId" } }, "firstNameTabs": { - "description": "A list of \n[First Name tabs][firstName].\n\nA First Name tab displays the recipient's first name. The system automatically populates this field by splitting the name in the recipient information on spaces. This value can't be set.\n\n\n[firstName]: https://developers.docusign.com/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/firstName \n", + "description": "A list of\n[First Name tabs][firstName].\n\nA First Name tab displays the recipient's first name. The system automatically populates this field by splitting the name in the recipient information on spaces. This value can't be set.\n\n\n[firstName]: https://developers.docusign.com/docs/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/firstName\n", "type": "array", "items": { "$ref": "#/definitions/firstName" } }, "formulaTabs": { - "description": "A list of [Formula tabs][formulaTab].\n\nThe value of a Formula tab is calculated from the values of other number or date tabs in the document. When the recipient completes the underlying fields, the Formula tab calculates and displays the result. This value can be set.\n\nThe `formula` property of the tab contains the references to the underlying tabs. To learn more about formulas, see [Calculated Fields][calculatedfields].\n\nIf a Formula tab contains a `paymentDetails` property, the tab is considered a payment item. To learn more about payments, see [Requesting Payments Along with Signatures][paymentguide].\n\n[calculatedfields]: https://support.docusign.com/en/guides/ndse-user-guide-calculated-fields\n[paymentguide]: https://support.docusign.com/en/guides/requesting-payments-along-with-signatures\n[formulaTab]:\t \thttps://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/formulaTab\n", + "description": "A list of [Formula tabs][formulaTab].\n\nThe value of a Formula tab is calculated from the values of other number or date tabs in the document. When the recipient completes the underlying fields, the Formula tab calculates and displays the result. This value can be set.\n\nThe `formula` property of the tab contains the references to the underlying tabs. To learn more about formulas, see [Calculated Fields][calculatedfields].\n\nIf a Formula tab contains a `paymentDetails` property, the tab is considered a payment item. To learn more about payments, see [Requesting Payments Along with Signatures][paymentguide].\n\n[calculatedfields]: https://support.docusign.com/en/guides/ndse-user-guide-calculated-fields\n[paymentguide]: https://support.docusign.com/en/guides/requesting-payments-along-with-signatures\n[formulaTab]:\t \thttps://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { "$ref": "#/definitions/formulaTab" } }, "fullNameTabs": { - "description": "A list of \n[Full Name tabs][fullName].\n\nA Full Name tab displays the recipient's full name. This value can't be set.\n\n\n[fullName]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/fullName \n", + "description": "A list of\n[Full Name tabs][fullName].\n\nA Full Name tab displays the recipient's full name. This value can't be set.\n\n\n[fullName]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { "$ref": "#/definitions/fullName" } }, "initialHereTabs": { - "description": "A list of \n[Initial Here tabs][initialHere].\n\nThis type of tab enables the recipient to initial the document. May be optional. This value can't be set.\n\n[initialHere]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/initialHere \n", + "description": "A list of\n[Initial Here tabs][initialHere].\n\nThis type of tab enables the recipient to initial the document. May be optional. This value can't be set.\n\n[initialHere]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { "$ref": "#/definitions/initialHere" } }, "lastNameTabs": { - "description": "A list of \n[Last Name tabs][lastName].\n\nA Last Name tab displays the recipient's last name. The system automatically populates this field by splitting the name in the recipient information on spaces. This value can't be set.\n\n\n[lastName]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/lastName \n", + "description": "A list of\n[Last Name tabs][lastName].\n\nA Last Name tab displays the recipient's last name. The system automatically populates this field by splitting the name in the recipient information on spaces. This value can't be set.\n\n\n[lastName]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { "$ref": "#/definitions/lastName" } }, "listTabs": { - "description": "A list of [List tabs][list].\n\nA List tab enables the recipient to choose from a list of options. You specify the options in the `listItems` property. This value can't be set.\n\n\n\n[list]: https://developers.docusign.com/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/list \n", + "description": "An array of List tabs.\n\nA List tab enables the recipient to choose from a list of options. You specify the options in the `listItems` property. This value can't be set.\n\nFind descriptions of all tab types in\nthe [EnvelopeRecipientTabs Resource][ert].\n\n[ert]: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n", "type": "array", "items": { "$ref": "#/definitions/list" } }, "notarizeTabs": { - "description": "A list of [Notarize tabs][notarize].\n\nA Notarize tab alerts notary recipients that they must take action on the page. This value can be set.\n\n**Note**: Only one notarize tab can appear on a page.\n\n[notarize]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/notarize \n", + "description": "A list of [Notarize tabs][notarize].\n\nA Notarize tab alerts notary recipients that they must take action on the page. This value can be set.\n\n**Note**: Only one notarize tab can appear on a page.\n\n[notarize]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { "$ref": "#/definitions/notarize" } }, + "notarySealTabs": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/notarySeal" + } + }, "noteTabs": { - "description": "A list of \n[Note tabs][note].\n\nA Note tab displays additional information to the recipient in the form of a note. This value can be set.\n\n[note]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/note \n", + "description": "A list of\n[Note tabs][note].\n\nA Note tab displays additional information to the recipient in the form of a note. This value can be set.\n\n[note]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { "$ref": "#/definitions/note" } }, "numberTabs": { - "description": "A list of \n[Number tabs][number].\n\nA Number tab enables the recipient to enter numbers and decimal points (.). This value can be set.\n\n\n\n[number]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/number \n", + "description": "A list of\n[Number tabs][number].\n\nA Number tab enables the recipient to enter numbers and decimal points (.). This value can be set.\n\n\n\n[number]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { "$ref": "#/definitions/number" } }, + "phoneNumberTabs": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/phoneNumber" + } + }, "polyLineOverlayTabs": { "description": "This type of tab enables the recipient to strike through document text. This value can't be set. ", "type": "array", @@ -50496,22 +61871,26 @@ "$ref": "#/definitions/polyLineOverlay" } }, + "prefillTabs": { + "$ref": "#/definitions/prefillTabs", + "description": "" + }, "radioGroupTabs": { - "description": "A list of [Radio Group tabs][radioGroup].\n\nA Radio Group tab places a group of radio buttons on a document. The `radios` property is used to add and place the radio\nbuttons associated with the group. Only one radio button can be selected in a group. This value can be set.\n\n\n[radioGroup]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/radioGroup \n", + "description": "A list of [Radio Group tabs][radioGroup].\n\nA Radio Group tab places a group of radio buttons on a document. The `radios` property is used to add and place the radio\nbuttons associated with the group. Only one radio button can be selected in a group. This value can be set.\n\n\n[radioGroup]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { "$ref": "#/definitions/radioGroup" } }, "signerAttachmentTabs": { - "description": "A list of \n[Signer Attachment tabs][signerAttachment].\n\nThis type of tab enables the recipient to attach supporting documents to an envelope. This value can't be set.\n\n\n[signerAttachment]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/signerAttachment \n", + "description": "A list of\n[Signer Attachment tabs][signerAttachment].\n\nThis type of tab enables the recipient to attach supporting documents to an envelope. This value can't be set.\n\n\n[signerAttachment]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { "$ref": "#/definitions/signerAttachment" } }, "signHereTabs": { - "description": "A list of \n[Sign Here tabs][signHere].\n\nThis type of tab enables the recipient to sign a document. May be optional. This value can't be set.\n\n[signHere]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/signHere \n", + "description": "A list of\n[Sign Here tabs][signHere].\n\nThis type of tab enables the recipient to sign a document. May be optional. This value can't be set.\n\n[signHere]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { "$ref": "#/definitions/signHere" @@ -50525,7 +61904,7 @@ } }, "ssnTabs": { - "description": "A list of \n[SSN tabs][ssn].\n\nAn SSN tab contains a one-line field that enables the recipient to enter a Social Security Number (SSN) with or without\ndashes. It uses the same parameters as a Text tab, with the validation message and pattern set for SSN information. This value can be set.\n\n\n[ssn]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/ssn \n", + "description": "A list of\n[SSN tabs][ssn].\n\nAn SSN tab contains a one-line field that enables the recipient to enter a Social Security Number (SSN) with or without\ndashes. It uses the same parameters as a Text tab, with the validation message and pattern set for SSN information. This value can be set.\n\n\n[ssn]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { "$ref": "#/definitions/ssn" @@ -50539,1350 +61918,1930 @@ } }, "textTabs": { - "description": "A list of \n[Text tabs][text].\n\nA text tab enables the recipient to enter free text. This value can be set.\n\n[text]: https://developers.docusign.com/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/text \n", + "description": "A list of\nText tabs.\n\nA text tab enables the recipient to enter free text. This value can be set.\n\nFind descriptions of all tab types in\nthe [EnvelopeRecipientTabs Resource][ert].\n\n[ert]: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n", "type": "array", "items": { "$ref": "#/definitions/text" } }, "titleTabs": { - "description": "A list of \n[Title tabs][title].\n\nA Title tab displays the recipient's title. This value can't be set.\n\n\n[title]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/title \n", + "description": "A list of\n[Title tabs][title].\n\nA Title tab displays the recipient's title. This value can't be set.\n\n\n[title]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { "$ref": "#/definitions/title" } }, "viewTabs": { - "description": "A list of \n[View tabs][view].\n\nA View tab is used with an Approve tab to handle supplemental documents. This value can be set.\n\n[view]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/view \n", + "description": "A list of\n[View tabs][view].\n\nA View tab is used with an Approve tab to handle supplemental documents. This value can be set.\n\n[view]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", "type": "array", "items": { "$ref": "#/definitions/view" } }, "zipTabs": { - "description": "A list of \n[Zip tabs][zip].\n\nA Zip tab enables the recipient to enter a ZIP code. The ZIP code can be five digits or nine digits ( in ZIP+4 format), and can be entered with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for ZIP code information. This value can be set.\n\n\n[zip]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/zip\n", + "description": "A list of\n[Zip tabs][zip].\n\nA Zip tab enables the recipient to enter a ZIP code. The ZIP code can be five digits or nine digits ( in ZIP+4 format), and can be entered with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for ZIP code information. This value can be set.\n\n\n[zip]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", + "type": "array", + "items": { + "$ref": "#/definitions/zip" + } + } + }, + "x-ds-definition-name": "tabs", + "description": "", + "x-ds-category": "Templates", + "x-ds-order": "50", + "x-ms-summary": "" + }, + "EnvelopeViews": { + "type": "object", + "properties": { + "url": { + "description": "The view URL to be navigated to.", + "type": "string" + } + }, + "x-ds-definition-name": "viewUrl", + "description": "Embedding Envelope views", + "x-ds-category": "Envelopes", + "x-ds-order": "1", + "x-ms-summary": "Embedding Envelope views" + }, + "AccountSealProviders": { + "type": "object", + "properties": { + "seals": { + "description": "A list of electronic seals to apply to documents.", + "type": "array", + "items": { + "$ref": "#/definitions/sealIdentifier" + } + } + }, + "x-ds-definition-name": "accountSeals", + "description": "", + "x-ds-category": "Accounts", + "x-ds-order": "10", + "x-ms-summary": "" + }, + "Accounts": { + "description": "Account management", + "type": "object", + "properties": { + "accountIdGuid": { + "description": "The GUID associated with the account ID.", + "type": "string" + }, + "accountName": { + "description": "The name on the account.", + "type": "string" + }, + "accountSettings": { + "$ref": "#/definitions/accountSettingsInformation", + "description": "The list of\naccount settings accountsettings\nthat determine\nthe features available for the account.\nNote that some features are determined\nby the plan used to create the account and cannot be overridden.\n\n" + }, + "allowTransactionRooms": { + "description": "When set to **true**, the transaction rooms feature exposed through the Workspaces API is enabled.", + "type": "string" + }, + "billingPeriodDaysRemaining": { + "description": "Number of days remaining in the current billing period.", + "type": "string" + }, + "billingPeriodEndDate": { + "description": "The billing period end date in UTC timedate format.", + "type": "string" + }, + "billingPeriodEnvelopesAllowed": { + "description": "The number of envelopes that can be sent in the current billing period (can be unlimited).", + "type": "string" + }, + "billingPeriodEnvelopesSent": { + "description": "The number of envelopes that have been sent in the current billing period.", + "type": "string" + }, + "billingPeriodStartDate": { + "description": "The billing period start date in UTC timedate format.", + "type": "string" + }, + "billingProfile": { + "description": "The type of billing method on the account. Valid values are: \n\n- `direct`\n- `web`", + "type": "string" + }, + "canUpgrade": { + "description": "When set to **true**, specifies that you can upgrade the account through the API. For GET methods, you must set the `include_metadata` query parameter to **true** for this property to appear in the response.", + "type": "string" + }, + "connectPermission": { + "description": "", + "type": "string" + }, + "createdDate": { + "description": "The creation date of the account in UTC timedate format.", + "type": "string" + }, + "currencyCode": { + "description": "The currency code for the account, based on the [ISO 4217 currency code](https://www.iso.org/iso-4217-currency-codes.html).", + "type": "string" + }, + "currentPlanId": { + "description": "ID of the plan used to create this account.", + "type": "string" + }, + "displayApplianceStartUrl": { + "description": "", + "type": "string" + }, + "displayApplianceUrl": { + "description": "", + "type": "string" + }, + "distributorCode": { + "description": "The code that identifies the billing plan groups and plans for the new account.", + "type": "string" + }, + "docuSignLandingUrl": { + "description": "URL of the landing page used to create the account.", + "type": "string" + }, + "dssValues": { + "description": "", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "envelopeSendingBlocked": { + "description": "When **true**, the ability to send envelopes is blocked. When **false**, envelopes can be sent.", + "type": "string" + }, + "envelopeUnitPrice": { + "description": "The price of sending an envelope, represented in the account's local currency.", + "type": "string" + }, + "externalAccountId": { + "description": "The Account ID displayed on the user's Account page.", + "type": "string" + }, + "forgottenPasswordQuestionsCount": { + "description": " A complex element that contains up to four Question/Answer pairs for forgotten password information for a user.", + "type": "string" + }, + "isDowngrade": { + "description": "When **true**, the account has been downgraded from a premium account type. Otherwise **false**.", + "type": "string" + }, + "paymentMethod": { + "description": "The payment method used for the billing plan. Valid values are:\n\n- `NotSupported`\n- `CreditCard`\n- `PurchaseOrder`\n- `Premium`\n- `Freemium`\n- `FreeTrial`\n- `AppStore`\n- `DigitalExternal`\n- `DirectDebit`", + "type": "string" + }, + "planClassification": { + "description": "Identifies the type of plan. Examples include:\n\n- `business`\n- `corporate`\n- `enterprise` \n- `free`", + "type": "string" + }, + "planEndDate": { + "description": "The date that the current plan will end.", + "type": "string" + }, + "planName": { + "description": "The name of the billing plan used for the account.\n\nExamples: \n\n- `Personal - Annual`\n- `Unlimited Envelope Subscription - Annual Billing`", + "type": "string" + }, + "planStartDate": { + "description": "The date that the Account started using the current plan.", + "type": "string" + }, + "recipientDomains": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/recipientDomain" + } + }, + "seatsAllowed": { + "description": "The number of active users the account can have at one time.", + "type": "string" + }, + "seatsInUse": { + "description": "The number of users currently active on the account.", + "type": "string" + }, + "status21CFRPart11": { + "description": "The status of the account content per (Title 21 CFR Part 11)[https://www.fda.gov/regulatory-information/search-fda-guidance-documents/part-11-electronic-records-electronic-signatures-scope-and-application]. This regulation defines the criteria under which electronic records and electronic signatures are considered trustworthy.", + "type": "string" + }, + "suspensionDate": { + "description": "The date on which the account was suspended.", + "type": "string" + }, + "suspensionStatus": { + "description": "Indicates whether the account is currently suspended.", + "type": "string" + }, + "useDisplayAppliance": { + "description": "", + "type": "boolean" + } + }, + "x-ds-definition-name": "accountInformation", + "x-ds-category": "Accounts", + "x-ds-order": "1", + "x-ms-summary": "Account management" + }, + "AccountSignatureProviders": { + "type": "object", + "properties": { + "signatureProviders": { + "description": "Names of electronic or digital signature providers that can be used.", + "type": "array", + "items": { + "$ref": "#/definitions/accountSignatureProvider" + } + } + }, + "x-ds-definition-name": "accountSignatureProviders", + "description": "This resource provides information on the Standards Based Signature providers that have been provisioned for an account.\n", + "x-ds-category": "Accounts", + "x-ds-order": "30", + "x-ms-summary": "This resource provides information on the Standards Based Signature providers that have been provisioned for an account.\n" + }, + "BillingPlans": { + "description": "Billing plans", + "type": "object", + "properties": { + "billingAddress": { + "$ref": "#/definitions/accountAddress", + "description": "The billing address for the account." + }, + "billingAddressIsCreditCardAddress": { + "description": "When set to **true**, the credit card address information is the same as that returned as the billing address. If false, then the billing address is considered a billing contact address, and the credit card address can be different.", + "type": "string" + }, + "billingPlan": { + "$ref": "#/definitions/accountBillingPlan", + "description": "An object that contains details about the billing plan." + }, + "creditCardInformation": { + "$ref": "#/definitions/creditCardInformation", + "description": "A complex type that has information about the credit card used to pay for this account." + }, + "directDebitProcessorInformation": { + "$ref": "#/definitions/directDebitProcessorInformation", + "description": "Information about the bank that processes direct debits for the payment plan." + }, + "downgradePlanInformation": { + "$ref": "#/definitions/downgradePlanUpdateResponse", + "description": "" + }, + "paymentMethod": { + "description": "The payment method used for the billing plan. Valid values are:\n\n- `NotSupported`\n- `CreditCard`\n- `PurchaseOrder`\n- `Premium`\n- `Freemium`\n- `FreeTrial`\n- `AppStore`\n- `DigitalExternal`\n- `DirectDebit`", + "type": "string" + }, + "paymentProcessorInformation": { + "$ref": "#/definitions/paymentProcessorInformation", + "description": "Information about the entity that processes payments for the billing plan." + }, + "referralInformation": { + "$ref": "#/definitions/referralInformation", + "description": "Contains information describing discounts and promotions." + }, + "successorPlans": { + "description": "A list of billing plans that the current billing plan can be rolled into.", + "type": "array", + "items": { + "$ref": "#/definitions/billingPlan" + } + } + }, + "x-ds-definition-name": "accountBillingPlanResponse", + "x-ds-category": "Billing", + "x-ds-order": "10", + "x-ms-summary": "Billing plans" + }, + "Invoices": { + "description": "Invoices", + "type": "object", + "properties": { + "amount": { + "description": "Reserved: TBD", + "type": "string" + }, + "balance": { + "description": "Reserved: TBD", + "type": "string" + }, + "dueDate": { + "description": "Reserved: TBD", + "type": "string" + }, + "invoiceId": { + "description": "Reserved: TBD", + "type": "string" + }, + "invoiceItems": { + "description": "Reserved: TBD", + "type": "array", + "items": { + "$ref": "#/definitions/billingInvoiceItem" + } + }, + "invoiceNumber": { + "description": "Reserved: TBD", + "type": "string" + }, + "invoiceUri": { + "description": "Contains a URI for an endpoint that you can use to retrieve invoice information.", + "type": "string" + }, + "nonTaxableAmount": { + "description": "", + "type": "string" + }, + "pdfAvailable": { + "description": "", + "type": "string" + }, + "taxableAmount": { + "description": "", + "type": "string" + } + }, + "x-ds-definition-name": "billingInvoice", + "x-ds-category": "Billing", + "x-ds-order": "20", + "x-ms-summary": "Invoices" + }, + "Payments": { + "description": "Payments", + "type": "object", + "properties": { + "amount": { + "description": "Reserved: TBD", + "type": "string" + }, + "description": { + "description": "A sender-defined description of the line item.\n", + "type": "string" + }, + "paymentDate": { + "description": "", + "type": "string" + }, + "paymentId": { + "description": "", + "type": "string" + }, + "paymentNumber": { + "description": "When set to **true**, a PDF version of the invoice is available. \n\nTo get the PDF, make the call again and change \"Accept:\" in the header to \"Accept: application/pdf\".", + "type": "string" + } + }, + "x-ds-definition-name": "billingPaymentItem", + "x-ds-category": "Billing", + "x-ds-order": "30", + "x-ms-summary": "Payments" + }, + "CloudStorage": { + "type": "object", + "properties": { + "endPosition": { + "description": "The last index position in the result set. ", + "type": "string" + }, + "errorDetails": { + "$ref": "#/definitions/externalDocServiceErrorDetails", + "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." + }, + "id": { + "description": "A unique ID for the Salesforce object.", + "type": "string" + }, + "items": { + "description": "A list of objects that contain information about a file or folder in cloud storage.", + "type": "array", + "items": { + "$ref": "#/definitions/externalFile" + } + }, + "name": { + "description": "The name of the cloud storage item.", + "type": "string" + }, + "nextUri": { + "description": "The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. ", + "type": "string" + }, + "previousUri": { + "description": "The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. ", + "type": "string" + }, + "resultSetSize": { + "description": "The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`.", + "type": "string" + }, + "startPosition": { + "description": "The starting index position of the current result set.", + "type": "string" + }, + "totalSetSize": { + "description": "The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`.", + "type": "string" + } + }, + "x-ds-definition-name": "externalFolder", + "description": "Cloud storage", + "x-ds-category": "CloudStorage", + "x-ds-order": "10", + "x-ms-summary": "Cloud storage" + }, + "CloudStorageProviders": { + "type": "object", + "properties": { + "storageProviders": { + "description": "An Array containing the storage providers associated with the user.", "type": "array", "items": { - "$ref": "#/definitions/zip" + "$ref": "#/definitions/cloudStorageProvider" } } }, - "x-ds-definition-name": "tabs", - "description": "Envelope Document Tabs resource ", - "x-ds-category": "Envelopes", - "x-ds-order": "50", - "x-ms-summary": "Envelope Document Tabs resource " + "x-ds-definition-name": "cloudStorageProviders", + "description": "The CloudStorageProviders resource provides methods that allow you to manage the cloud storage providers associate with an account.", + "x-ds-category": "CloudStorage", + "x-ds-order": "20", + "x-ms-summary": "The CloudStorageProviders resource provides methods that allow you to manage the cloud storage providers associate with an account." }, - "TemplateDocumentTabs": { + "ConnectConfigurations": { "type": "object", "properties": { - "approveTabs": { - "description": "A list of\n[Approve tabs][approve].\n\nAn Approve tab enables\nthe recipient to approve documents without\nplacing a signature or initials on the document. If the\nrecipient clicks the tab during the signing process, the\nrecipient is considered to have signed the document. No\ninformation is shown on the document of the approval, but it\nis recorded as a signature in the envelope history.\nThe value of an approve tab can't be set.\n\n[approve]:\t\t https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/approve\n", - "type": "array", - "items": { - "$ref": "#/definitions/approve" - } + "allowEnvelopePublish": { + "description": "When set to **true**, data is sent to the urlToPublishTo web address. This option can be set to false to stop sending data while maintaining the Connect configuration information.", + "type": "string" }, - "checkboxTabs": { - "description": "A list of\n[Checkbox tabs][checkbox].\n\n\nA Checkbox tab enables the recipient to select a yes/no (on/off) option. This value can be set.\n\n\n[checkbox]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/checkbox\n", - "type": "array", - "items": { - "$ref": "#/definitions/checkbox" - } + "allowSalesforcePublish": { + "description": "When set to **true** (default), DocuSign sends data to the designated Salesforce account through Connect.", + "type": "string" }, - "commentThreadTabs": { - "description": "An array of tabs that represents a collection of comments in a comment thread. For example, if a recipient has questions about the content of a document, they can add a comment to the document and control who else can see the comment. This value can't be set.", - "type": "array", - "items": { - "$ref": "#/definitions/commentThread" - } + "allUsers": { + "description": "When set to **true**, the tracked envelope and recipient events for all users, including users that are added a later time, are sent through Connect.", + "type": "string" }, - "companyTabs": { - "description": "A list of \n[Company tabs][company].\n\n\nA Company tab displays a field for the name of the recipient's company. This value can't be set.\n\n\n\n[company]: https://developers.docusign.com/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/company \n", - "type": "array", - "items": { - "$ref": "#/definitions/company" - } + "configurationType": { + "description": "If you are using merge fields, this property specifies the type of the merge field. The only supported value is `salesforce`.", + "type": "string" }, - "dateSignedTabs": { - "description": "A list of \n[Date Signed tabs][dateSigned].\n\n\nA Date Signed tab displays the date that the recipient signed the document. This value can't be set.\n\n[dateSigned]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/dateSigned \n", - "type": "array", - "items": { - "$ref": "#/definitions/dateSigned" - } + "connectId": { + "description": "The DocuSign-generated ID for the Connect configuration. This property is read only.", + "type": "string" }, - "dateTabs": { - "description": "A list of \n[Date tabs][date].\n\nA Date tab enables the recipient to enter a date. This value can't be set. The tooltip for this tab recommends the date format MM/DD/YYYY, but this format is not enforced. The system retains the format that the recipient enters.\n\n**Note**: If you need to enforce a specific date format, we recommend that you use a Text tab with a validation pattern and validation message.\n\n\n[date]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/date \n", - "type": "array", - "items": { - "$ref": "#/definitions/date" - } + "enableLog": { + "description": "When set to **true**, Connect logging is turned on. We recommend that you enable this functionality, which helps you troubleshoot any issues. \n\nYou can have a maximum of 100 active logs in your account. You can view the entries in active logs in the **Logs** tab in the console.", + "type": "string" }, - "declineTabs": { - "description": "A list of \n[Decline tabs][decline].\n\nA Decline tab enables the recipient to decline the envelope. If the recipient clicks the tab during the signing process, the envelope is voided. The value of this tab can't be set.\n\n\n[decline]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/decline \n", + "envelopeEvents": { + "description": "An array of strings that lists envelope-related events to track through Connect. The possible event values are: \n\n- `sent`: An envelope has the status `sent` in the following scenarios:\n - When the envelope has been sent to recipients.\n - When using remote signing, this event is triggered when the email notification with a link to the documents is sent to at least one recipient.\n - When using embedded signing, this event is triggered when the link is ready for the recipient to sign the envelope.\n\n An envelope remains in this state until all recipients have viewed or taken action on the envelope.\n\n- `delivered`: This status is triggered when all recipients have opened the envelope, selected the **Continue** button in the interface, and viewed the documents.\n- `completed`: This status is triggered when all recipients have completed their assigned actions on an envelope.\n- `declined`: This status is triggered when a recipient has declined to sign the envelope.\n- `voided`: The voided status indicates that the sender has voided the envelope.\n\n**Note**: In previous versions of the API, this value was a single comma-separated string.\n", "type": "array", "items": { - "$ref": "#/definitions/decline" + "type": "string" } }, - "emailAddressTabs": { - "description": "A list of \n[Email Address tabs][emailAddress].\n\nAn Email Address tab displays the recipient's email as entered in the recipient information. This value can't be set.\n\n\n[emailAddress]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/emailAddress \n", - "type": "array", - "items": { - "$ref": "#/definitions/emailAddress" - } + "eventData": { + "$ref": "#/definitions/connectEventData", + "description": "Allows you to specify the format of the information the Connect webhooks returns. For more information, see [Connect webhooks with JSON notifications](https://www.docusign.com/blog/developers/connect-webhooks-json-notifications)" }, - "emailTabs": { - "description": "A list of \n[Email tabs][email].\n\nAn Email tab enables the recipient to enter an email address.\nThis is a one-line field that checks that a valid email\naddress is entered. It uses the same parameters as a Text\ntab, with the validation message and pattern set for email\ninformation. This value can be set.\n\nWhen getting information that includes\nthis tab type, the original value of the tab when the\nassociated envelope was sent is included in the response.\n\n[email]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/email \n", - "type": "array", - "items": { - "$ref": "#/definitions/email" - } + "externalFolderId": { + "description": "The id of an external folder.", + "type": "string" }, - "envelopeIdTabs": { - "description": "A list of \n[Envelope ID tabs][envelopeId].\n\nAn Envelope ID tab displays the envelope ID. Recipients cannot enter or change the information in this tab. This value can't be set.\n\n\n[envelopeId]: https://developers.docusign.com/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/envelopeId \n", - "type": "array", - "items": { - "$ref": "#/definitions/envelopeId" - } + "externalFolderLabel": { + "description": "The label for an external folder.", + "type": "string" }, - "firstNameTabs": { - "description": "A list of \n[First Name tabs][firstName].\n\nA First Name tab displays the recipient's first name. The system automatically populates this field by splitting the name in the recipient information on spaces. This value can't be set.\n\n\n[firstName]: https://developers.docusign.com/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/firstName \n", - "type": "array", - "items": { - "$ref": "#/definitions/firstName" - } + "includeCertificateOfCompletion": { + "description": "When set to **true**, the Connect Service includes the Certificate of Completion with completed envelopes. ", + "type": "string" }, - "formulaTabs": { - "description": "A list of [Formula tabs][formulaTab].\n\nThe value of a Formula tab is calculated from the values of other number or date tabs in the document. When the recipient completes the underlying fields, the Formula tab calculates and displays the result. This value can be set.\n\nThe `formula` property of the tab contains the references to the underlying tabs. To learn more about formulas, see [Calculated Fields][calculatedfields].\n\nIf a Formula tab contains a `paymentDetails` property, the tab is considered a payment item. To learn more about payments, see [Requesting Payments Along with Signatures][paymentguide].\n\n[calculatedfields]: https://support.docusign.com/en/guides/ndse-user-guide-calculated-fields\n[paymentguide]: https://support.docusign.com/en/guides/requesting-payments-along-with-signatures\n[formulaTab]:\t \thttps://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/formulaTab\n", - "type": "array", - "items": { - "$ref": "#/definitions/formulaTab" - } + "includeCertSoapHeader": { + "description": "When set to **true**, a certificate for a SOAP header is included in messages sent through Connect.", + "type": "string" }, - "fullNameTabs": { - "description": "A list of \n[Full Name tabs][fullName].\n\nA Full Name tab displays the recipient's full name. This value can't be set.\n\n\n[fullName]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/fullName \n", - "type": "array", - "items": { - "$ref": "#/definitions/fullName" - } + "includeDocumentFields": { + "description": "When set to **true**, the Document Fields associated with the envelope's documents are included in the notification messages. Document Fields are optional custom name-value pairs added to documents using the API. ", + "type": "string" }, - "initialHereTabs": { - "description": "A list of \n[Initial Here tabs][initialHere].\n\nThis type of tab enables the recipient to initial the document. May be optional. This value can't be set.\n\n[initialHere]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/initialHere \n", - "type": "array", - "items": { - "$ref": "#/definitions/initialHere" - } + "includeDocuments": { + "description": "When set to **true**, Connect attaches the envelope documents to the XML payloads of your event notification messages.\n\n**Note**: Consider resources and scaling when adding documents to your event payloads. Documents attached to these messages are sent in base64 XML element nodes, which are larger than binary document data. This can significantly increase your payload size, opening up windows for failure. If you include documents, you must build your application to scale in these situations. ", + "type": "string" }, - "lastNameTabs": { - "description": "A list of \n[Last Name tabs][lastName].\n\nA Last Name tab displays the recipient's last name. The system automatically populates this field by splitting the name in the recipient information on spaces. This value can't be set.\n\n\n[lastName]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/lastName \n", - "type": "array", - "items": { - "$ref": "#/definitions/lastName" - } + "includeEnvelopeVoidReason": { + "description": "When set to **true**, Connect will include the voidedReason for voided envelopes.", + "type": "string" }, - "listTabs": { - "description": "A list of [List tabs][list].\n\nA List tab enables the recipient to choose from a list of options. You specify the options in the `listItems` property. This value can't be set.\n\n\n\n[list]: https://developers.docusign.com/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/list \n", - "type": "array", - "items": { - "$ref": "#/definitions/list" - } + "includeHMAC": { + "description": "When set to **true**, a Hash-based Message Authentication Code (HMAC) signature is included in messages sent through Connect.\nFor more information, see [Using HMAC Security with DocuSign Connect](https://developers.docusign.com/esign-rest-api/guides/connect-hmac).", + "type": "string" }, - "notarizeTabs": { - "description": "A list of [Notarize tabs][notarize].\n\nA Notarize tab alerts notary recipients that they must take action on the page. This value can be set.\n\n**Note**: Only one notarize tab can appear on a page.\n\n[notarize]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/notarize \n", - "type": "array", - "items": { - "$ref": "#/definitions/notarize" - } + "includeSenderAccountasCustomField": { + "description": "When set to **true**, Connect will include the sender account as Custom Field in the data.", + "type": "string" }, - "noteTabs": { - "description": "A list of \n[Note tabs][note].\n\nA Note tab displays additional information to the recipient in the form of a note. This value can be set.\n\n[note]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/note \n", - "type": "array", - "items": { - "$ref": "#/definitions/note" - } + "includeTimeZoneInformation": { + "description": "When set to **true**, Connect will include the envelope time zone information.", + "type": "string" }, - "numberTabs": { - "description": "A list of \n[Number tabs][number].\n\nA Number tab enables the recipient to enter numbers and decimal points (.). This value can be set.\n\n\n\n[number]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/number \n", - "type": "array", - "items": { - "$ref": "#/definitions/number" - } + "name": { + "description": "The name of the Connect configuration. The name helps identify the configuration in the list.", + "type": "string" }, - "polyLineOverlayTabs": { - "description": "This type of tab enables the recipient to strike through document text. This value can't be set. ", - "type": "array", - "items": { - "$ref": "#/definitions/polyLineOverlay" - } + "password": { + "description": "The user's encrypted password hash.", + "type": "string" }, - "radioGroupTabs": { - "description": "A list of [Radio Group tabs][radioGroup].\n\nA Radio Group tab places a group of radio buttons on a document. The `radios` property is used to add and place the radio\nbuttons associated with the group. Only one radio button can be selected in a group. This value can be set.\n\n\n[radioGroup]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/radioGroup \n", + "recipientEvents": { + "description": "An array of strings that lists of recipient-related events that trigger a notification\nto your webhook Connect listener. The possible event values are:\n\n- `sent`: If a recipient type is set to receive an email notification to take action on an envelope, the recipient status is set to `sent` upon delivery of the email.\n- `delivered`: The recipient has viewed the documents in the envelope. This recipient status does not indicate email delivery of the documents in the envelope.\n- `completed`: The recipient has completed their assigned actions on an envelope.\n- `declined`: The recipient has declined to sign a document in the envelope.\n- `authenticationfailed`: At least one signer has failed the authentication check on the document. If this occurs, you have two options:\n - Send a reminder to the recipients, which provides the signer with another chance to access and pass the authentication.\n - Correct the document and modify the authentication setting.\n- `autoresponded`: The recipient's email system sent back an automatic response. This status is only used when **Send-on-behalf-of** is turned off for the account.\n\n**Note**: In previous versions of the API, this value was a single comma-separated string.\n", "type": "array", "items": { - "$ref": "#/definitions/radioGroup" + "type": "string" } }, - "signerAttachmentTabs": { - "description": "A list of \n[Signer Attachment tabs][signerAttachment].\n\nThis type of tab enables the recipient to attach supporting documents to an envelope. This value can't be set.\n\n\n[signerAttachment]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/signerAttachment \n", - "type": "array", - "items": { - "$ref": "#/definitions/signerAttachment" - } + "requireMutualTls": { + "description": "When set to **true**, [Mutual TLS](https://developers.docusign.com/esign-rest-api/guides/mutual-tls-intro) authentication is enabled.", + "type": "string" }, - "signHereTabs": { - "description": "A list of \n[Sign Here tabs][signHere].\n\nThis type of tab enables the recipient to sign a document. May be optional. This value can't be set.\n\n[signHere]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/signHere \n", - "type": "array", - "items": { - "$ref": "#/definitions/signHere" - } + "requiresAcknowledgement": { + "description": "When set to **true**, event delivery acknowledgements are enabled for your Connect configuration.\n\nDocuSign Connect awaits a valid 200 response from your application acknowledging that it received a message. If you do not acknowledge receiving an event notification message within 100 seconds, DocuSign treats the message as a failure and places it into a failure queue. It is imperative that you acknowledge successful receipt of Connect events as they occur by sending a 200 event back.\n\n#### When set to **true** and Send Individual Messages (SIM) mode is activated\n\nIf the HTTP status response to a notification message is not in the range of 200-299,\nthen the message delivery failed, and the configuration is marked as down.\n\nThe message will be queued and retried once per day.\nWhile a Connect configuration is marked down, subsequent notifications will not be tried. Instead they will be immediately queued with the reason `Pending`.\nWhen a message succeeds, all queued messages for the configuration will be tried immediately, in order.\n\nThere is a maximum of ten retries. Alternately, you can use **Republish Connect Information** to manually republish the notification.\n\n#### When set to **true** and SIM mode is not activated\n\nIf the HTTP Status response to a notification message is not in the range of 200-299, then the message delivery failed, and the message is queued.\n\nThe message will be retried after at least a day the next time a subsequent message is successfully sent to this configuration (subscription). Subsequent notifications will be tried when they occur.\nThere is a maximum of ten retries. Alternately, you can use **Republish Connect Information** to manually republish the notification.\n\n#### When set to **false**\n\nWhen `requiresAcknowledgement` is set to **false** and you do not acknowledge receiving an event notification message within 100 seconds, DocuSign treats the message as a failure and determines that the server is unavailable. It does not retry to send the notification message, and you must handle the failure manually.\n\n", + "type": "string" }, - "smartSectionTabs": { - "description": "A list of [Smart Section](https://www.docusign.com/blog/dsdev-deep-dive-responsive-smart-sections/) tabs.\n\nSmart Section tabs enhance responsive signing on mobile devices by enabling collapsible sections, page breaks, custom formatting options, and other advanced functionality.\n\n**Note**: Smart Sections are a premium feature. Responsive signing must also be enabled for your account.", - "type": "array", - "items": { - "$ref": "#/definitions/smartSection" - } + "salesforceApiVersion": { + "description": "The version of the Salesforce API that you are using.", + "type": "string" }, - "ssnTabs": { - "description": "A list of \n[SSN tabs][ssn].\n\nAn SSN tab contains a one-line field that enables the recipient to enter a Social Security Number (SSN) with or without\ndashes. It uses the same parameters as a Text tab, with the validation message and pattern set for SSN information. This value can be set.\n\n\n[ssn]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/ssn \n", - "type": "array", - "items": { - "$ref": "#/definitions/ssn" - } + "salesforceAuthcode": { + "description": "", + "type": "string" }, - "tabGroups": { - "description": "An array of `tabGroup` items that contain information about tab groups. To assign a tab to a `tabGroup`, you assign the `tabGroupLabel` to the `Tab.TabGroupLabels` array.", - "type": "array", - "items": { - "$ref": "#/definitions/tabGroup" - } + "salesforceCallBackUrl": { + "description": "", + "type": "string" }, - "textTabs": { - "description": "A list of \n[Text tabs][text].\n\nA text tab enables the recipient to enter free text. This value can be set.\n\n[text]: https://developers.docusign.com/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/text \n", - "type": "array", - "items": { - "$ref": "#/definitions/text" - } + "salesforceDocumentsAsContentFiles": { + "description": "When set to **true**, DocuSign can use documents in your Salesforce account for sending and signing.", + "type": "string" }, - "titleTabs": { - "description": "A list of \n[Title tabs][title].\n\nA Title tab displays the recipient's title. This value can't be set.\n\n\n[title]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/title \n", + "senderOverride": { + "description": "", + "type": "string" + }, + "senderSelectableItems": { + "description": "This property sets the items that are available for selection when adding or editing Connect objects. ", "type": "array", "items": { - "$ref": "#/definitions/title" + "type": "string" } }, - "viewTabs": { - "description": "A list of \n[View tabs][view].\n\nA View tab is used with an Approve tab to handle supplemental documents. This value can be set.\n\n[view]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/view \n", + "sfObjects": { + "description": "An array of Salesforce objects.", "type": "array", "items": { - "$ref": "#/definitions/view" + "$ref": "#/definitions/connectSalesforceObject" } }, - "zipTabs": { - "description": "A list of \n[Zip tabs][zip].\n\nA Zip tab enables the recipient to enter a ZIP code. The ZIP code can be five digits or nine digits ( in ZIP+4 format), and can be entered with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for ZIP code information. This value can be set.\n\n\n[zip]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/zip\n", + "signMessageWithX509Certificate": { + "description": "When set to **true**, Mutual TLS will be enabled for notifications. Mutual TLS must be initiated by the listener (the customer's web server) during the TLS handshake protocol. ", + "type": "string" + }, + "soapNamespace": { + "description": "The namespace of the SOAP interface.\n\n**Note**: If `useSoapInterface` is set to **true**, you must set this value.", + "type": "string" + }, + "urlToPublishTo": { + "description": "The endpoint to which Connect should send webhook notification messages via an HTTPS POST request. The URL must start with `https`. The customer's web server must use an SSL/TLS certificate whose CA is in the Microsoft list of trusted CAs. Self-signed certificates are not acceptable, but you can use free certificates from Let's Encrypt.", + "type": "string" + }, + "userIds": { + "description": "A comma-separated list of userIds. This sets the users associated with the tracked envelope and recipient events. When a tracked event occurs for a set user, the a notification message is sent to your Connect listener.\n\n**Note**: If allUsers is set to `false` then you must provide a list of user ids.", "type": "array", "items": { - "$ref": "#/definitions/zip" + "type": "string" } - } - }, - "x-ds-definition-name": "tabs", - "description": "", - "x-ds-category": "Templates", - "x-ds-order": "50", - "x-ms-summary": "" - }, - "EnvelopeViews": { - "type": "object", - "properties": { - "url": { - "description": "The view URL to be navigated to.", + }, + "userName": { + "description": "The name of the user.", + "type": "string" + }, + "useSoapInterface": { + "description": "When set to **true**, indicates that the `urlToPublishTo` property contains a SOAP endpoint.", "type": "string" } }, - "x-ds-definition-name": "viewUrl", - "description": "Embedding Envelope views", - "x-ds-category": "Envelopes", - "x-ds-order": "1", - "x-ms-summary": "Embedding Envelope views" + "x-ds-definition-name": "connectCustomConfiguration", + "description": "Contains information about a DocuSign Connect configuration.", + "x-ds-category": "Connect", + "x-ds-order": "10", + "x-ms-summary": "Contains information about a DocuSign Connect configuration." }, - "AccountSealProviders": { + "ConnectEvents": { "type": "object", "properties": { - "seals": { - "description": "A list of electronic seals to apply to documents.", + "failures": { + "description": "A list of Connect failure logs.", "type": "array", "items": { - "$ref": "#/definitions/sealIdentifier" + "$ref": "#/definitions/connectLog" + } + }, + "logs": { + "description": "A list of Connect general logs.", + "type": "array", + "items": { + "$ref": "#/definitions/connectLog" } + }, + "totalRecords": { + "description": "The count of records in the log list.", + "type": "string" + }, + "type": { + "description": "", + "type": "string" } }, - "x-ds-definition-name": "accountSeals", - "description": "", - "x-ds-category": "Accounts", - "x-ds-order": "10", - "x-ms-summary": "" + "x-ds-definition-name": "connectLogs", + "description": "Connect event logging information. This object contains sections for regular Connect logs and for Connect failures. ", + "x-ds-category": "Connect", + "x-ds-order": "20", + "x-ms-summary": "Connect event logging information. This object contains sections for regular Connect logs and for Connect failures. " }, - "Accounts": { - "description": "Account management", + "CustomTabs": { "type": "object", "properties": { - "accountIdGuid": { - "description": "The GUID associated with the account ID.", + "anchor": { + "description": "An optional string that is used to auto-match tabs to strings located in the documents of an envelope.", "type": "string" }, - "accountName": { - "description": "The name of the account associated with the current workspace user.", + "anchorCaseSensitive": { + "description": "This property controls how [anchor tabs][AnchorTabs] are placed. When **true**, the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false**.\n\nFor example, when set to **true**, if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When set to **false**, `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**.\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place", "type": "string" }, - "accountSettings": { - "$ref": "#/definitions/accountSettingsInformation", - "description": "The list of\n[account settings][accountsettings]\nthat determine\nthe features available for the account.\nNote that some features are determined\nby the plan used to create the account and cannot be overridden.\n\n[accountsettings]: https://developers.docusign.com/esign-rest-api/reference/Accounts/Accounts/create/#account-settings\n" + "anchorHorizontalAlignment": { + "description": "This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are :\n\n- `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value.\n- `right`: Aligns the tab’s left side with the last character of the matching anchor word.\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place\n", + "type": "string" }, - "allowTransactionRooms": { - "description": "When set to **true**, the transaction rooms feature exposed through the Workspaces API is enabled.", + "anchorIgnoreIfNotPresent": { + "description": "When set to **true**, this tab is ignored if the `anchorString` is not found in the document.", "type": "string" }, - "billingPeriodDaysRemaining": { - "description": "Number of days remaining in the current billing period.", + "anchorMatchWholeWord": { + "description": "When set to **true**, the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false**.\n\nFor example, when set to **true**, if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When set to **false**, if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**.\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n\n**Note**: You can only specify the value of this property in POST requests.\n\n[AnchorTab]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place\n", "type": "string" }, - "billingPeriodEndDate": { - "description": "The billing period end date in UTC timedate format.", + "anchorUnits": { + "description": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n", "type": "string" }, - "billingPeriodEnvelopesAllowed": { - "description": "The number of envelopes that can be sent in the current billing period (can be unlimited).", + "anchorXOffset": { + "description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n", "type": "string" }, - "billingPeriodEnvelopesSent": { - "description": "The number of envelopes that have been sent in the current billing period.", + "anchorYOffset": { + "description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n", "type": "string" }, - "billingPeriodStartDate": { - "description": "The billing period start date in UTC timedate format.", + "bold": { + "description": "When set to **true**, the information in the tab is bold.", "type": "string" }, - "billingProfile": { - "description": "The type of billing method on the account; for example `direct` or `web`.", + "collaborative": { + "description": "", "type": "string" }, - "canUpgrade": { - "description": "When set to **true**, specifies that you can upgrade the account through the API. For GET methods, you must set the `include_metadata` query parameter to **true** for this property to appear in the response.", + "concealValueOnDocument": { + "description": "When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender.\n\nWhen an envelope is completed the information is only available to the sender through the Form Data link in the DocuSign Console. The information on the downloaded document remains masked by asterisks.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.", "type": "string" }, - "connectPermission": { - "description": "", + "createdByDisplayName": { + "description": "The user name of the DocuSign user who created this object.", "type": "string" }, - "createdDate": { - "description": "The creation date of the account in UTC timedate format.", + "createdByUserId": { + "description": "The userId of the DocuSign user who created this object.", "type": "string" }, - "currencyCode": { - "description": "The currency code for the account, based on the [ISO 4217 currency code](https://www.iso.org/iso-4217-currency-codes.html).", + "customTabId": { + "description": "The DocuSign-generated custom tab ID for the custom tab to be applied. This property can only be used when adding new tabs for a recipient. When used, the new tab inherits all of the custom tab properties.", "type": "string" }, - "currentPlanId": { - "description": "ID of the plan used to create this account.", + "disableAutoSize": { + "description": "When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes.", "type": "string" }, - "distributorCode": { - "description": "The code that identifies the billing plan groups and plans for the new account.", + "editable": { + "description": "When set to **true**, the custom tab is editable. Otherwise the custom tab cannot be modified.", "type": "string" }, - "docuSignLandingUrl": { - "description": "URL of the landing page used to create the account.", + "font": { + "description": "The font to be used for the tab value. Supported fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n", "type": "string" }, - "envelopeSendingBlocked": { - "description": "When **true**, the ability to send envelopes is blocked. When **false**, envelopes can be sent.", + "fontColor": { + "description": "The font color to use for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n", "type": "string" }, - "envelopeUnitPrice": { - "description": "The price of sending an envelope, represented in the account's local currency.", + "fontSize": { + "description": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72", "type": "string" }, - "externalAccountId": { - "description": "The Account ID displayed on the user's Account page.", + "height": { + "description": "The height of the tab in pixels.", "type": "string" }, - "forgottenPasswordQuestionsCount": { - "description": " A complex element that contains up to four Question/Answer pairs for forgotten password information for a user.", + "includedInEmail": { + "description": "When set to **true**, the tab is included in e-mails related to the envelope on which it exists. This applies to only specific tabs.", "type": "string" }, - "isDowngrade": { - "description": "When **true**, the account has been downgraded from a premium account type. Otherwise **false**.", + "initialValue": { + "description": "The original value of the tab.", "type": "string" }, - "paymentMethod": { - "description": "The payment method used for the billing plan. Valid values are:\n\n- `NotSupported`\n- `CreditCard`\n- `PurchaseOrder`\n- `Premium`\n- `Freemium`\n- `FreeTrial`\n- `AppStore`\n- `DigitalExternal`\n- `DirectDebit`", + "italic": { + "description": "When set to **true**, the information in the tab is italic.", "type": "string" }, - "planClassification": { - "description": "Identifies the type of plan. Examples include:\n\n- `business`\n- `corporate`\n- `enterprise` \n- `free`", + "items": { + "description": "If the tab is a list, this represents the values that are possible for the tab.", + "type": "array", + "items": { + "type": "string" + } + }, + "lastModified": { + "description": "The UTC DateTime this object was last modified. This is in ISO8601 format.", "type": "string" }, - "planEndDate": { - "description": "The date that the current plan will end.", + "lastModifiedByDisplayName": { + "description": "The User Name of the DocuSign user who last modified this object.", "type": "string" }, - "planName": { - "description": "The name of the billing plan used for the account.", + "lastModifiedByUserId": { + "description": "The userId of the DocuSign user who last modified this object.", "type": "string" }, - "planStartDate": { - "description": "The date that the Account started using the current plan.", + "locked": { + "description": "When set to **true**, the signer cannot change the data of the custom tab.", "type": "string" }, - "recipientDomains": { - "description": "", - "type": "array", - "items": { - "$ref": "#/definitions/recipientDomain" - } + "maximumLength": { + "description": "The maximum number of entry characters supported by the custom tab.", + "type": "string" }, - "seatsAllowed": { - "description": "The number of active users the account can have at one time.", + "mergeField": { + "$ref": "#/definitions/mergeField", + "description": "Contains the information necessary to map the tab to a field in SalesForce." + }, + "name": { + "description": "The name of the custom tab.", "type": "string" }, - "seatsInUse": { - "description": "The number of users currently active on the account.", + "paymentItemCode": { + "description": "If the custom tab is for a payment request, this is the external code for the item associated with the charge. For example, this might be your product id.\n\nExample: `SHAK1`\n\nMaximum Length: 100 characters.", "type": "string" }, - "status21CFRPart11": { - "description": "The status of the account content per (Title 21 CFR Part 11)[https://www.fda.gov/regulatory-information/search-fda-guidance-documents/part-11-electronic-records-electronic-signatures-scope-and-application]. This regulation defines the criteria under which electronic records and electronic signatures are considered trustworthy.", + "paymentItemDescription": { + "description": "If the custom tab is for a payment request, this is the description of the item associated with the charge.\n\nExample: `The Danish play by Shakespeare`\n\nMaximum Length: 100 characters.", "type": "string" }, - "suspensionDate": { - "description": "The date on which the account was suspended.", + "paymentItemName": { + "description": "If the custom tab is for a payment request, this is the name of the item associated with the charge.\n\nMaximum Length: 100 characters.\n\nExample: `Hamlet`", "type": "string" }, - "suspensionStatus": { - "description": "Indicates whether the account is currently suspended.", + "requireAll": { + "description": "When set to **true** and shared is true, information must be entered in this field to complete the envelope. ", + "type": "string" + }, + "required": { + "description": "When set to **true**, the signer is required to fill out this tab.", + "type": "string" + }, + "requireInitialOnSharedChange": { + "description": "Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.", + "type": "string" + }, + "scaleValue": { + "description": "Sets the size of the tab. This field accepts values from `0.5` to `1.0`, where `1.0` represents full size and `0.5` is 50% of full size.", + "type": "string" + }, + "selected": { + "description": "When set to **true**, the radio button is selected.", + "type": "string" + }, + "shared": { + "description": "When set to **true**, this custom tab is shared.", + "type": "string" + }, + "stampType": { + "description": "The type of stamp. Valid values are:\n\n- `signature`: A signature image. This is the default value.\n- `stamp`: A stamp image.\n- null", + "type": "string" + }, + "stampTypeMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `stampType` property is editable.\n" + }, + "tabLabel": { + "description": "The label associated with the tab. This value may be an empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum Length: 500 characters.\n", + "type": "string" + }, + "type": { + "description": "The type of this tab. Values are:\n\n- Approve\n- CheckBox\n- Company\n- Date\n- DateSigned,\tDecline\n- Email,\tEmailAddress\n- EnvelopeId\n- FirstName\n- Formula\n- FullName,\tInitialHere\n- InitialHereOptional\n- LastName\n- List\n- Note\n- Number\n- Radio\n- SignerAttachment\n- SignHere\n- SignHereOptional\n- Ssn\n- Text\n- Title\n- Zip5\n- Zip5Dash4\n", + "type": "string" + }, + "underline": { + "description": "When set to **true**, the information in the tab is underlined.", + "type": "string" + }, + "validationMessage": { + "description": "The message displayed if the custom tab fails input validation (either custom of embedded).", + "type": "string" + }, + "validationPattern": { + "description": "A regular expression used to validate input for the tab.", + "type": "string" + }, + "width": { + "description": "The width of the tab in pixels.", "type": "string" } }, - "x-ds-definition-name": "accountInformation", - "x-ds-category": "Accounts", - "x-ds-order": "1", - "x-ms-summary": "Account management" + "x-ds-definition-name": "tabMetadata", + "description": "Custom tabs", + "x-ds-category": "CustomTabs", + "x-ds-order": "10", + "x-ms-summary": "Custom tabs" + }, + "RequestLogs": { + "type": "object", + "properties": { + "apiRequestLogging": { + "description": " When set to **true**, enables API request logging for the user. ", + "type": "string" + }, + "apiRequestLogMaxEntries": { + "description": "Specifies the maximum number of API requests to log.", + "type": "string" + }, + "apiRequestLogRemainingEntries": { + "description": "Indicates the remaining number of API requests that can be logged.", + "type": "string" + } + }, + "x-ds-definition-name": "diagnosticsSettingsInformation", + "description": "Request logs", + "x-ds-category": "Diagnostics", + "x-ds-order": "10", + "x-ms-summary": "Request logs" }, - "AccountSignatureProviders": { + "Resources": { "type": "object", "properties": { - "signatureProviders": { - "description": "Names of electronic or digital signature providers that can be used.", + "resources": { + "description": "", "type": "array", "items": { - "$ref": "#/definitions/accountSignatureProvider" + "$ref": "#/definitions/nameValue" } } }, - "x-ds-definition-name": "accountSignatureProviders", - "description": "Account SBS Signature Providers", - "x-ds-category": "Accounts", - "x-ds-order": "30", - "x-ms-summary": "Account SBS Signature Providers" + "x-ds-definition-name": "resourceInformation", + "description": "API resource information", + "x-ds-category": "Diagnostics", + "x-ds-order": "20", + "x-ms-summary": "API resource information" }, - "BillingPlans": { - "description": "Billing plans", + "Services": { "type": "object", "properties": { - "billingAddress": { - "$ref": "#/definitions/accountAddress", - "description": "The billing address for the account." - }, - "billingAddressIsCreditCardAddress": { - "description": "When set to **true**, the credit card address information is the same as that returned as the billing address. If false, then the billing address is considered a billing contact address, and the credit card address can be different.", + "buildBranch": { + "description": "Reserved: TBD", "type": "string" }, - "billingPlan": { - "$ref": "#/definitions/accountBillingPlan", - "description": "An object that contains details about the billing plan." - }, - "creditCardInformation": { - "$ref": "#/definitions/creditCardInformation", - "description": "A complex type that has information about the credit card used to pay for this account." - }, - "directDebitProcessorInformation": { - "$ref": "#/definitions/directDebitProcessorInformation", - "description": "Information about the bank that processes direct debits for the payment plan." + "buildBranchDeployedDateTime": { + "description": "Reserved: TBD", + "type": "string" }, - "paymentMethod": { - "description": "The payment method used for the billing plan. Valid values are:\n\n- `NotSupported`\n- `CreditCard`\n- `PurchaseOrder`\n- `Premium`\n- `Freemium`\n- `FreeTrial`\n- `AppStore`\n- `DigitalExternal`\n- `DirectDebit`", + "buildSHA": { + "description": "Reserved: TBD", "type": "string" }, - "paymentProcessorInformation": { - "$ref": "#/definitions/paymentProcessorInformation", - "description": "Information about the entity that processes payments for the billing plan." + "buildVersion": { + "description": "Reserved: TBD", + "type": "string" }, - "referralInformation": { - "$ref": "#/definitions/referralInformation", - "description": "Contains information describing discounts and promotions." + "linkedSites": { + "description": "", + "type": "array", + "items": { + "type": "string" + } }, - "successorPlans": { + "serviceVersions": { "description": "", "type": "array", "items": { - "$ref": "#/definitions/billingPlan" + "$ref": "#/definitions/serviceVersion" } } }, - "x-ds-definition-name": "accountBillingPlanResponse", - "x-ds-category": "Billing", - "x-ds-order": "10", - "x-ms-summary": "Billing plans" + "x-ds-definition-name": "serviceInformation", + "description": "API service information", + "x-ds-category": "Diagnostics", + "x-ds-order": "30", + "x-ms-summary": "API service information" }, - "Invoices": { - "description": "Invoices", + "EnvelopeConsumerDisclosures": { "type": "object", "properties": { - "amount": { - "description": "Reserved: TBD", + "accountEsignId": { + "description": "The GUID of the account associated with the consumer disclosure.", "type": "string" }, - "balance": { - "description": "Reserved: TBD", + "allowCDWithdraw": { + "description": "When set to **true**, indicates that the customer can withdraw their consent to the consumer disclosure when they decline to sign documents. If these recipients sign documents sent to them from your account in the future, they will be required to agree to the terms in the disclosure. The default value is **false**.\n**Note**: Only Admin users can change this setting.", "type": "string" }, - "dueDate": { - "description": "Reserved: TBD", - "type": "string" + "allowCDWithdrawMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `allowCDWithdraw` property is editable.\n" }, - "invoiceId": { - "description": "Reserved: TBD", + "changeEmail": { + "description": "If the customer needs to change their email address, this is the email address to which they should the change request.", "type": "string" }, - "invoiceItems": { - "description": "Reserved: TBD", - "type": "array", - "items": { - "$ref": "#/definitions/billingInvoiceItem" - } + "changeEmailOther": { + "description": "Other information about the requirements for the user to change their email address.\n\nExample: \n\n`We do not require any other information from you to change your email address.`", + "type": "string" }, - "invoiceNumber": { - "description": "Reserved: TBD", + "companyName": { + "description": "Specifies the company name used in the disclosure. The default value is the account name.\n\nHowever, if your account uses signing brands that specify a company name, you can substitute the brand's company name by setting the `useBrand` property to **true**. Whenever an envelope is sent from the account that uses a signing brand with a specified `companyName`, that value is used in email notifications and in the signing experience.\n\n**Note**: This substitution only works if you use the default legal disclosure or if you apply the `companyName` to the merge fields in a custom ERSD. You must also set the value of the `useBrand` property to **true**.\n", "type": "string" }, - "invoiceUri": { - "description": "Contains a URI for an endpoint that you can use to retrieve invoice information.", + "companyPhone": { + "description": "The phone number of the company associated with the consumer disclosure, as a free-formatted string.", "type": "string" }, - "nonTaxableAmount": { - "description": "", + "copyCostPerPage": { + "description": "The cost per page if the customer requests paper copies.\n\nExample: \n\n`0.0000`", "type": "string" }, - "pdfAvailable": { - "description": "", + "copyFeeCollectionMethod": { + "description": "Specifies the fee collection method for cases in which the customer requires paper copies of the document.\n\nMaximum length: 255 characters.\n\nExample: \n\n`We will bill you for any fees at that time, if any.`", "type": "string" }, - "taxableAmount": { - "description": "", + "copyRequestEmail": { + "description": "The email address to which the customer should send a request for copies of a document.\n\nMaximum length: 100 characters.", "type": "string" - } - }, - "x-ds-definition-name": "billingInvoice", - "x-ds-category": "Billing", - "x-ds-order": "20", - "x-ms-summary": "Invoices" - }, - "Payments": { - "description": "Payments", - "type": "object", - "properties": { - "amount": { - "description": "Reserved: TBD", + }, + "custom": { + "description": "When set to **true**, indicates that the consumer disclosure is a custom disclosure. The default is **false**.", "type": "string" }, - "description": { - "description": "A sender-defined description of the line item.\n", + "enableEsign": { + "description": "When set to **true** (default), indicates that eSign is enabled.", "type": "string" }, - "paymentDate": { - "description": "", + "esignAgreement": { + "description": "The final, assembled text of the Electronic Record and Signature Disclosure that includes the appropriate `companyName` and other specifics. It also includes the HTML tags used for formatting.", "type": "string" }, - "paymentId": { - "description": "", + "esignText": { + "description": "The template for the Electronic Record and Signature Disclosure, which contains placeholders for information such as the `companyName`. It also includes the HTML tags used for formatting.\n\n**Note**: If you are switching to or updating a custom disclosure, you can edit both the text and the HTML formatting.", "type": "string" }, - "paymentNumber": { - "description": "When set to **true**, a PDF version of the invoice is available. \n\nTo get the PDF, make the call again and change \"Accept:\" in the header to \"Accept: application/pdf\".", + "languageCode": { + "description": "The simple type enumeration for the language to use when displaying the disclosure. The following languages are supported:\n\n- Arabic (`ar`)\n- Bulgarian (`bg`)\n- Czech (`cs`)\n- Chinese Simplified (`zh_CN`)\n- Chinese Traditional (`zh_TW`)\n- Croatian (`hr`)\n- Danish (`da`)\n- Dutch (`nl`)\n- English US (`en`)\n- English UK (`en_GB`)\n- Estonian (`et`)\n- Farsi (`fa`)\n- Finnish (`fi`)\n- French (`fr`)\n- French Canadian (`fr_CA`)\n- German (`de`)\n- Greek (`el`)\n- Hebrew (`he`)\n- Hindi (`hi`)\n- Hungarian (`hu`)\n- Bahasa Indonesian (`id`)\n- Italian (`it`)\n- Japanese (`ja`)\n- Korean (`ko`)\n- Latvian (`lv`)\n- Lithuanian (`lt`)\n- Bahasa Melayu (`ms`)\n- Norwegian (`no`)\n- Polish (`pl`)\n- Portuguese (`pt`)\n- Portuguese Brazil (`pt_BR`)\n- Romanian (`ro`)\n- Russian (`ru`)\n- Serbian (`sr`)\n- Slovak (`sk`)\n- Slovenian (`sl`)\n- Spanish (`es`)\n- Spanish Latin America (`es_MX`)\n- Swedish (`sv`)\n- Thai (`th`)\n- Turkish (`tr`)\n- Ukrainian (`uk`) \n- Vietnamese (`vi`)\n\nAdditionally, you can automatically detect the browser language being used by the viewer and display the disclosure in that language by setting the value to `browser`.", "type": "string" - } - }, - "x-ds-definition-name": "billingPaymentItem", - "x-ds-category": "Billing", - "x-ds-order": "30", - "x-ms-summary": "Payments" - }, - "BulkEnvelopes": { - "type": "object", - "properties": { - "bulkEnvelopeStatuses": { - "description": "Reserved: TBD", - "type": "array", - "items": { - "$ref": "#/definitions/bulkEnvelopeStatus" - } }, - "endPosition": { - "description": "The last position in the result set. ", + "mustAgreeToEsign": { + "description": "When set to **true**, the recipient must agree to the consumer disclosure. The value of this property is read only. It is calculated based on the account setting `consumerDisclosureFrequency` and the user's actions.", "type": "string" }, - "nextUri": { - "description": "The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. ", + "pdfId": { + "description": "**Deprecated**. \n\nThe `pdfId` property in the consumer_disclosure PUT request is deprecated. For security reasons going forward, any value provided in the request packet must be ignored. ", "type": "string" }, - "previousUri": { - "description": "The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. ", + "useBrand": { + "description": "When set to **true**, specifies that the company name in the signing brand is used for the disclosure. Whenever an envelope is sent from the account that uses a signing brand with a specified company name, that value is used in email notifications and in the signing experience. \n\nWhen set to **false** (default), or if the signing brand does not specify a company name, the account name is used instead.\n\n**Note**: This substitution only works if you use the default legal disclosure or if you apply the `companyName` to the merge fields in a custom ERSD. ", "type": "string" }, - "resultSetSize": { - "description": "The number of results returned in this response. Because you can filter which entries are included in the response, this value is always less than or equal to `totalSetSize`.", + "useConsumerDisclosureWithinAccount": { + "description": "When set to **true**, specifies that recipients in the same account as the sender must agree to eSign an Electronic Record and Signature Disclosure Statement.", "type": "string" }, - "startPosition": { - "description": "The starting position of the current result set.", + "useConsumerDisclosureWithinAccountMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `useConsumerDisclosureWithinAccount` property is editable.\n" + }, + "withdrawAddressLine1": { + "description": "Contains the first address line of the postal address to which a customer can send a consent withdrawal notification.\n\nMaximum length: 100 characters. ", "type": "string" }, - "totalSetSize": { - "description": "The total number of items in the search's result set. This value is always greater than or equal to the value of `resultSetSize`.", + "withdrawAddressLine2": { + "description": "Contains the second address line of the postal address to which a customer can send a consent withdrawal notification.\n\nMaximum length: 100 characters. ", "type": "string" - } - }, - "x-ds-definition-name": "bulkEnvelopesResponse", - "description": "Bulk envelopes", - "x-ds-category": "BulkEnvelopes", - "x-ds-order": "10", - "x-ms-summary": "Bulk envelopes" - }, - "CloudStorage": { - "type": "object", - "properties": { - "endPosition": { - "description": "The last position in the result set. ", + }, + "withdrawByEmail": { + "description": "When set to **true** (default), indicates that the customer can withdraw consent by email.", "type": "string" }, - "errorDetails": { - "$ref": "#/definitions/externalDocServiceErrorDetails", - "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." + "withdrawByMail": { + "description": "When set to **true**, indicates that the customer can withdraw consent by postal mail. The default is **false**.", + "type": "string" }, - "id": { - "description": "A unique ID for the Salesforce object.", + "withdrawByPhone": { + "description": "When set to **true**, indicates that the customer can withdraw consent by phone. The default is **false**.", "type": "string" }, - "items": { - "description": "", - "type": "array", - "items": { - "$ref": "#/definitions/externalFile" - } + "withdrawCity": { + "description": "Contains the city of the postal address to which a customer can send a consent withdrawal notification.\n\nMaximum length: 50 characters. ", + "type": "string" }, - "name": { - "description": "", + "withdrawConsequences": { + "description": "Text indicating the consequences of withdrawing consent.\n\nMaximum length: 255 characters.", "type": "string" }, - "nextUri": { - "description": "The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. ", + "withdrawEmail": { + "description": "Contains the email address to which a customer can send a consent withdrawal notification.\n\nMaximum length: 100 characters. ", "type": "string" }, - "previousUri": { - "description": "The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. ", + "withdrawOther": { + "description": "Contains any other information needed to withdraw consent.\n\nMaximum length: 255 characters.\n\nExample:\n\n`We do not need any other information from you to withdraw consent.`", "type": "string" }, - "resultSetSize": { - "description": "The number of results returned in this response. Because you can filter which entries are included in the response, this value is always less than or equal to `totalSetSize`.", + "withdrawPhone": { + "description": "Contains the phone number that a customer can call to register consent withdrawal notification as a free-formatted string.\n\nMaximum length: 20 characters. ", "type": "string" }, - "startPosition": { - "description": "The starting position of the current result set.", + "withdrawPostalCode": { + "description": "Contains the postal code of the postal address to which a customer can send a consent withdrawal notification.\n\nMaximum length: 20 characters. ", "type": "string" }, - "totalSetSize": { - "description": "The total number of items in the search's result set. This value is always greater than or equal to the value of `resultSetSize`.", + "withdrawState": { + "description": "Contains the state of the postal address to which a customer can send a consent withdrawal notification.\n\nExample: `PA`", "type": "string" } }, - "x-ds-definition-name": "externalFolder", - "description": "Cloud storage", - "x-ds-category": "CloudStorage", - "x-ds-order": "10", - "x-ms-summary": "Cloud storage" + "x-ds-definition-name": "consumerDisclosure", + "description": "Details about envelope consumer disclosures.", + "x-ds-category": "Envelopes", + "x-ds-order": "90", + "x-ms-summary": "Details about envelope consumer disclosures." }, - "CloudStorageProviders": { + "EnvelopeDocuments": { "type": "object", "properties": { - "storageProviders": { - "description": "An Array containing the storage providers associated with the user.", + "envelopeDocuments": { + "description": "An array of document objects.", "type": "array", "items": { - "$ref": "#/definitions/cloudStorageProvider" + "$ref": "#/definitions/envelopeDocument" } + }, + "envelopeId": { + "description": "The envelope ID of the envelope status that failed to post.", + "type": "string" } }, - "x-ds-definition-name": "cloudStorageProviders", - "description": "Cloud storage providers", - "x-ds-category": "CloudStorage", - "x-ds-order": "20", - "x-ms-summary": "Cloud storage providers" + "x-ds-definition-name": "envelopeDocumentsResult", + "description": "Envelope documents", + "x-ds-category": "Envelopes", + "x-ds-order": "40", + "x-ms-summary": "Envelope documents" }, - "ConnectConfigurations": { + "EnvelopeEmailSettings": { + "description": "Envelope email settings", "type": "object", "properties": { - "allowEnvelopePublish": { - "description": "When set to **true**, data is sent to the urlToPublishTo web address. This option can be set to false to stop sending data while maintaining the Connect configuration information.", - "type": "string" + "bccEmailAddresses": { + "description": "An array containing the email address that should receive a copy of all email communications related to an envelope for archiving purposes. Maximum Length: 100 characters.\n\nWhile this property is an array, note that it takes only a single email address.\n\n**Note**: Only users with the `canManageAccount` setting set to **true** can use this option. \n\nDocuSign verifies that the email format is correct, but does not verify that the email address is active. You can use this for archiving purposes. However, using this property overrides the BCC for Email Archive information setting for this envelope. \n\n**Example**: if your account has BCC for Email Archive set up for the email address archive@mycompany.com and you send an envelope using the BCC Email Override to send a BCC email to salesarchive@mycompany.com, then a copy of the envelope is only sent to the salesarchive@mycompany.com email address.", + "type": "array", + "items": { + "$ref": "#/definitions/bccEmailAddress" + } }, - "allowSalesforcePublish": { - "description": "", + "replyEmailAddressOverride": { + "description": "The Reply To email address to use for email replies, instead of the one that is configured at the account level. DocuSign verifies that the email address is in a correct format, but does not verify that it is active. Maximum Length: 100 characters.", "type": "string" }, - "allUsers": { - "description": "When set to **true**, the tracked envelope and recipient events for all users, including users that are added a later time, are sent through Connect.", + "replyEmailNameOverride": { + "description": "The name to associate with the Reply To email address, instead of the name that is configured at the account level. Maximum Length: 100 characters.", + "type": "string" + } + }, + "x-ds-definition-name": "emailSettings", + "x-ds-category": "Envelopes", + "x-ds-order": "30", + "x-ms-summary": "Envelope email settings" + }, + "Envelopes": { + "type": "object", + "properties": { + "accessControlListBase64": { + "description": "Reserved for DocuSign.", "type": "string" }, - "configurationType": { - "description": "If merge fields are being used, specifies the type of the merge field. The only supported value is **salesforce**.", + "allowComments": { + "description": "When set to **true**, users can add comments to the documents in the envelope. For example, if a signer has a question about the text in the document, they can add a comment to the document.", "type": "string" }, - "connectId": { - "description": " Read only: the DocuSign generated ID for the Connect configuration. ", + "allowMarkup": { + "description": "When set to **true**, the Document Markup feature is enabled.\n\n**Note**: To use this feature, Document Markup must be enabled at both the account and envelope levels. Only Admin users can change this setting for at the account level.", "type": "string" }, - "enableLog": { - "description": "This turns Connect logging on or off. When set to **true**, logging is turned on.", + "allowReassign": { + "description": "When **true**, the recipient can redirect an envelope to a more appropriate recipient.", "type": "string" }, - "envelopeEvents": { - "description": "An array of strings that lists envelope-related events that are tracked through Connect. The possible event values are: \n\n- `sent`\n- `delivered`\n- `completed`\n- `declined`\n- `voided`\n\n\n**Note**: In previous versions of the API, this value was a single comma-separated string.", - "type": "array", - "items": { - "type": "string" - } + "allowViewHistory": { + "description": "When set to **true**, recipients can view the history of the envelope.", + "type": "string" }, - "externalFolderId": { - "description": "", + "anySigner": { + "description": "Deprecated. This feature has been replaced by signing groups.", "type": "string" }, - "externalFolderLabel": { - "description": "", + "asynchronous": { + "description": "When **true**, the envelope is queued for\nprocessing and the value of the `status` property\nis set to `Processing`. Additionally, GET status\ncalls return `Processing` until completed.\n\n\n**Note**: A `transactionId` is required for this\ncall to work correctly. When the envelope is\ncreated, the status is `Processing` and an\n`envelopeId` is not returned in the response. To\nget the `envelopeId`, use a GET envelope query by\nusing the\n[transactionId](https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/Envelopes/create/) or by checking the\nConnect notification.", "type": "string" }, - "includeCertificateOfCompletion": { - "description": "When set to **true**, the Connect Service includes the Certificate of Completion with completed envelopes. ", + "attachmentsUri": { + "description": "Contains a URL for retrieving the attachments that are associated with the envelope.", "type": "string" }, - "includeCertSoapHeader": { - "description": "", + "authoritativeCopy": { + "description": "When **true**, marks all of the documents in the envelope as authoritative copies.\n\n**Note**: You can override this value for a specific document. For example, you can set the `authoritativeCopy` property to **true** at the envelope level, but turn it off for a single document by setting the `authoritativeCopy` property for the document to **false**.", "type": "string" }, - "includeDocumentFields": { - "description": "When set to **true**, the Document Fields associated with the envelope's documents are included in the notification messages. Document Fields are optional custom name-value pairs added to documents using the API. ", + "authoritativeCopyDefault": { + "description": "The default `authoritativeCopy` setting for documents in this envelope that do not have `authoritativeCopy` set.\nIf this property is not set, each document defaults to the envelope's `authoritativeCopy`.", "type": "string" }, - "includeDocuments": { - "description": "When set to **true**, Connect will send the PDF document along with the update XML.", + "autoNavigation": { + "description": "When set to **true**, autonavigation is set for the recipient.\n", "type": "string" }, - "includeEnvelopeVoidReason": { - "description": "When set to **true**, Connect will include the voidedReason for voided envelopes.", + "brandId": { + "description": "The id of the brand.", "type": "string" }, - "includeHMAC": { - "description": "", + "brandLock": { + "description": "When **true**, the `brandId` for the envelope is locked and senders cannot change the brand used for the envelope.", "type": "string" }, - "includeSenderAccountasCustomField": { - "description": "When set to **true**, Connect will include the sender account as Custom Field in the data.", + "certificateUri": { + "description": "The URI for retrieving certificate information.", "type": "string" }, - "includeTimeZoneInformation": { - "description": "When set to **true**, Connect will include the envelope time zone information.", + "completedDateTime": { + "description": "Specifies the date and time this item was completed.", "type": "string" }, - "name": { - "description": "The name of the Connect configuration. The name helps identify the configuration in the list.", + "copyRecipientData": { + "description": "", "type": "string" }, - "password": { - "description": "The user's encrypted password hash.", + "createdDateTime": { + "description": "The UTC DateTime when the item was created.", "type": "string" }, - "recipientEvents": { - "description": "An array of strings that lists of recipient-related events that trigger a notification\nto your webhook Connect listener. The possible event values are:\n\n- `sent`\n- `delivered`\n- `completed`\n- `declined`\n- `authenticationfailed`\n- `autoresponded`\n\n**Note**: In previous versions of the API, this value was a single comma-separated string.", - "type": "array", - "items": { - "type": "string" - } + "customFields": { + "$ref": "#/definitions/AccountCustomFields", + "description": "An optional array of strings that enables the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each `customField` string can be a maximum of 100 characters." }, - "requireMutualTls": { - "description": "If **true** [Mutual TLS](https://developers.docusign.com/esign-rest-api/guides/mutual-tls-intro) authentication is enabled.", + "customFieldsUri": { + "description": "The URI for retrieving custom fields.", "type": "string" }, - "requiresAcknowledgement": { - "description": "#### When set to **true**, and SIM mode is activated:\n\nIf the HTTP Status response to a notification message is not in the range of 200-299,\nthen the message delivery failed, and the configuration is marked as down.\n\nThe message will be queued and retried once per day.\nWhile a Connect configuration is marked down, subsequent notifications will not be tried, they'll be immediately queued with reason \"Pending\".\nOnce a message succeeds, all queued messages for the configuration will be tried immediately, in order.\n\nThere is a maximum of ten retries. Alternately, you can use Republish Connect Information to manually republish the notification.\n\n#### When set to **true**, and SIM mode is not activated: \n\nIf the HTTP Status response to a notification message is not in the range of 200-299, then the message delivery failed, and the message is queued.\n\nThe message will be retried after at least a day the next time a subsequent message is successfully sent to this configuration (subscription). Subsequent notifications will be tried when they occur.\nThere is a maximum of ten retries. Alternately, you can use Republish Connect Information to manually republish the notification.", + "declinedDateTime": { + "description": "The date and time the recipient declined the document. Read only.", "type": "string" }, - "salesforceAccessToken": { - "description": "The access token to use for Salesforce integration.", + "deletedDateTime": { + "description": "Reserved for DocuSign.", "type": "string" }, - "salesforceApiVersion": { - "description": "The version of the Salesforce API that you are using.", + "deliveredDateTime": { + "description": "The date and time that the envelope was delivered to the recipient. Read only.", "type": "string" }, - "salesforceDocumentsAsContentFiles": { - "description": "", + "disableResponsiveDocument": { + "description": "When set to **true**, responsive documents are disabled for the envelope.", "type": "string" }, - "salesforceRefreshToken": { - "description": "", + "documentsCombinedUri": { + "description": "The URI for retrieving all of the documents associated with the envelope as a single PDF file.", "type": "string" }, - "senderOverride": { - "description": "", + "documentsUri": { + "description": "The URI for retrieving all of the documents associated with the envelope as separate files.", "type": "string" }, - "senderSelectableItems": { - "description": "", - "type": "array", - "items": { - "type": "string" - } + "emailBlurb": { + "description": "This is the same as the email body. If specified it is included in the email body for all envelope recipients.", + "type": "string" }, - "sfObjects": { - "description": "", - "type": "array", - "items": { - "$ref": "#/definitions/connectSalesforceObject" - } + "emailSettings": { + "$ref": "#/definitions/emailSettings", + "description": "A complex element that allows the sender to override some envelope email setting information. This can be used to override the Reply To email address and name associated with the envelope and to override the BCC email addresses to which an envelope is sent. \n\nWhen the emailSettings information is used for an envelope, it only applies to that envelope. \n\n**IMPORTANT**: The `emailSettings` information is not returned in the GET method for envelope status. Use GET /email_settings to return information about the email settings. " }, - "signMessageWithX509Certificate": { - "description": "When set to **true**, Mutual TLS will be enabled for notifications. Mutual TLS must be initiated by the listener (the customer's web server) during the TLS handshake protocol. ", + "emailSubject": { + "description": "The subject line of the email message that is sent to all recipients.\n\nFor information about adding merge field information to the email subject, see [Template Email Subject Merge Fields](https://developers.docusign.com/docs/esign-rest-api/reference/Templates/Templates/create#template-email-subject-merge-fields).\n", "type": "string" }, - "soapNamespace": { - "description": "The namespace of the SOAP interface.\n\nThe namespace value must be set if useSoapInterface is set to true.", + "enableWetSign": { + "description": "When set to **true**, the signer is allowed to print the document and sign it on paper.", "type": "string" }, - "urlToPublishTo": { - "description": "The endpoint to which webhook notification messages are sent via an HTTPS POST request. The url must start with https. The customer's web server must use an SSL/TLS certificate whose CA is in the Microsoft list of trusted CAs. Self-signed certificates are not ok. Free certificates from Let's Encrypt can be used.", + "enforceSignerVisibility": { + "description": "When set to **true**, signers can only view the documents on which they have tabs. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all of the documents in an envelope, unless they are specifically excluded by using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded by using this setting when an envelope is sent.\n\n**Note**: To use this functionality, [Document Visibility][docviz] must be enabled for the account by making the account setting `allowDocumentVisibility` **true**.\n\n[docviz]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeDocumentVisibility/", "type": "string" }, - "userIds": { - "description": "A comma separated list of userIds. This sets the users associated with the tracked envelope and recipient events. When a tracked event occurs for a set user, the a notification message is sent to your Connect listener. \n\n###### Note: If allUsers is set to `false` then you must provide a list of user ids.", + "envelopeAttachments": { + "description": "An array of attachment objects that provide information about the attachments that are associated with the envelope.", "type": "array", "items": { - "type": "string" + "$ref": "#/definitions/attachment" } }, - "userName": { - "description": "The name of the user.", - "type": "string" - }, - "useSoapInterface": { - "description": "When set to **true**, indicates that the `urlToPublishTo` property contains a SOAP endpoint.", - "type": "string" - } - }, - "x-ds-definition-name": "connectCustomConfiguration", - "description": "Connect configurations", - "x-ds-category": "Connect", - "x-ds-order": "10", - "x-ms-summary": "Connect configurations" - }, - "ConnectEvents": { - "type": "object", - "properties": { - "failures": { - "description": "A list of Connect failure logs.", + "envelopeDocuments": { + "description": "An array containing information about the documents that are included in the envelope.", "type": "array", "items": { - "$ref": "#/definitions/connectLog" + "$ref": "#/definitions/envelopeDocument" } }, - "logs": { - "description": "A list of Connect general logs.", - "type": "array", - "items": { - "$ref": "#/definitions/connectLog" - } + "envelopeId": { + "description": "The envelope ID of the envelope status that failed to post.", + "type": "string" }, - "totalRecords": { - "description": "The count of records in the log list.", + "envelopeIdStamping": { + "description": "When set to **true**, [Envelope ID Stamping](https://support.docusign.com/en/guides/ndse-user-guide-set-advanced-document-options) is enabled.\nAfter a document or attachment is stamped with an Envelope ID,\nthe ID is seen by all recipients\nand becomes a permanent part of the document\nand cannot be removed.", "type": "string" }, - "type": { - "description": "Type of user:\n- `type_owner`\n- `type_participant`", + "envelopeLocation": { + "description": "Reserved for DocuSign.", "type": "string" - } - }, - "x-ds-definition-name": "connectLogs", - "description": "Connect event logging information. This object contains sections for regular Connect logs and for Connect failures. ", - "x-ds-category": "Connect", - "x-ds-order": "20", - "x-ms-summary": "Connect event logging information. This object contains sections for regular Connect logs and for Connect failures. " - }, - "CustomTabs": { - "type": "object", - "properties": { - "anchor": { - "description": "An optional string that is used to auto-match tabs to strings located in the documents of an envelope.", + }, + "envelopeMetadata": { + "$ref": "#/definitions/envelopeMetadata", + "description": "Metadata that indicates whether the `envelope` property is editable.\n" + }, + "envelopeUri": { + "description": "The URI for retrieving the envelope or envelopes.", "type": "string" }, - "anchorCaseSensitive": { - "description": "Reserved for DocuSign.\n", + "expireAfter": { + "description": "An integer specifying the number of days that a sent envelope remains active before it expires. A negative number in a response indicates that the envelope has already expired.", "type": "string" }, - "anchorHorizontalAlignment": { - "description": "Reserved for DocuSign.\n\n", + "expireDateTime": { + "description": "The date and time the envelope is set to expire.", "type": "string" }, - "anchorIgnoreIfNotPresent": { - "description": "When set to **true**, this tab is ignored if the `anchorString` is not found in the document.", + "expireEnabled": { + "description": "When set to **true**, the envelope expires (is no longer available for signing) after the specified number of days after it is sent (`sentDateTime`). Set `expireAfter` to set the number of days until an envelope expires. When **false**, the account default setting is used. If the account does not have an expiration setting, the DocuSign default value of 120 days is used.", "type": "string" }, - "anchorMatchWholeWord": { - "description": "Reserved for DocuSign.\n\n", + "externalEnvelopeId": { + "description": "May contain an external identifier for the envelope.", "type": "string" }, - "anchorUnits": { - "description": "Specifies the units of the X and Y offset. Units may be pixels, millimeters, centimeters, or inches.", + "folders": { + "description": "A list of folder objects.", + "type": "array", + "items": { + "$ref": "#/definitions/folder" + } + }, + "hasComments": { + "description": "When set to **true**, indicates that users have added comments to the envelope.", "type": "string" }, - "anchorXOffset": { - "description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.", + "hasFormDataChanged": { + "description": "Specifies if the `EnvelopeFormData` associated with any forms in the envelope has changed.", "type": "string" }, - "anchorYOffset": { - "description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.", + "hasWavFile": { + "description": "When set to **true**, indicates that a .wav file used for voice authentication is included in the envelope. ", "type": "string" }, - "bold": { - "description": "When set to **true**, the information in the tab is bold.", + "holder": { + "description": "Reserved for DocuSign.", "type": "string" }, - "concealValueOnDocument": { - "description": "When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender.\n\nWhen an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.", + "initialSentDateTime": { + "description": "The date and time the envelope was initially sent.", "type": "string" }, - "createdByDisplayName": { - "description": "The user name of the DocuSign user who created this object.", + "is21CFRPart11": { + "description": "When **true**, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).", "type": "string" }, - "createdByUserId": { - "description": "The userId of the DocuSign user who created this object.", + "isDynamicEnvelope": { + "description": "When set to **true**, indicates that the envelope is a dynamic envelope.", "type": "string" }, - "customTabId": { - "description": "The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.", + "isSignatureProviderEnvelope": { + "description": "When set to **true**, indicates that the envelope is a signature-provided envelope.", "type": "string" }, - "disableAutoSize": { - "description": "When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes.", + "lastModifiedDateTime": { + "description": "The date and time that the item was last modified.", "type": "string" }, - "editable": { - "description": "When set to **true**, the custom tab is editable. Otherwise the custom tab cannot be modified.", + "location": { + "description": "Reserved for DocuSign.", "type": "string" }, - "font": { - "description": "The font to be used for the tab value. Supported fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n", + "lockInformation": { + "$ref": "#/definitions/EnvelopeLocks", + "description": "Provides lock information about an envelope that a user has locked." + }, + "messageLock": { + "description": "When set to **true**, prevents senders from changing the contents of `emailBlurb` and `emailSubject` properties for the envelope. \n\nAdditionally, this prevents users from making changes to the contents of `emailBlurb` and `emailSubject` properties when correcting envelopes. \n\nHowever, if the `messageLock` node is set to **true** and the `emailSubject` property is empty, senders and correctors are able to add a subject to the envelope.", "type": "string" }, - "fontColor": { - "description": "The font color to use for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n", - "type": "string" + "notification": { + "$ref": "#/definitions/notification", + "description": "A complex element that specifies the notification options for the envelope. It consists of:\n\n* useAccountDefaults - When set to **true**, the account default notification settings are used for the envelope. \n* reminders - A complex element that specifies reminder settings for the envelope. It consists of: \n\n * reminderEnabled - When set to **true**, a reminder message is sent to the recipient.\n * reminderDelay - An interger that sets the number of days after the recipient receives the envelope that reminder emails are sent to the recipient. \n * reminderFrequency - An interger that sets the interval, in days, between reminder emails. \n\n* expirations - A complex element that specifies the expiration settings for the envelope. It consists of:\n\n * expireEnabled - When set to **true**, the envelope expires (is no longer available for signing) in the set number of days. If false, the account default setting is used. If the account does not have an expiration setting, the DocuSign default value of 120 days is used. \n * expireAfter - An integer that sets the number of days the envelope is active.\n * expireWarn - An integer that sets the number of days before envelope expiration that an expiration warning email is sent to the recipient. If set to 0 (zero), no warning email is sent. \n" }, - "fontSize": { - "description": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72", + "notificationUri": { + "description": "The URI for retrieving notifications.", "type": "string" }, - "height": { - "description": "The height of the tab in pixels.", - "type": "string" + "powerForm": { + "$ref": "#/definitions/powerForm", + "description": "Information about any PowerForms that are included in the envelope." }, - "includedInEmail": { - "description": "When set to **true**, the tab is included in e-mails related to the envelope on which it exists. This applies to only specific tabs.", + "purgeCompletedDate": { + "description": "The date that a purge was completed.", "type": "string" }, - "initialValue": { - "description": "The original value of the tab.", + "purgeRequestDate": { + "description": "The date that a purge was requested.", "type": "string" }, - "italic": { - "description": "When set to **true**, the information in the tab is italic.", + "purgeState": { + "description": "Shows the current purge state for the envelope. The possible values are:\n\n* `unpurged`: There has been no successful request to purge documents.\n* `documents_queued`: The envelope documents have been added to the purge queue, but have not been purged.\n* `documents_dequeued`: The envelope documents have been taken out of the purge queue.\n* `documents_and_metadata_queued`: The envelope documents and metadata have been added to the purge queue, but have not yet been purged.\n* `documents_purged`: The envelope documents have been successfully purged.\n* `documents_and_metadata_purged`: The envelope documents and metadata have been successfully purged.\n\n", "type": "string" }, - "items": { - "description": "If the tab is a list, this represents the values that are possible for the tab.", - "type": "array", - "items": { - "type": "string" - } + "recipients": { + "$ref": "#/definitions/EnvelopeRecipients", + "description": "An array of recipient objects that provides details about the recipients of the envelope." }, - "lastModified": { - "description": "The UTC DateTime this object was last modified. This is in ISO8601 format.", + "recipientsLock": { + "description": "When set to **true**, prevents senders from changing, correcting, or deleting the recipient information for the envelope.", "type": "string" }, - "lastModifiedByDisplayName": { - "description": "The User Name of the DocuSign user who last modified this object.", + "recipientsUri": { + "description": "Contains a URI for an endpoint that you can use to retrieve the recipients.", "type": "string" }, - "lastModifiedByUserId": { - "description": "The userId of the DocuSign user who last modified this object.", - "type": "string" + "sender": { + "$ref": "#/definitions/userInfo", + "description": "Information about the sender of the envelope." }, - "locked": { - "description": "When set to **true**, the signer cannot change the data of the custom tab.", + "sentDateTime": { + "description": "The UTC DateTime when the envelope was sent. Read only.", "type": "string" }, - "maximumLength": { - "description": "The maximum number of entry characters supported by the custom tab.", + "signerCanSignOnMobile": { + "description": "When set to **true**, recipients can sign on a mobile device.\n\n**Note**: Only Admin users can change this setting.\n", "type": "string" }, - "mergeField": { - "$ref": "#/definitions/mergeField", - "description": "Contains the information necessary to map the tab to a field in SalesForce." + "signingLocation": { + "description": "Specifies the physical location where the signing takes place. It can have two enumeration values; `inPerson` and `online`. The default value is `online`.", + "type": "string" }, - "name": { - "description": "", + "status": { + "description": "* `completed`: The recipients have finished working with the envelope: the documents are signed and all required tabs are filled in.\n* `created`: The envelope is created as a draft. It can be modified and sent later.\n* `declined`: The envelope has been declined by the recipients.\n* `delivered`: The envelope has been delivered to the recipients.\n* `sent`: The envelope will be sent to the recipients after the envelope is created.\n* `signed`: The envelope has been signed by the recipients.\n* `voided`: The envelope is no longer valid and recipients cannot access or sign the envelope.\n", "type": "string" }, - "paymentItemCode": { - "description": "", + "statusChangedDateTime": { + "description": "The data and time that the status changed.", "type": "string" }, - "paymentItemDescription": { - "description": "", + "statusDateTime": { + "description": "The DateTime that the envelope changed status (i.e. was created or sent.)", "type": "string" }, - "paymentItemName": { - "description": "", + "templatesUri": { + "description": "The URI for retrieving the templates.", "type": "string" }, - "required": { - "description": "When set to **true**, the signer is required to fill out this tab.", + "transactionId": { + "description": " Used to identify an envelope. The id is a sender-generated value and is valid in the DocuSign system for 7 days. It is recommended that a transaction ID is used for offline signing to ensure that an envelope is not sent multiple times. The `transactionId` property can be used determine an envelope's status (i.e. was it created or not) in cases where the internet connection was lost before the envelope status was returned.", "type": "string" }, - "scaleValue": { - "description": "Sets the size of the tab. This field accepts values from `0.5` to `1.0`, where `1.0` represents full size and `0.5` is 50% of full size.", + "useDisclosure": { + "description": "When set to **true**, the disclosure is shown to recipients in accordance with the account's Electronic Record and Signature Disclosure frequency setting. When set to **false**, the Electronic Record and Signature Disclosure is not shown to any envelope recipients. \n\nIf the `useDisclosure` property is not set, then the account's normal disclosure setting is used and the value of the `useDisclosure` property is not returned in responses when getting envelope information.", "type": "string" }, - "selected": { - "description": "When set to **true**, the radio button is selected.", + "voidedDateTime": { + "description": "The date and time the envelope or template was voided.", "type": "string" }, - "shared": { - "description": "When set to **true**, this custom tab is shared.", + "voidedReason": { + "description": "The reason the envelope or template was voided.", "type": "string" }, - "stampType": { - "description": "If the recipient signs by using a personal stamp that is representative of their signature, this property specifies the stamp type.", + "workflow": { + "$ref": "#/definitions/workflow", + "description": "" + } + }, + "x-ds-definition-name": "envelope", + "description": "Envelope creation, management", + "x-ds-category": "Envelopes", + "x-ds-order": "10", + "x-ms-summary": "Envelope creation, management" + }, + "EnvelopeTemplates": { + "type": "object", + "properties": { + "templates": { + "description": "An array of `templateSummary` objects that contain information about templates.", + "type": "array", + "items": { + "$ref": "#/definitions/templateSummary" + } + } + }, + "x-ds-definition-name": "templateInformation", + "description": "Envelope templates", + "x-ds-category": "Envelopes", + "x-ds-order": "85", + "x-ms-summary": "Envelope templates" + }, + "Folders": { + "type": "object", + "properties": { + "endPosition": { + "description": "The last index position in the result set. ", "type": "string" }, - "stampTypeMetadata": { - "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `stampType` property is editable.\n" + "envelopes": { + "description": "A list of envelopes in this folder.", + "type": "array", + "items": { + "$ref": "#/definitions/envelopeSummary" + } }, - "tabLabel": { - "description": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n", - "type": "string" + "folders": { + "description": "A list of folder objects.", + "type": "array", + "items": { + "$ref": "#/definitions/folder" + } }, - "type": { - "description": "The type of this tab. Values are:\n\n- Approve\n- CheckBox\n- Company\n- Date\n- DateSigned,\tDecline\n- Email,\tEmailAddress\n- EnvelopeId\n- FirstName\n- Formula\n- FullName,\tInitialHere\n- InitialHereOptional\n- LastName\n- List\n- Note\n- Number\n- Radio\n- SignerAttachment\n- SignHere\n- SignHereOptional\n- Ssn\n- Text\n- Title\n- Zip5\n- Zip5Dash4\n", + "nextUri": { + "description": "The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. ", "type": "string" }, - "underline": { - "description": "When set to **true**, the information in the tab is underlined.", + "previousUri": { + "description": "The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. ", "type": "string" }, - "validationMessage": { - "description": "The message displayed if the custom tab fails input validation (either custom of embedded).", + "resultSetSize": { + "description": "The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`.", "type": "string" }, - "validationPattern": { - "description": "A regular expression used to validate input for the tab.", + "startPosition": { + "description": "The starting index position of the current result set.", "type": "string" }, - "width": { - "description": "The width of the tab in pixels.", + "totalSetSize": { + "description": "The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`.", "type": "string" } }, - "x-ds-definition-name": "tabMetadata", - "description": "Custom tabs", - "x-ds-category": "CustomTabs", + "x-ds-definition-name": "foldersResponse", + "description": "Folder management", + "x-ds-category": "Folders", "x-ds-order": "10", - "x-ms-summary": "Custom tabs" + "x-ms-summary": "Folder management" }, - "RequestLogs": { + "GroupBrands": { "type": "object", "properties": { - "apiRequestLogging": { - "description": " When set to **true**, enables API request logging for the user. ", + "recipientBrandIdDefault": { + "description": "The brand that envelope recipients see when a brand is not explicitly set.", "type": "string" }, - "apiRequestLogMaxEntries": { - "description": "Specifies the maximum number of API requests to log.", + "senderBrandIdDefault": { + "description": "The brand that envelope senders see when a brand is not explicitly set.", "type": "string" }, - "apiRequestLogRemainingEntries": { - "description": "Indicates the remaining number of API requests that can be logged.", - "type": "string" + "brandOptions": { + "description": "A list of brands.", + "type": "array", + "items": { + "$ref": "#/definitions/brand" + } } }, - "x-ds-definition-name": "diagnosticsSettingsInformation", - "description": "Request logs", - "x-ds-category": "Diagnostics", - "x-ds-order": "10", - "x-ms-summary": "Request logs" + "x-ds-definition-name": "brandsResponse", + "description": "If your account includes multiple signing brands, you can use the groups functionality to assign different brands to different groups. This resource enables you to manage group brands.", + "x-ds-category": "UserGroups", + "x-ds-order": "30", + "x-ms-summary": "If your account includes multiple signing brands, you can use the groups functionality to assign different brands to different groups. This resource enables you to manage group brands." }, - "Resources": { + "Groups": { "type": "object", "properties": { - "resources": { - "description": "", + "endPosition": { + "description": "The last index position in the result set. ", + "type": "string" + }, + "groups": { + "description": "A collection group objects containing information about the groups.", "type": "array", "items": { - "$ref": "#/definitions/nameValue" + "$ref": "#/definitions/group" } + }, + "nextUri": { + "description": "The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. ", + "type": "string" + }, + "previousUri": { + "description": "The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. ", + "type": "string" + }, + "resultSetSize": { + "description": "The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`.", + "type": "string" + }, + "startPosition": { + "description": "The starting index position of the current result set.", + "type": "string" + }, + "totalSetSize": { + "description": "The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`.", + "type": "string" } }, - "x-ds-definition-name": "resourceInformation", - "description": "API resource information", - "x-ds-category": "Diagnostics", - "x-ds-order": "20", - "x-ms-summary": "API resource information" + "x-ds-definition-name": "groupInformation", + "description": "Group information", + "x-ds-category": "UserGroups", + "x-ds-order": "10", + "x-ms-summary": "Group information" }, - "Services": { + "GroupUsers": { "type": "object", "properties": { - "buildBranch": { - "description": "Reserved: TBD", + "endPosition": { + "description": "The last index position in the result set. ", "type": "string" }, - "buildBranchDeployedDateTime": { - "description": "Reserved: TBD", + "nextUri": { + "description": "The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. ", "type": "string" }, - "buildSHA": { - "description": "Reserved: TBD", + "previousUri": { + "description": "The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. ", "type": "string" }, - "buildVersion": { - "description": "Reserved: TBD", + "resultSetSize": { + "description": "The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`.", "type": "string" }, - "linkedSites": { - "description": "", - "type": "array", - "items": { - "type": "string" - } + "startPosition": { + "description": "The starting index position of the current result set.", + "type": "string" }, - "serviceVersions": { - "description": "", + "totalSetSize": { + "description": "The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`.", + "type": "string" + }, + "users": { + "description": "An array of `userInfo` objects containing information about the users in the group.", "type": "array", "items": { - "$ref": "#/definitions/serviceVersion" + "$ref": "#/definitions/userInfo" } } }, - "x-ds-definition-name": "serviceInformation", - "description": "API service information", - "x-ds-category": "Diagnostics", - "x-ds-order": "30", - "x-ms-summary": "API service information" + "x-ds-definition-name": "usersResponse", + "description": "Groups' users", + "x-ds-category": "UserGroups", + "x-ds-order": "20", + "x-ms-summary": "Groups' users" }, - "EnvelopeConsumerDisclosures": { + "SigningGroups": { "type": "object", "properties": { - "accountEsignId": { - "description": "A GUID identifying the account associated with the consumer disclosure", + "created": { + "description": "The UTC DateTime when the workspace user authorization was created.", "type": "string" }, - "allowCDWithdraw": { - "description": "Indicates whether the customer can withdraw their acceptance of the consumer disclosure.", + "createdBy": { + "description": "The name of the user who created the signing group.", "type": "string" }, - "allowCDWithdrawMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `allowCDWithdraw` property is editable.\n" + "errorDetails": { + "$ref": "#/definitions/errorDetails", + "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." }, - "changeEmail": { - "description": "", + "groupEmail": { + "description": "The email address for the signing group. You can use a group email address to email all of the group members at the same time.", "type": "string" }, - "changeEmailOther": { - "description": "", + "groupName": { + "description": "The name of the group. The search_text provided in the call automatically performs a wild card search on group_name.", "type": "string" }, - "companyName": { - "description": "The name of the company associated with the consumer disclosure.", + "groupType": { + "description": "The group type. Possible values include:\n\n- `adminstrators`\n- `everyone`\n- `customGroup`\n- `sharedSigningGroup`\n\n", "type": "string" }, - "companyPhone": { - "description": "The phone number of the company associated with the consumer disclosure.", + "modified": { + "description": "The date and time that the signing group was last modified.", "type": "string" }, - "copyCostPerPage": { - "description": "", + "modifiedBy": { + "description": "The user id (GUID) of the user who last modified this user record.", "type": "string" }, - "copyFeeCollectionMethod": { - "description": "Specifies the fee collection method for cases in which the customer requires paper copies of the document.\n\nMaximum Length: 255 characters", + "signingGroupId": { + "description": "When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once).", "type": "string" }, - "copyRequestEmail": { - "description": "", - "type": "string" + "users": { + "description": "User management information.", + "type": "array", + "items": { + "$ref": "#/definitions/signingGroupUser" + } + } + }, + "x-ds-definition-name": "signingGroup", + "description": "Signing groups", + "x-ds-category": "SigningGroups", + "x-ds-order": "10", + "x-ms-summary": "Signing groups" + }, + "SigningGroupUsers": { + "type": "object", + "properties": { + "users": { + "description": "User management information.", + "type": "array", + "items": { + "$ref": "#/definitions/signingGroupUser" + } + } + }, + "x-ds-definition-name": "signingGroupUsers", + "description": "Signing groups' users", + "x-ds-category": "SigningGroups", + "x-ds-order": "20", + "x-ms-summary": "Signing groups' users" + }, + "TemplateRecipients": { + "description": "Template recipients", + "type": "object", + "properties": { + "agents": { + "description": "A list of agent recipients assigned to the documents.", + "type": "array", + "items": { + "$ref": "#/definitions/agent" + } }, - "custom": { - "description": "", - "type": "string" + "carbonCopies": { + "description": "A list of carbon copy recipients assigned to the documents.", + "type": "array", + "items": { + "$ref": "#/definitions/carbonCopy" + } }, - "enableEsign": { - "description": "", - "type": "string" + "certifiedDeliveries": { + "description": "A complex type containing information on a recipient the must receive the completed documents for the envelope to be completed, but the recipient does not need to sign, initial, date, or add information to any of the documents.", + "type": "array", + "items": { + "$ref": "#/definitions/certifiedDelivery" + } }, - "esignAgreement": { - "description": "The Electronic Record and Signature Disclosure text. The disclosure text includes the html formatting.", + "currentRoutingOrder": { + "description": "The routing order of the current recipient. If this value equals a particular signer's routing order, it indicates that the envelope has been sent to that recipient, but he or she has not completed the required actions.", "type": "string" }, - "esignText": { - "description": "", - "type": "string" + "editors": { + "description": "A complex type defining the management and access rights of a recipient assigned assigned as an editor on the document.", + "type": "array", + "items": { + "$ref": "#/definitions/editor" + } }, - "languageCode": { - "description": "", - "type": "string" + "errorDetails": { + "$ref": "#/definitions/errorDetails", + "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." }, - "mustAgreeToEsign": { - "description": "", - "type": "string" + "inPersonSigners": { + "description": "Specifies a signer that is in the same physical location as a DocuSign user who will act as a Signing Host for the transaction. The recipient added is the Signing Host and new separate Signer Name field appears after Sign in person is selected.", + "type": "array", + "items": { + "$ref": "#/definitions/inPersonSigner" + } }, - "pdfId": { - "description": "**Deprecated**\n\nThe `€œpdfId` property in the consumer_disclosure PUT request is deprecated. For security reasons going forward, any value provided in the request packet must be ignored. ", - "type": "string" + "intermediaries": { + "description": "Identifies a recipient that can, but is not required to, add name and email information for recipients at the same or subsequent level in the routing order (until subsequent Agents, Editors or Intermediaries recipient types are added).", + "type": "array", + "items": { + "$ref": "#/definitions/intermediary" + } }, - "useBrand": { + "notaries": { "description": "", - "type": "string" - }, - "useConsumerDisclosureWithinAccount": { - "description": "Boolean that specifies whether recipients in the same account as the sender must agree to eSign an Electronic Record and Signature Disclosure Statement.", - "type": "string" - }, - "useConsumerDisclosureWithinAccountMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `useConsumerDisclosureWithinAccount` property is editable.\n" - }, - "withdrawAddressLine1": { - "description": "Contains the first address line of the postal address to which a customer can send a consent withdrawal notification.\n\nMaximum length: 100 characters. ", - "type": "string" + "type": "array", + "items": { + "$ref": "#/definitions/notaryRecipient" + } }, - "withdrawAddressLine2": { - "description": "Contains the second address line of the postal address to which a customer can send a consent withdrawal notification.\n\nMaximum length: 100 characters. ", + "recipientCount": { + "description": "The number of recipients in the envelope.", "type": "string" }, - "withdrawByEmail": { - "description": "Indicates whether the customer can withdraw consent by email.", - "type": "string" + "seals": { + "description": "Specifies one or more electronic seals to apply on documents. For more information on Electronic Seals , see https://support.docusign.com/en/guides/ndse-user-guide-apply-electronic-seals", + "type": "array", + "items": { + "$ref": "#/definitions/sealSign" + } }, - "withdrawByMail": { - "description": "Indicates whether the customer can withdraw consent by postal mail.", - "type": "string" + "signers": { + "description": "A list of signers on the envelope.", + "type": "array", + "items": { + "$ref": "#/definitions/signer" + } }, - "withdrawByPhone": { - "description": "Indicates whether the customer can withdraw consent by phone.", - "type": "string" + "witnesses": { + "description": "A list of signers who act as witnesses on the envelope.", + "type": "array", + "items": { + "$ref": "#/definitions/witness" + } + } + }, + "x-ds-definition-name": "recipients", + "x-ds-category": "Templates", + "x-ds-order": "20", + "x-ms-summary": "Template recipients" + }, + "TemplateBulkRecipients": { + "type": "object", + "properties": { + "bulkRecipients": { + "description": "A complex type containing information about the bulk recipients in the response.", + "type": "array", + "items": { + "$ref": "#/definitions/bulkRecipient" + } }, - "withdrawCity": { - "description": "Contains the city of the postal address to which a customer can send a consent withdrawal notification.\n\nMaximum length: 50 characters. ", + "endPosition": { + "description": "The last index position in the result set. ", "type": "string" }, - "withdrawConsequences": { - "description": "Indicates the consequences of withdrawing consent.", + "nextUri": { + "description": "The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. ", "type": "string" }, - "withdrawEmail": { - "description": "Contains the email address to which a customer can send a consent withdrawal notification.\n\nMaximum length: 100 characters. ", + "previousUri": { + "description": "The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. ", "type": "string" }, - "withdrawOther": { - "description": "Indicates other information need to withdraw consent.\n\nMaximum length: 255 characters.", + "resultSetSize": { + "description": "The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`.", "type": "string" }, - "withdrawPhone": { - "description": "Contains the phone number which a customer can call to register consent withdrawal notification.\n\nMaximum length: 20 characters. ", + "startPosition": { + "description": "The starting index position of the current result set.", "type": "string" }, - "withdrawPostalCode": { - "description": "Contains the postal code of the postal address to which a customer can send a consent withdrawal notification.\n\nMaximum length: 20 characters. ", + "totalSetSize": { + "description": "The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`.", "type": "string" + } + }, + "x-ds-definition-name": "bulkRecipientsResponse", + "description": "Template bulk recipients", + "x-ds-category": "Templates", + "x-ds-order": "30", + "x-ms-summary": "Template bulk recipients" + }, + "TemplateCustomFields": { + "description": "A template custom field enables you to prepopulate custom metadata for all new envelopes that are created by using a specific template. You can then use the custom data for sorting, organizing, searching, and other downstream processes.", + "type": "object", + "properties": { + "listCustomFields": { + "description": "An array of list custom fields.", + "type": "array", + "items": { + "$ref": "#/definitions/listCustomField" + } }, - "withdrawState": { - "description": "Contains the state of the postal address to which a customer can send a consent withdrawal notification.", - "type": "string" + "textCustomFields": { + "description": "An array of text custom fields.", + "type": "array", + "items": { + "$ref": "#/definitions/textCustomField" + } + } + }, + "x-ds-definition-name": "customFields", + "x-ds-category": "Templates", + "x-ds-order": "70", + "x-ms-summary": "A template custom field enables you to prepopulate custom metadata for all new envelopes that are created by using a specific template. You can then use the custom data for sorting, organizing, searching, and other downstream processes." + }, + "TemplateDocumentFields": { + "type": "object", + "properties": { + "documentFields": { + "description": "The array of name/value custom data strings to add to a document. Custom document field information is returned in the status, but otherwise is not used by DocuSign. The array contains the following elements: \n\n* `name` - A string that can be a maximum of 50 characters. \n* `value` - A string that can be a maximum of 200 characters.\n\n**Important**: If you are using XML, the name/value pair is contained in a `nameValue` element. \n", + "type": "array", + "items": { + "$ref": "#/definitions/nameValue" + } } }, - "x-ds-definition-name": "consumerDisclosure", - "description": "Envelope consumer disclosures", - "x-ds-category": "Envelopes", - "x-ds-order": "90", - "x-ms-summary": "Envelope consumer disclosures" + "x-ds-definition-name": "documentFieldsInformation", + "description": "Template document fields", + "x-ds-category": "Templates", + "x-ds-order": "60", + "x-ms-summary": "Template document fields" }, - "EnvelopeDocuments": { + "TemplateDocuments": { "type": "object", "properties": { - "envelopeDocuments": { - "description": "An array of document objects.", + "templateDocuments": { + "description": "An array of document objects that contain information about the documents associated with the template.", "type": "array", "items": { "$ref": "#/definitions/envelopeDocument" } }, - "envelopeId": { - "description": "The envelope ID of the envelope status that failed to post.", + "templateId": { + "description": "The id of the template. If a value is not provided, DocuSign generates a value. ", "type": "string" } }, - "x-ds-definition-name": "envelopeDocumentsResult", - "description": "Envelope documents", - "x-ds-category": "Envelopes", + "x-ds-definition-name": "templateDocumentsResult", + "description": "Template documents", + "x-ds-category": "Templates", "x-ds-order": "40", - "x-ms-summary": "Envelope documents" + "x-ms-summary": "Template documents" }, - "EnvelopeEmailSettings": { - "description": "Envelope email settings", + "TemplateLocks": { "type": "object", "properties": { - "bccEmailAddresses": { - "description": "An array of up to five email addresses that receive a copy of all email communications for an envelope. Maximum Length: 100 characters.\n\n**Note**: Only users with the `canManageAccount` setting set to **true** can use this option. \n\nDocuSign verifies that the email format is correct, but does not verify that the email address is active. You can use this for archiving purposes. However, using this property overrides the BCC for Email Archive information setting for this envelope. \n\n**Example**: if your account has BCC for Email Archive set up for the email address archive@mycompany.com and you send an envelope using the BCC Email Override to send a BCC email to salesarchive@mycompany.com, then a copy of the envelope is only sent to the salesarchive@mycompany.com email address.", - "type": "array", - "items": { - "$ref": "#/definitions/bccEmailAddress" - } + "errorDetails": { + "$ref": "#/definitions/errorDetails", + "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." }, - "replyEmailAddressOverride": { - "description": "The Reply To email address to use for email replies, instead of the one that is configured at the account level. DocuSign verifies that the email address is in a correct format, but does not verify that it is active. Maximum Length: 100 characters.", + "lockDurationInSeconds": { + "description": "The number of seconds until the lock expires when there is no activity on the template.\n\nIf no value is entered, then the default value of 300 seconds is used. The maximum value is 1,800 seconds.\n\nThe lock duration can be extended.\n", "type": "string" }, - "replyEmailNameOverride": { - "description": "The name to associate with the Reply To email address, instead of the name that is configured at the account level. Maximum Length: 100 characters.", + "lockedByApp": { + "description": "Specifies the friendly name of the application that is locking the envelope.", + "type": "string" + }, + "lockedByUser": { + "$ref": "#/definitions/userInfo", + "description": "A complex type containing information about the user that has the envelope or template locked." + }, + "lockedUntilDateTime": { + "description": "The date and time that the lock expires.", + "type": "string" + }, + "lockToken": { + "description": "A unique identifier provided to the owner of the lock. You must use this token with subsequent calls to prove ownership of the lock.", + "type": "string" + }, + "lockType": { + "description": "The type of lock. Currently `edit` is the only supported type.", + "type": "string" + }, + "useScratchPad": { + "description": "When set to **true**, a scratchpad is used to edit information.\n ", "type": "string" } }, - "x-ds-definition-name": "emailSettings", - "x-ds-category": "Envelopes", - "x-ds-order": "30", - "x-ms-summary": "Envelope email settings" + "x-ds-definition-name": "lockInformation", + "description": "This section provides information about template locks. You use template locks to prevent others from making changes to a template while you are modifying it.", + "x-ds-category": "Templates", + "x-ds-order": "80", + "x-ms-summary": "This section provides information about template locks. You use template locks to prevent others from making changes to a template while you are modifying it." }, - "Envelopes": { + "Templates": { "type": "object", "properties": { "accessControlListBase64": { @@ -51890,11 +63849,11 @@ "type": "string" }, "allowComments": { - "description": "When set to **true**, users can add comments to the documents in the envelope. For example, if a signer has a question about the text in the document, they can add a comment to the document.", + "description": "When set to **true**, indicates that comments are allowed on the envelope.", "type": "string" }, "allowMarkup": { - "description": "When **true**, Document Markup is enabled for envelope. The account must have Document Markup enabled to use this.", + "description": "When set to **true**, the Document Markup feature is enabled.\n\n**Note**: To use this feature, Document Markup must be enabled at both the account and envelope levels. Only Admin users can change this setting for at the account level.", "type": "string" }, "allowReassign": { @@ -51910,7 +63869,7 @@ "type": "string" }, "asynchronous": { - "description": "When **true**, the envelope is queued for processing and the value of the `status` property is set to 'Processing'. Additionally, get status calls return 'Processing' until completed. \n\n\n**Note**: A `transactionId` is required for this call to work correctly. When the envelope is created, the status is 'Processing' and an `envelopeId` is not returned in the response. To get the `envelopeId`, use a GET envelope query using the [transactionId](https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/create/#envelopeDefinition) or by checking the Connect notification.", + "description": "When **true**, the envelope is queued for\nprocessing and the value of the `status` property\nis set to `Processing`. Additionally, GET status\ncalls return `Processing` until completed.\n\n\n**Note**: A `transactionId` is required for this\ncall to work correctly. When the envelope is\ncreated, the status is `Processing` and an\n`envelopeId` is not returned in the response. To\nget the `envelopeId`, use a GET envelope query by\nusing the\n[transactionId](https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/Envelopes/create/) or by checking the\nConnect notification.", "type": "string" }, "attachmentsUri": { @@ -51918,15 +63877,23 @@ "type": "string" }, "authoritativeCopy": { - "description": "Specifies whether all documents in this envelope are authoritative copies.\nA document can set its own `authoritativeCopy` property to override this value. For example you can set the `authoritativeCopy` on an envelope level to true but can turn it off for a specific document. ", + "description": "When **true**, marks all of the documents in the envelope as authoritative copies.\n\n**Note**: You can override this value for a specific document. For example, you can set the `authoritativeCopy` property to **true** at the envelope level, but turn it off for a single document by setting the `authoritativeCopy` property for the document to **false**.", "type": "string" }, "authoritativeCopyDefault": { "description": "The default `authoritativeCopy` setting for documents in this envelope that do not have `authoritativeCopy` set.\nIf this property is not set, each document defaults to the envelope's `authoritativeCopy`.", "type": "string" }, + "autoMatch": { + "description": "By default, templates that have been used within\nthe last 60 days are included in auto-matching.\n\nBy explicitly setting `autoMatch`,\nyou can permanently include or exclude the template\nin auto matching.\n\nWhen **true** the template is included in auto-matching\nregardless of when it was last used.\n\nWhen **false** the template is never included in auto-matching.", + "type": "string" + }, + "autoMatchSpecifiedByUser": { + "description": "If **true**, the template has been explicitly included in or excluded from auto-matching. The default is false.\nThis is a read-only property.", + "type": "string" + }, "autoNavigation": { - "description": "When **true**, auto navigation is set for the recipient.\n", + "description": "When set to **true**, autonavigation is set for the recipient.\n", "type": "string" }, "brandId": { @@ -51934,63 +63901,82 @@ "type": "string" }, "brandLock": { - "description": "Indicates if the brandId for the envelope is locked.", + "description": "When **true**, the `brandId` for the envelope is locked and senders cannot change the brand used for the envelope.", "type": "string" }, "certificateUri": { - "description": "Contains a URI that you can use to retrieve certificate information.", + "description": "The URI for retrieving certificate information.", "type": "string" }, "completedDateTime": { "description": "Specifies the date and time this item was completed.", "type": "string" }, + "copyRecipientData": { + "description": "", + "type": "string" + }, + "created": { + "description": "The UTC DateTime when the workspace user authorization was created.", + "type": "string" + }, "createdDateTime": { - "description": "The date and time the item was created.", + "description": "The UTC DateTime when the item was created.", "type": "string" }, "customFields": { "$ref": "#/definitions/AccountCustomFields", - "description": "An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters." + "description": "An optional array of strings that enables the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each `customField` string can be a maximum of 100 characters." }, "customFieldsUri": { - "description": "Contains a URI for an endpoint to retrieve the custom fields.", + "description": "The URI for retrieving custom fields.", "type": "string" }, "declinedDateTime": { - "description": "The date and time the recipient declined the document.", + "description": "The date and time the recipient declined the document. Read only.", "type": "string" }, "deletedDateTime": { - "description": "Specifies the data and time the item was deleted.", + "description": "Reserved for DocuSign.", "type": "string" }, "deliveredDateTime": { - "description": "The date and time that the envelope was delivered to the recipient.", + "description": "The date and time that the envelope was delivered to the recipient. Read only.", + "type": "string" + }, + "description": { + "description": "A sender-defined description of the line item.\n", "type": "string" }, "disableResponsiveDocument": { "description": "When set to **true**, responsive documents are disabled for the envelope.", "type": "string" }, + "documents": { + "description": "A complex element that contains details about the documents associated with the envelope.", + "type": "array", + "items": { + "$ref": "#/definitions/document" + } + }, "documentsCombinedUri": { - "description": "Contains a URL that you can use to retrieve all of the documents associated with the envelope combined into a single PDF file.", + "description": "The URI for retrieving all of the documents associated with the envelope as a single PDF file.", "type": "string" }, "documentsUri": { - "description": "Contains a URI for an endpoint that you can use to retrieve the documents.", + "description": "The URI for retrieving all of the documents associated with the envelope as separate files.", "type": "string" }, "emailBlurb": { - "description": "This is the same as the email body. If specified it is included in the email body for all envelope recipients.", + "description": "This is the same as the email body. If the sender enters an email blurb, it is included in the email body for all envelope recipients.", "type": "string" }, "emailSettings": { - "$ref": "#/definitions/EnvelopeEmailSettings", - "description": "A complex element that allows the sender to override some envelope email setting information. This can be used to override the Reply To email address and name associated with the envelope and to override the BCC email addresses to which an envelope is sent. \n\nWhen the emailSettings information is used for an envelope, it only applies to that envelope. \n\n**IMPORTANT**: The `emailSettings` information is not returned in the GET method for envelope status. Use GET /email_settings to return information about the email settings. " + "$ref": "#/definitions/emailSettings", + "description": "A complex type that contains email settings." }, "emailSubject": { - "description": "The subject line of the email message that is sent to all recipients.\n\nFor information about adding merge field information to the email subject, see [Template Email Subject Merge Fields](https://developers.docusign.com/esign-rest-api/reference/Templates/Templates/create#template-email-subject-merge-fields).\n", + "description": "The subject line of the email message that is sent to all recipients.\n\nFor information about adding merge field information to the email subject, see [Template Email Subject Merge Fields](https://developers.docusign.com/docs/esign-rest-api/reference/Templates/Templates/create#template-email-subject-merge-fields).\n", "type": "string" }, "enableWetSign": { @@ -51998,7 +63984,7 @@ "type": "string" }, "enforceSignerVisibility": { - "description": "When set to **true**, signers can only view the documents on which they have tabs. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all of the documents in an envelope, unless they are specifically excluded by using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded by using this setting when an envelope is sent.\n\n**Note**: To use this functionality, [Document Visibility][docviz] must be enabled for the account by making the account setting `allowDocumentVisibility` **true**.\n\n[docviz]: /esign/restapi/Envelopes/EnvelopeDocumentVisibility", + "description": "When set to **true**, signers can only view the documents on which they have tabs. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all of the documents in an envelope, unless they are specifically excluded by using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded by using this setting when an envelope is sent.\n\n**Note**: To use this functionality, [Document Visibility][docviz] must be enabled for the account by making the account setting `allowDocumentVisibility` **true**.\n\n[docviz]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeDocumentVisibility/", "type": "string" }, "envelopeAttachments": { @@ -52016,11 +64002,11 @@ } }, "envelopeId": { - "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", + "description": "The envelope ID of the envelope status that failed to post.", "type": "string" }, "envelopeIdStamping": { - "description": "When set to **true**, [Envelope ID Stamping](https://support.docusign.com/en/guides/ndse-user-guide-set-advanced-document-options) is enabled.\nOnce a document or attachment is stamped with an Envelope ID,\nthe ID is seen by all recipients\nand becomes a permanent part of the document\nand cannot be removed.", + "description": "When set to **true**, [Envelope ID Stamping](https://support.docusign.com/en/guides/ndse-user-guide-set-advanced-document-options) is enabled.\nAfter a document or attachment is stamped with an Envelope ID,\nthe ID is seen by all recipients\nand becomes a permanent part of the document\nand cannot be removed.", "type": "string" }, "envelopeLocation": { @@ -52029,10 +64015,10 @@ }, "envelopeMetadata": { "$ref": "#/definitions/envelopeMetadata", - "description": "Metadata that indicates whether the `envelope` property is editable.\n" + "description": "Provides information about the features and services that are enabled for the envelope, including the Correct feature, the Advanced Correct feature, and DocuSign eNotary service." }, "envelopeUri": { - "description": "URI that you can use to retrieve the bulk envelopes.", + "description": "The URI for retrieving the envelope or envelopes.", "type": "string" }, "expireAfter": { @@ -52051,8 +64037,27 @@ "description": "May contain an external identifier for the envelope.", "type": "string" }, + "favoritedByMe": { + "description": "", + "type": "string" + }, + "folderId": { + "description": "The unique identifier for the folder that the template belongs to.", + "type": "string" + }, + "folderIds": { + "description": "An array of folder IDs that the template is in.", + "type": "array", + "items": { + "type": "string" + } + }, + "folderName": { + "description": "The name of the folder the template belongs to.", + "type": "string" + }, "folders": { - "description": "A collection of folder objects returned in a response.", + "description": "A list of folder objects.", "type": "array", "items": { "$ref": "#/definitions/folder" @@ -52063,11 +64068,11 @@ "type": "string" }, "hasFormDataChanged": { - "description": "Specifies if the `EnvelopeFormData` associated with any forms in the envelope has changed.", + "description": "Specifies if the `EnvelopeFormData` associated with any forms in the template has changed.", "type": "string" }, "hasWavFile": { - "description": "When set to **true**, indicates that a .wav file used for voice authentication is included in the envelope. ", + "description": "When set to **true**, indicates that the template includes a .wav file.", "type": "string" }, "holder": { @@ -52075,7 +64080,7 @@ "type": "string" }, "initialSentDateTime": { - "description": "The date and time the envelope was initially sent.", + "description": "The date and time the envelope that used the template was initially sent.", "type": "string" }, "is21CFRPart11": { @@ -52090,8 +64095,20 @@ "description": "When set to **true**, indicates that the envelope is a signature-provided envelope.", "type": "string" }, + "lastModified": { + "description": "The UTC date and time that the comment was last updated.\n\n**Note**: This can only be done by the creator.", + "type": "string" + }, + "lastModifiedBy": { + "$ref": "#/definitions/userInfo", + "description": "The userId of the user who last modified the template." + }, "lastModifiedDateTime": { - "description": "The date and time the item was last modified.", + "description": "The date and time the template was last modified.", + "type": "string" + }, + "lastUsed": { + "description": "The date and time the template was last used.", "type": "string" }, "location": { @@ -52106,17 +64123,48 @@ "description": "When set to **true**, prevents senders from changing the contents of `emailBlurb` and `emailSubject` properties for the envelope. \n\nAdditionally, this prevents users from making changes to the contents of `emailBlurb` and `emailSubject` properties when correcting envelopes. \n\nHowever, if the `messageLock` node is set to **true** and the `emailSubject` property is empty, senders and correctors are able to add a subject to the envelope.", "type": "string" }, + "name": { + "description": "The name of the template.", + "type": "string" + }, + "newPassword": { + "description": "The user's new password.", + "type": "string" + }, "notification": { "$ref": "#/definitions/notification", - "description": "A complex element that specifies the notification options for the envelope. It consists of:\n\n* useAccountDefaults - When set to **true**, the account default notification settings are used for the envelope. \n* reminders - A complex element that specifies reminder settings for the envelope. It consists of: \n\n * reminderEnabled - When set to **true**, a reminder message is sent to the recipient.\n * reminderDelay - An interger that sets the number of days after the recipient receives the envelope that reminder emails are sent to the recipient. \n * reminderFrequency - An interger that sets the interval, in days, between reminder emails. \n\n* expirations - A complex element that specifies the expiration settings for the envelope. It consists of:\n\n * expireEnabled - When set to **true**, the envelope expires (is no longer available for signing) in the set number of days. If false, the account default setting is used. If the account does not have an expiration setting, the DocuSign default value of 120 days is used. \n * expireAfter - An integer that sets the number of days the envelope is active.\n * expireWarn - An integer that sets the number of days before envelope expiration that an expiration warning email is sent to the recipient. If set to 0 (zero), no warning email is sent. \n" + "description": "A complex element that specifies the notification options for envelopes that use the template." }, "notificationUri": { - "description": "Contains a URI for an endpoint that you can use to retrieve the notifications.", + "description": "The URI for retrieving notifications.", + "type": "string" + }, + "owner": { + "$ref": "#/definitions/userInfo", + "description": "The owner of the template." + }, + "pageCount": { + "description": "An integer value specifying the number of document pages in the template. ", + "type": "string" + }, + "password": { + "description": "The password for editing the template.", + "type": "string" + }, + "passwordProtected": { + "description": "If **true**, a password is required to edit the template.", "type": "string" }, "powerForm": { - "$ref": "#/definitions/PowerForms", - "description": "Contains information about any PowerForms that are included in the envelope." + "$ref": "#/definitions/powerForm", + "description": "A PowerForm objects that contain information about any PowerForms that are included in the template." + }, + "powerForms": { + "description": "An array of PowerForm objects that contain information about any PowerForms that are included in the template.", + "type": "array", + "items": { + "$ref": "#/definitions/powerForm" + } }, "purgeCompletedDate": { "description": "The date that a purge was completed.", @@ -52132,7 +64180,7 @@ }, "recipients": { "$ref": "#/definitions/EnvelopeRecipients", - "description": "An array of recipient objects that provides details about the recipients of the envelope." + "description": "An array of recipient objects." }, "recipientsLock": { "description": "When set to **true**, prevents senders from changing, correcting, or deleting the recipient information for the envelope.", @@ -52144,1853 +64192,2085 @@ }, "sender": { "$ref": "#/definitions/userInfo", - "description": "Information about the sender of the envelope." + "description": "Information about the sender." }, "sentDateTime": { - "description": "The date and time the envelope was sent.", + "description": "The UTC DateTime when the envelope was sent. Read only.", + "type": "string" + }, + "shared": { + "description": "When **true**, indicates the template is shared with the **Everyone** group,\nand is shared with all users on the account.\n\nIf **false**, the template is only shared with the **Administrator** group.\n", "type": "string" }, "signerCanSignOnMobile": { - "description": "When set to **true**, the recipient can sign on a mobile device.", + "description": "When set to **true**, recipients can sign on a mobile device.\n\n**Note**: Only Admin users can change this setting.\n", "type": "string" }, "signingLocation": { "description": "Specifies the physical location where the signing takes place. It can have two enumeration values; `inPerson` and `online`. The default value is `online`.", "type": "string" }, - "status": { - "description": "Indicates the envelope status. Valid values are: \n\n* `completed`: The envelope has been completed and all tags have been signed.\n* `created`: The envelope is created as a draft. It can be modified and sent later.\n* `declined`: The envelope has been declined by the recipients.\n* `delivered`: The envelope has been delivered to the recipients.\n* `sent`: The envelope is sent to the recipients.\n* `signed`: The envelope has been signed by the recipients.\n* `voided`: The envelope is no longer valid and recipients cannot access or sign the envelope.\n", + "status": { + "description": "Indicates the envelope status. Valid values are:\n\n* `completed`: The recipients have finished working with the envelope: the documents are signed and all required tabs are filled in.\n* `created`: The envelope is created as a draft. It can be modified and sent later.\n* `declined`: The envelope has been declined by the recipients.\n* `delivered`: The envelope has been delivered to the recipients.\n* `sent`: The envelope will be sent to the recipients after the envelope is created.\n* `signed`: The envelope has been signed by the recipients.\n* `voided`: The envelope is no longer valid and recipients cannot access or sign the envelope.\n", + "type": "string" + }, + "statusChangedDateTime": { + "description": "The data and time that the status changed.", + "type": "string" + }, + "statusDateTime": { + "description": "The DateTime that the envelope changed status (i.e. was created or sent.)", + "type": "string" + }, + "templateId": { + "description": "The unique identifier of the template. If this is not provided, DocuSign will generate a value. ", + "type": "string" + }, + "templatesUri": { + "description": "The URI for retrieving the templates.", + "type": "string" + }, + "transactionId": { + "description": " Used to identify an envelope. The id is a sender-generated value and is valid in the DocuSign system for 7 days. It is recommended that a transaction ID is used for offline signing to ensure that an envelope is not sent multiple times. The `transactionId` property can be used determine an envelope's status (i.e. was it created or not) in cases where the internet connection was lost before the envelope status was returned.", + "type": "string" + }, + "uri": { + "description": "Contains a URI that you can use to retreve the template.", + "type": "string" + }, + "useDisclosure": { + "description": "When set to **true**, the disclosure is shown to recipients in accordance with the account's Electronic Record and Signature Disclosure frequency setting. When set to **false**, the Electronic Record and Signature Disclosure is not shown to any envelope recipients. \n\nIf the `useDisclosure` property is not set, then the account's normal disclosure setting is used and the value of the `useDisclosure` property is not returned in responses when getting envelope information.", + "type": "string" + }, + "voidedDateTime": { + "description": "The date and time the envelope or template was voided.", + "type": "string" + }, + "voidedReason": { + "description": "The reason the envelope or template was voided.", + "type": "string" + }, + "workflow": { + "$ref": "#/definitions/workflow", + "description": "" + } + }, + "x-ds-definition-name": "envelopeTemplate", + "description": "Template management", + "x-ds-category": "Templates", + "x-ds-order": "10", + "x-ms-summary": "Template management" + }, + "TemplateRecipientTabs": { + "type": "object", + "properties": { + "approveTabs": { + "description": "A list of\n[Approve tabs][approve].\n\nAn Approve tab enables\nthe recipient to approve documents without\nplacing a signature or initials on the document. If the\nrecipient clicks the tab during the signing process, the\nrecipient is considered to have signed the document. No\ninformation is shown on the document of the approval, but it\nis recorded as a signature in the envelope history.\nThe value of an approve tab can't be set.\n\n[approve]:\t\t https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", + "type": "array", + "items": { + "$ref": "#/definitions/approve" + } + }, + "checkboxTabs": { + "description": "A list of\n[Checkbox tabs][checkbox].\n\n\nA Checkbox tab enables the recipient to select a yes/no (on/off) option. This value can be set.\n\n\n[checkbox]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", + "type": "array", + "items": { + "$ref": "#/definitions/checkbox" + } + }, + "commentThreadTabs": { + "description": "An array of tabs that represents a collection of comments in a comment thread. For example, if a recipient has questions about the content of a document, they can add a comment to the document and control who else can see the comment. This value can't be set.", + "type": "array", + "items": { + "$ref": "#/definitions/commentThread" + } + }, + "commissionCountyTabs": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/commissionCounty" + } + }, + "commissionExpirationTabs": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/commissionExpiration" + } + }, + "commissionNumberTabs": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/commissionNumber" + } + }, + "commissionStateTabs": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/commissionState" + } + }, + "companyTabs": { + "description": "A list of\n[Company tabs][company].\n\n\nA Company tab displays a field for the name of the recipient's company. This value can't be set.\n\n\n\n[company]: https://developers.docusign.com/docs/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/company\n", + "type": "array", + "items": { + "$ref": "#/definitions/company" + } + }, + "currencyTabs": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/currency" + } + }, + "dateSignedTabs": { + "description": "A list of\n[Date Signed tabs][dateSigned].\n\n\nA Date Signed tab displays the date that the recipient signed the document. This value can't be set.\n\n[dateSigned]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", + "type": "array", + "items": { + "$ref": "#/definitions/dateSigned" + } + }, + "dateTabs": { + "description": "A list of\n[Date tabs][date].\n\nA Date tab enables the recipient to enter a date. This value can't be set. The tooltip for this tab recommends the date format MM/DD/YYYY, but this format is not enforced. The system retains the format that the recipient enters.\n\n**Note**: If you need to enforce a specific date format, we recommend that you use a Text tab with a validation pattern and validation message.\n\n\n[date]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", + "type": "array", + "items": { + "$ref": "#/definitions/date" + } + }, + "declineTabs": { + "description": "A list of\n[Decline tabs][decline].\n\nA Decline tab enables the recipient to decline the envelope. If the recipient clicks the tab during the signing process, the envelope is voided. The value of this tab can't be set.\n\n\n[decline]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", + "type": "array", + "items": { + "$ref": "#/definitions/decline" + } + }, + "drawTabs": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/draw" + } + }, + "emailAddressTabs": { + "description": "A list of\n[Email Address tabs][emailAddress].\n\nAn Email Address tab displays the recipient's email as entered in the recipient information. This value can't be set.\n\n\n[emailAddress]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", + "type": "array", + "items": { + "$ref": "#/definitions/emailAddress" + } + }, + "emailTabs": { + "description": "A list of\n[Email tabs][email].\n\nAn Email tab enables the recipient to enter an email address.\nThis is a one-line field that checks that a valid email\naddress is entered. It uses the same parameters as a Text\ntab, with the validation message and pattern set for email\ninformation. This value can be set.\n\nWhen getting information that includes\nthis tab type, the original value of the tab when the\nassociated envelope was sent is included in the response.\n\n[email]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", + "type": "array", + "items": { + "$ref": "#/definitions/email" + } + }, + "envelopeIdTabs": { + "description": "A list of\n[Envelope ID tabs][envelopeId].\n\nAn Envelope ID tab displays the envelope ID. Recipients cannot enter or change the information in this tab. This value can't be set.\n\n\n[envelopeId]: https://developers.docusign.com/docs/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/envelopeId\n", + "type": "array", + "items": { + "$ref": "#/definitions/envelopeId" + } + }, + "firstNameTabs": { + "description": "A list of\n[First Name tabs][firstName].\n\nA First Name tab displays the recipient's first name. The system automatically populates this field by splitting the name in the recipient information on spaces. This value can't be set.\n\n\n[firstName]: https://developers.docusign.com/docs/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/firstName\n", + "type": "array", + "items": { + "$ref": "#/definitions/firstName" + } + }, + "formulaTabs": { + "description": "A list of [Formula tabs][formulaTab].\n\nThe value of a Formula tab is calculated from the values of other number or date tabs in the document. When the recipient completes the underlying fields, the Formula tab calculates and displays the result. This value can be set.\n\nThe `formula` property of the tab contains the references to the underlying tabs. To learn more about formulas, see [Calculated Fields][calculatedfields].\n\nIf a Formula tab contains a `paymentDetails` property, the tab is considered a payment item. To learn more about payments, see [Requesting Payments Along with Signatures][paymentguide].\n\n[calculatedfields]: https://support.docusign.com/en/guides/ndse-user-guide-calculated-fields\n[paymentguide]: https://support.docusign.com/en/guides/requesting-payments-along-with-signatures\n[formulaTab]:\t \thttps://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", + "type": "array", + "items": { + "$ref": "#/definitions/formulaTab" + } + }, + "fullNameTabs": { + "description": "A list of\n[Full Name tabs][fullName].\n\nA Full Name tab displays the recipient's full name. This value can't be set.\n\n\n[fullName]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", + "type": "array", + "items": { + "$ref": "#/definitions/fullName" + } + }, + "initialHereTabs": { + "description": "A list of\n[Initial Here tabs][initialHere].\n\nThis type of tab enables the recipient to initial the document. May be optional. This value can't be set.\n\n[initialHere]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", + "type": "array", + "items": { + "$ref": "#/definitions/initialHere" + } + }, + "lastNameTabs": { + "description": "A list of\n[Last Name tabs][lastName].\n\nA Last Name tab displays the recipient's last name. The system automatically populates this field by splitting the name in the recipient information on spaces. This value can't be set.\n\n\n[lastName]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", + "type": "array", + "items": { + "$ref": "#/definitions/lastName" + } + }, + "listTabs": { + "description": "An array of List tabs.\n\nA List tab enables the recipient to choose from a list of options. You specify the options in the `listItems` property. This value can't be set.\n\nFind descriptions of all tab types in\nthe [EnvelopeRecipientTabs Resource][ert].\n\n[ert]: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n", + "type": "array", + "items": { + "$ref": "#/definitions/list" + } + }, + "notarizeTabs": { + "description": "A list of [Notarize tabs][notarize].\n\nA Notarize tab alerts notary recipients that they must take action on the page. This value can be set.\n\n**Note**: Only one notarize tab can appear on a page.\n\n[notarize]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", + "type": "array", + "items": { + "$ref": "#/definitions/notarize" + } + }, + "notarySealTabs": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/notarySeal" + } + }, + "noteTabs": { + "description": "A list of\n[Note tabs][note].\n\nA Note tab displays additional information to the recipient in the form of a note. This value can be set.\n\n[note]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", + "type": "array", + "items": { + "$ref": "#/definitions/note" + } + }, + "numberTabs": { + "description": "A list of\n[Number tabs][number].\n\nA Number tab enables the recipient to enter numbers and decimal points (.). This value can be set.\n\n\n\n[number]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", + "type": "array", + "items": { + "$ref": "#/definitions/number" + } + }, + "phoneNumberTabs": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/phoneNumber" + } + }, + "polyLineOverlayTabs": { + "description": "This type of tab enables the recipient to strike through document text. This value can't be set. ", + "type": "array", + "items": { + "$ref": "#/definitions/polyLineOverlay" + } + }, + "prefillTabs": { + "$ref": "#/definitions/prefillTabs", + "description": "" + }, + "radioGroupTabs": { + "description": "A list of [Radio Group tabs][radioGroup].\n\nA Radio Group tab places a group of radio buttons on a document. The `radios` property is used to add and place the radio\nbuttons associated with the group. Only one radio button can be selected in a group. This value can be set.\n\n\n[radioGroup]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", + "type": "array", + "items": { + "$ref": "#/definitions/radioGroup" + } + }, + "signerAttachmentTabs": { + "description": "A list of\n[Signer Attachment tabs][signerAttachment].\n\nThis type of tab enables the recipient to attach supporting documents to an envelope. This value can't be set.\n\n\n[signerAttachment]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", + "type": "array", + "items": { + "$ref": "#/definitions/signerAttachment" + } + }, + "signHereTabs": { + "description": "A list of\n[Sign Here tabs][signHere].\n\nThis type of tab enables the recipient to sign a document. May be optional. This value can't be set.\n\n[signHere]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", + "type": "array", + "items": { + "$ref": "#/definitions/signHere" + } + }, + "smartSectionTabs": { + "description": "A list of [Smart Section](https://www.docusign.com/blog/dsdev-deep-dive-responsive-smart-sections/) tabs.\n\nSmart Section tabs enhance responsive signing on mobile devices by enabling collapsible sections, page breaks, custom formatting options, and other advanced functionality.\n\n**Note**: Smart Sections are a premium feature. Responsive signing must also be enabled for your account.", + "type": "array", + "items": { + "$ref": "#/definitions/smartSection" + } + }, + "ssnTabs": { + "description": "A list of\n[SSN tabs][ssn].\n\nAn SSN tab contains a one-line field that enables the recipient to enter a Social Security Number (SSN) with or without\ndashes. It uses the same parameters as a Text tab, with the validation message and pattern set for SSN information. This value can be set.\n\n\n[ssn]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", + "type": "array", + "items": { + "$ref": "#/definitions/ssn" + } + }, + "tabGroups": { + "description": "An array of `tabGroup` items that contain information about tab groups. To assign a tab to a `tabGroup`, you assign the `tabGroupLabel` to the `Tab.TabGroupLabels` array.", + "type": "array", + "items": { + "$ref": "#/definitions/tabGroup" + } + }, + "textTabs": { + "description": "A list of\nText tabs.\n\nA text tab enables the recipient to enter free text. This value can be set.\n\nFind descriptions of all tab types in\nthe [EnvelopeRecipientTabs Resource][ert].\n\n[ert]: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n", + "type": "array", + "items": { + "$ref": "#/definitions/text" + } + }, + "titleTabs": { + "description": "A list of\n[Title tabs][title].\n\nA Title tab displays the recipient's title. This value can't be set.\n\n\n[title]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", + "type": "array", + "items": { + "$ref": "#/definitions/title" + } + }, + "viewTabs": { + "description": "A list of\n[View tabs][view].\n\nA View tab is used with an Approve tab to handle supplemental documents. This value can be set.\n\n[view]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", + "type": "array", + "items": { + "$ref": "#/definitions/view" + } + }, + "zipTabs": { + "description": "A list of\n[Zip tabs][zip].\n\nA Zip tab enables the recipient to enter a ZIP code. The ZIP code can be five digits or nine digits ( in ZIP+4 format), and can be entered with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for ZIP code information. This value can be set.\n\n\n[zip]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n", + "type": "array", + "items": { + "$ref": "#/definitions/zip" + } + } + }, + "x-ds-definition-name": "tabs", + "description": "Template tabs", + "x-ds-category": "Templates", + "x-ds-order": "50", + "x-ms-summary": "Template tabs" + }, + "TemplateViews": { + "type": "object", + "properties": { + "url": { + "description": "The URL that you navigate to in order to start the view.", + "type": "string" + } + }, + "x-ds-definition-name": "viewUrl", + "description": "A TemplateView contains a URL that you can embed in your application to generate a template view that uses the DocuSign user interface (UI).", + "x-ds-category": "Templates", + "x-ds-order": "55", + "x-ms-summary": "A TemplateView contains a URL that you can embed in your application to generate a template view that uses the DocuSign user interface (UI)." + }, + "UserCustomSettings": { + "type": "object", + "properties": { + "customSettings": { + "description": "The name/value pair information for the user custom setting.", + "type": "array", + "items": { + "$ref": "#/definitions/nameValue" + } + } + }, + "x-ds-definition-name": "customSettingsInformation", + "description": "Users' custom settings", + "x-ds-category": "Users", + "x-ds-order": "30", + "x-ms-summary": "Users' custom settings" + }, + "UserProfiles": { + "type": "object", + "properties": { + "address": { + "$ref": "#/definitions/addressInformation", + "description": "The user's address." + }, + "authenticationMethods": { + "description": "Indicates the authentication methods that the user uses. These properties cannot be modified by the PUT operation. ", + "type": "array", + "items": { + "$ref": "#/definitions/authenticationMethod" + } + }, + "companyName": { + "description": "The name of the user's company.", + "type": "string" + }, + "displayOrganizationInfo": { + "description": " When set to **true**, the user's company and title information display on the ID card. ", "type": "string" }, - "statusChangedDateTime": { - "description": "The data and time the status changed.", + "displayPersonalInfo": { + "description": "When set to **true**, the user's address and phone number display on the ID card.", "type": "string" }, - "statusDateTime": { - "description": "The DateTime that the envelope changed status (i.e. was created or sent.)", + "displayProfile": { + "description": "When set to **true**, the user's ID card can be viewed from signed documents and envelope history.", "type": "string" }, - "templatesUri": { - "description": "Contains a URI for an endpoint that you can use to retrieve the templates.", + "displayUsageHistory": { + "description": "When set to **true**, the user's usage information displays on the ID card.", "type": "string" }, - "transactionId": { - "description": " Used to identify an envelope. The id is a sender-generated value and is valid in the DocuSign system for 7 days. It is recommended that a transaction ID is used for offline signing to ensure that an envelope is not sent multiple times. The `transactionId` property can be used determine an envelope's status (i.e. was it created or not) in cases where the internet connection was lost before the envelope status was returned.", + "profileImageUri": { + "description": "The URL for retrieving the user's profile image.", "type": "string" }, - "useDisclosure": { - "description": "When set to **true**, the disclosure is shown to recipients in accordance with the account's Electronic Record and Signature Disclosure frequency setting. When set to **false**, the Electronic Record and Signature Disclosure is not shown to any envelope recipients. \n\nIf the `useDisclosure` property is not set, then the account's normal disclosure setting is used and the value of the `useDisclosure` property is not returned in responses when getting envelope information.", + "title": { + "description": "The user's job title.\n\nLimit: 100 characters.", "type": "string" }, - "voidedDateTime": { - "description": "The date and time the envelope or template was voided.", - "type": "string" + "usageHistory": { + "$ref": "#/definitions/usageHistory", + "description": "A complex element consisting of: \n\n- `lastSentDateTime`: The date and time the user last sent an envelope. \n- `lastSignedDateTime`: The date and time the user last signed an envelope.\n- `sentCount`: The number of envelopes the user has sent.\n- `signedCount`: The number of envelopes the user has signed. \n" }, - "voidedReason": { - "description": "The reason the envelope or template was voided.", + "userDetails": { + "$ref": "#/definitions/userInformation", + "description": "Detailed information about the user." + }, + "userProfileLastModifiedDate": { + "description": "The date and time that the user's profile was last modified.", "type": "string" } }, - "x-ds-definition-name": "envelope", - "description": "Envelope creation, management", - "x-ds-category": "Envelopes", - "x-ds-order": "10", - "x-ms-summary": "Envelope creation, management" - }, - "EnvelopeTemplates": { - "type": "object", - "properties": { - "templates": { - "description": "An array of `templateSummary` objects that contain information about templates.", - "type": "array", - "items": { - "$ref": "#/definitions/templateSummary" - } - } - }, - "x-ds-definition-name": "templateInformation", - "description": "Envelope templates", - "x-ds-category": "Envelopes", - "x-ds-order": "85", - "x-ms-summary": "Envelope templates" + "x-ds-definition-name": "userProfile", + "description": "Users' profiles", + "x-ds-category": "Users", + "x-ds-order": "20", + "x-ms-summary": "Users' profiles" }, - "Folders": { + "Users": { "type": "object", "properties": { - "endPosition": { - "description": "The last position in the result set. ", + "activationAccessCode": { + "description": "The activation code a new user must enter when activating their account.", "type": "string" }, - "envelopes": { - "description": "A list of envelopes in this folder.", + "company": { + "description": "The name of the user's company.", + "type": "string" + }, + "connectConfigurations": { + "description": "Object representing the user's custom Connect configuration.", "type": "array", "items": { - "$ref": "#/definitions/envelopeSummary" + "$ref": "#/definitions/connectUserObject" } }, - "folders": { - "description": "A collection of folder objects returned in a response.", + "countryCode": { + "description": "The three-letter code for the user's country.", + "type": "string" + }, + "createdDateTime": { + "description": "The UTC DateTime when the item was created.", + "type": "string" + }, + "customSettings": { + "description": "The name/value pair information for the user custom setting.", "type": "array", "items": { - "$ref": "#/definitions/folder" + "$ref": "#/definitions/nameValue" } }, - "nextUri": { - "description": "The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. ", + "defaultAccountId": { + "description": "The default account ID associated with the user.", "type": "string" }, - "previousUri": { - "description": "The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. ", + "email": { + "description": "The user's email address.", "type": "string" }, - "resultSetSize": { - "description": "The number of results returned in this response. Because you can filter which entries are included in the response, this value is always less than or equal to `totalSetSize`.", + "enableConnectForUser": { + "description": "Boolean value that specifies whether the user is enabled for updates from DocuSign Connect.", "type": "string" }, - "startPosition": { - "description": "The starting position of the current result set.", - "type": "string" + "errorDetails": { + "$ref": "#/definitions/errorDetails", + "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." }, - "totalSetSize": { - "description": "The total number of items in the search's result set. This value is always greater than or equal to the value of `resultSetSize`.", + "firstName": { + "description": "The user's first name. \nMaximum Length: 50 characters.", "type": "string" - } - }, - "x-ds-definition-name": "foldersResponse", - "description": "Folder management", - "x-ds-category": "Folders", - "x-ds-order": "10", - "x-ms-summary": "Folder management" - }, - "GroupBrands": { - "type": "object", - "properties": { - "brands": { - "description": "A list of brands.", + }, + "forgottenPasswordInfo": { + "$ref": "#/definitions/forgottenPasswordInformation", + "description": "A complex element containing up to four Question/Answer pairs for forgotten password information." + }, + "groupList": { + "description": "A list of the group information for groups to add the user to.\nUse [UserGroups::listGroups](https://developers.docusign.com/docs/esign-rest-api/reference/UserGroups/Groups/list) to get information about groups.\n\nWhen setting a user's group, only the `groupId` is required.\n", "type": "array", "items": { - "$ref": "#/definitions/brand" + "$ref": "#/definitions/group" } }, - "recipientBrandIdDefault": { - "description": "The brand that envelope recipients see when a brand is not explicitly set.", - "type": "string" + "hasRemoteNotary": { + "description": "", + "type": "boolean" }, - "senderBrandIdDefault": { - "description": "The brand that envelope senders see when a brand is not explicitly set.", + "homeAddress": { + "$ref": "#/definitions/addressInformation", + "description": "The user's physical home address." + }, + "initialsImageUri": { + "description": "The URI for retrieving the image of the user's initials.", "type": "string" - } - }, - "x-ds-definition-name": "brandsResponse", - "description": "Brand management for groups", - "x-ds-category": "UserGroups", - "x-ds-order": "30", - "x-ms-summary": "Brand management for groups" - }, - "Groups": { - "type": "object", - "properties": { - "endPosition": { - "description": "The last position in the result set. ", + }, + "isAdmin": { + "description": "Determines if the feature set is actively set as part of the plan.", "type": "string" }, - "groups": { - "description": "A collection group objects containing information about the groups.", - "type": "array", - "items": { - "$ref": "#/definitions/group" - } + "isNAREnabled": { + "description": "When set to **true**, National Association of Realtors (NAR) signature logos are enabled for the user.", + "type": "string" }, - "nextUri": { - "description": "The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. ", + "lastLogin": { + "description": "The date and time when the user last logged in to the system.", "type": "string" }, - "previousUri": { - "description": "The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. ", + "lastName": { + "description": "The user's last name. \nMaximum Length: 50 characters.", "type": "string" }, - "resultSetSize": { - "description": "The number of results returned in this response. Because you can filter which entries are included in the response, this value is always less than or equal to `totalSetSize`.", + "loginStatus": { + "description": "Shows the current status of the user's password. Possible values are: \n\n* password_reset\n* password_active\n* password_expired\n* password_locked\n* password_reset_failed \n", "type": "string" }, - "startPosition": { - "description": "The starting position of the current result set.", + "middleName": { + "description": "The user's middle name. \nLimit: 50 characters.", "type": "string" }, - "totalSetSize": { - "description": "The total number of items in the search's result set. This value is always greater than or equal to the value of `resultSetSize`.", + "password": { + "description": "The user's password.", "type": "string" - } - }, - "x-ds-definition-name": "groupInformation", - "description": "Group information", - "x-ds-category": "UserGroups", - "x-ds-order": "10", - "x-ms-summary": "Group information" - }, - "GroupUsers": { - "type": "object", - "properties": { - "endPosition": { - "description": "The last position in the result set. ", + }, + "passwordExpiration": { + "description": "If password expiration is enabled, the date-time when the user's password expires.", "type": "string" }, - "nextUri": { - "description": "The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. ", + "permissionProfileId": { + "description": "The id of the permission profile associated with the user.", "type": "string" }, - "previousUri": { - "description": "The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. ", + "permissionProfileName": { + "description": "The name of the permission profile associated with the user.", "type": "string" }, - "resultSetSize": { - "description": "The number of results returned in this response. Because you can filter which entries are included in the response, this value is always less than or equal to `totalSetSize`.", + "profileImageUri": { + "description": "The URL for retrieving the user's profile image.", "type": "string" }, - "startPosition": { - "description": "The starting position of the current result set.", + "sendActivationEmail": { + "description": "When set to **true**, specifies that an activation email will be sent to the user.", "type": "string" }, - "totalSetSize": { - "description": "The total number of items in the search's result set. This value is always greater than or equal to the value of `resultSetSize`.", + "sendActivationOnInvalidLogin": { + "description": "When set to **true**, specifies that an additional activation email be sent if user's log on fails before the account is activated.", "type": "string" }, - "users": { - "description": "An array of `userInfo` objects containing information about the users in the group.", - "type": "array", - "items": { - "$ref": "#/definitions/userInfo" - } - } - }, - "x-ds-definition-name": "usersResponse", - "description": "Groups' users", - "x-ds-category": "UserGroups", - "x-ds-order": "20", - "x-ms-summary": "Groups' users" - }, - "SigningGroups": { - "type": "object", - "properties": { - "created": { - "description": "The UTC DateTime when the workspace user authorization was created.", + "signatureImageUri": { + "description": "An endpoint URI that you can use to retrieve the user's signature image.", "type": "string" }, - "createdBy": { + "subscribe": { "description": "", "type": "string" }, - "errorDetails": { - "$ref": "#/definitions/errorDetails", - "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." + "suffixName": { + "description": "The suffix for the user's name, such as Jr, IV, PhD, etc.\n\nLimit: 50 characters. ", + "type": "string" }, - "groupEmail": { - "description": "", + "title": { + "description": "The salutation for the user, such as Ms, Dr, Capt., etc.\n\nLimit: 10 characters.", "type": "string" }, - "groupName": { - "description": "The name of the group. The search_text provided in the call automatically performs a wild card search on group_name.", + "uri": { + "description": "A URI containing the user ID.", "type": "string" }, - "groupType": { - "description": "The group type. Potential values for POST and PUT requests include:\n\n- `adminstrators`\n- `everyone`\n- `customGroup`\n\n", + "userAddedToAccountDateTime": { + "description": "The date and time that the user was added to the account.", "type": "string" }, - "modified": { - "description": "", + "userId": { + "description": "The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.\n", "type": "string" }, - "modifiedBy": { - "description": "User ID (GUID) of the user who last modified this user record.", + "userName": { + "description": "The user's full name.\n", "type": "string" }, - "signingGroupId": { - "description": "When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once).", + "userProfileLastModifiedDate": { + "description": "The date and time that the user's profile was last modified.", "type": "string" }, - "users": { - "description": "User management information.", - "type": "array", - "items": { - "$ref": "#/definitions/signingGroupUser" - } + "userSettings": { + "$ref": "#/definitions/userSettingsInformation", + "description": "The collection of settings representing the actions a user can perform. See [userSettingsInformation](https://developers.docusign.com/docs/esign-rest-api/reference/users/users/get/#userSettingsInformation) for available settings." + }, + "userStatus": { + "description": "Status of the user's account. One of:\n\n- `ActivationRequired`\n- `ActivationSent`\n- `Active`\n- `Closed`\n- `Disabled`\n", + "type": "string" + }, + "userType": { + "description": "The type of user, for example `CompanyUser`.", + "type": "string" + }, + "workAddress": { + "$ref": "#/definitions/addressInformation", + "description": "The user's physical work address." } }, - "x-ds-definition-name": "signingGroup", - "description": "Signing groups", - "x-ds-category": "SigningGroups", + "x-ds-definition-name": "userInformation", + "description": "The Users resource enables you to create and manage account users.", + "x-ds-category": "Users", "x-ds-order": "10", - "x-ms-summary": "Signing groups" - }, - "SigningGroupUsers": { - "type": "object", - "properties": { - "users": { - "description": "User management information.", - "type": "array", - "items": { - "$ref": "#/definitions/signingGroupUser" - } - } - }, - "x-ds-definition-name": "signingGroupUsers", - "description": "Signing groups' users", - "x-ds-category": "SigningGroups", - "x-ds-order": "20", - "x-ms-summary": "Signing groups' users" + "x-ms-summary": "The Users resource enables you to create and manage account users." }, - "TemplateRecipients": { - "description": "Template recipients", + "UserSignatures": { "type": "object", "properties": { - "agents": { - "description": "A list of agent recipients assigned to the documents.", - "type": "array", - "items": { - "$ref": "#/definitions/agent" - } - }, - "carbonCopies": { - "description": "A list of carbon copy recipients assigned to the documents.", - "type": "array", - "items": { - "$ref": "#/definitions/carbonCopy" - } + "adoptedDateTime": { + "description": "The date and time the user adopted their signature.", + "type": "string" }, - "certifiedDeliveries": { - "description": "A complex type containing information on a recipient the must receive the completed documents for the envelope to be completed, but the recipient does not need to sign, initial, date, or add information to any of the documents.", - "type": "array", - "items": { - "$ref": "#/definitions/certifiedDelivery" - } + "createdDateTime": { + "description": "The UTC date and time when the user created the signature.", + "type": "string" }, - "currentRoutingOrder": { - "description": "The routing order of the current recipient. If this value equals a particular signer's routing order, it indicates that the envelope has been sent to that recipient, but he or she has not completed the required actions.", + "customField": { + "description": "Serialized information about any custom [eHanko stamps](https://support.docusign.com/en/articles/Sending-and-Signing-with-eHanko) that have been ordered from an eHanko provider, including the order status, purchase order id, time created, and time modified.", "type": "string" }, - "editors": { - "description": "A complex type defining the management and access rights of a recipient assigned assigned as an editor on the document.", - "type": "array", - "items": { - "$ref": "#/definitions/editor" - } + "dateStampProperties": { + "$ref": "#/definitions/dateStampProperties", + "description": "Specifies the area in which a date stamp is placed. This parameter uses pixel positioning to draw a rectangle at the center of the stamp area. The stamp is superimposed on top of this central area.\n\nThis property contains the following information about the central rectangle:\n\n- `DateAreaX`: The X axis position of the top-left corner.\n- `DateAreaY`: The Y axis position of the top-left corner.\n- `DateAreaWidth`: The width of the rectangle.\n- `DateAreaHeight`: The height of the rectangle." + }, + "disallowUserResizeStamp": { + "description": "When set to **true**, users may not resize the stamp.", + "type": "string" }, "errorDetails": { "$ref": "#/definitions/errorDetails", "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." }, - "inPersonSigners": { - "description": "Specifies a signer that is in the same physical location as a DocuSign user who will act as a Signing Host for the transaction. The recipient added is the Signing Host and new separate Signer Name field appears after Sign in person is selected.", - "type": "array", - "items": { - "$ref": "#/definitions/inPersonSigner" - } + "externalID": { + "description": "An external ID for the signature or stamp.\n\n**Note**: If a recipient uses a stamp instead of a signature, this is the stamp vendor's serial number for the stamp.", + "type": "string" }, - "intermediaries": { - "description": "Identifies a recipient that can, but is not required to, add name and email information for recipients at the same or subsequent level in the routing order (until subsequent Agents, Editors or Intermediaries recipient types are added).", - "type": "array", - "items": { - "$ref": "#/definitions/intermediary" - } + "imageBase64": { + "description": "A Base64-encoded representation of the signature image.", + "type": "string" }, - "recipientCount": { - "description": "The list of recipient event statuses that will trigger Connect to send updates to the url. It can be a two-part list with:\n\n* recipientEventStatusCode - The recipient status, this can be Sent, Delivered, Completed, Declined, AuthenticationFailed, and AutoResponded.\n* includeDocuments - When set to **true**, the envelope time zone information is included in the message.", + "imageType": { + "description": "The format of the signature image, such as:\n\n- `GIF`\n- `PNG`\n- `JPG`\n- `PDF`\n- `BMP`", "type": "string" }, - "seals": { - "description": "Specifies one or more electronic seals to apply on documents. For more information on Electronic Seals , see https://support.docusign.com/en/guides/ndse-user-guide-apply-electronic-seals", - "type": "array", - "items": { - "$ref": "#/definitions/sealSign" - } + "initials150ImageId": { + "description": "The ID of the user's initials image.", + "type": "string" }, - "signers": { - "description": "A list of signers on the envelope.", - "type": "array", - "items": { - "$ref": "#/definitions/signer" - } + "initialsImageUri": { + "description": "The URI for retrieving the image of the user's initials.", + "type": "string" }, - "witnesses": { - "description": "A list of signers who act as witnesses on the envelope.", - "type": "array", - "items": { - "$ref": "#/definitions/witness" - } - } - }, - "x-ds-definition-name": "recipients", - "x-ds-category": "Templates", - "x-ds-order": "20", - "x-ms-summary": "Template recipients" - }, - "TemplateBulkRecipients": { - "type": "object", - "properties": { - "bulkRecipients": { - "description": "A complex type containing information about the bulk recipients in the response.", - "type": "array", - "items": { - "$ref": "#/definitions/bulkRecipient" - } + "isDefault": { + "description": "Boolean that specifies whether the signature is the default signature for the user.", + "type": "string" }, - "endPosition": { - "description": "The last position in the result set. ", + "lastModifiedDateTime": { + "description": "The UTC date and time when the signature was last modified.", "type": "string" }, - "nextUri": { - "description": "The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. ", + "nrdsId": { + "description": "The National Association of Realtors (NAR) membership ID for a user who is a realtor.", "type": "string" }, - "previousUri": { - "description": "The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. ", + "nrdsLastName": { + "description": "The realtor's last name.", "type": "string" }, - "resultSetSize": { - "description": "The number of results returned in this response. Because you can filter which entries are included in the response, this value is always less than or equal to `totalSetSize`.", + "nrdsStatus": { + "description": "The realtor's NAR membership status. The value `active` verifies that the user is a current NAR member. Valid values are:\n\n- `Active`\n- `Inactive`\n- `Terminate`\n- `Provisional`\n- `Deceased`\n- `Suspend`\n- `Unknown`", "type": "string" }, - "startPosition": { - "description": "The starting position of the current result set.", + "phoneticName": { + "description": "The phonetic spelling of the `signatureName`.", "type": "string" }, - "totalSetSize": { - "description": "The total number of items in the search's result set. This value is always greater than or equal to the value of `resultSetSize`.", + "signature150ImageId": { + "description": "The ID of the user's signature image.", "type": "string" - } - }, - "x-ds-definition-name": "bulkRecipientsResponse", - "description": "Template bulk recipients", - "x-ds-category": "Templates", - "x-ds-order": "30", - "x-ms-summary": "Template bulk recipients" - }, - "TemplateCustomFields": { - "description": "Template custom fields", - "type": "object", - "properties": { - "listCustomFields": { - "description": "An array of list custom fields.", - "type": "array", - "items": { - "$ref": "#/definitions/listCustomField" - } }, - "textCustomFields": { - "description": "An array of text custom fields.", - "type": "array", - "items": { - "$ref": "#/definitions/textCustomField" - } - } - }, - "x-ds-definition-name": "customFields", - "x-ds-category": "Templates", - "x-ds-order": "70", - "x-ms-summary": "Template custom fields" - }, - "TemplateDocumentFields": { - "type": "object", - "properties": { - "documentFields": { - "description": "The array of name/value custom data strings to add to a document. Custom document field information is returned in the status, but otherwise is not used by DocuSign. The array contains the following elements: \n\n* `name` - A string that can be a maximum of 50 characters. \n* `value` - A string that can be a maximum of 200 characters.\n\n**Important**: If you are using XML, the name/value pair is contained in a `nameValue` element. \n", - "type": "array", - "items": { - "$ref": "#/definitions/nameValue" - } - } - }, - "x-ds-definition-name": "documentFieldsInformation", - "description": "Template document fields", - "x-ds-category": "Templates", - "x-ds-order": "60", - "x-ms-summary": "Template document fields" - }, - "TemplateDocuments": { - "type": "object", - "properties": { - "templateDocuments": { - "description": "An array of document objects that contain information about the documents associated with the template.", - "type": "array", - "items": { - "$ref": "#/definitions/envelopeDocument" - } + "signatureFont": { + "description": "The font type for the signature, if the signature is not drawn. The supported font types are:\n\n\"7_DocuSign\", \"1_DocuSign\", \"6_DocuSign\", \"8_DocuSign\", \"3_DocuSign\", \"Mistral\", \"4_DocuSign\", \"2_DocuSign\", \"5_DocuSign\", \"Rage Italic\"\n", + "type": "string" + }, + "signatureId": { + "description": "The ID associated with the signature name. You can use this property in the URI in place of the signature name. This enables the use of special characters (such as \"&\", \"<\", and \">\") in a signature name.\n\n**Note**: When you update a signature, its signature ID might change. In that case you need to use `signatureName` to get the new `signatureId`.", + "type": "string" + }, + "signatureImageUri": { + "description": "An endpoint URI that you can use to retrieve the user's signature image.", + "type": "string" + }, + "signatureInitials": { + "description": " The initials associated with the signature.", + "type": "string" + }, + "signatureName": { + "description": "Specifies the user's signature name.", + "type": "string" + }, + "signatureRights": { + "description": "The rights that the user has to the signature. Valid values are:\n\n- `none`\n- `read`\n- `admin`", + "type": "string" + }, + "signatureType": { + "description": "Specifies the type of signature. Possible values include:\n\n- `RubberStamp`: A DocuSign pre-formatted signature style. This is the default value.\n- `Imported`: A signature image that the user uploaded.\n- `Drawn`: A freehand drawing of the user's signature and initials.", + "type": "string" + }, + "stampFormat": { + "description": "The format of a stamp. Valid values are:\n\n- `NameHanko`: The stamp represents only the signer's name.\n- `NameDateHanko`: The stamp represents the signer's name and the date. ", + "type": "string" + }, + "stampImageUri": { + "description": "The URI for retrieving the image of the user's stamp.", + "type": "string" + }, + "stampSizeMM": { + "description": "The physical height of the stamp image (in millimeters) that the stamp vendor recommends for displaying the image in PDF documents.", + "type": "string" }, - "templateId": { - "description": "The unique identifier of the template. If this is not provided, DocuSign will generate a value. ", + "stampType": { + "description": "The type of stamp. Valid values are:\n\n- `signature`: A signature image. This is the default value.\n- `stamp`: A stamp image.\n- null", + "type": "string" + }, + "status": { + "description": "Indicates the envelope status. Valid values are:\n\n* sent - The envelope is sent to the recipients. \n* created - The envelope is saved as a draft and can be modified and sent later.", "type": "string" } }, - "x-ds-definition-name": "templateDocumentsResult", - "description": "Template documents", - "x-ds-category": "Templates", + "x-ds-definition-name": "userSignature", + "description": "Users' signatures", + "x-ds-category": "Users", "x-ds-order": "40", - "x-ms-summary": "Template documents" + "x-ms-summary": "Users' signatures" }, - "TemplateLocks": { + "Contacts": { "type": "object", "properties": { + "cloudProvider": { + "description": "The cloud service that provided the contact. Valid values are:\n\n- `rooms`\n- `docusignCore` (default)\n\n", + "type": "string" + }, + "cloudProviderContainerId": { + "description": "The id of the container at the cloud provider. For example, this might be the room id for a DocuSign Transaction Room.", + "type": "string" + }, + "contactId": { + "description": "The id of a contact person in the account's address book.", + "type": "string" + }, + "contactPhoneNumbers": { + "description": "A list of the contact's phone numbers.\n\n**Note**: The phone numbers associated with shared contacts do not display to users other than the user who added the contact. Additionally, in the following scenarios, the phone number of a shared contact does not populate automatically for anyone other than the user who added the contact:\n\n- Sending an envelope by using SMS\n- Using phone authentication\n\nYou must ask the user who added the contact for the phone number and then manually enter it into the authentication box.", + "type": "array", + "items": { + "$ref": "#/definitions/contactPhoneNumber" + } + }, + "contactUri": { + "description": "The URI for retrieving information about the contact.", + "type": "string" + }, + "emails": { + "description": "The email address or addresses associated with the contact.", + "type": "array", + "items": { + "type": "string" + } + }, "errorDetails": { "$ref": "#/definitions/errorDetails", "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." }, - "lockDurationInSeconds": { - "description": "Sets the time, in seconds, until the lock expires when there is no activity on the envelope.\n\nIf no value is entered, then the default value of 300 seconds is used. The maximum value is 1,800 seconds.\n\nThe lock duration can be extended.\n", - "type": "string" + "isOwner": { + "description": "When **true**, the current user is the owner of the contact.", + "type": "boolean" }, - "lockedByApp": { - "description": "Specifies the friendly name of the application that is locking the envelope.", + "name": { + "description": "The name of the contact.", "type": "string" }, - "lockedByUser": { - "$ref": "#/definitions/userInfo", - "description": "A complex type containing information about the user that has the envelope or template locked." - }, - "lockedUntilDateTime": { - "description": "The date and time that the lock expires.", + "organization": { + "description": "The name of the contact's organization.", "type": "string" }, - "lockToken": { - "description": "A unique identifier provided to the owner of the lock. You must use this token with subsequent calls to prove ownership of the lock.", + "shared": { + "description": "When set to **true**, the contact is shared. For more information, see [Shared Contacts](https://support.docusign.com/guides/ndse-user-guide-manage-contacts).\n\n**Note**: The phone numbers associated with shared contacts do not display to users other than the user who added the contact. Additionally, in the following scenarios, the phone number of a shared contact does not populate automatically for anyone other than the user who added the contact:\n\n- Sending an envelope by using SMS\n- Using phone authentication\n\nYou must ask the user who added the contact for the phone number and then manually enter it into the authentication box.", "type": "string" }, - "lockType": { - "description": "The type of lock. Currently `edit` is the only supported type.", + "signingGroup": { + "description": "If the contact belongs to a signing group, this property contains the `signingGroupId`.", "type": "string" }, - "useScratchPad": { - "description": "Indicates whether a scratchpad is used for editing information.\n ", + "signingGroupName": { + "description": "The name of the signing group that the contact belongs to.", "type": "string" } }, - "x-ds-definition-name": "lockInformation", - "description": "Template locks", - "x-ds-category": "Templates", - "x-ds-order": "80", - "x-ms-summary": "Template locks" + "x-ds-definition-name": "contact", + "description": "The `Contacts` resource enables you to manage the contact in an account's address book.", + "x-ds-category": "Users", + "x-ds-order": "50", + "x-ms-summary": "The `Contacts` resource enables you to manage the contact in an account's address book." }, - "Templates": { + "EnvelopeAttachments": { "type": "object", "properties": { - "accessControlListBase64": { - "description": "Reserved for DocuSign.", + "accessControl": { + "description": "Valid values are `sender` and `senderAndAllRecipients`.", "type": "string" }, - "allowComments": { - "description": "When set to **true**, indicates that comments are allowed on the envelope.", + "attachmentId": { + "description": "The unique identifier for the attachment.", "type": "string" }, - "allowMarkup": { - "description": "When **true**, Document Markup is enabled for envelope. The account must have Document Markup enabled to use this.", + "attachmentType": { + "description": "Specifies the type of the attachment for the recipient. Possible values are:\n\n- `.htm`\n- `.xml`", "type": "string" }, - "allowReassign": { - "description": "When **true**, the recipient can redirect an envelope to a more appropriate recipient.", - "type": "string" + "errorDetails": { + "$ref": "#/definitions/errorDetails", + "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." }, - "allowViewHistory": { - "description": "When set to **true**, recipients can view the history of the envelope.", + "label": { + "description": "A label for the attachment. Potential values include: \n\n- `guidedForm`: [Guided forms](https://www.docusign.com/products/guided-forms) provide a step-by-step, mobile-ready experience to help signers easily complete long or complex forms.\n- `eventNotifications`: A list of envelope-level event statuses that trigger Connect to send updates to the endpoint specified in the `url` property. ", "type": "string" }, - "anySigner": { - "description": "Deprecated. This feature has been replaced by signing groups.", + "name": { + "description": "The name of the attachment.", "type": "string" - }, - "asynchronous": { - "description": "When **true**, the envelope is queued for processing and the value of the `status` property is set to 'Processing'. Additionally, get status calls return 'Processing' until completed. \n\n\n**Note**: A `transactionId` is required for this call to work correctly. When the envelope is created, the status is 'Processing' and an `envelopeId` is not returned in the response. To get the `envelopeId`, use a GET envelope query using the [transactionId](https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/create/#envelopeDefinition) or by checking the Connect notification.", + } + }, + "x-ds-definition-name": "envelopeAttachment", + "description": "", + "x-ds-category": "Envelopes", + "x-ds-order": "60", + "x-ms-summary": "" + }, + "AccountPermissionProfiles": { + "type": "object", + "properties": { + "modifiedByUsername": { + "description": "The username of the user who last modified the permission profile.", "type": "string" }, - "attachmentsUri": { - "description": "Contains a URL for retrieving the attachments that are associated with the envelope.", + "modifiedDateTime": { + "description": "The date and time when the permission profile was last modified.", "type": "string" }, - "authoritativeCopy": { - "description": "Specifies whether all documents in this envelope are authoritative copies.\nA document can set its own `authoritativeCopy` property to override this value. For example you can set the `authoritativeCopy` on an envelope level to true but can turn it off for a specific document. ", + "permissionProfileId": { + "description": "The ID of the permission profile. Possible values include:\n\n- `2301416` (for the `DocuSign Viewer` profile)\n- `2301415` (for the `DocuSign Sender` profile)\n- `2301414` (for the `Account Administrator` profile)\n\nIn addition, any custom permission profiles associated with your account will have an automatically generated `permissionProfileId`.", "type": "string" }, - "authoritativeCopyDefault": { - "description": "The default `authoritativeCopy` setting for documents in this envelope that do not have `authoritativeCopy` set.\nIf this property is not set, each document defaults to the envelope's `authoritativeCopy`.", + "permissionProfileName": { + "description": "The name of the account permission profile. \n\nExample: `Account Administrator`", "type": "string" }, - "autoMatch": { - "description": "By default, templates that have been used within\nthe last 60 days are included in auto-matching.\n\nBy explicitly setting `autoMatch`,\nyou can permanently include or exclude the template\nin auto matching.\n\nWhen **true** the template is included in auto-matching\nregardless of when it was last used.\n\nWhen **false** the template is never included in auto-matching.", - "type": "string" + "settings": { + "$ref": "#/definitions/accountRoleSettings", + "description": "This object specifies the permissions that are associated with the account permission profile." }, - "autoMatchSpecifiedByUser": { - "description": "If **true**, the template has been explicitly included in or excluded from auto-matching. The default is false.\nThis is a read-only property.", + "userCount": { + "description": "The total number of users in the group associated with the account permission profile.", "type": "string" }, - "autoNavigation": { - "description": "When **true**, auto navigation is set for the recipient.\n", + "users": { + "description": "A list of user objects containing information about the users who are associated with the account permission profile.", + "type": "array", + "items": { + "$ref": "#/definitions/userInformation" + } + } + }, + "x-ds-definition-name": "permissionProfile", + "description": "The AccountPermissionProfiles resource provides methods that allow you to manage permission profiles for groups of account users.", + "x-ds-category": "Accounts", + "x-ds-order": "70", + "x-ms-summary": "The AccountPermissionProfiles resource provides methods that allow you to manage permission profiles for groups of account users." + }, + "PowerForms": { + "type": "object", + "properties": { + "createdBy": { + "description": "The id of the user who created the PowerForm. This property is returned in a response only when you set the `include_created_by` query parameter to **true**.", "type": "string" }, - "brandId": { - "description": "The id of the brand.", + "createdDateTime": { + "description": "The date and time that the PowerForm was created.", "type": "string" }, - "brandLock": { - "description": "Indicates if the brandId for the envelope is locked.", + "emailBody": { + "description": "For a PowerForm that is sent by email, this is the body of the email message sent to the recipients.\n\nMaximum length: 10000 characters.", "type": "string" }, - "certificateUri": { - "description": "Contains a URI that you can use to retrieve certificate information.", + "emailSubject": { + "description": "Sets the envelope name for the envelopes that the PowerForm generates. One option is to make this property the same as the subject from the template.\n\nYou can customize the subject line to include a recipient's name or email address by using merge fields. For information about adding merge fields to the email subject, see [Template Email Subject Merge Fields](https://developers.docusign.com/docs/esign-rest-api/reference/templates/templates/create/).\n", "type": "string" }, - "completedDateTime": { - "description": "Specifies the date and time this item was completed.", + "envelopes": { + "description": "An array of envelope objects that contain information about the envelopes that are associated with the PowerForm.", + "type": "array", + "items": { + "$ref": "#/definitions/envelope" + } + }, + "errorDetails": { + "$ref": "#/definitions/errorDetails", + "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." + }, + "instructions": { + "description": "The instructions that display on the landing page for the first recipient. These instructions are important if the recipient accesses the PowerForm by a method other than email. When you include instructions, they display as an introduction after the recipient accesses the PowerForm.", "type": "string" }, - "created": { - "description": "The UTC DateTime when the workspace user authorization was created.", + "isActive": { + "description": "When **true**, indicates that the PowerForm is active and can be sent to recipients. This is the default value.\n\n\nWhen **false**, the PowerForm cannot be emailed or accessed by a recipient, even if they arrive at the PowerForm URL. \n\nIf a recipient attempts to sign an inactive PowerForm, an error message informs the recipient that the document is not active and suggests that they contact the sender.", "type": "string" }, - "createdDateTime": { - "description": "The date and time the item was created.", + "lastUsed": { + "description": "The date and time that the PowerForm was last used.", "type": "string" }, - "customFields": { - "$ref": "#/definitions/AccountCustomFields", - "description": "An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters." + "limitUseInterval": { + "description": "The length of time before the same recipient can sign the same PowerForm again. This property is used in combination with the `limitUseIntervalUnits` property.", + "type": "string" }, - "customFieldsUri": { - "description": "Contains a URI for an endpoint to retrieve the custom fields.", + "limitUseIntervalEnabled": { + "description": "When **true**, the `limitUseInterval` is enabled.", "type": "string" }, - "declinedDateTime": { - "description": "The date and time the recipient declined the document.", + "limitUseIntervalUnits": { + "description": "The units associated with the `limitUseInterval`. Valid values are:\n\n- `minutes`\n- `hours`\n- `days`\n- `weeks`\n- `months`\n\nFor example, to limit a recipient to signing once per year, set the `limitUseInterval` to 365 and the `limitUseIntervalUnits` to `days`.\n", "type": "string" }, - "deletedDateTime": { - "description": "Specifies the data and time the item was deleted.", + "maxUseEnabled": { + "description": "When set to **true**, you can set a maximum number of uses for the PowerForm.", "type": "string" }, - "deliveredDateTime": { - "description": "The date and time that the envelope was delivered to the recipient.", + "name": { + "description": "The name of the PowerForm.", "type": "string" }, - "description": { - "description": "A sender-defined description of the line item.\n", + "powerFormId": { + "description": "The id of the PowerForm.", "type": "string" }, - "disableResponsiveDocument": { - "description": "When set to **true**, responsive documents are disabled for the envelope.", + "powerFormUrl": { + "description": "The URL for the PowerForm.", "type": "string" }, - "documents": { - "description": "Complex element contains the details on the documents in the envelope.", + "recipients": { + "description": "An array of `powerFormRecipient` objects.\n\n**Note**: For self-service documents where you do not know who the recipients are in advance, you can enter generic information for the `role` property and leave other details (such as `name` and `email`) blank.", "type": "array", "items": { - "$ref": "#/definitions/document" + "$ref": "#/definitions/powerFormRecipient" } }, - "documentsCombinedUri": { - "description": "Contains a URL that you can use to retrieve all of the documents associated with the envelope combined into a single PDF file.", + "senderName": { + "description": "The name of the sender. \n\n**Note**: The default sender for a PowerForm is the PowerForm Administrator who created it.", "type": "string" }, - "documentsUri": { - "description": "Contains a URI for an endpoint that you can use to retrieve the documents.", + "senderUserId": { + "description": "The id of the sender.", "type": "string" }, - "emailBlurb": { - "description": "This is the same as the email body. If the sender enters an email blurb, it is included in the email body for all envelope recipients.", + "signingMode": { + "description": "The signing method to use. Valid values are:\n\n- `email`: This mode verifies the recipient's identity by using email authentication before the recipient can sign a document.\n\n- `direct`: This mode does not require any verification. We recommend that you use this signing method only when another form of authentication is in use.\n\n**Note**: In the account settings, `enablePowerFormDirect` must be **true** to use `direct` as the `signingMode`.\n\nFor more information about signing modes, see the [overview of the Create method](https://developers.docusign.com/docs/esign-rest-api/reference/PowerForms/PowerForms/create).", "type": "string" }, - "emailSettings": { - "$ref": "#/definitions/EnvelopeEmailSettings", - "description": "A complex type that contains email settings." + "templateId": { + "description": "The id of the template used to create the PowerForm.", + "type": "string" }, - "emailSubject": { - "description": "The subject line of the email message that is sent to all recipients.\n\nFor information about adding merge field information to the email subject, see [Template Email Subject Merge Fields](https://developers.docusign.com/esign-rest-api/reference/Templates/Templates/create#template-email-subject-merge-fields).\n", + "templateName": { + "description": "The name of the template used to create the PowerForm.", "type": "string" }, - "enableWetSign": { - "description": "When set to **true**, the signer is allowed to print the document and sign it on paper.", + "timesUsed": { + "description": "The number of times the PowerForm has been used. ", "type": "string" }, - "enforceSignerVisibility": { - "description": "When set to **true**, signers can only view the documents on which they have tabs. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all of the documents in an envelope, unless they are specifically excluded by using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded by using this setting when an envelope is sent.\n\n**Note**: To use this functionality, [Document Visibility][docviz] must be enabled for the account by making the account setting `allowDocumentVisibility` **true**.\n\n[docviz]: /esign/restapi/Envelopes/EnvelopeDocumentVisibility", + "uri": { + "description": "The URI for the PowerForm.", "type": "string" }, - "envelopeAttachments": { - "description": "An array of attachment objects that provide information about the attachments that are associated with the envelope.", - "type": "array", - "items": { - "$ref": "#/definitions/attachment" - } + "usesRemaining": { + "description": "The number of times that the PowerForm can still be used. If no use limit is set, the value is `Unlimited`. ", + "type": "string" + } + }, + "x-ds-definition-name": "powerForm", + "description": "The PowerForms resource enables you to create fillable forms that you can email or make available for self service on the web.", + "x-ds-category": "PowerForms", + "x-ds-order": "80", + "x-ms-summary": "The PowerForms resource enables you to create fillable forms that you can email or make available for self service on the web." + }, + "PowerFormData": { + "type": "object", + "properties": { + "envelopeId": { + "description": "The envelope ID of the envelope status that failed to post.", + "type": "string" }, - "envelopeDocuments": { - "description": "An array containing information about the documents that are included in the envelope.", + "recipients": { + "description": "An array of powerform recipients.", "type": "array", "items": { - "$ref": "#/definitions/envelopeDocument" + "$ref": "#/definitions/powerFormFormDataRecipient" } - }, - "envelopeId": { - "description": "The envelope ID of the envelope status that failed to post.", + } + }, + "x-ds-definition-name": "powerFormFormDataEnvelope", + "description": "Data that recipients have entered in PowerForm fields.", + "x-ds-category": "PowerForms", + "x-ds-order": "90", + "x-ms-summary": "Data that recipients have entered in PowerForm fields." + }, + "AccountTabSettings": { + "type": "object", + "properties": { + "allowTabOrder": { + "description": "When set to **true**, account users can set a tab order for the signing process.\n\n**Note**: Only Admin users can change this setting.", "type": "string" }, - "envelopeIdStamping": { - "description": "When set to **true**, [Envelope ID Stamping](https://support.docusign.com/en/guides/ndse-user-guide-set-advanced-document-options) is enabled.\nOnce a document or attachment is stamped with an Envelope ID,\nthe ID is seen by all recipients\nand becomes a permanent part of the document\nand cannot be removed.", + "allowTabOrderMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `allowTabOrder` property is editable.\n" + }, + "approveDeclineTabsEnabled": { + "description": "When **true**, approve and decline tabs are enabled.", "type": "string" }, - "envelopeLocation": { - "description": "Reserved for DocuSign.", + "approveDeclineTabsMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `approveDeclineTabs` property is editable.\n" + }, + "calculatedFieldsEnabled": { + "description": "When **true**, [calculated fields](https://support.docusign.com/en/guides/ndse-user-guide-calculated-fields) are enabled for tabs.", "type": "string" }, - "envelopeMetadata": { - "$ref": "#/definitions/envelopeMetadata", - "description": "Provides information about the features and services that are enabled for the envelope, including the Correct feature, the Advanced Correct feature, and DocuSign eNotary service." + "calculatedFieldsMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `calculatedFields` property is editable.\n" }, - "envelopeUri": { - "description": "URI that you can use to retrieve the bulk envelopes.", + "checkboxTabsEnabled": { + "description": "When **true**, checkbox tabs are enabled.", "type": "string" }, - "expireAfter": { - "description": "An integer specifying the number of days that a sent envelope remains active before it expires. A negative number in a response indicates that the envelope has already expired.", + "checkBoxTabsMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `checkBoxTabs` property is editable." + }, + "dataFieldRegexEnabled": { + "description": "When **true**, regular expressions are enabled for tabs that contain data fields.", "type": "string" }, - "expireDateTime": { - "description": "The date and time the envelope is set to expire.", + "dataFieldRegexMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `dataFieldRegex` property is editable.\n" + }, + "dataFieldSizeEnabled": { + "description": "When **true**, setting character limits for input fields is enabled.", "type": "string" }, - "expireEnabled": { - "description": "When set to **true**, the envelope expires (is no longer available for signing) after the specified number of days after it is sent (`sentDateTime`). Set `expireAfter` to set the number of days until an envelope expires. When **false**, the account default setting is used. If the account does not have an expiration setting, the DocuSign default value of 120 days is used.", + "dataFieldSizeMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `dataFieldSize` property is editable.\n" + }, + "drawTabsEnabled": { + "description": "", "type": "string" }, - "externalEnvelopeId": { - "description": "May contain an external identifier for the envelope.", + "drawTabsMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "" + }, + "firstLastEmailTabsEnabled": { + "description": "Reserved for DocuSign.", "type": "string" }, - "folderId": { - "description": "The unique identifier for the folder that the template belongs to.", + "firstLastEmailTabsMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Reserved for DocuSign." + }, + "listTabsEnabled": { + "description": "When **true**, list tabs are enabled.", "type": "string" }, - "folderIds": { - "description": "An array of folder IDs that the template is in.", - "type": "array", - "items": { - "type": "string" - } + "listTabsMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `listTabs` property is editable.\n" }, - "folderName": { - "description": "The name of the folder the template belongs to.", + "noteTabsEnabled": { + "description": "When **true**, note tabs are enabled.", "type": "string" }, - "folders": { - "description": "A collection of folder objects returned in a response.", - "type": "array", - "items": { - "$ref": "#/definitions/folder" - } + "noteTabsMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `noteTabs` property is editable.\n" }, - "hasComments": { - "description": "When set to **true**, indicates that users have added comments to the envelope.", + "prefillTabsEnabled": { + "description": "", "type": "string" }, - "hasFormDataChanged": { - "description": "Specifies if the `EnvelopeFormData` associated with any forms in the template has changed.", + "prefillTabsMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "" + }, + "radioTabsEnabled": { + "description": "When **true**, radio button tabs are enabled.", "type": "string" }, - "hasWavFile": { - "description": "When set to **true**, indicates that the template includes a .wav file.", + "radioTabsMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `radioTabs` property is editable.\n" + }, + "savingCustomTabsEnabled": { + "description": "When **true**, saving custom tabs is enabled.", "type": "string" }, - "holder": { + "savingCustomTabsMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `savingCustomTabs` property is editable.\n" + }, + "senderToChangeTabAssignmentsEnabled": { "description": "Reserved for DocuSign.", "type": "string" }, - "initialSentDateTime": { - "description": "The date and time the envelope that used the template was initially sent.", - "type": "string" + "senderToChangeTabAssignmentsMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Reserved for DocuSign." }, - "is21CFRPart11": { - "description": "When **true**, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).", + "sharedCustomTabsEnabled": { + "description": "When **true**, shared custom tabs are enabled.", "type": "string" }, - "isDynamicEnvelope": { - "description": "When set to **true**, indicates that the envelope is a dynamic envelope.", - "type": "string" + "sharedCustomTabsMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `sharedCustomTabs` property is editable.\n" }, - "isSignatureProviderEnvelope": { - "description": "When set to **true**, indicates that the envelope is a signature-provided envelope.", + "tabDataLabelEnabled": { + "description": "When set to **true**, [data\nlabels](https://support.docusign.com/en/videos/Data-Labels) are enabled.\n\n**Note**: Only Admin users can change this setting.\n", "type": "string" }, - "lastModified": { - "description": "Utc date and time the comment was last updated (can only be done by creator.)", + "tabDataLabelMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `tabDataLabel` property is editable.\n" + }, + "tabLocationEnabled": { + "description": "Reserved for DocuSign.", "type": "string" }, - "lastModifiedBy": { - "$ref": "#/definitions/userInfo", - "description": "The userId of the user who last modified the template." + "tabLocationMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Reserved for DocuSign." }, - "lastModifiedDateTime": { - "description": "The date and time the template was last modified.", + "tabLockingEnabled": { + "description": "When set to **true**, tab locking is enabled.\n\n**Note**: Only Admin users can change this setting.\n", "type": "string" }, - "lastUsed": { - "description": "The date and time the template was last used.", - "type": "string" + "tabLockingMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `tabLocking` property is editable.\n" }, - "location": { + "tabScaleEnabled": { "description": "Reserved for DocuSign.", "type": "string" }, - "lockInformation": { - "$ref": "#/definitions/EnvelopeLocks", - "description": "Provides lock information about an envelope that a user has locked." + "tabScaleMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Reserved for DocuSign." }, - "messageLock": { - "description": "When set to **true**, prevents senders from changing the contents of `emailBlurb` and `emailSubject` properties for the envelope. \n\nAdditionally, this prevents users from making changes to the contents of `emailBlurb` and `emailSubject` properties when correcting envelopes. \n\nHowever, if the `messageLock` node is set to **true** and the `emailSubject` property is empty, senders and correctors are able to add a subject to the envelope.", + "tabTextFormattingEnabled": { + "description": "When set to **true**, text formatting (such as font type, font size,\nfont color, bold, italic, and underline) is enabled for tabs that\nsupport formatting.\n\n**Note**: Only Admin users can change this setting.\n", "type": "string" }, - "name": { - "description": "The name of the template.", - "type": "string" + "tabTextFormattingMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `tabTextFormatting` property is editable.\n" }, - "newPassword": { - "description": "The user's new password.", + "textTabsEnabled": { + "description": "When **true**, text tabs are enabled.", "type": "string" }, - "notification": { - "$ref": "#/definitions/notification", - "description": "A complex element that specifies the notification options for envelopes that use the template." + "textTabsMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `textTabs` property is editable.\n" + } + }, + "x-ds-definition-name": "tabAccountSettings", + "description": "Tab settings determine the tab types and tab functionality that are enabled for an account.", + "x-ds-category": "Accounts", + "x-ds-order": "100", + "x-ms-summary": "Tab settings determine the tab types and tab functionality that are enabled for an account." + }, + "ENoteConfigurations": { + "type": "object", + "properties": { + "apiKey": { + "description": "", + "type": "string" }, - "notificationUri": { - "description": "Contains a URI for an endpoint that you can use to retrieve the notifications.", + "connectConfigured": { + "description": "", "type": "string" }, - "owner": { - "$ref": "#/definitions/userInfo", - "description": "The owner of the template." + "eNoteConfigured": { + "description": "", + "type": "string" }, - "pageCount": { - "description": "An integer value specifying the number of document pages in the template. ", + "organization": { + "description": "", "type": "string" }, "password": { - "description": "The password for editing the template.", + "description": "The user's encrypted password hash.", "type": "string" }, - "passwordProtected": { - "description": "If **true**, a password is required to edit the template.", + "userName": { + "description": "The name of the user.", "type": "string" + } + }, + "x-ds-definition-name": "eNoteConfiguration", + "description": "", + "x-ds-category": "Accounts", + "x-ds-order": "110", + "x-ms-summary": "" + }, + "WorkspaceItems": { + "description": "This object contains information about a file or folder in a workspace.", + "type": "object", + "properties": { + "callerAuthorization": { + "$ref": "#/definitions/workspaceUserAuthorization", + "description": "An object that describes the caller's workspace permissions." }, - "powerForm": { - "$ref": "#/definitions/PowerForms", - "description": "A PowerForm objects that contain information about any PowerForms that are included in the template." - }, - "powerForms": { - "description": "An array of PowerForm objects that contain information about any PowerForms that are included in the template.", - "type": "array", - "items": { - "$ref": "#/definitions/PowerForms" - } - }, - "purgeCompletedDate": { - "description": "The date that a purge was completed.", + "contentType": { + "description": "If the item is a file, this property specifies the content type of the file.", "type": "string" }, - "purgeRequestDate": { - "description": "The date that a purge was requested.", + "created": { + "description": "The UTC DateTime when the workspace item was created.", "type": "string" }, - "purgeState": { - "description": "Shows the current purge state for the envelope. The possible values are:\n\n* `unpurged`: There has been no successful request to purge documents.\n* `documents_queued`: The envelope documents have been added to the purge queue, but have not been purged.\n* `documents_dequeued`: The envelope documents have been taken out of the purge queue.\n* `documents_and_metadata_queued`: The envelope documents and metadata have been added to the purge queue, but have not yet been purged.\n* `documents_purged`: The envelope documents have been successfully purged.\n* `documents_and_metadata_purged`: The envelope documents and metadata have been successfully purged.\n\n", + "createdById": { + "description": "The id of the user who created the workspace item.", "type": "string" }, - "recipients": { - "$ref": "#/definitions/EnvelopeRecipients", - "description": "An array of recipient objects." + "createdByInformation": { + "$ref": "#/definitions/workspaceUser", + "description": "Details about the user who created the workspace item." }, - "recipientsLock": { - "description": "When set to **true**, prevents senders from changing, correcting, or deleting the recipient information for the envelope.", + "extension": { + "description": "The file extension of a file item.", "type": "string" }, - "recipientsUri": { - "description": "Contains a URI for an endpoint that you can use to retrieve the recipients.", + "fileSize": { + "description": "The size of the file in bytes.", "type": "string" }, - "sender": { - "$ref": "#/definitions/userInfo", - "description": "Information about the sender." - }, - "sentDateTime": { - "description": "The date and time the envelope was sent.", + "fileUri": { + "description": "The URI for retrieving the file.", "type": "string" }, - "shared": { - "description": "When **true**, indicates the template is shared with the **Everyone** group,\nand is shared with all users on the account.\n\nIf **false**, the template is only shared with the **Administrator** group.\n", + "id": { + "description": "The id of the workspace item.", "type": "string" }, - "sharedWithMe": { - "description": "When **true**, indicates that another user has shared the template with you.", + "isPublic": { + "description": " When **true**, the item is public.", "type": "string" }, - "signerCanSignOnMobile": { - "description": "When set to **true**, the recipient can sign on a mobile device.", + "lastModified": { + "description": "The UTC DateTime that the item was last modified.", "type": "string" }, - "signingLocation": { - "description": "Specifies the physical location where the signing takes place. It can have two enumeration values; `inPerson` and `online`. The default value is `online`.", + "lastModifiedById": { + "description": "The id of the user who last modified the item.", "type": "string" }, - "status": { - "description": "Indicates the envelope status. Valid values are:\n\n* `sent` - The envelope is sent to the recipients. \n* `created` - The envelope is saved as a draft and can be modified and sent later.", - "type": "string" + "lastModifiedByInformation": { + "$ref": "#/definitions/workspaceUser", + "description": "Details about the user who last modified the workspace item." }, - "statusChangedDateTime": { - "description": "The data and time the status changed.", + "name": { + "description": "The name of the file or folder.", "type": "string" }, - "statusDateTime": { - "description": "The DateTime that the envelope changed status (i.e. was created or sent.)", + "pageCount": { + "description": "The number of pages in a file.", "type": "string" }, - "templateId": { - "description": "The ID of the template.", + "parentFolderId": { + "description": "The id of the parent folder, or the special value `root` for the root folder.", "type": "string" }, - "templatesUri": { - "description": "Contains a URI for an endpoint that you can use to retrieve the templates.", + "parentFolderUri": { + "description": "The URI of the parent folder.", "type": "string" }, - "transactionId": { - "description": " Used to identify an envelope. The id is a sender-generated value and is valid in the DocuSign system for 7 days. It is recommended that a transaction ID is used for offline signing to ensure that an envelope is not sent multiple times. The `transactionId` property can be used determine an envelope's status (i.e. was it created or not) in cases where the internet connection was lost before the envelope status was returned.", + "sha256": { + "description": "A 64-byte, Secure Hash Algorithm 256 (SHA256) checksum that the caller computes across the entirety of the original content of a file. DocuSign compares this value to its own computation. If the two values are not equal, the original content and received content are not the same and the upload is refused.", "type": "string" }, - "uri": { - "description": "Contains a URI that you can use to retreve the template.", + "thumbHeight": { + "description": "The height of the thumbnail image.", "type": "string" }, - "useDisclosure": { - "description": "When set to **true**, the disclosure is shown to recipients in accordance with the account's Electronic Record and Signature Disclosure frequency setting. When set to **false**, the Electronic Record and Signature Disclosure is not shown to any envelope recipients. \n\nIf the `useDisclosure` property is not set, then the account's normal disclosure setting is used and the value of the `useDisclosure` property is not returned in responses when getting envelope information.", + "thumbnail": { + "$ref": "#/definitions/page", + "description": "" + }, + "thumbWidth": { + "description": "The width of the thumbnail image.", "type": "string" }, - "voidedDateTime": { - "description": "The date and time the envelope or template was voided.", + "type": { + "description": "The type of workspace item. Valid values are:\n\n- `file`\n- `folder`", "type": "string" }, - "voidedReason": { - "description": "The reason the envelope or template was voided.", + "uri": { + "description": "A URI containing the user ID.", "type": "string" + }, + "userAuthorization": { + "$ref": "#/definitions/workspaceUserAuthorization", + "description": "An object that describes the user's workspace permissions." } }, - "x-ds-definition-name": "envelopeTemplate", - "description": "Template management", - "x-ds-category": "Templates", - "x-ds-order": "10", - "x-ms-summary": "Template management" + "x-ds-definition-name": "workspaceItem", + "x-ds-category": "Workspaces", + "x-ds-order": "130", + "x-ms-summary": "This object contains information about a file or folder in a workspace." }, - "TemplateRecipientTabs": { + "Workspaces": { + "description": "A DocuSign workspace is a collaboration area for sharing files and data.", "type": "object", "properties": { - "approveTabs": { - "description": "A list of\n[Approve tabs][approve].\n\nAn Approve tab enables\nthe recipient to approve documents without\nplacing a signature or initials on the document. If the\nrecipient clicks the tab during the signing process, the\nrecipient is considered to have signed the document. No\ninformation is shown on the document of the approval, but it\nis recorded as a signature in the envelope history.\nThe value of an approve tab can't be set.\n\n[approve]:\t\t https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/approve\n", - "type": "array", - "items": { - "$ref": "#/definitions/approve" - } - }, - "checkboxTabs": { - "description": "A list of\n[Checkbox tabs][checkbox].\n\n\nA Checkbox tab enables the recipient to select a yes/no (on/off) option. This value can be set.\n\n\n[checkbox]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/checkbox\n", - "type": "array", - "items": { - "$ref": "#/definitions/checkbox" - } - }, - "commentThreadTabs": { - "description": "An array of tabs that represents a collection of comments in a comment thread. For example, if a recipient has questions about the content of a document, they can add a comment to the document and control who else can see the comment. This value can't be set.", - "type": "array", - "items": { - "$ref": "#/definitions/commentThread" - } - }, - "companyTabs": { - "description": "A list of \n[Company tabs][company].\n\n\nA Company tab displays a field for the name of the recipient's company. This value can't be set.\n\n\n\n[company]: https://developers.docusign.com/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/company \n", - "type": "array", - "items": { - "$ref": "#/definitions/company" - } + "billableAccountId": { + "description": "The id of the account to bill.", + "type": "string" }, - "dateSignedTabs": { - "description": "A list of \n[Date Signed tabs][dateSigned].\n\n\nA Date Signed tab displays the date that the recipient signed the document. This value can't be set.\n\n[dateSigned]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/dateSigned \n", - "type": "array", - "items": { - "$ref": "#/definitions/dateSigned" - } + "callerInformation": { + "$ref": "#/definitions/workspaceUser", + "description": "" }, - "dateTabs": { - "description": "A list of \n[Date tabs][date].\n\nA Date tab enables the recipient to enter a date. This value can't be set. The tooltip for this tab recommends the date format MM/DD/YYYY, but this format is not enforced. The system retains the format that the recipient enters.\n\n**Note**: If you need to enforce a specific date format, we recommend that you use a Text tab with a validation pattern and validation message.\n\n\n[date]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/date \n", - "type": "array", - "items": { - "$ref": "#/definitions/date" - } + "created": { + "description": "The UTC DateTime when the workspace user authorization was created.", + "type": "string" }, - "declineTabs": { - "description": "A list of \n[Decline tabs][decline].\n\nA Decline tab enables the recipient to decline the envelope. If the recipient clicks the tab during the signing process, the envelope is voided. The value of this tab can't be set.\n\n\n[decline]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/decline \n", - "type": "array", - "items": { - "$ref": "#/definitions/decline" - } + "createdByInformation": { + "$ref": "#/definitions/workspaceUser", + "description": "Details about the user who created the workspace." }, - "emailAddressTabs": { - "description": "A list of \n[Email Address tabs][emailAddress].\n\nAn Email Address tab displays the recipient's email as entered in the recipient information. This value can't be set.\n\n\n[emailAddress]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/emailAddress \n", - "type": "array", - "items": { - "$ref": "#/definitions/emailAddress" - } + "lastModified": { + "description": "Utc date and time the comment was last updated (can only be done by creator.)", + "type": "string" }, - "emailTabs": { - "description": "A list of \n[Email tabs][email].\n\nAn Email tab enables the recipient to enter an email address.\nThis is a one-line field that checks that a valid email\naddress is entered. It uses the same parameters as a Text\ntab, with the validation message and pattern set for email\ninformation. This value can be set.\n\nWhen getting information that includes\nthis tab type, the original value of the tab when the\nassociated envelope was sent is included in the response.\n\n[email]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/email \n", - "type": "array", - "items": { - "$ref": "#/definitions/email" - } + "lastModifiedByInformation": { + "$ref": "#/definitions/workspaceUser", + "description": "Details about the user who last modified the workspace." }, - "envelopeIdTabs": { - "description": "A list of \n[Envelope ID tabs][envelopeId].\n\nAn Envelope ID tab displays the envelope ID. Recipients cannot enter or change the information in this tab. This value can't be set.\n\n\n[envelopeId]: https://developers.docusign.com/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/envelopeId \n", - "type": "array", - "items": { - "$ref": "#/definitions/envelopeId" - } + "settings": { + "$ref": "#/definitions/workspaceSettings", + "description": "Information about the settings for the workspace." }, - "firstNameTabs": { - "description": "A list of \n[First Name tabs][firstName].\n\nA First Name tab displays the recipient's first name. The system automatically populates this field by splitting the name in the recipient information on spaces. This value can't be set.\n\n\n[firstName]: https://developers.docusign.com/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/firstName \n", - "type": "array", - "items": { - "$ref": "#/definitions/firstName" - } + "status": { + "description": "The status of the workspace. Valid values are:\n\n- `active`\n- `closed`", + "type": "string" }, - "formulaTabs": { - "description": "A list of [Formula tabs][formulaTab].\n\nThe value of a Formula tab is calculated from the values of other number or date tabs in the document. When the recipient completes the underlying fields, the Formula tab calculates and displays the result. This value can be set.\n\nThe `formula` property of the tab contains the references to the underlying tabs. To learn more about formulas, see [Calculated Fields][calculatedfields].\n\nIf a Formula tab contains a `paymentDetails` property, the tab is considered a payment item. To learn more about payments, see [Requesting Payments Along with Signatures][paymentguide].\n\n[calculatedfields]: https://support.docusign.com/en/guides/ndse-user-guide-calculated-fields\n[paymentguide]: https://support.docusign.com/en/guides/requesting-payments-along-with-signatures\n[formulaTab]:\t \thttps://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/formulaTab\n", - "type": "array", - "items": { - "$ref": "#/definitions/formulaTab" - } + "workspaceBaseUrl": { + "description": "The relative URL for accessing the workspace.", + "type": "string" }, - "fullNameTabs": { - "description": "A list of \n[Full Name tabs][fullName].\n\nA Full Name tab displays the recipient's full name. This value can't be set.\n\n\n[fullName]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/fullName \n", - "type": "array", - "items": { - "$ref": "#/definitions/fullName" - } + "workspaceDescription": { + "description": "Text describing the purpose of the workspace.", + "type": "string" }, - "initialHereTabs": { - "description": "A list of \n[Initial Here tabs][initialHere].\n\nThis type of tab enables the recipient to initial the document. May be optional. This value can't be set.\n\n[initialHere]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/initialHere \n", - "type": "array", - "items": { - "$ref": "#/definitions/initialHere" - } + "workspaceId": { + "description": "The id of the workspace, always populated.", + "type": "string" }, - "lastNameTabs": { - "description": "A list of \n[Last Name tabs][lastName].\n\nA Last Name tab displays the recipient's last name. The system automatically populates this field by splitting the name in the recipient information on spaces. This value can't be set.\n\n\n[lastName]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/lastName \n", - "type": "array", - "items": { - "$ref": "#/definitions/lastName" - } + "workspaceName": { + "description": "The name of the workspace.", + "type": "string" }, - "listTabs": { - "description": "A list of [List tabs][list].\n\nA List tab enables the recipient to choose from a list of options. You specify the options in the `listItems` property. This value can't be set.\n\n\n\n[list]: https://developers.docusign.com/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/list \n", - "type": "array", - "items": { - "$ref": "#/definitions/list" - } + "workspaceUri": { + "description": "The relative URI for accessing the workspace.", + "type": "string" + } + }, + "x-ds-definition-name": "workspace", + "x-ds-category": "Workspaces", + "x-ds-order": "140", + "x-ms-summary": "A DocuSign workspace is a collaboration area for sharing files and data." + }, + "ChunkedUploads": { + "type": "object", + "properties": { + "checksum": { + "description": "A 64-byte, Secure Hash Algorithm 256 (SHA256) checksum that the caller computes across the entirety of the original content that has been uploaded to the chunked upload. DocuSign compares this value to its own computation. If the two values are not equal, the original content and received content are not the same and the commit action is refused.", + "type": "string" }, - "notarizeTabs": { - "description": "A list of [Notarize tabs][notarize].\n\nA Notarize tab alerts notary recipients that they must take action on the page. This value can be set.\n\n**Note**: Only one notarize tab can appear on a page.\n\n[notarize]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/notarize \n", - "type": "array", - "items": { - "$ref": "#/definitions/notarize" - } + "chunkedUploadId": { + "description": "The id of the chunked upload. ", + "type": "string" }, - "noteTabs": { - "description": "A list of \n[Note tabs][note].\n\nA Note tab displays additional information to the recipient in the form of a note. This value can be set.\n\n[note]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/note \n", + "chunkedUploadParts": { + "description": "A list of the parts that compose the chunked upload, including their byte sizes. The list must be contiguous before you can commit the chunked upload.", "type": "array", "items": { - "$ref": "#/definitions/note" + "$ref": "#/definitions/chunkedUploadPart" } }, - "numberTabs": { - "description": "A list of \n[Number tabs][number].\n\nA Number tab enables the recipient to enter numbers and decimal points (.). This value can be set.\n\n\n\n[number]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/number \n", - "type": "array", - "items": { - "$ref": "#/definitions/number" - } + "chunkedUploadUri": { + "description": "The URI that you use to reference the chunked upload in other API requests, such as envelope document and envelope attachment requests. ", + "type": "string" }, - "polyLineOverlayTabs": { - "description": "This type of tab enables the recipient to strike through document text. This value can't be set. ", - "type": "array", - "items": { - "$ref": "#/definitions/polyLineOverlay" - } + "committed": { + "description": "When **true**, the chunked upload has been committed. A committed chunked upload can no longer receive any additional parts and is ready for use within other API requests. ", + "type": "string" }, - "radioGroupTabs": { - "description": "A list of [Radio Group tabs][radioGroup].\n\nA Radio Group tab places a group of radio buttons on a document. The `radios` property is used to add and place the radio\nbuttons associated with the group. Only one radio button can be selected in a group. This value can be set.\n\n\n[radioGroup]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/radioGroup \n", - "type": "array", - "items": { - "$ref": "#/definitions/radioGroup" - } + "expirationDateTime": { + "description": "The UTC time at which the chunked upload expires and is no longer addressable. \n\n**Note**: The length of time before expiration is configurable, and begins when you initiate the chunked upload. You must fully upload and use a chunked upload within this time. The default value for this duration is 20 minutes.", + "type": "string" }, - "signerAttachmentTabs": { - "description": "A list of \n[Signer Attachment tabs][signerAttachment].\n\nThis type of tab enables the recipient to attach supporting documents to an envelope. This value can't be set.\n\n\n[signerAttachment]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/signerAttachment \n", - "type": "array", - "items": { - "$ref": "#/definitions/signerAttachment" - } + "maxChunkedUploadParts": { + "description": "The maximum number of parts allowed for a chunked upload. This value is configurable per DocuSign environment, account, or integrator. The default value is 128. The maximum possible value is 256. \n", + "type": "string" }, - "signHereTabs": { - "description": "A list of \n[Sign Here tabs][signHere].\n\nThis type of tab enables the recipient to sign a document. May be optional. This value can't be set.\n\n[signHere]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/signHere \n", - "type": "array", - "items": { - "$ref": "#/definitions/signHere" - } + "maxTotalSize": { + "description": "The maximum total size allowed for a chunked upload. This value is configured per DocuSign environment, account, or integrator. The default value is 50 MB.", + "type": "string" }, - "smartSectionTabs": { - "description": "A list of [Smart Section](https://www.docusign.com/blog/dsdev-deep-dive-responsive-smart-sections/) tabs.\n\nSmart Section tabs enhance responsive signing on mobile devices by enabling collapsible sections, page breaks, custom formatting options, and other advanced functionality.\n\n**Note**: Smart Sections are a premium feature. Responsive signing must also be enabled for your account.", - "type": "array", - "items": { - "$ref": "#/definitions/smartSection" - } + "totalSize": { + "description": "The total size of the parts of the chunked upload.\n\n**Note**: When a chunked upload is used as an envelope document, it is subject to the PDF size limit (25 MB) and page count limit that apply to all envelope documents.", + "type": "string" + } + }, + "x-ds-definition-name": "chunkedUploadResponse", + "description": "The ChunkedUploads resource provides methods to complete integrity checks, and to add, commit, retrieve, initiate and delete chunked uploads.", + "x-ds-category": "Envelopes", + "x-ds-order": "150", + "x-ms-summary": "The ChunkedUploads resource provides methods to complete integrity checks, and to add, commit, retrieve, initiate and delete chunked uploads." + }, + "EnvelopeFormData": { + "type": "object", + "properties": { + "emailSubject": { + "description": "The subject line of the email message that is sent to all recipients.\n\nFor information about adding merge field information to the email subject, see [Template Email Subject Merge Fields](https://developers.docusign.com/docs/esign-rest-api/reference/Templates/Templates/create#template-email-subject-merge-fields).\n", + "type": "string" }, - "ssnTabs": { - "description": "A list of \n[SSN tabs][ssn].\n\nAn SSN tab contains a one-line field that enables the recipient to enter a Social Security Number (SSN) with or without\ndashes. It uses the same parameters as a Text tab, with the validation message and pattern set for SSN information. This value can be set.\n\n\n[ssn]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/ssn \n", - "type": "array", - "items": { - "$ref": "#/definitions/ssn" - } + "envelopeId": { + "description": "The id of the envelope.", + "type": "string" }, - "tabGroups": { - "description": "An array of `tabGroup` items that contain information about tab groups. To assign a tab to a `tabGroup`, you assign the `tabGroupLabel` to the `Tab.TabGroupLabels` array.", + "formData": { + "description": "An array of form data objects.", "type": "array", "items": { - "$ref": "#/definitions/tabGroup" + "$ref": "#/definitions/formDataItem" } }, - "textTabs": { - "description": "A list of \n[Text tabs][text].\n\nA text tab enables the recipient to enter free text. This value can be set.\n\n[text]: https://developers.docusign.com/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/text \n", + "prefillFormData": { + "description": "", "type": "array", "items": { - "$ref": "#/definitions/text" + "$ref": "#/definitions/formDataItem" } }, - "titleTabs": { - "description": "A list of \n[Title tabs][title].\n\nA Title tab displays the recipient's title. This value can't be set.\n\n\n[title]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/title \n", + "recipientFormData": { + "description": "An array of form data objects that are associated with specific recipients.", "type": "array", "items": { - "$ref": "#/definitions/title" + "$ref": "#/definitions/recipientFormData" } }, - "viewTabs": { - "description": "A list of \n[View tabs][view].\n\nA View tab is used with an Approve tab to handle supplemental documents. This value can be set.\n\n[view]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/view \n", - "type": "array", - "items": { - "$ref": "#/definitions/view" - } + "sentDateTime": { + "description": "The UTC DateTime when the envelope was sent. Read only.", + "type": "string" }, - "zipTabs": { - "description": "A list of \n[Zip tabs][zip].\n\nA Zip tab enables the recipient to enter a ZIP code. The ZIP code can be five digits or nine digits ( in ZIP+4 format), and can be entered with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for ZIP code information. This value can be set.\n\n\n[zip]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/zip\n", - "type": "array", - "items": { - "$ref": "#/definitions/zip" - } - } - }, - "x-ds-definition-name": "tabs", - "description": "Template tabs", - "x-ds-category": "Templates", - "x-ds-order": "50", - "x-ms-summary": "Template tabs" - }, - "TemplateViews": { - "type": "object", - "properties": { - "url": { - "description": "The view URL to be navigated to.", + "status": { + "description": "Indicates the envelope status. Valid values are:\n\n* `completed`: The recipients have finished working with the envelope: the documents are signed and all required tabs are filled in.\n* `created`: The envelope is created as a draft. It can be modified and sent later.\n* `declined`: The envelope has been declined by the recipients.\n* `delivered`: The envelope has been delivered to the recipients.\n* `sent`: The envelope will be sent to the recipients after the envelope is created.\n* `signed`: The envelope has been signed by the recipients.\n* `voided`: The envelope is no longer valid and recipients cannot access or sign the envelope.\n", "type": "string" } }, - "x-ds-definition-name": "viewUrl", - "description": "Embedding template views", - "x-ds-category": "Templates", - "x-ds-order": "55", - "x-ms-summary": "Embedding template views" + "x-ds-definition-name": "envelopeFormData", + "description": "This object contains the data that recipients have entered into the form fields associated with an envelope.", + "x-ds-category": "Envelopes", + "x-ds-order": "160", + "x-ms-summary": "This object contains the data that recipients have entered into the form fields associated with an envelope." }, - "UserCustomSettings": { + "EnvelopeDocumentVisibility": { "type": "object", "properties": { - "customSettings": { - "description": "The name/value pair information for the user custom setting.", + "documentVisibility": { + "description": "An array of `documentVisibility` objects that specifies which documents are visible to which recipients.", "type": "array", "items": { - "$ref": "#/definitions/nameValue" + "$ref": "#/definitions/documentVisibility" } } }, - "x-ds-definition-name": "customSettingsInformation", - "description": "Users' custom settings", - "x-ds-category": "Users", - "x-ds-order": "30", - "x-ms-summary": "Users' custom settings" + "x-ds-definition-name": "documentVisibilityList", + "description": "Document Visibility enables senders to control the visibility of the documents in an envelope at the recipient level. For example, if the parties associated with a legal proceeding should have access to different documents, the Document Visibility feature enables you to keep all of the documents in the same envelope and set view permissions for the documents by recipient. This functionality is enabled for envelopes and templates. It is not available for PowerForms.\n\n**Note**: Before you use Document Visibility, you should be aware of the following information:\n\n- Document Visibility must be enabled for your account by your DocuSign administrator. \n- A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. \n- When the Document Visibility setting hides a document from a recipient, the document also does not appear in the recipient's list of envelopes, documents, or page images.\n- Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all of the documents associated with the envelope or template.\n\nThe Document Visibility feature has multiple settings that specify the options that senders have when sending documents. For more information, see [Use Document Visibility to Control Recipient Access](https://support.docusign.com/en/guides/ndse-user-guide-document-visibility).", + "x-ds-category": "Envelopes", + "x-ds-order": "170", + "x-ms-summary": "Document Visibility enables senders to control the visibility of the documents in an envelope at the recipient level. For example, if the parties associated with a legal proceeding should have access to different documents, the Document Visibility feature enables you to keep all of the documents in the same envelope and set view permissions for the documents by recipient. This functionality is enabled for envelopes and templates. It is not available for PowerForms.\n\n**Note**: Before you use Document Visibility, you should be aware of the following information:\n\n- Document Visibility must be enabled for your account by your DocuSign administrator. \n- A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. \n- When the Document Visibility setting hides a document from a recipient, the document also does not appear in the recipient's list of envelopes, documents, or page images.\n- Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all of the documents associated with the envelope or template.\n\nThe Document Visibility feature has multiple settings that specify the options that senders have when sending documents. For more information, see [Use Document Visibility to Control Recipient Access](https://support.docusign.com/en/guides/ndse-user-guide-document-visibility)." }, - "UserProfiles": { + "TemplateDocumentVisibility": { "type": "object", "properties": { - "address": { - "$ref": "#/definitions/addressInformation", - "description": "The user's address." - }, - "authenticationMethods": { - "description": "Indicates the authentication methods that the user uses. These properties cannot be modified by the PUT operation. ", + "documentVisibility": { + "description": "An array of `documentVisibility` objects that specifies which documents are visible to which recipients.", "type": "array", "items": { - "$ref": "#/definitions/authenticationMethod" + "$ref": "#/definitions/documentVisibility" } - }, - "companyName": { - "description": "The name of the user's company.", - "type": "string" - }, - "displayOrganizationInfo": { - "description": " When set to **true**, the user's company and title information display on the ID card. ", - "type": "string" - }, - "displayPersonalInfo": { - "description": "When set to **true**, the user's address and phone number display on the ID card.", - "type": "string" - }, - "displayProfile": { - "description": "When set to **true**, the user's ID card can be viewed from signed documents and envelope history.", - "type": "string" - }, - "displayUsageHistory": { - "description": "When set to **true**, the user's usage information displays on the ID card.", - "type": "string" - }, - "profileImageUri": { - "description": "The URL for retrieving the user's profile image.", - "type": "string" - }, - "title": { - "description": "The user's job title.\n\nLimit: 100 characters.", - "type": "string" - }, - "usageHistory": { - "$ref": "#/definitions/usageHistory", - "description": "A complex element consisting of: \n\n- `lastSentDateTime`: The date and time the user last sent an envelope. \n- `lastSignedDateTime`: The date and time the user last signed an envelope.\n- `sentCount`: The number of envelopes the user has sent.\n- `signedCount`: The number of envelopes the user has signed. \n" - }, - "userDetails": { - "$ref": "#/definitions/Users", - "description": "Detailed information about the user." - }, - "userProfileLastModifiedDate": { - "description": "The date and time that the user's profile was last modified.", - "type": "string" } }, - "x-ds-definition-name": "userProfile", - "description": "Users' profiles", - "x-ds-category": "Users", - "x-ds-order": "20", - "x-ms-summary": "Users' profiles" + "x-ds-definition-name": "templateDocumentVisibilityList", + "description": "Document Visibility enables senders to control the visibility of the documents in an envelope at the recipient level. For example, if the parties associated with a legal proceeding should have access to different documents, the Document Visibility feature enables you to keep all of the documents in the same envelope and set view permissions for the documents by recipient. This functionality is enabled for envelopes and templates. It is not available for PowerForms.\n\n**Note**: Before you use Document Visibility, you should be aware of the following information:\n\n- Document Visibility must be enabled for your account by your DocuSign administrator. \n- A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. \n- When the Document Visibility setting hides a document from a recipient, the document also does not appear in the recipient's list of envelopes, documents, or page images.\n- Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all of the documents associated with the envelope or template.\n\nThe Document Visibility feature has multiple settings that specify the options that senders have when sending documents. For more information, see [Use Document Visibility to Control Recipient Access](https://support.docusign.com/en/guides/ndse-user-guide-document-visibility).", + "x-ds-category": "Templates", + "x-ds-order": "180", + "x-ms-summary": "Document Visibility enables senders to control the visibility of the documents in an envelope at the recipient level. For example, if the parties associated with a legal proceeding should have access to different documents, the Document Visibility feature enables you to keep all of the documents in the same envelope and set view permissions for the documents by recipient. This functionality is enabled for envelopes and templates. It is not available for PowerForms.\n\n**Note**: Before you use Document Visibility, you should be aware of the following information:\n\n- Document Visibility must be enabled for your account by your DocuSign administrator. \n- A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. \n- When the Document Visibility setting hides a document from a recipient, the document also does not appear in the recipient's list of envelopes, documents, or page images.\n- Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all of the documents associated with the envelope or template.\n\nThe Document Visibility feature has multiple settings that specify the options that senders have when sending documents. For more information, see [Use Document Visibility to Control Recipient Access](https://support.docusign.com/en/guides/ndse-user-guide-document-visibility)." }, - "Users": { + "AccountPasswordRules": { "type": "object", "properties": { - "activationAccessCode": { - "description": "The activation code a new user must enter when activating their account.", - "type": "string" - }, - "company": { - "description": "The name of the user's company.", - "type": "string" - }, - "connectConfigurations": { - "description": "Object representing the user's custom Connect configuration.", - "type": "array", - "items": { - "$ref": "#/definitions/connectUserObject" - } - }, - "countryCode": { - "description": "The three-letter code for the user's country.", - "type": "string" - }, - "createdDateTime": { - "description": "The date and time the item was created.", - "type": "string" - }, - "customSettings": { - "description": "The name/value pair information for the user custom setting.", - "type": "array", - "items": { - "$ref": "#/definitions/nameValue" - } - }, - "defaultAccountId": { - "description": "The default account ID associated with the user.", - "type": "string" - }, - "email": { - "description": "The user's email address.", - "type": "string" - }, - "enableConnectForUser": { - "description": "Boolean value that specifies whether the user is enabled for updates from DocuSign Connect.", - "type": "string" - }, - "errorDetails": { - "$ref": "#/definitions/errorDetails", - "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." - }, - "firstName": { - "description": "The user's first name. \nMaximum Length: 50 characters.", - "type": "string" - }, - "forgottenPasswordInfo": { - "$ref": "#/definitions/forgottenPasswordInformation", - "description": "A complex element containing up to four Question/Answer pairs for forgotten password information." - }, - "groupList": { - "description": "A list of the group information for groups to add the user to.\nUse [UserGroups::listGroups](https://developers.docusign.com/esign-rest-api/reference/UserGroups/Groups/list) to get information about groups.\n\nWhen setting a user's group, only the `groupId` is required.\n", - "type": "array", - "items": { - "$ref": "#/definitions/group" - } - }, - "homeAddress": { - "$ref": "#/definitions/addressInformation", - "description": "The user's physical home address." - }, - "initialsImageUri": { - "description": "Contains the URI for an endpoint that you can use to retrieve the initials image.", - "type": "string" - }, - "isAdmin": { - "description": "Determines if the feature set is actively set as part of the plan.", - "type": "string" - }, - "isNAREnabled": { - "description": "", - "type": "string" - }, - "jobTitle": { - "description": "The user's job title.", - "type": "string" - }, - "lastLogin": { - "description": "The date and time when the user last logged in to the system.", - "type": "string" - }, - "lastName": { - "description": "The user's last name. \nMaximum Length: 50 characters.", - "type": "string" - }, - "loginStatus": { - "description": "Shows the current status of the user's password. Possible values are: \n\n* password_reset\n* password_active\n* password_expired\n* password_locked\n* password_reset_failed \n", - "type": "string" - }, - "middleName": { - "description": "The user's middle name. \nLimit: 50 characters.", - "type": "string" - }, - "password": { - "description": "The user's password.", - "type": "string" - }, - "passwordExpiration": { - "description": "If password expiration is enabled, the date-time when the user's password expires.", - "type": "string" - }, - "permissionProfileId": { - "description": "The id of the permission profile associated with the user.", + "expirePassword": { + "description": "When set to **true**, passwords expire. The default value is `false`.", "type": "string" }, - "permissionProfileName": { - "description": "The name of the permission profile associated with the user.", + "expirePasswordDays": { + "description": "The number of days before passwords expire. To use this property, the `expirePassword` property must be set to **true**.", "type": "string" }, - "profileImageUri": { - "description": "The URL for retrieving the user's profile image.", - "type": "string" + "expirePasswordDaysMetadata": { + "$ref": "#/definitions/accountPasswordExpirePasswordDays", + "description": "Metadata that indicates whether the `expirePasswordDays` property is editable.\n" }, - "sendActivationEmail": { - "description": "When set to **true**, specifies that an activation email be sent to the user.", + "lockoutDurationMinutes": { + "description": "The number of minutes a user is locked out of the system after three (?) failed login attempts. The default value is `2`.", "type": "string" }, - "sendActivationOnInvalidLogin": { - "description": "When set to **true**, specifies that an additional activation email be sent if user's log on fails before the account is activated.", - "type": "string" + "lockoutDurationMinutesMetadata": { + "$ref": "#/definitions/accountPasswordLockoutDurationMinutes", + "description": "Metadata that indicates whether the `lockoutDurationMinutes` property is editable.\n" }, - "signatureImageUri": { - "description": "An endpoint URI that you can use to retrieve the user's signature image.", + "lockoutDurationType": { + "description": "The interval associated with the user lockout after a failed login attempt.\n\nPossible values are: (?????)\n\n- `minutes` (default)\n- `hours`\n- `days`", "type": "string" }, - "subscribe": { - "description": "", - "type": "string" + "lockoutDurationTypeMetadata": { + "$ref": "#/definitions/accountPasswordLockoutDurationType", + "description": "Metadata that indicates whether the `lockoutDurationType` property is editable.\n" }, - "suffixName": { - "description": "The suffix for the user's name, such as Jr, IV, PhD, etc.\n\nLimit: 50 characters. ", + "minimumPasswordAgeDays": { + "description": "The minimum number of days after a password is set before it can be changed. This value can be `0` or more days. The default value is `0`.", "type": "string" }, - "title": { - "description": "The salutation for the user, such as Ms, Dr, Capt., etc.\n\nLimit: 10 characters.", - "type": "string" + "minimumPasswordAgeDaysMetadata": { + "$ref": "#/definitions/accountPasswordMinimumPasswordAgeDays", + "description": "Metadata that indicates whether the `minimumPasswordAgeDays` property is editable.\n" }, - "uri": { - "description": "URI containing the user ID.", + "minimumPasswordLength": { + "description": "The minimum number of characters in the password. This value must be a number between `6` and `15`. The default value is `6`.", "type": "string" }, - "userAddedToAccountDateTime": { - "description": "The date and time that the user was added to the account.", + "minimumPasswordLengthMetadata": { + "$ref": "#/definitions/accountMinimumPasswordLength", + "description": "Metadata that indicates whether the `minimumPasswordLength` property is editable.\n" + }, + "passwordIncludeDigit": { + "description": "When set to **true**, passwords must include a digit. The default value is `false`.", "type": "string" }, - "userId": { - "description": "The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.\n", + "passwordIncludeDigitOrSpecialCharacter": { + "description": "When set to **true**, passwords must include either a digit or a special character. The default value is `false`.\n\n**Note**: Passwords cannot include angle brackets (`<` `>`) or spaces.", "type": "string" }, - "userName": { - "description": "The user's full name.\n", + "passwordIncludeLowerCase": { + "description": "When set to **true**, passwords must include a lowercase letter. The default value is `false`.", "type": "string" }, - "userProfileLastModifiedDate": { - "description": "The date and time that the user's profile was last modified.", + "passwordIncludeSpecialCharacter": { + "description": "When set to **true**, passwords must include a special character. The default value is `false`.\n\n**Note**: Passwords cannot include angle brackets (`<` `>`) or spaces.", "type": "string" }, - "userSettings": { - "$ref": "#/definitions/userSettingsInformation", - "description": "The collection of settings representing the actions a user can perform. See [userSettingsInformation](https://developers.docusign.com/esign-rest-api/reference/Users/Users/get#userSettingsInformation) for available settings." + "passwordIncludeUpperCase": { + "description": "When set to **true**, passwords must include an uppercase letter. The default value is `false`.", + "type": "string" }, - "userStatus": { - "description": "Status of the user's account. One of:\n\n- `ActivationRequired`\n- `ActivationSent`\n- `Active`\n- `Closed`\n- `Disabled`\n", + "passwordStrengthType": { + "description": "The type of password strength. Possible values are:\n\n- `basic`: The minimum password length is 6 characters with no other password requirements.\n- `medium`: The minimum password length is 7 characters. Passwords must also have one uppercase letter, one lowercase letter, and one number or special character.\n- `strong`: The minimum password length is 9 characters. Passwords must also have one uppercase letter, one lowercase letter, one number, and one special character.\n- `custom`: This option enables you to customize password requirements, including the following properties:\n\n - `minimumPasswordLength`\n - `minimumPasswordAgeDays`\n - `passwordIncludeDigit`\n - `passwordIncludeDigitOrSpecialCharacter`\n - `passwordIncludeLowerCase`\n - `passwordIncludeSpecialCharacter`\n - `passwordIncludeUpperCase`\n - `questionsRequired`", "type": "string" }, - "userType": { - "description": "The type of user, for example `CompanyUser`.", + "passwordStrengthTypeMetadata": { + "$ref": "#/definitions/accountPasswordStrengthType", + "description": "Metadata that indicates whether the `passwordStrengthType` property is editable.\n" + }, + "questionsRequired": { + "description": "The number of security questions required to confirm the user’s identity before the user can reset their password. The default value is `0`.", "type": "string" }, - "workAddress": { - "$ref": "#/definitions/addressInformation", - "description": "The user's physical work address." + "questionsRequiredMetadata": { + "$ref": "#/definitions/accountPasswordQuestionsRequired", + "description": "Metadata that indicates whether the `questionsRequired` property is editable.\n" } }, - "x-ds-definition-name": "userInformation", - "description": "User management", - "x-ds-category": "Users", - "x-ds-order": "10", - "x-ms-summary": "User management" + "x-ds-definition-name": "accountPasswordRules", + "description": "Contains details about the password rules for an account.", + "x-ds-category": "Accounts", + "x-ds-order": "190", + "x-ms-summary": "Contains details about the password rules for an account." }, - "UserSignatures": { + "AccountWatermarks": { "type": "object", "properties": { - "adoptedDateTime": { - "description": "The date and time on which the user adopted the signature.", + "displayAngle": { + "description": "", "type": "string" }, - "createdDateTime": { - "description": "The date and time on which the user created the signature.", + "enabled": { + "description": "", "type": "string" }, - "customField": { - "description": "Serialized information about custom eHanko stamps that have been ordered, including the order status, purchase order ID, time created, and time modified.", + "font": { + "description": "The font to be used for the tab value. Supported fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n", "type": "string" }, - "dateStampProperties": { - "$ref": "#/definitions/dateStampProperties", - "description": "Specifies the area in which a date stamp is placed. This parameter uses pixel positioning to draw a rectangle at the center of the stamp area. The stamp is superimposed on top of this central area.\n\nThis property contains the following information about the central rectangle:\n\n- `DateAreaX`: The X axis position of the top-left corner.\n- `DateAreaY`: The Y axis position of the top-left corner.\n- `DateAreaWidth`: The width of the rectangle.\n- `DateAreaHeight`: The height of the rectangle." - }, - "disallowUserResizeStamp": { - "description": "When set to **true**, the user cannot resize the stamp.", + "fontColor": { + "description": "The font color to use for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n", "type": "string" }, - "errorDetails": { - "$ref": "#/definitions/errorDetails", - "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." - }, - "externalID": { - "description": "Optionally specify an external identifier for the user's signature.", + "fontSize": { + "description": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72", "type": "string" }, - "imageBase64": { - "description": "The base64-encoded bytes of the signature image.", + "id": { + "description": "A unique ID for the Salesforce object.", "type": "string" }, - "imageType": { - "description": "The type of image. Valid values are: \n\n- `signature_image` \n- `initials_image`", + "imageBase64": { + "description": "", "type": "string" }, - "initials150ImageId": { - "description": "The ID of the user's initials image.", + "transparency": { + "description": "", "type": "string" }, - "initialsImageUri": { - "description": "Contains the URI for an endpoint that you can use to retrieve the initials image.", + "watermarkText": { + "description": "", "type": "string" + } + }, + "x-ds-definition-name": "watermark", + "description": "", + "x-ds-category": "Accounts", + "x-ds-order": "200", + "x-ms-summary": "" + }, + "PaymentGatewayAccounts": { + "type": "object", + "properties": { + "allowCustomMetadata": { + "description": "When **true**, the sender can pass custom metadata about the payment to the payment gateway. You pass in this metadata on an EnvelopeRecipientTab, in the `customMetadata` property under `paymentDetails`. \n\nFor example, this property is set to **true** for the Authorize.net gateway by default. As a result, the extra metadata that you send displays for the Authorize.net transaction in the merchant gateway portal under **Description**.\n\n**Note**: This property is read only and cannot be changed.", + "type": "boolean" }, - "isDefault": { - "description": "Boolean that specifies whether the signature is the default signature for the user.", - "type": "string" + "config": { + "$ref": "#/definitions/paymentGatewayAccountSetting", + "description": "This property contains metadata about the payment gateway account's configuration such as the API key, `userId`, and `merchantId` details." }, - "lastModifiedDateTime": { - "description": "The date and time on which the signature was last modified.", + "displayName": { + "description": "A user-defined name for a connected gateway account.\n\nThis name is used in the Admin panel in the list of connected accounts and in Tagger in the payment gateway selector.\n\nThe human-readable version of `paymentGatewayAccountId`.", "type": "string" }, - "nrdsId": { - "description": "The National Association of Realtors (NAR) membership ID for a user who is a realtor.", + "isEnabled": { + "description": "When **true**, the payment gateway account is enabled.", "type": "string" }, - "nrdsLastName": { - "description": "The realtor's last name.", + "isLegacy": { + "description": "Reserved for DocuSign.", "type": "string" }, - "nrdsStatus": { - "description": "The realtor's NAR membership status. The value `active` verifies that the user is a current NAR member. Valid values are:\n\n- `Active`\n- `Inactive`\n- `Terminate`\n- `Provisional`\n- `Deceased`\n- `Suspend`\n- `Unknown`", + "lastModified": { + "description": "The UTC DateTime that the payment gateway account was last updated.", "type": "string" }, - "phoneticName": { - "description": "The phonetic spelling of the `signatureName`.", + "paymentGateway": { + "description": "Payment gateway used by the connected gateway account.\nThis is the name used by the API.\nFor a human-readable version use `paymentGatewayDisplayName`.\n\nPossible values are:\n\n* `Stripe`\n* `Braintree`\n* `AuthorizeDotNet`", "type": "string" }, - "signature150ImageId": { - "description": "The ID of the user's signature image.", + "paymentGatewayAccountId": { + "description": "A GUID that identifies the payment gateway account. For a human-readable version use `displayName`.", "type": "string" }, - "signatureFont": { - "description": "The font type for the signature if the signature is not drawn. The supported font types are:\n\n- `7_DocuSign`\n- `1_DocuSign`\n- `6_DocuSign`\n- `8_DocuSign`\n- `3_DocuSign`\n- `Mistral`\n- `4_DocuSign`\n- `2_DocuSign`\n- `5_DocuSign`\n- `Rage Italic`\n", + "paymentGatewayDisplayName": { + "description": "The display name of the payment gateway that the connected gateway account uses.\nThis is the human-readable version of `paymentGateway`.\n\nPossible values are:\n\n* Stripe\n* Braintree\n* Authorize.Net", "type": "string" }, - "signatureId": { - "description": "The ID associated with the signature name. You can use this property in the URI in place of the signature name. This enables the use of special characters (such as \"&\", \"<\", and \">\") in a signature name.\n\n**Note**: When you update a signature, its signature ID might change. In that case you need to use `signatureName` to get the new `signatureId`.", - "type": "string" + "payPalLegacySettings": { + "$ref": "#/definitions/payPalLegacySettings", + "description": "Reserved for DocuSign." }, - "signatureImageUri": { - "description": "An endpoint URI that you can use to retrieve the user's signature image.", - "type": "string" + "supportedCurrencies": { + "description": "A list of ISO 4217 currency codes for the currencies that the payment gateway account supports.\n\nExamples: \n\n- `USD`\n- `CAD`\n- `EUR`\n- `HKD`", + "type": "array", + "items": { + "type": "string" + } }, - "signatureInitials": { - "description": " The initials associated with the signature.", - "type": "string" + "supportedPaymentMethods": { + "description": "An array of paymentMethodWithOptions objects that specify the payment methods that are available for the gateway.", + "type": "array", + "items": { + "type": "string" + } }, - "signatureName": { - "description": "Specifies the user's signature name.", - "type": "string" + "supportedPaymentMethodsWithOptions": { + "description": "An array of `paymentMethodWithOptions` objects that specify the payment methods that are available for the gateway, as well as the payment options that are compatible with each payment method.", + "type": "array", + "items": { + "$ref": "#/definitions/paymentMethodWithOptions" + } }, - "signatureRights": { - "description": "The rights that the user has to the signature. Valid values are:\n\n- `none`\n- `read`\n- `admin`", + "zeroDecimalCurrencies": { + "description": "", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ds-definition-name": "paymentGatewayAccount", + "description": "Information about a connected payment gateway account.", + "x-ds-category": "Payments", + "x-ds-order": "210", + "x-ms-summary": "Information about a connected payment gateway account." + }, + "NotaryJournals": { + "type": "object", + "properties": { + "createdDate": { + "description": "The creation date of the account in UTC timedate format.", "type": "string" }, - "signatureType": { - "description": "Specifies the type of signature.", + "documentName": { + "description": "", "type": "string" }, - "stampFormat": { - "description": "The format of the stamp. Valid values are:\n\n- `NameHanko`: The stamp represents only the signer's name.\n- `NameDateHanko`: The stamp represents the signer's name and the date. ", - "type": "string" + "jurisdiction": { + "$ref": "#/definitions/jurisdiction", + "description": "" }, - "stampImageUri": { - "description": "The URL for retrieving the image of the user's stamp.", + "notaryJournalId": { + "description": "", "type": "string" }, - "stampSizeMM": { - "description": "The physical height of the stamp image (in millimeters) that the stamp vendor recommends for displaying the image in PDF documents.", - "type": "string" + "notaryJournalMetaData": { + "$ref": "#/definitions/notaryJournalMetaData", + "description": "" }, - "stampType": { - "description": "If the recipient signs by using a personal stamp that is representative of their signature, this property specifies the stamp type.", + "signerName": { + "description": "The in-person signer's full legal name.\n\nRequired when `inPersonSigningType` is `inPersonSigner`.\nFor eNotary flow, use `name` instead.\n\nMaximum Length: 100 characters.\n", "type": "string" } }, - "x-ds-definition-name": "userSignature", - "description": "Users' signatures", - "x-ds-category": "Users", - "x-ds-order": "40", - "x-ms-summary": "Users' signatures" + "x-ds-definition-name": "notaryJournal", + "description": "", + "x-ds-category": "Envelopes", + "x-ds-order": "220", + "x-ms-summary": "" }, - "Contacts": { + "IdentityVerifications": { "type": "object", "properties": { - "cloudProvider": { - "description": "", - "type": "string" - }, - "cloudProviderContainerId": { - "description": "", - "type": "string" - }, - "contactId": { - "description": "The unique identifier of a person in the contacts address book.", - "type": "string" - }, - "contactPhoneNumbers": { - "description": "", + "identityVerification": { + "description": " \n", "type": "array", "items": { - "$ref": "#/definitions/contactPhoneNumber" + "$ref": "#/definitions/accountIdentityVerificationWorkflow" } - }, - "contactUri": { - "description": "", - "type": "string" - }, - "emails": { - "description": "", + } + }, + "x-ds-definition-name": "accountIdentityVerificationResponse", + "description": "Identity Verification enables you to verify a signer's identity before they can access a document. The `IdentityVerifications` resource provides a method that enables you to list the workflows that are available to an account.", + "x-ds-category": "Accounts", + "x-ds-order": "30", + "x-ms-summary": "Identity Verification enables you to verify a signer's identity before they can access a document. The `IdentityVerifications` resource provides a method that enables you to list the workflows that are available to an account." + }, + "EnvelopeDocumentHtmlDefinitions": { + "type": "object", + "properties": { + "htmlDefinitions": { + "description": "Holds the properties that define how to generate the responsive-formatted HTML for the document.", "type": "array", "items": { - "type": "string" + "$ref": "#/definitions/documentHtmlDefinitionOriginal" } - }, - "errorDetails": { - "$ref": "#/definitions/errorDetails", - "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." - }, - "isOwner": { - "description": "", - "type": "boolean" - }, - "name": { - "description": "", - "type": "string" - }, - "organization": { - "description": "", - "type": "string" - }, - "shared": { - "description": "When set to **true**, this custom tab is shared.", - "type": "string" - }, - "signingGroup": { - "description": "", - "type": "string" - }, - "signingGroupName": { - "description": "The display name for the signing group. \n\nMaximum Length: 100 characters. ", - "type": "string" } }, - "x-ds-definition-name": "contact", + "x-ds-definition-name": "documentHtmlDefinitionOriginals", "description": "", - "x-ds-category": "Users", - "x-ds-order": "50", + "x-ds-category": "Envelopes", + "x-ds-order": "220", "x-ms-summary": "" }, - "EnvelopeAttachments": { + "DocumentResponsiveHtmlPreview": { "type": "object", "properties": { - "accessControl": { - "description": "Valid values are `sender` and `senderAndAllRecipients`.", - "type": "string" - }, - "attachmentId": { - "description": "The unique identifier for the attachment.", - "type": "string" - }, - "attachmentType": { - "description": "Specifies the type of the attachment for the recipient. Possible values are:\n\n- `.htm`\n- `.xml`", - "type": "string" - }, - "errorDetails": { - "$ref": "#/definitions/errorDetails", - "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." - }, - "label": { - "description": "A label for the attachment. Potential values include: \n\n- `guidedForm`: [Guided forms](https://www.docusign.com/products/guided-forms) provide a step-by-step, mobile-ready experience to help signers easily complete long or complex forms.\n- `eventNotifications`: A list of envelope-level event statuses that trigger Connect to send updates to the endpoint specified in the `url` property. ", - "type": "string" - }, - "name": { - "description": "The name of the attachment.", - "type": "string" + "htmlDefinitions": { + "description": "Holds the properties that define how to generate the responsive-formatted HTML for the document.", + "type": "array", + "items": { + "type": "string" + } } }, - "x-ds-definition-name": "envelopeAttachment", + "x-ds-definition-name": "documentHtmlDefinitions", + "description": "This resource is used to create a responsive preview of a specific document.", + "x-ds-category": "Envelopes", + "x-ds-order": "230", + "x-ms-summary": "This resource is used to create a responsive preview of a specific document." + }, + "EnvelopeHtmlDefinitions": { + "type": "object", + "properties": { + "htmlDefinitions": { + "description": "Holds the properties that define how to generate the responsive-formatted HTML for the document.", + "type": "array", + "items": { + "$ref": "#/definitions/documentHtmlDefinitionOriginal" + } + } + }, + "x-ds-definition-name": "documentHtmlDefinitionOriginals", "description": "", "x-ds-category": "Envelopes", - "x-ds-order": "60", + "x-ds-order": "240", "x-ms-summary": "" }, - "AccountPermissionProfiles": { + "ResponsiveHtmlPreview": { "type": "object", "properties": { - "modifiedByUsername": { - "description": "The username of the user who last modified the permission profile.", - "type": "string" - }, - "modifiedDateTime": { - "description": "The date and time when the permission profile was last modified.", - "type": "string" - }, - "permissionProfileId": { - "description": "The ID of the permission profile. Possible values include:\n\n- `2301416` (for the `DocuSign Viewer` profile)\n- `2301415` (for the `DocuSign Sender` profile)\n- `2301414` (for the `Account Administrator` profile)\n\nIn addition, any custom permission profiles associated with your account will have an automatically generated `permissionProfileId`.", - "type": "string" - }, - "permissionProfileName": { - "description": "The name of the account permission profile. \n\nExample: `Account Administrator`", - "type": "string" - }, - "settings": { - "$ref": "#/definitions/accountRoleSettings", - "description": "This object specifies the permissions that are associated with the account permission profile." - }, - "userCount": { - "description": "The total number of users in the group associated with the account permission profile.", - "type": "string" - }, - "users": { - "description": "A list of user objects containing information about the users who are associated with the account permission profile.", + "htmlDefinitions": { + "description": "Holds the properties that define how to generate the responsive-formatted HTML for the document.", "type": "array", "items": { - "$ref": "#/definitions/Users" + "type": "string" } } }, - "x-ds-definition-name": "permissionProfile", - "description": "The AccountPermissionProfiles resource provides methods that allow you to manage permission profiles for groups of account users.", - "x-ds-category": "Accounts", - "x-ds-order": "70", - "x-ms-summary": "The AccountPermissionProfiles resource provides methods that allow you to manage permission profiles for groups of account users." + "x-ds-definition-name": "documentHtmlDefinitions", + "description": "This resource is used to create a responsive preview of all of the documents in an envelope.", + "x-ds-category": "Envelopes", + "x-ds-order": "250", + "x-ms-summary": "This resource is used to create a responsive preview of all of the documents in an envelope." }, - "PowerForms": { + "TemplateDocumentResponsiveHtmlPreview": { "type": "object", "properties": { - "createdBy": { - "description": "The id of the user who created the PowerForm. This property is returned in a response only when you set the `include_created_by` query parameter to **true**.", - "type": "string" - }, - "createdDateTime": { - "description": "The date and time that the PowerForm was created.", - "type": "string" - }, - "emailBody": { - "description": "For a PowerForm that is sent by email, this is the body of the email message sent to the recipients.\n\nMaximum length: 10000 characters.", - "type": "string" - }, - "emailSubject": { - "description": "Sets the envelope name for the envelopes that the PowerForm generates. One option is to make this property the same as the subject from the template. \n\nYou can customize the subject line to include a recipient's name or email address by using merge fields. For information about adding merge fields to the email subject, see [Template Email Subject Merge Fields](https://developers.docusign.com/esign-rest-api/reference/Templates/Templates/create#template-email-subject-merge-fields).\n", - "type": "string" - }, - "envelopes": { - "description": "An array of envelope objects that contain information about the envelopes that are associated with the PowerForm.", + "htmlDefinitions": { + "description": "Holds the properties that define how to generate the responsive-formatted HTML for the document.", "type": "array", "items": { - "$ref": "#/definitions/Envelopes" + "type": "string" } - }, - "errorDetails": { - "$ref": "#/definitions/errorDetails", - "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." - }, - "instructions": { - "description": "The instructions that display on the landing page for the first recipient. These instructions are important if the recipient accesses the PowerForm by a method other than email. When you include instructions, they display as an introduction after the recipient accesses the PowerForm.", - "type": "string" - }, - "isActive": { - "description": "When **true**, indicates that the PowerForm is active and can be sent to recipients. This is the default value.\n\n\nWhen **false**, the PowerForm cannot be emailed or accessed by a recipient, even if they arrive at the PowerForm URL. \n\nIf a recipient attempts to sign an inactive PowerForm, an error message informs the recipient that the document is not active and suggests that they contact the sender.", - "type": "string" - }, - "lastUsed": { - "description": "The date and time that the PowerForm was last used.", - "type": "string" - }, - "limitUseInterval": { - "description": "The length of time before the same recipient can sign the same PowerForm again. This property is used in combination with the `limitUseIntervalUnits` property.", - "type": "string" - }, - "limitUseIntervalEnabled": { - "description": "When **true**, the `limitUseInterval` is enabled.", - "type": "string" - }, - "limitUseIntervalUnits": { - "description": "The units associated with the `limitUseInterval`. Valid values are:\n\n- `minutes`\n- `hours`\n- `days`\n- `weeks`\n- `months`\n\nFor example, to limit a recipient to signing once per year, set the `limitUseInterval` to 365 and the `limitUseIntervalUnits` to `days`.\n", - "type": "string" - }, - "maxUseEnabled": { - "description": "The maximum number of times that the PowerForm can be used. Setting this property can limit your account's exposure to excessive envelope usage. Each time a recipient clicks **Begin Signing** for a document, the number of uses remaining is reduced by one. If a recipient attempts to sign a PowerForm that has reached the maximum number of uses, an error message informs the recipient that the document is not available for signing.\n\n**Note**: A PowerForm Administrator can edit this number at any time after the PowerForm is created, even if it has reached a previous use limit.", - "type": "string" - }, - "name": { - "description": "The name of the PowerForm.", - "type": "string" - }, - "powerFormId": { - "description": "The id of the PowerForm.", - "type": "string" - }, - "powerFormUrl": { - "description": "The URL for the PowerForm.", + } + }, + "x-ds-definition-name": "documentHtmlDefinitions", + "description": "This resource is used to create a responsive preview of a specific template document.", + "x-ds-category": "Templates", + "x-ds-order": "280", + "x-ms-summary": "This resource is used to create a responsive preview of a specific template document." + }, + "TemplateResponsiveHtmlPreview": { + "type": "object", + "properties": { + "htmlDefinitions": { + "description": "Holds the properties that define how to generate the responsive-formatted HTML for the document.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ds-definition-name": "documentHtmlDefinitions", + "description": "This resource is used to create a responsive preview of all of the documents associated with a template.", + "x-ds-category": "Templates", + "x-ds-order": "290", + "x-ms-summary": "This resource is used to create a responsive preview of all of the documents associated with a template." + }, + "TemplateDocumentHtmlDefinitions": { + "type": "object", + "properties": { + "htmlDefinitions": { + "description": "Holds the properties that define how to generate the responsive-formatted HTML for the document.", + "type": "array", + "items": { + "$ref": "#/definitions/documentHtmlDefinitionOriginal" + } + } + }, + "x-ds-definition-name": "documentHtmlDefinitionOriginals", + "description": "", + "x-ds-category": "Templates", + "x-ds-order": "300", + "x-ms-summary": "" + }, + "TemplateHtmlDefinitions": { + "type": "object", + "properties": { + "htmlDefinitions": { + "description": "Holds the properties that define how to generate the responsive-formatted HTML for the document.", + "type": "array", + "items": { + "$ref": "#/definitions/documentHtmlDefinitionOriginal" + } + } + }, + "x-ds-definition-name": "documentHtmlDefinitionOriginals", + "description": "", + "x-ds-category": "Templates", + "x-ds-order": "310", + "x-ms-summary": "" + }, + "EnvelopeTransferRules": { + "type": "object", + "properties": { + "endPosition": { + "description": "The last index position in the result set. ", "type": "string" }, - "recipients": { - "description": "An array of `powerFormRecipient` objects.\n\n**Note**: For self-service documents where you do not know who the recipients are in advance, you can enter generic information for the `role` property and leave other details (such as `name` and `email`) blank.", + "envelopeTransferRules": { + "description": "Contains information about a specific envelope transfer rule.", "type": "array", "items": { - "$ref": "#/definitions/powerFormRecipient" + "$ref": "#/definitions/envelopeTransferRule" } }, - "senderName": { - "description": "The name of the sender. \n\n**Note**: The default sender for a PowerForm is the PowerForm Administrator who created it.", + "nextUri": { + "description": "The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. ", "type": "string" }, - "senderUserId": { - "description": "The id of the sender.", + "previousUri": { + "description": "The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. ", "type": "string" }, - "signingMode": { - "description": "The signing method to use. Valid values are:\n \n- `email`: This mode verifies the recipient's identity by using email authentication before the recipient can sign a document.\n\n- `direct`: This mode does not require any verification. We recommend that you use this signing method only when another form of authentication is in use.\n\n**Note**: In the account settings, `enablePowerFormDirect` must be **true** to use `direct` as the `signingMode`.\n\nFor more information about signing modes, see the [overview of the Create method](https://developers.docusign.com/esign-rest-api/reference/PowerForms/PowerForms/create).", + "resultSetSize": { + "description": "The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`.", "type": "string" }, - "templateId": { - "description": "The id of the template used to create the PowerForm.", + "startPosition": { + "description": "The starting index position of the current result set.", "type": "string" }, - "templateName": { - "description": "The name of the template used to create the PowerForm.", + "totalSetSize": { + "description": "The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`.", "type": "string" + } + }, + "x-ds-definition-name": "envelopeTransferRuleInformation", + "description": "This resource provides methods that enable account administrators to create and manage envelope transfer rules.", + "x-ds-category": "Envelopes", + "x-ds-order": "120", + "x-ms-summary": "This resource provides methods that enable account administrators to create and manage envelope transfer rules." + }, + "NotificationDefaults": { + "type": "object", + "properties": { + "apiEmailNotifications": { + "$ref": "#/definitions/notificationDefaultSettings", + "description": "The default notification settings for envelopes sent by using the console." }, - "timesUsed": { - "description": "The number of times the PowerForm has been used. ", - "type": "string" + "emailNotifications": { + "$ref": "#/definitions/notificationDefaultSettings", + "description": "The default notification settings for envelopes sent by using the API." + } + }, + "x-ds-definition-name": "notificationDefaults", + "description": "The `NotificationDefaults` resource provides methods that enable you to manage the default notifications for envelopes.", + "x-ds-category": "Accounts", + "x-ds-order": "120", + "x-ms-summary": "The `NotificationDefaults` resource provides methods that enable you to manage the default notifications for envelopes." + }, + "BulkSend": { + "type": "object", + "properties": { + "bulkCopies": { + "description": "An array of `bulkCopy` objects. Each object represents an instance or copy of an envelope and contains details such as the recipient, custom fields, tabs, and other information.", + "type": "array", + "items": { + "$ref": "#/definitions/bulkSendingCopy" + } }, - "uri": { - "description": "The URI for the PowerForm.", + "listId": { + "description": "The GUID of the bulk send list. This property is created after you post a new bulk send list.", "type": "string" }, - "usesRemaining": { - "description": "The number of times that the PowerForm can still be used. If no use limit is set, the value is `Unlimited`. ", + "name": { + "description": "The name of the bulk send list.", "type": "string" } }, - "x-ds-definition-name": "powerForm", - "description": "The PowerForms resource enables you to create fillable forms that you can email or make available for self service on the web.", - "x-ds-category": "PowerForms", - "x-ds-order": "80", - "x-ms-summary": "The PowerForms resource enables you to create fillable forms that you can email or make available for self service on the web." + "x-ds-definition-name": "bulkSendingList", + "description": "The bulk send list resource provides methods that enable you to create and manage bulk sending lists, which you can use to send multiple copies of an envelope in a single batch. \n\n**Note**: The Bulk Send feature is only available on Business Pro plans that are using EasySign.", + "x-ds-category": "BulkEnvelopes", + "x-ds-order": "120", + "x-ms-summary": "The bulk send list resource provides methods that enable you to create and manage bulk sending lists, which you can use to send multiple copies of an envelope in a single batch. \n\n**Note**: The Bulk Send feature is only available on Business Pro plans that are using EasySign." }, - "PowerFormData": { + "BCCEmailArchive": { "type": "object", "properties": { - "envelopeId": { - "description": "The envelope ID of the envelope status that failed to post.", - "type": "string" - }, - "recipients": { - "description": "An array of powerform recipients.", + "bccEmailArchiveHistory": { + "description": "A list of changes to the BCC email archive configuration.", "type": "array", "items": { - "$ref": "#/definitions/powerFormFormDataRecipient" + "$ref": "#/definitions/bccEmailArchiveHistory" } + }, + "endPosition": { + "description": "The last index position in the result set. ", + "type": "string" + }, + "nextUri": { + "description": "The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. ", + "type": "string" + }, + "previousUri": { + "description": "The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. ", + "type": "string" + }, + "resultSetSize": { + "description": "The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`.", + "type": "string" + }, + "startPosition": { + "description": "The starting index position of the current result set.", + "type": "string" + }, + "totalSetSize": { + "description": "The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`.", + "type": "string" } }, - "x-ds-definition-name": "powerFormFormDataEnvelope", - "description": "Data that recipients have entered in PowerForm fields.", - "x-ds-category": "PowerForms", - "x-ds-order": "90", - "x-ms-summary": "Data that recipients have entered in PowerForm fields." + "x-ds-definition-name": "bccEmailArchiveHistoryList", + "description": "The `EmailArchive` resource provides methods for managing your email archive configuration, which consists of the BCC email address or addresses that you want to use to archive DocuSign emails. Each account can use up to five BCC email addresses for archiving purposes.\n", + "x-ds-category": "EmailArchive", + "x-ds-order": "120", + "x-ms-summary": "The `EmailArchive` resource provides methods for managing your email archive configuration, which consists of the BCC email address or addresses that you want to use to archive DocuSign emails. Each account can use up to five BCC email addresses for archiving purposes.\n" }, - "AccountTabSettings": { + "TabsBlob": { "type": "object", "properties": { "allowTabOrder": { - "description": "Boolean that specifies whether the order for tabs used in signing can be set for the account.", + "description": "When set to **true**, account users can set a tab order for the signing process.\n\n**Note**: Only Admin users can change this setting.", "type": "string" }, "allowTabOrderMetadata": { @@ -53998,7 +66278,7 @@ "description": "Metadata that indicates whether the `allowTabOrder` property is editable.\n" }, "approveDeclineTabsEnabled": { - "description": "Boolean that specifies whether the approve and decline fields for use in the tagger and when sending envelopes are enabled.", + "description": "When **true**, approve and decline tabs are enabled.", "type": "string" }, "approveDeclineTabsMetadata": { @@ -54006,7 +66286,7 @@ "description": "Metadata that indicates whether the `approveDeclineTabs` property is editable.\n" }, "calculatedFieldsEnabled": { - "description": "Boolean that specifies whether calculated fields are enabled for the account.", + "description": "When **true**, [calculated fields](https://support.docusign.com/en/guides/ndse-user-guide-calculated-fields) are enabled for tabs.", "type": "string" }, "calculatedFieldsMetadata": { @@ -54014,15 +66294,15 @@ "description": "Metadata that indicates whether the `calculatedFields` property is editable.\n" }, "checkboxTabsEnabled": { - "description": "Boolean that specifies whether the checkbox field can be used in the tagger and for sending envelopes.", + "description": "When **true**, checkbox tabs are enabled.", "type": "string" }, "checkBoxTabsMetadata": { "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `checkboxTabsEnabled` property is editable." + "description": "Metadata that indicates whether the `checkBoxTabs` property is editable." }, "dataFieldRegexEnabled": { - "description": "Boolean that specifies whether the account can add regular expression (RegEx) field validation to a text field during sending, which will constrict what data the signer can enter.", + "description": "When **true**, regular expressions are enabled for tabs that contain data fields.", "type": "string" }, "dataFieldRegexMetadata": { @@ -54030,23 +66310,31 @@ "description": "Metadata that indicates whether the `dataFieldRegex` property is editable.\n" }, "dataFieldSizeEnabled": { - "description": "Boolean that specifies whether the account enables a sender to change the data field size during sending.", + "description": "When **true**, setting character limits for input fields is enabled.", "type": "string" }, "dataFieldSizeMetadata": { "$ref": "#/definitions/settingsMetadata", "description": "Metadata that indicates whether the `dataFieldSize` property is editable.\n" }, + "drawTabsEnabled": { + "description": "", + "type": "string" + }, + "drawTabsMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "" + }, "firstLastEmailTabsEnabled": { - "description": "Boolean that specifies whether an account can use the first, last, and email tags when sending an envelope.", + "description": "Reserved for DocuSign.", "type": "string" }, "firstLastEmailTabsMetadata": { "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `firstLastEmailTabs` property is editable.\n" + "description": "Reserved for DocuSign." }, "listTabsEnabled": { - "description": "Boolean that specifies whether the account can use the list field in the tagger and when sending envelopes.", + "description": "When **true**, list tabs are enabled.", "type": "string" }, "listTabsMetadata": { @@ -54054,15 +66342,23 @@ "description": "Metadata that indicates whether the `listTabs` property is editable.\n" }, "noteTabsEnabled": { - "description": "Boolean that specifies whether the account can use the note field in the tagger and when sending envelopes.", + "description": "When **true**, note tabs are enabled.", "type": "string" }, "noteTabsMetadata": { "$ref": "#/definitions/settingsMetadata", "description": "Metadata that indicates whether the `noteTabs` property is editable.\n" }, + "prefillTabsEnabled": { + "description": "", + "type": "string" + }, + "prefillTabsMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "" + }, "radioTabsEnabled": { - "description": "Boolean that specifies whether the account can use the radio button field in the tagger and when sending envelopes.", + "description": "When **true**, radio button tabs are enabled.", "type": "string" }, "radioTabsMetadata": { @@ -54070,7 +66366,7 @@ "description": "Metadata that indicates whether the `radioTabs` property is editable.\n" }, "savingCustomTabsEnabled": { - "description": "Boolean that specifies whether an account can create and save custom tabs.", + "description": "When **true**, saving custom tabs is enabled.", "type": "string" }, "savingCustomTabsMetadata": { @@ -54078,15 +66374,15 @@ "description": "Metadata that indicates whether the `savingCustomTabs` property is editable.\n" }, "senderToChangeTabAssignmentsEnabled": { - "description": "Boolean that specifies whether a sender can change the recipient to which an existing tag is assigned.", + "description": "Reserved for DocuSign.", "type": "string" }, "senderToChangeTabAssignmentsMetadata": { "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `senderToChangeTabAssignments` property is editable.\n" + "description": "Reserved for DocuSign." }, "sharedCustomTabsEnabled": { - "description": "Boolean that specifies whether an account member can share custom tabs to other members of the account.", + "description": "When **true**, shared custom tabs are enabled.", "type": "string" }, "sharedCustomTabsMetadata": { @@ -54094,7 +66390,7 @@ "description": "Metadata that indicates whether the `sharedCustomTabs` property is editable.\n" }, "tabDataLabelEnabled": { - "description": "Boolean that specifies whether an account admin can change the default (generated) name for a field.", + "description": "When set to **true**, [data\nlabels](https://support.docusign.com/en/videos/Data-Labels) are enabled.\n\n**Note**: Only Admin users can change this setting.\n", "type": "string" }, "tabDataLabelMetadata": { @@ -54102,15 +66398,15 @@ "description": "Metadata that indicates whether the `tabDataLabel` property is editable.\n" }, "tabLocationEnabled": { - "description": "Boolean that specifies whether an account admin can change the location of a tab by editing x,y props for a field.", + "description": "Reserved for DocuSign.", "type": "string" }, "tabLocationMetadata": { "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `tabLocation` property is editable.\n" + "description": "Reserved for DocuSign." }, "tabLockingEnabled": { - "description": "Boolean that specifies whether an account admin can lock the properties of a field.", + "description": "When set to **true**, tab locking is enabled.\n\n**Note**: Only Admin users can change this setting.\n", "type": "string" }, "tabLockingMetadata": { @@ -54118,804 +66414,451 @@ "description": "Metadata that indicates whether the `tabLocking` property is editable.\n" }, "tabScaleEnabled": { - "description": "Boolean that specifies whether an account admin can scale the size of a field.", + "description": "Reserved for DocuSign.", "type": "string" }, "tabScaleMetadata": { "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `tabScale` property is editable.\n" - }, - "tabTextFormattingEnabled": { - "description": "Boolean that specifies whether an account admin can change the text formatting (font, font size, bold, etc) of a field.", - "type": "string" - }, - "tabTextFormattingMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `tabTextFormatting` property is editable.\n" - }, - "textTabsEnabled": { - "description": "Boolean that specifies whether the text field can be used in the tagger and for sending envelopes.", - "type": "string" - }, - "textTabsMetadata": { - "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `textTabs` property is editable.\n" - } - }, - "x-ds-definition-name": "tabAccountSettings", - "description": "A complex object that configures tab settings for the account.", - "x-ds-category": "Accounts", - "x-ds-order": "100", - "x-ms-summary": "A complex object that configures tab settings for the account." - }, - "ENoteConfigurations": { - "type": "object", - "properties": { - "connectConfigured": { - "description": "", - "type": "string" - }, - "eNoteConfigured": { - "description": "", - "type": "string" - }, - "organization": { - "description": "", - "type": "string" - }, - "password": { - "description": "The user's encrypted password hash.", - "type": "string" - }, - "userName": { - "description": "The name of the user.", - "type": "string" - } - }, - "x-ds-definition-name": "eNoteConfiguration", - "description": "", - "x-ds-category": "Accounts", - "x-ds-order": "110", - "x-ms-summary": "" - }, - "WorkspaceItems": { - "description": "", - "type": "object", - "properties": { - "callerAuthorization": { - "$ref": "#/definitions/workspaceUserAuthorization", - "description": "" - }, - "contentType": { - "description": "", - "type": "string" - }, - "created": { - "description": "The UTC DateTime when the workspace item was created.", - "type": "string" - }, - "createdById": { - "description": "", - "type": "string" - }, - "createdByInformation": { - "$ref": "#/definitions/workspaceUser", - "description": "" - }, - "extension": { - "description": "", - "type": "string" - }, - "fileSize": { - "description": "", - "type": "string" - }, - "fileUri": { - "description": "", - "type": "string" - }, - "id": { - "description": "A unique ID for the Salesforce object.", - "type": "string" - }, - "isPublic": { - "description": " If true, this supersedes need for bit mask permission with workspaceUserAuthorization", - "type": "string" - }, - "lastModified": { - "description": "Utc date and time the comment was last updated (can only be done by creator.)", - "type": "string" - }, - "lastModifiedById": { - "description": "Utc date and time the comment was last updated (can only be done by creator)", - "type": "string" - }, - "lastModifiedByInformation": { - "$ref": "#/definitions/workspaceUser", - "description": "" - }, - "name": { - "description": "A simple string description of the item, such as a file name or a folder name.", - "type": "string" - }, - "pageCount": { - "description": "An integer value specifying the number of document pages in the template. ", - "type": "string" - }, - "parentFolderId": { - "description": "The ID of the parent folder. This is the GUID of the parent folder, or the special value 'root' for the root folder.", - "type": "string" - }, - "parentFolderUri": { - "description": "", - "type": "string" - }, - "sha256": { - "description": "", - "type": "string" - }, - "thumbHeight": { - "description": "", - "type": "string" - }, - "thumbnail": { - "$ref": "#/definitions/page", - "description": "" - }, - "thumbWidth": { - "description": "", - "type": "string" - }, - "type": { - "description": "The type of the workspace item. Valid values are file, folder.", - "type": "string" - }, - "uri": { - "description": "URI containing the user ID.", - "type": "string" - }, - "userAuthorization": { - "$ref": "#/definitions/workspaceUserAuthorization", - "description": "" - } - }, - "x-ds-definition-name": "workspaceItem", - "x-ds-category": "Workspaces", - "x-ds-order": "130", - "x-ms-summary": "" - }, - "Workspaces": { - "description": "", - "type": "object", - "properties": { - "billableAccountId": { - "description": "", - "type": "string" - }, - "callerInformation": { - "$ref": "#/definitions/workspaceUser", - "description": "" - }, - "created": { - "description": "The UTC DateTime when the workspace user authorization was created.", - "type": "string" - }, - "createdByInformation": { - "$ref": "#/definitions/workspaceUser", - "description": "" - }, - "lastModified": { - "description": "Utc date and time the comment was last updated (can only be done by creator.)", - "type": "string" - }, - "lastModifiedByInformation": { - "$ref": "#/definitions/workspaceUser", - "description": "" - }, - "settings": { - "$ref": "#/definitions/workspaceSettings", - "description": "" - }, - "status": { - "description": "The status of the item.", - "type": "string" - }, - "workspaceBaseUrl": { - "description": "The relative URL that may be used to access the workspace.", - "type": "string" - }, - "workspaceDescription": { - "description": "Text describing the purpose of the workspace.", - "type": "string" - }, - "workspaceId": { - "description": "The id of the workspace, always populated.", - "type": "string" - }, - "workspaceName": { - "description": "The name of the workspace.", - "type": "string" - }, - "workspaceUri": { - "description": "The relative URI that may be used to access the workspace.", - "type": "string" - } - }, - "x-ds-definition-name": "workspace", - "x-ds-category": "Workspaces", - "x-ds-order": "140", - "x-ms-summary": "" - }, - "ChunkedUploads": { - "type": "object", - "properties": { - "checksum": { - "description": "A 64-byte, Secure Hash Algorithm 256 (SHA256) checksum that the caller computes across the entirety of the original content that has been uploaded to the chunked upload. DocuSign compares this value to its own computation. If the two values are not equal, the original content and received content are not the same and the commit action is refused.", - "type": "string" - }, - "chunkedUploadId": { - "description": "The id of the chunked upload. ", - "type": "string" - }, - "chunkedUploadParts": { - "description": "A list of the parts that compose the chunked upload, including their byte sizes. The list must be contiguous before you can commit the chunked upload.", - "type": "array", - "items": { - "$ref": "#/definitions/chunkedUploadPart" - } - }, - "chunkedUploadUri": { - "description": "The URI that you use to reference the chunked upload in other API requests, such as envelope document and envelope attachment requests. ", - "type": "string" - }, - "committed": { - "description": "When **true**, the chunked upload has been committed. A committed chunked upload can no longer receive any additional parts and is ready for use within other API requests. ", - "type": "string" - }, - "expirationDateTime": { - "description": "The UTC time at which the chunked upload expires and is no longer addressable. ", - "type": "string" - }, - "maxChunkedUploadParts": { - "description": "The maximum number of parts allowed for a chunked upload. This value is configurable per DocuSign environment, account, or integrator. The default value is 128. The maximum possible value is 256. \n", - "type": "string" - }, - "maxTotalSize": { - "description": "The maximum total size allowed for a chunked upload. This value is configured per DocuSign environment, account, or integrator. The default value is 50 MB.", - "type": "string" - }, - "totalSize": { - "description": "The total size of the parts of the chunked upload.\n\n**Note**: When a chunked upload is used as an envelope document, it is subject to the PDF size limit (25 MB) and page count limit that apply to all envelope documents.", - "type": "string" - } - }, - "x-ds-definition-name": "chunkedUploadResponse", - "description": "The ChunkedUploads resource provides methods to complete integrity checks, and to add, commit, retrieve, initiate and delete chunked uploads.", - "x-ds-category": "Envelopes", - "x-ds-order": "150", - "x-ms-summary": "The ChunkedUploads resource provides methods to complete integrity checks, and to add, commit, retrieve, initiate and delete chunked uploads." - }, - "EnvelopeFormData": { - "type": "object", - "properties": { - "emailSubject": { - "description": "The subject line of the email message that is sent to all recipients.\n\nFor information about adding merge field information to the email subject, see [Template Email Subject Merge Fields](https://developers.docusign.com/esign-rest-api/reference/Templates/Templates/create#template-email-subject-merge-fields).\n", - "type": "string" - }, - "envelopeId": { - "description": "The id of the envelope.", - "type": "string" - }, - "formData": { - "description": "An array of form data objects.", - "type": "array", - "items": { - "$ref": "#/definitions/formDataItem" - } - }, - "recipientFormData": { - "description": "An array of form data objects that are associated with specific recipients.", - "type": "array", - "items": { - "$ref": "#/definitions/recipientFormData" - } - }, - "sentDateTime": { - "description": "The date and time the envelope was sent.", - "type": "string" - }, - "status": { - "description": "The status of the envelope. Valid values are:\n\n* `sent`: The envelope is sent to the recipients. \n* `created`: The envelope is saved as a draft and can be modified and sent later.", - "type": "string" - } - }, - "x-ds-definition-name": "envelopeFormData", - "description": "This object contains the data that recipients have entered into the form fields associated with an envelope.", - "x-ds-category": "Envelopes", - "x-ds-order": "160", - "x-ms-summary": "This object contains the data that recipients have entered into the form fields associated with an envelope." - }, - "EnvelopeDocumentVisibility": { - "type": "object", - "properties": { - "documentVisibility": { - "description": "An array of `documentVisibility` objects that specifies which documents are visible to which recipients.", - "type": "array", - "items": { - "$ref": "#/definitions/documentVisibility" - } - } - }, - "x-ds-definition-name": "documentVisibilityList", - "description": "Document Visibility enables senders to control the visibility of the documents in an envelope at the recipient level. For example, if the parties associated with a legal proceeding should have access to different documents, the Document Visibility feature enables you to keep all of the documents in the same envelope and set view permissions for the documents by recipient. This functionality is enabled for envelopes and templates. It is not available for PowerForms.\n\n**Note**: Before you use Document Visibility, you should be aware of the following information:\n\n- Document Visibility must be enabled for your account by your DocuSign administrator. \n- A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. \n- When the Document Visibility setting hides a document from a recipient, the document also does not appear in the recipient's list of envelopes, documents, or page images.\n- Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all of the documents associated with the envelope or template.\n\nThe Document Visibility feature has multiple settings that specify the options that senders have when sending documents. For more information, see [Use Document Visibility to Control Recipient Access](https://support.docusign.com/en/guides/ndse-user-guide-document-visibility).", - "x-ds-category": "Envelopes", - "x-ds-order": "170", - "x-ms-summary": "Document Visibility enables senders to control the visibility of the documents in an envelope at the recipient level. For example, if the parties associated with a legal proceeding should have access to different documents, the Document Visibility feature enables you to keep all of the documents in the same envelope and set view permissions for the documents by recipient. This functionality is enabled for envelopes and templates. It is not available for PowerForms.\n\n**Note**: Before you use Document Visibility, you should be aware of the following information:\n\n- Document Visibility must be enabled for your account by your DocuSign administrator. \n- A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. \n- When the Document Visibility setting hides a document from a recipient, the document also does not appear in the recipient's list of envelopes, documents, or page images.\n- Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all of the documents associated with the envelope or template.\n\nThe Document Visibility feature has multiple settings that specify the options that senders have when sending documents. For more information, see [Use Document Visibility to Control Recipient Access](https://support.docusign.com/en/guides/ndse-user-guide-document-visibility)." - }, - "TemplateDocumentVisibility": { - "type": "object", - "properties": { - "documentVisibility": { - "description": "An array of `documentVisibility` objects that specifies which documents are visible to which recipients.", - "type": "array", - "items": { - "$ref": "#/definitions/documentVisibility" - } - } - }, - "x-ds-definition-name": "templateDocumentVisibilityList", - "description": "Document Visibility enables senders to control the visibility of the documents in an envelope at the recipient level. For example, if the parties associated with a legal proceeding should have access to different documents, the Document Visibility feature enables you to keep all of the documents in the same envelope and set view permissions for the documents by recipient. This functionality is enabled for envelopes and templates. It is not available for PowerForms.\n\n**Note**: Before you use Document Visibility, you should be aware of the following information:\n\n- Document Visibility must be enabled for your account by your DocuSign administrator. \n- A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. \n- When the Document Visibility setting hides a document from a recipient, the document also does not appear in the recipient's list of envelopes, documents, or page images.\n- Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all of the documents associated with the envelope or template.\n\nThe Document Visibility feature has multiple settings that specify the options that senders have when sending documents. For more information, see [Use Document Visibility to Control Recipient Access](https://support.docusign.com/en/guides/ndse-user-guide-document-visibility).", - "x-ds-category": "Templates", - "x-ds-order": "180", - "x-ms-summary": "Document Visibility enables senders to control the visibility of the documents in an envelope at the recipient level. For example, if the parties associated with a legal proceeding should have access to different documents, the Document Visibility feature enables you to keep all of the documents in the same envelope and set view permissions for the documents by recipient. This functionality is enabled for envelopes and templates. It is not available for PowerForms.\n\n**Note**: Before you use Document Visibility, you should be aware of the following information:\n\n- Document Visibility must be enabled for your account by your DocuSign administrator. \n- A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. \n- When the Document Visibility setting hides a document from a recipient, the document also does not appear in the recipient's list of envelopes, documents, or page images.\n- Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all of the documents associated with the envelope or template.\n\nThe Document Visibility feature has multiple settings that specify the options that senders have when sending documents. For more information, see [Use Document Visibility to Control Recipient Access](https://support.docusign.com/en/guides/ndse-user-guide-document-visibility)." - }, - "AccountPasswordRules": { - "type": "object", - "properties": { - "expirePassword": { - "description": "", - "type": "string" - }, - "expirePasswordDays": { - "description": "", - "type": "string" - }, - "expirePasswordDaysMetadata": { - "$ref": "#/definitions/accountPasswordExpirePasswordDays", - "description": "Metadata that indicates whether the `expirePasswordDays` property is editable.\n" - }, - "lockoutDurationMinutes": { - "description": "", - "type": "string" - }, - "lockoutDurationMinutesMetadata": { - "$ref": "#/definitions/accountPasswordLockoutDurationMinutes", - "description": "Metadata that indicates whether the `lockoutDurationMinutes` property is editable.\n" - }, - "lockoutDurationType": { - "description": "", - "type": "string" - }, - "lockoutDurationTypeMetadata": { - "$ref": "#/definitions/accountPasswordLockoutDurationType", - "description": "Metadata that indicates whether the `lockoutDurationType` property is editable.\n" - }, - "minimumPasswordAgeDays": { - "description": "", - "type": "string" - }, - "minimumPasswordAgeDaysMetadata": { - "$ref": "#/definitions/accountPasswordMinimumPasswordAgeDays", - "description": "Metadata that indicates whether the `minimumPasswordAgeDays` property is editable.\n" - }, - "minimumPasswordLength": { - "description": "", - "type": "string" - }, - "minimumPasswordLengthMetadata": { - "$ref": "#/definitions/accountMinimumPasswordLength", - "description": "Metadata that indicates whether the `minimumPasswordLength` property is editable.\n" - }, - "passwordIncludeDigit": { - "description": "", - "type": "string" - }, - "passwordIncludeDigitOrSpecialCharacter": { - "description": "", - "type": "string" - }, - "passwordIncludeLowerCase": { - "description": "", - "type": "string" - }, - "passwordIncludeSpecialCharacter": { - "description": "", - "type": "string" - }, - "passwordIncludeUpperCase": { - "description": "", - "type": "string" + "description": "Reserved for DocuSign." }, - "passwordStrengthType": { - "description": "", + "tabTextFormattingEnabled": { + "description": "When set to **true**, text formatting (such as font type, font size,\nfont color, bold, italic, and underline) is enabled for tabs that\nsupport formatting.\n\n**Note**: Only Admin users can change this setting.\n", "type": "string" }, - "passwordStrengthTypeMetadata": { - "$ref": "#/definitions/accountPasswordStrengthType", - "description": "Metadata that indicates whether the `passwordStrengthType` property is editable.\n" + "tabTextFormattingMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `tabTextFormatting` property is editable.\n" }, - "questionsRequired": { - "description": "", + "textTabsEnabled": { + "description": "When **true**, text tabs are enabled.", "type": "string" }, - "questionsRequiredMetadata": { - "$ref": "#/definitions/accountPasswordQuestionsRequired", - "description": "Metadata that indicates whether the `questionsRequired` property is editable.\n" + "textTabsMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `textTabs` property is editable.\n" } }, - "x-ds-definition-name": "accountPasswordRules", + "x-ds-definition-name": "tabAccountSettings", "description": "", - "x-ds-category": "Accounts", - "x-ds-order": "190", + "x-ds-category": "Envelopes", + "x-ds-order": "120", "x-ms-summary": "" }, - "AccountWatermarks": { + "Comments": { "type": "object", "properties": { - "displayAngle": { - "description": "", + "envelopeId": { + "description": "The envelope ID of the envelope status that failed to post.", "type": "string" }, - "enabled": { - "description": "", + "hmac": { + "description": "Reserved for DocuSign.", "type": "string" }, - "font": { - "description": "The font to be used for the tab value. Supported fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n", + "id": { + "description": "A unique ID for the Salesforce object.", "type": "string" }, - "fontColor": { - "description": "The font color to use for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n", + "mentions": { + "description": "An array of userIds that are mentioned directly in the body of a comment.", + "type": "array", + "items": { + "type": "string" + } + }, + "read": { + "description": "Indicates if the comment has been read by the target recipient of the comment.", + "type": "boolean" + }, + "sentByEmail": { + "description": "", "type": "string" }, - "fontSize": { - "description": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72", + "sentByFullName": { + "description": "", "type": "string" }, - "id": { - "description": "A unique ID for the Salesforce object.", + "sentByImageId": { + "description": "Reserved for DocuSign.", "type": "string" }, - "imageBase64": { + "sentByInitials": { "description": "", "type": "string" }, - "transparency": { + "sentByRecipientId": { "description": "", "type": "string" }, - "watermarkText": { + "sentByUserId": { "description": "", "type": "string" - } - }, - "x-ds-definition-name": "watermark", - "description": "", - "x-ds-category": "Accounts", - "x-ds-order": "200", - "x-ms-summary": "" - }, - "PaymentGatewayAccounts": { - "type": "object", - "properties": { - "config": { - "$ref": "#/definitions/paymentGatewayAccountSetting", - "description": "" }, - "displayName": { - "description": "A user-defined name for a connected gateway account.\n\nThis name is used in the Admin panel in the list of connected accounts and in Tagger in the payment gateway selector.\n\nThe human-readable version of `paymentGatewayAccountId`.", + "signingGroupId": { + "description": "When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once).", "type": "string" }, - "isEnabled": { - "description": "", + "signingGroupName": { + "description": "Optional. The name of the signing group. \n\nMaximum Length: 100 characters. ", "type": "string" }, - "isLegacy": { + "subject": { "description": "", "type": "string" }, - "lastModified": { - "description": "Utc date and time the comment was last updated (can only be done by creator.)", + "tabId": { + "description": "The unique identifier for the tab.", "type": "string" }, - "paymentGateway": { - "description": "Payment gateway used by the connected gateway account.\nThis is the name used by the API.\nFor a human-readable version use `paymentGatewayDisplayName`.\n\nPossible values are:\n\n* `Stripe`\n* `Braintree`\n* `AuthorizeDotNet`", + "text": { + "description": "Specifies the text that is shown in the dropdown list. ", "type": "string" }, - "paymentGatewayAccountId": { - "description": "A GUID that identifies the payment gateway account. For a human-readable version use `displayName`.", + "threadId": { + "description": "The unique identifier for the comment thread.", "type": "string" }, - "paymentGatewayDisplayName": { - "description": "Display name of the payment gateway used by the connected gateway account.\nThis is the human-readable version of `paymentGateway`.\n\nPossible values are:\n\n* Stripe\n* Braintree\n* Authorize.Net", + "threadOriginatorId": { + "description": "The userId of the user who created the thread.", "type": "string" }, - "payPalLegacySettings": { - "$ref": "#/definitions/payPalLegacySettings", - "description": "" + "timestamp": { + "description": "", + "type": "string" }, - "supportedCurrencies": { + "timeStampFormatted": { "description": "", - "type": "array", - "items": { - "type": "string" - } + "type": "string" }, - "supportedPaymentMethods": { + "visibleTo": { "description": "", "type": "array", "items": { "type": "string" } + } + }, + "x-ds-definition-name": "comment", + "description": "Details about envelope comments.", + "x-ds-category": "Envelopes", + "x-ds-order": "160", + "x-ms-summary": "Details about envelope comments." + }, + "FavoriteTemplates": { + "type": "object", + "properties": { + "errorDetails": { + "$ref": "#/definitions/errorDetails", + "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." }, - "supportedPaymentMethodsWithOptions": { + "favoriteTemplates": { "description": "", "type": "array", "items": { - "$ref": "#/definitions/paymentMethodWithOptions" + "$ref": "#/definitions/favoriteTemplatesContentItem" } + }, + "templatesUpdatedCount": { + "format": "int32", + "description": "", + "type": "integer" } }, - "x-ds-definition-name": "paymentGatewayAccount", - "description": "Information about a connected payment gateway account.", - "x-ds-category": "Payments", - "x-ds-order": "210", - "x-ms-summary": "Information about a connected payment gateway account." + "x-ds-definition-name": "favoriteTemplatesInfo", + "description": "", + "x-ds-category": "Accounts", + "x-ds-order": "270", + "x-ms-summary": "" }, - "NotaryJournals": { + "Notary": { "type": "object", "properties": { "createdDate": { "description": "The creation date of the account in UTC timedate format.", "type": "string" }, - "documentName": { + "enabled": { "description": "", "type": "string" }, - "jurisdiction": { - "$ref": "#/definitions/jurisdiction", - "description": "" - }, - "notaryJournalId": { + "searchable": { "description": "", "type": "string" }, - "notaryJournalMetaData": { - "$ref": "#/definitions/notaryJournalMetaData", + "userInfo": { + "$ref": "#/definitions/userInformation", "description": "" - }, - "signerName": { - "description": "The in-person signer's full legal name.\n\nRequired when `inPersonSigningType` is `inPersonSigner`.\nFor eNotary flow, use `name` instead.\n\nMaximum Length: 100 characters.\n", - "type": "string" - } - }, - "x-ds-definition-name": "notaryJournal", - "description": "", - "x-ds-category": "Envelopes", - "x-ds-order": "220", - "x-ms-summary": "" - }, - "IdentityVerifications": { - "type": "object", - "properties": { - "identityVerification": { - "description": " ", - "type": "array", - "items": { - "$ref": "#/definitions/accountIdentityVerificationWorkflow" - } } }, - "x-ds-definition-name": "accountIdentityVerificationResponse", - "description": "Identity verification workflows available to an account", - "x-ds-category": "Accounts", - "x-ds-order": "30", - "x-ms-summary": "Identity verification workflows available to an account" + "x-ds-definition-name": "notary", + "description": "Use DocuSign eNotary to notarize documents digitally.\nCheck the [DocuSign eNotary support documentation](https://support.docusign.com/en/guides/ndse-user-guide-enotary-resources)\nto see which jurisdictions are supported.\n", + "x-ds-category": "Notary", + "x-ds-order": "280", + "x-ms-summary": "Use DocuSign eNotary to notarize documents digitally.\nCheck the [DocuSign eNotary support documentation](https://support.docusign.com/en/guides/ndse-user-guide-enotary-resources)\nto see which jurisdictions are supported.\n" }, - "EnvelopeDocumentHtmlDefinitions": { + "NotaryJurisdiction": { "type": "object", "properties": { - "htmlDefinitions": { + "commissionExpiration": { "description": "", - "type": "array", - "items": { - "$ref": "#/definitions/documentHtmlDefinitionOriginal" - } - } - }, - "x-ds-definition-name": "documentHtmlDefinitionOriginals", - "description": "", - "x-ds-category": "Envelopes", - "x-ds-order": "220", - "x-ms-summary": "" - }, - "DocumentResponsiveHtmlPreview": { - "type": "object", - "properties": { - "htmlDefinitions": { + "type": "string" + }, + "commissionId": { "description": "", - "type": "array", - "items": { - "type": "string" - } - } - }, - "x-ds-definition-name": "documentHtmlDefinitions", - "description": "", - "x-ds-category": "Envelopes", - "x-ds-order": "230", - "x-ms-summary": "" - }, - "EnvelopeHtmlDefinitions": { - "type": "object", - "properties": { - "htmlDefinitions": { + "type": "string" + }, + "county": { "description": "", - "type": "array", - "items": { - "$ref": "#/definitions/documentHtmlDefinitionOriginal" - } + "type": "string" + }, + "errorDetails": { + "$ref": "#/definitions/errorDetails", + "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." + }, + "jurisdiction": { + "$ref": "#/definitions/jurisdiction", + "description": "" + }, + "registeredName": { + "description": "", + "type": "string" + }, + "sealType": { + "description": "", + "type": "string" } }, - "x-ds-definition-name": "documentHtmlDefinitionOriginals", - "description": "", - "x-ds-category": "Envelopes", - "x-ds-order": "240", - "x-ms-summary": "" + "x-ds-definition-name": "notaryJurisdiction", + "description": "Creating, updating, and deleting notary jurisdiction objects.", + "x-ds-category": "Notary", + "x-ds-order": "290", + "x-ms-summary": "Creating, updating, and deleting notary jurisdiction objects." }, - "ResponsiveHtmlPreview": { + "EnvelopeWorkflowDefinition": { "type": "object", "properties": { - "htmlDefinitions": { + "currentWorkflowStepId": { + "description": "", + "type": "string" + }, + "workflowStatus": { + "description": "", + "type": "string" + }, + "workflowSteps": { "description": "", "type": "array", "items": { - "type": "string" + "$ref": "#/definitions/workflowStep" } } }, - "x-ds-definition-name": "documentHtmlDefinitions", + "x-ds-definition-name": "workflow", "description": "", "x-ds-category": "Envelopes", - "x-ds-order": "250", + "x-ds-order": "300", "x-ms-summary": "" }, - "TemplateDocumentResponsiveHtmlPreview": { + "Reports": { "type": "object", "properties": { - "htmlDefinitions": { + "reports": { "description": "", "type": "array", "items": { - "type": "string" + "$ref": "#/definitions/reportInProductListItem" } } }, - "x-ds-definition-name": "documentHtmlDefinitions", + "x-ds-definition-name": "reportInProductList", "description": "", - "x-ds-category": "Templates", - "x-ds-order": "280", + "x-ds-category": "Accounts", + "x-ds-order": "301", "x-ms-summary": "" }, - "TemplateResponsiveHtmlPreview": { + "AccountSignatures": { "type": "object", "properties": { - "htmlDefinitions": { + "adoptedDateTime": { + "description": "The UTC date and time when the user adopted the signature.", + "type": "string" + }, + "createdDateTime": { + "description": "The UTC DateTime when the item was created.", + "type": "string" + }, + "customField": { "description": "", - "type": "array", - "items": { - "type": "string" - } - } - }, - "x-ds-definition-name": "documentHtmlDefinitions", - "description": "", - "x-ds-category": "Templates", - "x-ds-order": "290", - "x-ms-summary": "" - }, - "TemplateDocumentHtmlDefinitions": { - "type": "object", - "properties": { - "htmlDefinitions": { + "type": "string" + }, + "dateStampProperties": { + "$ref": "#/definitions/dateStampProperties", + "description": "Specifies the area in which a date stamp is placed. This parameter uses pixel positioning to draw a rectangle at the center of the stamp area. The stamp is superimposed on top of this central area.\n\nThis property contains the following information about the central rectangle:\n\n- `DateAreaX`: The X axis position of the top-left corner.\n- `DateAreaY`: The Y axis position of the top-left corner.\n- `DateAreaWidth`: The width of the rectangle.\n- `DateAreaHeight`: The height of the rectangle." + }, + "disallowUserResizeStamp": { + "description": "When set to **true**, users may not resize the stamp.", + "type": "string" + }, + "errorDetails": { + "$ref": "#/definitions/errorDetails", + "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." + }, + "externalID": { + "description": "Optionally specify an external identifier for the user's signature.", + "type": "string" + }, + "imageBase64": { "description": "", - "type": "array", - "items": { - "$ref": "#/definitions/documentHtmlDefinitionOriginal" - } - } - }, - "x-ds-definition-name": "documentHtmlDefinitionOriginals", - "description": "", - "x-ds-category": "Templates", - "x-ds-order": "300", - "x-ms-summary": "" - }, - "TemplateHtmlDefinitions": { - "type": "object", - "properties": { - "htmlDefinitions": { + "type": "string" + }, + "imageType": { + "description": "Specificies the type of image. Valid values are:\n\n- `signature_image`\n- `initials_image`", + "type": "string" + }, + "initials150ImageId": { + "description": "The ID of the user's initials image.", + "type": "string" + }, + "initialsImageUri": { + "description": "The URI for retrieving the image of the user's initials.", + "type": "string" + }, + "isDefault": { + "description": "Boolean that specifies whether the signature is the default signature for the user.", + "type": "string" + }, + "lastModifiedDateTime": { + "description": "The date and time that the item was last modified.", + "type": "string" + }, + "nrdsId": { + "description": "The National Association of Realtors (NAR) membership ID for a user who is a realtor.", + "type": "string" + }, + "nrdsLastName": { + "description": "The realtor's last name.", + "type": "string" + }, + "nrdsStatus": { + "description": "The realtor's NAR membership status. The value `active` verifies that the user is a current NAR member. Valid values are:\n\n- `Active`\n- `Inactive`\n- `Terminate`\n- `Provisional`\n- `Deceased`\n- `Suspend`\n- `Unknown`", + "type": "string" + }, + "phoneticName": { + "description": "The phonetic spelling of the `signatureName`.", + "type": "string" + }, + "signature150ImageId": { + "description": "The ID of the user's signature image.", + "type": "string" + }, + "signatureFont": { + "description": "The font type to use for the signature if the signature is not drawn. The following font styles are supported. The quotes are to indicate that these values are strings, not `enums`.\n\n- `\"1_DocuSign\"`\n- `\"2_DocuSign\"`\n- `\"3_DocuSign\"`\n- `\"4_DocuSign\"`\n- `\"5_DocuSign\"`\n- `\"6_DocuSign\"`\n- `\"7_DocuSign\"`\n- `\"8_DocuSign\"`\n- `\"Mistral\"`\n- `\"Rage Italic\"`\n", + "type": "string" + }, + "signatureGroups": { "description": "", "type": "array", "items": { - "$ref": "#/definitions/documentHtmlDefinitionOriginal" + "$ref": "#/definitions/signatureGroup" } - } - }, - "x-ds-definition-name": "documentHtmlDefinitionOriginals", - "description": "", - "x-ds-category": "Templates", - "x-ds-order": "310", - "x-ms-summary": "" - }, - "EnvelopeTransferRules": { - "type": "object", - "properties": { - "endPosition": { - "description": "The last position in the result set. ", + }, + "signatureId": { + "description": "Specifies the signature ID associated with the signature name. You can use the signature ID in the URI in place of the signature name, and the value stored in the `signatureName` property in the body is used. This allows the use of special characters (such as \"&\", \"<\", \">\") in a the signature name. Note that with each update to signatures, the returned signature ID might change, so the caller will need to trigger off the signature name to get the new signature ID.", "type": "string" }, - "envelopeTransferRules": { + "signatureImageUri": { + "description": "An endpoint URI that you can use to retrieve the user's signature image.", + "type": "string" + }, + "signatureInitials": { + "description": "Specifies the user's signature in initials format.", + "type": "string" + }, + "signatureName": { + "description": "Specifies the user's signature name.", + "type": "string" + }, + "signatureRights": { + "description": "The rights that the user has to the signature. Valid values are:\n\n- `none`\n- `read`\n- `admin`", + "type": "string" + }, + "signatureType": { + "description": "Specifies the type of signature.", + "type": "string" + }, + "signatureUsers": { "description": "", "type": "array", "items": { - "$ref": "#/definitions/envelopeTransferRule" + "$ref": "#/definitions/signatureUser" } }, - "nextUri": { - "description": "The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. ", + "stampFormat": { + "description": "The format of a stamp. Valid values are:\n\n- `NameHanko`: The stamp represents only the signer's name.\n- `NameDateHanko`: The stamp represents the signer's name and the date. ", "type": "string" }, - "previousUri": { - "description": "The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. ", + "stampImageUri": { + "description": "The URI for retrieving the image of the user's stamp.", "type": "string" }, - "resultSetSize": { - "description": "The number of results returned in this response. Because you can filter which entries are included in the response, this value is always less than or equal to `totalSetSize`.", + "stampSizeMM": { + "description": "The physical height of the stamp image (in millimeters) that the stamp vendor recommends for displaying the image in PDF documents.", "type": "string" }, - "startPosition": { - "description": "The starting position of the current result set.", + "stampType": { + "description": "The type of stamp. Valid values are:\n\n- `signature`: A signature image. This is the default value.\n- `stamp`: A stamp image.\n- null", "type": "string" }, - "totalSetSize": { - "description": "The total number of items in the search's result set. This value is always greater than or equal to the value of `resultSetSize`.", + "status": { + "description": "Indicates the envelope status. Valid values are:\n\n* sent - The envelope is sent to the recipients. \n* created - The envelope is saved as a draft and can be modified and sent later.", "type": "string" } }, - "x-ds-definition-name": "envelopeTransferRuleInformation", + "x-ds-definition-name": "accountSignature", + "description": "", + "x-ds-category": "Accounts", + "x-ds-order": "40", + "x-ms-summary": "" + }, + "ApplianceInfo": { + "type": "object", + "properties": {}, + "x-ds-definition-name": "displayApplianceInfo", "description": "", "x-ds-category": "Envelopes", - "x-ds-order": "250", + "x-ds-order": "50", "x-ms-summary": "" }, - "NotificationDefaults": { + "ConnectSecret": { "type": "object", "properties": { - "apiEmailNotifications": { - "$ref": "#/definitions/notificationDefaultSettings", - "description": "" + "failures": { + "description": "A list of Connect failure logs.", + "type": "array", + "items": { + "$ref": "#/definitions/connectLog" + } }, - "emailNotifications": { - "$ref": "#/definitions/notificationDefaultSettings", - "description": "" + "logs": { + "description": "A list of Connect general logs.", + "type": "array", + "items": { + "$ref": "#/definitions/connectLog" + } + }, + "totalRecords": { + "description": "The count of records in the log list.", + "type": "string" + }, + "type": { + "description": "", + "type": "string" } }, - "x-ds-definition-name": "notificationDefaults", + "x-ds-definition-name": "connectLogs", "description": "", - "x-ds-category": "Accounts", - "x-ds-order": "120", + "x-ds-category": "Connect", + "x-ds-order": "50", "x-ms-summary": "" } }, @@ -54926,23 +66869,19 @@ "tags": [ { "name": "AccountBrands", - "description": "The AcccountBrands resource provides methods that enable you to create and manage brands for an account.\n\nBranding enables you to add the look and feel of your organization's brand to the sending, signing, and email processes, making it easier for recipients to identify envelopes coming from your organization.\n\nThe DocuSign Account Custom Branding feature enables you to set the colors, logo, and text that recipients see at the account level. The settings associated with a brand are applied to all of the envelopes that use the brand. You can create multiple brand profiles for different corporate brands or internal departments.\n\n**Note**: To use this resource, branding for either signing or sending must be enabled for the account (either `canSelfBrandSend`, `canSelfBrandSign`, or both of these account settings must be *true**). " + "description": "The AcccountBrands resource provides methods that enable you to create and manage brands for an account.\n\nBranding enables you to add the look and feel of your organization's brand to the sending, signing, and email processes, making it easier for recipients to identify envelopes coming from your organization.\n\nThe DocuSign Account Custom Branding feature enables you to set the colors, logo, and text that recipients see at the account level. The settings associated with a brand are applied to all of the envelopes that use the brand. You can create multiple brand profiles for different corporate brands or internal departments.\n\n**Note**: To use this resource, branding for either signing or sending must be enabled for the account (either `canSelfBrandSend`, `canSelfBrandSign`, or both of these account settings must be set to **true**). " }, { "name": "AccountConsumerDisclosures", - "description": "The AccountConsumerDisclosures resource provides methods that allow you to retrieve the consumer disclosures associated with the account." + "description": "The `AccountConsumerDisclosures` resource provides methods that enable you to enable, retrieve, and manage the Electronic Record and Signature Consent Disclosure (ERSD) options for your account. This is the disclosure that displays to each new recipient who is going to sign or add other information, or who is required to view the documents you send to them. The recipient must read and agree to the terms of the disclosure before they can access and take action on the documents you send. The ERSD does not apply to copy-only recipients, but does apply to recipients who must sign or view your documents.\n\nYou can use either the default ERSD that DocuSign provides for U.S.-based transactions, or a custom ERSD. \n\n## Languages\n\n**Important**: The system does not translate the ERSD for you. The default ERSD is always in English. For a custom ERSD, an account administrator must create a version of the disclosure for each language that your signers use. When you create a version of your custom ERSD for a specific signer language, you must:\n\n1. Specify the language code (`langCode`) for the signer language.\n2. Provide the `esignAgreementText` and `esignText` in the language associated with the `langCode`.\n\nFor more information, see [Legal Disclosure](https://support.docusign.com/en/guides/ndse-admin-guide-legal-disclosure)." }, { "name": "AccountCustomFields", - "description": "The CustomFields resource provides a method that enables you to retrieve the custom fields associated with an account.\n\nThese fields can be used with your account's envelopes to record information about the envelopes. The fields can be searched to find matching envelopes and track information. \n\nThe envelope custom fields are shown in the DocuSign member console's Envelope Settings section when a user creates an envelope. The envelope custom fields are not seen by envelope recipients.\n\nThere are two types of envelope custom fields, text and list. A text custom field lets the sender enter the value for the field. The list custom field lets the sender select the value of the field from a pre-determined list." - }, - { - "name": "EnvelopeBulkRecipients", - "description": "The EnvelopeBulkRecipients resource provide methods that allow you manage the bulk recipient file for an envelope.\n\nThe bulk recipient CSV (Comma Separated Value) file contains the list of recipient names and email addresses that you can add to an envelope to send the same document to a large number of recipients.\n\nThe required and optional information that can be included the file is described in the [BulkEnvelopes::updateRecipients](https://developers.docusign.com/esign-rest-api/reference/BulkEnvelopes/EnvelopeBulkRecipients/update) method\n" + "description": "Custom fields enable you to record custom information about envelopes that you can then use for sorting, organizing, searching, and other downstream processes. \n\nFor example, you can use custom fields to copy envelopes or data to multiple areas in Salesforce. eOriginal customers can eVault all of their documents from the web app by setting an account custom field with a name like `eVault with eOriginal` to **true**.\n\nYou can also use account custom fields to set the following information:\n\n- Tracking ID\n- Department \n- Use case\n- Other envelope metadata\n\n## Envelope Custom Field Visibility\n\nWhen you create an envelope custom field for your account, you have the following options: \n\n- Make it a required field for senders at the time of sending\n- Display it as an optional field at the time of sending\n- Set a specific value for the field behind the scenes (NOT SURE IF THIS IS RIGHT; MIGHT JUST BE AN UNUSED DRAFT FIELD)\n\nEnvelope recipients do not see the envelope custom fields.\n\n## Types of Envelope Custom Fields\n\nThere are two types of envelope custom fields:\n\n- `text`: Enables the sender to enter the value for the field. \n- `list`: Enables the sender to select the value of the field from a predetermined list." }, { "name": "EnvelopeCustomFields", - "description": "The EnvelopeCustomFields resource provides methods that allow you manage custom fields in an envelope. \n\nCustom fields can be used in the envelopes for your account to record information about the envelope, help search for envelopes and track information. The envelope custom fields are shown in the Envelope Settings section when a user is creating an envelope in the DocuSign member console. The envelope custom fields are not seen by the envelope recipients.\n\nThere are two types of envelope custom fields, text and list. A text custom field lets the sender enter the value for the field. With a list custom field, the sender selects the value of the field from a pre-made list." + "description": "The EnvelopeCustomFields resource provides methods that allow you manage custom fields in an envelope. \n\nCustom fields can be used in the envelopes for your account to record information about the envelope, help search for envelopes and track information. The envelope custom fields are shown in the Envelope Settings section when a user is creating an envelope in the DocuSign member console. The envelope custom fields are not seen by the envelope recipients.\n\nThere are two types of envelope custom fields:\n\n- `text`: Enables the sender to enter the value for the field. \n- `list`: Enables the sender to select the value of the field from a predetermined list.\n\nYou may assign up to three envelope custom fields to an envelope. This limit does not include account (document) custom fields." }, { "name": "EnvelopeDocumentFields", @@ -54950,15 +66889,15 @@ }, { "name": "EnvelopeLocks", - "description": "The EnvelopeLocks resource provides methods that allow you to manage locks on an envelope.\n\nYou can lock an envelope and set the time until the lock expires to prevent users or recipients from accessing and changing the envelope.\n\nTo use this functionality, users must have envelope locking capability enabled." + "description": "The EnvelopeLocks resource provides methods that allow you to\nmanage locks on an envelope.\n\nTo prevent users from changing an envelope while another user is\nmodifying it, you can lock the envelope and set the time until\nthe lock expires.\n\nFor example, you would use the following flow:\n\n1. Lock the envelope.\n2. Make changes to envelope.\n3. Delete the envelope lock and save the changes. If the envelope is based on a template that has a password, you must supply the template password to save the changes.\n\n**Note**: To use envelope locks, the user must have envelope locking capability enabled." }, { "name": "EnvelopeRecipients", - "description": "\n\n\nThe EnvelopeRecipients resource allows you manage the recipients of an envelope. All recipient types share a set of [core parameters](#core-recipient-parameters), but some recipient types have additional parameters. You specify the recipient type using the `recipientType` parameter. The recipient types are as follows:\n\n
\n\n| Recipient type | Description |\n| :--- | :--- |\n| [Agents](#agents-recipient) | Agent recipients can add name and email information for recipients that appear after the agent in routing order. |\n| [Carbon Copies](#carbon-copies-recipient) | Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date, or add information to any of the documents. This type of recipient can be used in any routing order. Carbon copy recipients receive their copy of the envelope when the envelope reaches the recipient's order in the process flow and when the envelope is completed. |\n| [Certified Deliveries](#certified-deliveries-recipient) | Certified delivery recipients must receive the completed documents for the envelope to be completed. However, they don't need to sign, initial, date, or add information to any of the documents. |\n| [Editors](#editors-recipient) | Editors have the same management and access rights for the envelope as the sender. They can make changes to the envelope as if they were using the Advanced Correct feature. This recipient can add name and email information, add or change the routing order, set authentication options, and can edit signature/initial tabs and data fields for the remaining recipients. The recipient must have a DocuSign account to be an editor. |\n| [In-Person Signers](#in-person-signers-recipient) | In-person recipients are DocuSign users who act as signing hosts in the same physical location as the signer. |\n| [Intermediaries](#intermediaries-recipient) | Intermediaries are recipients who can, but are not required to, add name and email information for recipients at the same or subsequent level in the routing order, unless subsequent agents, editors, or intermediaries are added. |\n| [Seals](#seal-recipient) | Electronic seal recipients represent legal entities rather than individuals. Organizations and governments can use electronic seals to show evidence of origin and integrity of documents. |\n| [Signers](#signers-recipient) | Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope. |\n| [Witnesses](#signers-recipient) | Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope. |\n\n
\n\nNot all recipients are are available to all account types. Review your account plan to determine which recipient types are available to you. All recipient types are available in the Demo environment.\n\n\n## Core Recipient Parameters\n\nAll recipients, regardless of type, have the same common core parameters. The following table contains the descriptions for the core properties for all recipient types:\n\n
\n\n| Name | Required | Schema Type | Description |\n| :--- | :--- | :--- | :--- |\n| email | Yes | Email | Email of the recipient. Notification will be sent to this email id.
Maximum Length: 100 characters. |\n| name | Yes | String | Full legal name of the recipient.
Maximum Length: 100 characters. |\n| accessCode | No | String | This optional element specifies the access code a recipient has to enter to validate the identity.
Maximum Length: 50 characters. |\n| addAccessCodeToEmail | No | Boolean | This optional attribute indicates that the access code is added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient. |\n| clientUserId | No | String | This specifies whether the recipient is embedded or remote.

If the `clientUserId` property is not null then the recipient is embedded. Note that if the `ClientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true**, an error is generated on sending. |\n| embeddedRecipientStartURL | No | String | This is a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would, but when the document link in the email is clicked the recipient is redirected, through DocuSign, to this URL to complete their actions. When routing to the URL, it is up to the sender's system (the server responding to the URL) to then request a recipient token to launch a signing session.

If the value `SIGN_AT_DOCUSIGN` is used for this node, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that would be launched by any partner.

It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application and DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets the `EmbeddedRecipientStartURL` property to `SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) be used to verify the identity of the recipient.

If the `clientUserId` property is NOT set and the `embeddedRecipientStartURL` property is set, DocuSign ignores the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the `embeddedRecipientStartURL` property using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The customFields must be part of the recipient or envelope. The merge fields are enclosed in double brackets.

_Example_:
`http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` |\n| customFields | No | customField |An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. String `customField` properties have a maximum length of 100 characters. |\n| emailNotification | No | emailNotification | An optional complex type that has information for setting the language for the recipient's email information. It is composed of three elements:

*emailBody*: a string with the email message sent to the recipient.
Maximum Length: 10000 characters.

*emailSubject*: a string with the subject of the email sent to the recipient.
Maximum Length: 100 characters.

*supportedLanguage*: The simple type enumeration of the language used. The supported languages, with the language value shown in parenthesis, are: Arabic (ar), Bahasa Indonesia (id), Bahasa Melayu (ms) Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro),Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi).

**IMPORTANT**: If this is enabled for one recipient, it overrides the Envelope Subject and `EmailBlurb` property settings. Also, you must set the `emailNotification` property for all recipients. |\n| excludedDocuments | No | Array of Strings | Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the enforceSignerVisibility property must be set to true for the envelope to use this.

When the enforceSignerVisibility property is set to **true**, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent. |\n| idCheckConfigurationName | No | String |Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account (these name can also be found in the web console sending interface in the Identify list for a recipient). This overrides any default authentication setting.

_Example_:
Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as 'ID Check $' and 'SMS Auth $'. To use ID check in an envelope, the `idCheckConfigurationName` property must be set to `ID Check $`. To use SMS, it must be set to `SMS Auth $` and you must add phone number information to the `smsAuthentication` node.|\n| iDCheckInformationInput | No | IdCheckInformationInput | This complex element contains input information related to a recipient ID check. It can include the following information.

*addressInformationInput*: Used to set recipient address information and consists of:

*addressInformation*: consists of six elements, with street2 and zipPlus4 being optional. The elements are: street1, street2, city, state, zip, zipPlus4\\. The maximum number of characters in each element are: street1/street2 = 150 characters, city = 50 characters, state = 2 characters, and zip/zipPlus4 = 20 characters.

displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.

*receiveInResponse*: A Boolean element that specifies if the information needs to be returned in the response.

*dobInformationInput*: Used to set recipient date of birth information and consists of:

*dateOfBirth*: Specifies the recipient's date, month and year of birth.

*displayLevelCode*: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.

*receiveInResponse*: A Boolean element that specifies if the information needs to be returned in the response.

*ssn4InformationInput*: Used to set the last four digits of the recipient's SSN information and consists of:

*ssn4*: Specifies the last four digits of the recipient's SSN.

*displayLevelCode*: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.

*receiveInResponse*: A Boolean element that specifies if the information needs to be returned in the response.

*ssn9InformationInput*: Used to set the recipient's SSN information. Note that the ssn9 information can never be returned in the response. The ssn9 input consists of:



*ssn9*: Specifies the recipient's SSN.

*displayLevelCode*: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. |\n| inheritEmailNotificationConfiguration | No | Boolean | Optional element. If true and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account. |\n| note | No | String | A note that is unique to this recipient. This note is sent to the recipient via the signing email. The note displays in the signing UI near the upper left corner of the document on the signing screen.
Maximum Length: 1000 characters. |\n| phoneAuthentication | No | RecipientPhoneAuthentication | Optional element. Contains the elements:

*recipMayProvideNumber*:Boolean. When set to **true** thenrecipient can use whatever phone number they choose to.

*senderProvidedNumbers*: ArrayOfString. A list of phone numbers the recipient can use.

*recordVoicePrint* - Reserved for DocuSign.

*validateRecipProvidedNumber* - Reserved for DocuSign. | |\n| recipientAttachment | No | Attachment | Reserved for DocuSign. |\n| recipientId | No | String | Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. |\n| requireIdLookup | No | Boolean | When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. |\n| roleName | No* | String | Optional element. Specifies the role name associated with the recipient.

This is required when working with template recipients. |\n| routingOrder | Yes | String | This element specifies the routing order of the recipient in the envelope. |\n| smsAuthentication | No | senderProvidedNumbers | Optional element. Contains the element:

*senderProvidedNumbers*: Array that contains a list of phone numbers the recipient can use for SMS text authentication. |\n| socialAuthentications | No | Boolean | Lists the social ID type that can be used for recipient authentication. |\n| templateAccessCodeRequired | No | Boolean | Optional element. Used only when working with template recipients. When set to **true** and the `TemplateLocked` parameter is set to **true**, the sender must enter an access code. |\n| templateLocked | No | Boolean | Optional element. Used only when working with template recipients. When set to **true**, the sender cannot change any attributes of the recipient. |\n| templateRequired | No | Boolean | Optional element. Used only when working with template recipients. When set to **true**, the sender may not remove the recipient. |\n| identityVerification | No | identityVerification | Optional element. Specifies ID Verification applied on an envelope by workflow ID.
See the [list](https://developers.docusign.com/esign-rest-api/reference/Accounts/IdentityVerifications/list) method in the [IdentityVerifications](https://developers.docusign.com/esign-rest-api/reference/Accounts/IdentityVerifications) resource for more information on how to retrieve workflow IDs available for an account.
This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods.
Note that ID Verification and ID Check are two distinct methods. ID Verification checks recipients' identity by verifying their ID while ID Check relies on data available on public records (such as current and former address). |\n\n
\n\n\n## Agents Recipient\n\nAn agent recipient can add name and email information for recipients that appear after the agent in routing order.\n\nIn addition to the [core parameters](#core-recipient-parameters),\nthis type adds the following parameters:\n\n
\n\n| Name | Required | Schema Type | Description |\n| :--- | :--- | :--- | :--- |\n| canEditRecipientEmails | No | Boolean | Optional element. When set to **true**, the Agents Recipient associated with this Recipient can change the Recipient's pre-populated Email address. This element is only active if enabled for the account. |\n| canEditRecipientNames | No | Boolean | Optional element. When set to **true**, the Agents Recipient associated with this recipient can change the recipient's pre-populated name (`UserName`). This element is only active if enabled for the account. |\n\n
\n\n\n## Carbon Copies Recipient\n\nCarbon copy recipients receive a copy of the envelope but don't need to sign, initial, date or add information to any of the documents. You can place this type of recipient in any routing order. Carbon copy recipients receive their copy of the envelope when the envelope reaches the recipient's order in the process flow and when the envelope is completed.\n\nThis recipient type uses only the [core parameters](#core-recipient-parameters).\n\n\n## Certified Deliveries Recipient\n\nCertified delivery recipients must receive the completed documents for the envelope to be completed. However, they don't need to sign, initial, date or add information to any of the documents.\n\nThis recipient type uses only the [core parameters](#core-recipient-parameters).\n\n\n## Editors Recipient\n\nEditors have the same management and access rights for the envelope as the sender. They can make changes to the envelope as if they were using the Advanced Correct feature. This recipient can add name and email information, add or change the routing order and set authentication options for the remaining recipients. Additionally, this recipient can edit signature/initial tabs and data fields for the remaining recipients. The recipient must have a DocuSign account to be an editor.\n\nIn addition to the [core parameters](#core-recipient-parameters), this type adds the following parameters:\n\n
\n\n| Name | Required | Schema Type | Description |\n| :--- | :--- | :--- | :--- |\n| canEditRecipientEmails | No | Boolean | Optional element. When set to **true**, the Editors Recipient associated with this Recipient can change the Recipient's pre-populated Email address. This element is only active if enabled for the account. |\n| canEditRecipientNames | No | Boolean | Optional element. When set to **true**, the Editors Recipient associated with this recipient can change the recipient's pre-populated name (`UserName`). This element is only active if enabled for the account. |\n\n
\n\n\n## In-Person Signers Recipient\n\nAn in-person recipient is a DocuSign user, acting as a Signing Host, who is in the same physical location as the signer.\n\nThe following restrictions apply to using electronic notary when sending documents:\n\n* Authentication methods are allowed for the signer but not the notary.\n* The Sign On Paper, Document Markup, Field Markup and Change Signer options cannot be used for the documents.\n* Tabs may be assigned to the signer, but cannot be assigned to the notary.\n\nSee [eNotary Resources][enotary-resources] in the DocuSign Support Center for more information about how the eNotary feature works.\n\nIn addition to the [core parameters](#core-recipient-parameters), this type adds the following parameters:\n\n
\n\n| Name | Required | Schema Type | Description |\n| :------------------ | :---------------------------------------------------------------- | :---------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| inPersonSigningType | No | String | Specifies whether the envelope uses the eNotary feature. The accepted values are:
  • `inPersonSigner` The envelope uses the normal in-person signing flow.
  • `notary`: The envelope uses the eNotary signing flow.
|\n| notaryHost | Yes, when `inPersonSigningType` is `notary` | NotaryHost | Sets the information for the notary host for the notary in person signing flow. The following information is required:
  • `recipientId`: A unique ID number for the notary signing host.
  • `name`: Specifies the notary's full legal name.
  • `email`: Specifies the notary's email address.
|\n| autoNavigation | No | Boolean | Specifies whether auto navigation is set for the recipient. |\n| defaultRecipient | No | Boolean | When set to **true**, this is the default recipient for the envelope. This option is used when creating an envelope from a template. |\n| hostName | Yes, when `inPersonSigningType` is `inPersonSigner` | String | The name of the signing host. This is the DocuSign user that is hosting the in-person signing session. |\n| hostEmail | Yes, when `inPersonSigningType` is `inPersonSigner` | String | The email address of the signing host. This is the DocuSign user that is hosting the in-person signing session. |\n| signerName | Yes, when `inPersonSigningType` is `inPersonSigner` | String | The in-person signer's full legal name. |\n| signerEmail | No, but valid only when `inPersonSigningType` is `inPersonSigner` | String | The in-person signer's email address. |\n| name | Yes, when `inPersonSigningType` is `notary` | String | The full legal name of the signer in an eNotary flow. |\n| email | Yes, when `inPersonSigningType` is `notary` | String | The signer's email address in an eNotary flow. |\n| signatureInfo | No | String | Optional element only used with recipient types In Person Signers and Signers.

Allows the sender to pre-specify the signature name, signature initials, and signature font used in the signature stamp for the recipient. |\n| signInEachLocation | No | Boolean | When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab (instead of adopting a signature/initial style or only drawing a signature/initial once). |\n| tabs | No | Tab | Optional element only used with recipient types In Person Signers and Signers.

Specifies the Tabs associated with the recipient. See the [EnvelopeRecipientTabs resource](https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/) for more information about tabs. |\n\n
\n\n\n## Intermediaries Recipient\n\nAn intermediary is a recipient who can, but is not required to, add name and email information for recipients at the same or subsequent level in the routing order, unless subsequent agents, editors or intermediaries are added.\n\nIn addition to the [core parameters](#core-recipient-parameters), this type adds the following parameters:\n\n
\n\n| Name | Required | Schema Type | Description |\n| :--- | :--- | :--- | :--- |\n| canEditRecipientEmails | No | Boolean | Optional element. When set to **true**, the Agents Recipient associated with this Recipient can change the Recipient's pre-populated Email address. This element is only active if enabled for the account. |\n| canEditRecipientNames | No | Boolean | Optional element. When set to **true**, the Agents Recipient associated with this recipient can change the recipient's pre-populated name (`UserName`). This element is only active if enabled for the account. |\n\n
\n\n\n## Seals Recipient\n\nAn electronic seal recipient is a legal entity rather than an actual person. Electronic Seals can be used by organizations and governments to show evidence of origin and integrity of documents. Even though electronic seals can be represented by a tab in a document, they do not require user interaction and apply automatically in the order specified by the sender. The sender is therefore the person authorizing usage of the electronic seal in the flow.\n\nElectronic seal recipients rely on a subset of core properties, described as follows, plus the `recipientSignatureProviders` parameter:\n\n\n
\n\n\n| Name               | Required               | Schema Type       | Description     |\n| :--- | :--- | :--- | :--- |\n| recipientId| Yes | String | Indicates the unique ID of the applied electronic seal.
|\n| routingOrder| No (default: 1) | String | Specifies the routing order of the electronic seal in the envelope.
The routing order assigned to your electronic seal cannot be shared with another recipient. It is recommended that you set a routing order for your electronic seals.. |\n| recipientSignatureProviders| Yes | String | Indicates which electronic seal to apply on documents when creating an envelope. |\n\nBy default, Electronic Seals apply on all documents in an envelope. However, the sealDocumentsWithTabsOnly property (see recipientSignatureProvider) allows you to seal only documents that have signHere tabs set for the Electronic Seal recipients.\n\n\n## Signers Recipient\n\nA signer is a recipient who must sign, initial, date, or add data to form fields on the documents in the envelope.\n\nIn addition to the [core parameters](#core-recipient-parameters), this recipient type adds the following parameters:\n\n
\n\n\n| Name | Required | Schema Type | Description |\n| :--- | :--- | :--- | :--- |\n| autoNavigation | No | Boolean | Specifies whether auto navigation is set for the recipient.|\n| defaultRecipient | No | Boolean | When set to **true**, this is the default recipient for the envelope. This option is used with the CreateEnvelopeFromTemplatesAndForms method. |\n| signInEachLocation | No | Boolean | When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab (instead of adopting a signature/initial style or only drawing a signature/initial once). |\n| signatureInfo | No | String | Optional element only used with recipient types In Person Signers and Signers.

Allows the sender to pre-specify the signature name, signature initials, and signature font used in the signature stamp for the recipient. |\n| signerEmail | No | String | Optional element. The email address for an InPersonSigner recipient Type.
Maximum Length: 100 characters. |\n| signerName | Yes | String | Required element with recipient type In Person Signers.
Maximum Length: 100 characters.

The full legal name of a signer for the envelope. |\n| tabs | No | Tab | Optional element only used with recipient types In Person Signers and Signers.

Specifies the Tabs associated with the recipient. See the the [EnvelopeRecipientTabs resource](https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs) for more information about tabs. |\n| deliveryMethod | No | String | Reserved for DocuSign.|\n| deliveredDateTime | No | DateTime | Reserved for DocuSign. |\n| signedDateTime | No | DateTime | Reserved for DocuSign. |\n| offlineAttributes | No |   | Reserved for DocuSign.|\n\n
\n\n[enotary-resources]: https://support.docusign.com/en/guides/ndse-user-guide-enotary-resources\n" + "description": "The EnvelopeRecipients resource enables you manage the recipients of an envelope. All recipient types share a set of [core parameters](#core-recipient-parameters), but some recipient types have additional parameters. You specify the recipient type using the `recipientType` parameter. The recipient types are as follows:\n\n
\n\n| Recipient type | Description |\n| :--- | :--- |\n| [Agent](#agent-recipient) | Agent recipients can add name and email information for recipients that appear after the agent in routing order. |\n| [Carbon Copy](#carbon-copy-recipient) | Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date, or add information to any of the documents. This type of recipient can be used in any routing order. Carbon copy recipients receive their copy of the envelope when the envelope reaches the recipient's order in the process flow and when the envelope is completed. |\n| [Certified Delivery](#certified-delivery-recipient) | Certified delivery recipients must receive the completed documents for the envelope to be completed. However, they don't need to sign, initial, date, or add information to any of the documents. |\n| [Editor](#editor-recipient) | Editors have the same management and access rights for the envelope as the sender. They can make changes to the envelope as if they were using the Advanced Correct feature. This recipient can add name and email information, add or change the routing order, set authentication options, and can edit signature/initial tabs and data fields for the remaining recipients. The recipient must have a DocuSign account to be an editor. |\n| [In-Person Signer](#in-person-signer-recipient) | In-person signer recipients are DocuSign users who act as signing hosts in the same physical location as the signer. |\n| [Intermediary](#intermediary-recipient) | Intermediaries are recipients who can, but are not required to, add name and email information for recipients at the same or subsequent level in the routing order, unless subsequent agents, editors, or intermediaries are added. |\n| [Seal](#seal-recipient) | Electronic seal recipients represent legal entities rather than individuals. Organizations and governments can use electronic seals to show evidence of origin and integrity of documents. |\n| [Signer](#signer-recipient) | Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope. |\n| [Witness](#witness-recipient) | Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope. |\n\n
\n\nNot all recipients are are available to all account types. Review your account plan to determine which recipient types are available to you. All recipient types are available in the Demo environment.\n\n\n## Core Recipient Parameters\n\nAll recipients, regardless of type, have the same common core parameters. The following table contains the descriptions for the core properties for all recipient types:\n\n
\n\n| Name | Required | Schema Type | Description |\n| :--- | :--- | :--- | :--- |\n| email | Yes | Email | Email of the recipient. Notification will be sent to this email id.
Maximum Length: 100 characters. |\n| name | Yes | String | Full legal name of the recipient.
Maximum Length: 100 characters.

**Note:** If you are creating an envelope with DocuSign EU advanced signature enabled, ensure that recipient names do not contain any of the following characters: **^ : \\ @ , + <** |\n| accessCode | No | String | This optional element specifies the access code a recipient has to enter to validate the identity.
Maximum Length: 50 characters. |\n| addAccessCodeToEmail | No | Boolean | This optional attribute indicates that the access code is added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient. |\n| agentCanEditEmail | No | Boolean | When set to **true**, the agent recipient associated with this recipient can change the recipient's pre-populated email address. This element is only active if enabled for the account. |\n| agentCanEditName | No | Boolean | When set to **true**, the agent recipient associated with this recipient can change the recipient's pre-populated name (`UserName`). This element is only active if enabled for the account. |\n| clientUserId | No | String | This specifies whether the recipient is embedded or remote.

If the `clientUserId` property is not null then the recipient is embedded. Note that if the `ClientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true**, an error is generated on sending. Maximum length: 100 characters. |\n| embeddedRecipientStartURL | No | String | This is a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would, but when the document link in the email is clicked the recipient is redirected, through DocuSign, to this URL to complete their actions. When routing to the URL, it is up to the sender's system (the server responding to the URL) to then request a recipient token to launch a signing session.

If the value `SIGN_AT_DOCUSIGN` is used for this node, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that would be launched by any partner.

It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application and DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets the `EmbeddedRecipientStartURL` property to `SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) be used to verify the identity of the recipient.

If the `clientUserId` property is NOT set and the `embeddedRecipientStartURL` property is set, DocuSign ignores the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the `embeddedRecipientStartURL` property using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The customFields must be part of the recipient or envelope. The merge fields are enclosed in double brackets.

_Example_:
`http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` |\n| customFields | No | customField |An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. String `customField` properties have a maximum length of 100 characters. |\n| emailNotification | No | emailNotification | An optional complex type that has information for setting the language for the recipient's email information. It is composed of three elements:

*emailBody*: a string with the email message sent to the recipient.
Maximum Length: 10000 characters.

*emailSubject*: a string with the subject of the email sent to the recipient.
Maximum Length: 100 characters.

*supportedLanguage*: The simple type enumeration (two-letter code) for the language to use for the standard email format and the signing view for the recipient. To retrieve the possible values, use the [Accounts::listSupportedLanguages method][ListLang].

**Note**: You can set the `emailNotification` property separately for each recipient. If you set the value only for certain recipients, the other recipients will inherit the this value from the top-level `emailSubject` and `emailBlurb`. |\n| excludedDocuments | No | Array of Strings | Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the enforceSignerVisibility property must be set to true for the envelope to use this.

When the enforceSignerVisibility property is set to **true**, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent. |\n| idCheckConfigurationName | No | String |Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account (these name can also be found in the web console sending interface in the Identify list for a recipient). This overrides any default authentication setting.

_Example_:
Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as 'ID Check $' and 'SMS Auth $'. To use ID check in an envelope, the `idCheckConfigurationName` property must be set to `ID Check $`. To use SMS, it must be set to `SMS Auth $` and you must add phone number information to the `smsAuthentication` node.|\n| iDCheckInformationInput | No | IdCheckInformationInput | This complex element contains input information related to a recipient ID check. It can include the following information.

*addressInformationInput*: Used to set recipient address information and consists of:

*addressInformation*: consists of six elements, with street2 and zipPlus4 being optional. The elements are: street1, street2, city, state, zip, zipPlus4\\. The maximum number of characters in each element are: street1/street2 = 150 characters, city = 50 characters, state = 2 characters, and zip/zipPlus4 = 20 characters.

displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.

*receiveInResponse*: A Boolean element that specifies if the information needs to be returned in the response.

*dobInformationInput*: Used to set recipient date of birth information and consists of:

*dateOfBirth*: Specifies the recipient's date, month and year of birth.

*displayLevelCode*: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.

*receiveInResponse*: A Boolean element that specifies if the information needs to be returned in the response.

*ssn4InformationInput*: Used to set the last four digits of the recipient's SSN information and consists of:

*ssn4*: Specifies the last four digits of the recipient's SSN.

*displayLevelCode*: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.

*receiveInResponse*: A Boolean element that specifies if the information needs to be returned in the response.

*ssn9InformationInput*: Used to set the recipient's SSN information. Note that the ssn9 information can never be returned in the response. The ssn9 input consists of:



*ssn9*: Specifies the recipient's SSN.

*displayLevelCode*: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. |\n| inheritEmailNotificationConfiguration | No | Boolean | Optional element. If true and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account. |\n| note | No | String | A note that is unique to this recipient. This note is sent to the recipient via the signing email. The note displays in the signing UI near the upper left corner of the document on the signing screen.
Maximum Length: 1000 characters. |\n| phoneAuthentication | No | RecipientPhoneAuthentication | Optional element. Contains the elements:

*recipMayProvideNumber*:Boolean. When set to **true** thenrecipient can use whatever phone number they choose to.

*senderProvidedNumbers*: ArrayOfString. A list of phone numbers the recipient can use.
\n| recipientId | No | String | Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. |\n| requireIdLookup | No | Boolean | When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. |\n| roleName | No* | String | Optional element. Specifies the role name associated with the recipient.

This is required when working with template recipients. |\n| routingOrder | Yes | String | This element specifies the routing order of the recipient in the envelope. |\n| smsAuthentication | No | senderProvidedNumbers | Optional element. Contains the element:

*senderProvidedNumbers*: Array that contains a list of phone numbers the recipient can use for SMS text authentication. |\n| templateAccessCodeRequired | No | Boolean | Optional element. Used only when working with template recipients. When set to **true** and the `TemplateLocked` parameter is set to **true**, the sender must enter an access code. |\n| templateLocked | No | Boolean | Optional element. Used only when working with template recipients. When set to **true**, the sender cannot change any attributes of the recipient. |\n| templateRequired | No | Boolean | Optional element. Used only when working with template recipients. When set to **true**, the sender may not remove the recipient. |\n| identityVerification | No | identityVerification | Optional element. Specifies ID Verification applied on an envelope by workflow ID.
See the [list](https://developers.docusign.com/docs/esign-rest-api/reference/accounts/identityverifications/list/) method in the [IdentityVerifications](https://developers.docusign.com/docs/esign-rest-api/reference/accounts/identityverifications/) resource for more information on how to retrieve workflow IDs available for an account.
This can be used in addition to other [recipient authentication](https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/recipients/auth/) methods.
Note that ID Verification and ID Check are two distinct methods. ID Verification checks recipients' identity by verifying their ID while ID Check relies on data available on public records (such as current and former address). |\n\n
\n\n\n\n## Agent Recipient\n\nAn agent recipient can add name and email information for recipients that appear after the agent in routing order.\n\nIn addition to the [core parameters](#core-recipient-parameters), this recipient type has the following parameters:\n\n
\n\n| Name | Required | Schema Type | Description |\n| :--- | :--- | :--- | :--- |\n| documentVisibility | No | documentVisibility | A complex type that specifies which documents are visible to this recipient. |\n\n
\n\n\n\n## Carbon Copy Recipient\n\nCarbon copy recipients receive a copy of the envelope but don't need to sign, initial, date or add information to any of the documents. You can place this type of recipient in any routing order. Carbon copy recipients receive their copy of the envelope when the envelope reaches the recipient's order in the process flow and when the envelope is completed.\n\nIn addition to the [core parameters](#core-recipient-parameters), this recipient type has the following parameters:\n\n
\n\n| Name | Required | Schema Type | Description |\n| :--- | :--- | :--- | :--- |\n| documentVisibility | No | documentVisibility | A complex type that specifies which documents are visible to this recipient. |\n\n
\n\n\n\n## Certified Delivery Recipient\n\nCertified delivery recipients must receive the completed documents for the envelope to be completed. However, they don't need to sign, initial, date or add information to any of the documents.\n\nIn addition to the [core parameters](#core-recipient-parameters), this recipient type has the following parameters:\n\n
\n\n| Name | Required | Schema Type | Description |\n| :--- | :--- | :--- | :--- |\n| documentVisibility | No | documentVisibility | A complex type that specifies which documents are visible to this recipient. |\n\n
\n\n\n\n## Editor Recipient\n\nEditors have the same management and access rights for the envelope as the sender. They can make changes to the envelope as if they were using the Advanced Correct feature. This recipient can add name and email information, add or change the routing order and set authentication options for the remaining recipients. Additionally, this recipient can edit signature/initial tabs and data fields for the remaining recipients. The recipient must have a DocuSign account to be an editor.\n\nIn addition to the [core parameters](#core-recipient-parameters), this recipient type has the following parameters:\n\n
\n\n\n| Name | Required | Schema Type | Description |\n| :--- | :--- | :--- | :--- |\n| documentVisibility | No | documentVisibility | A complex type that specifies which documents are visible to this recipient. |\n\n\n
\n\n\n## In-Person Signer Recipient\n\nAn in-person recipient is a DocuSign user, acting as a Signing Host, who is in the same physical location as the signer.\n\nThe following restrictions apply to using electronic notary when sending documents:\n\n* Authentication methods are allowed for the signer but not the notary.\n* The Sign On Paper, Document Markup, Field Markup and Change Signer options cannot be used for the documents.\n* Tabs may be assigned to the signer, but cannot be assigned to the notary.\n\nSee [eNotary Resources][enotary-resources] in the DocuSign Support Center for more information about how the eNotary feature works.\n\nIn addition to the [core parameters](#core-recipient-parameters), this type adds the following parameters:\n\n
\n\n\n| Name \t| Required \t| Schema Type \t| Description \t|\n|-----------------------\t|-----------------------------------------------------\t|-------------\t|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------\t|\n| inPersonSigningType \t| No \t| String \t| Specifies whether the envelope uses the eNotary feature. The accepted values are:
  • `inPersonSigner` The envelope uses the normal in-person signing flow.
  • `notary`: The envelope uses the eNotary signing flow.
\t|\n| notaryHost \t| Yes, when `inPersonSigningType` is `notary` \t| NotaryHost \t| Sets the information for the notary host for the notary in person signing flow. The following information is required:
  • `recipientId`: A unique ID number for the notary signing host.
  • `name`: Specifies the notary's full legal name.
  • `email`: Specifies the notary's email address.
\t|\n| autoNavigation \t| No \t| Boolean \t| Specifies whether auto navigation is set for the recipient. \t|\n| defaultRecipient \t| No \t| Boolean \t| When set to **true**, this is the default recipient for the envelope. This option is used when creating an envelope from a template. \t|\n| documentVisibility | No | documentVisibility | A complex type that specifies which documents are visible to this recipient. |\n| hostName \t| Yes, when `inPersonSigningType` is `inPersonSigner` \t| String \t| The name of the signing host. This is the DocuSign user that is hosting the in-person signing session. \t|\n| hostEmail \t| Yes, when `inPersonSigningType` is `inPersonSigner` \t| String \t| The email address of the signing host. This is the DocuSign user that is hosting the in-person signing session. \t|\n| signerName \t| Yes, when `inPersonSigningType` is `inPersonSigner` \t| String \t| The in-person signer's full legal name. \t|\n| Name \t| Yes, when `inPersonSigningType` is `notary` \t| String \t| The full legal name of the signer in an eNotary flow. \t|\n| email \t| Yes, when `inPersonSigningType` is `notary` \t| String \t| The signer's email address in an eNotary flow. \t|\n| recipientSuppliesTabs \t| No \t| Boolean \t| Indicates whether the recipient supplies tabs in the document. \t|\n| signatureInfo \t| No \t| String \t| Optional element only used with the recipient types In Person Signers, Signers, and Witnesses.

Allows the sender to pre-specify the signature name, signature initials, and signature font used in the signature stamp for the recipient. \t|\n| signInEachLocation \t| No \t| Boolean \t| When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab (instead of adopting a signature/initial style or only drawing a signature/initial once). \t|\n| tabs \t| No \t| Tab \t| Optional element only used with recipient types In Person Signers and Signers.

Specifies the Tabs associated with the recipient. See the [EnvelopeRecipientTabs resource](https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/) for more information about tabs. \t|\n| \t| \t| \t| \t|\n\n\n
\n\n\n\n## Intermediary Recipient\n\nAn intermediary is a recipient who can, but is not required to, add name and email information for recipients at the same or subsequent level in the routing order, unless subsequent agents, editors or intermediaries are added.\n\nIn addition to the [core parameters](#core-recipient-parameters), this recipient type has the following parameters:\n\n
\n\n\n| Name | Required | Schema Type | Description |\n| :--- | :--- | :--- | :--- |\n| documentVisibility | No | documentVisibility | A complex type that specifies which documents are visible to this recipient. |\n\n
\n\n\n\n## Seal Recipient\n\nAn electronic seal recipient is a legal entity rather than an actual person. Electronic Seals can be used by organizations and governments to show evidence of origin and integrity of documents. Even though electronic seals can be represented by a tab in a document, they do not require user interaction and apply automatically in the order specified by the sender. The sender is therefore the person authorizing usage of the electronic seal in the flow.\n\nElectronic seal recipients rely on a subset of core properties, described as follows, plus the `recipientSignatureProviders` parameter:\n\n\n
\n\n\n| Name               | Required               | Schema Type       | Description     |\n| :--- | :--- | :--- | :--- |\n| recipientId| Yes | String | Indicates the unique ID of the applied electronic seal.
|\n| routingOrder| No (default: 1) | String | Specifies the routing order of the electronic seal in the envelope.
The routing order assigned to your electronic seal cannot be shared with another recipient. It is recommended that you set a routing order for your electronic seals.. |\n| recipientSignatureProviders| Yes | String | Indicates which electronic seal to apply on documents when creating an envelope. |\n\n\n
\n\n\n\nBy default, Electronic Seals apply on all documents in an envelope. However, the sealDocumentsWithTabsOnly property (see recipientSignatureProvider) allows you to seal only documents that have signHere tabs set for the Electronic Seal recipients.\n\n
\n\n\n\n## Signer Recipient\n\nA signer is a recipient who must sign, initial, date, or add data to form fields on the documents in the envelope.\n\nIn addition to the [core parameters](#core-recipient-parameters), this recipient type adds the following parameters:\n\n
\n\n\n| Name | Required | Schema Type | Description |\n| :--- | :--- | :--- | :--- |\n| autoNavigation | No | Boolean | Specifies whether auto navigation is set for the recipient.|\n| defaultRecipient | No | Boolean | When set to **true**, this is the default recipient for the envelope. This option is used with the CreateEnvelopeFromTemplatesAndForms method. |\n| documentVisibility | No | documentVisibility | A complex type that specifies which documents are visible to this recipient. |\n| isBulkRecipient | No | Boolean | Indicates whether the recipient is a bulk send recipient or not. |\n| recipientSuppliesTabs | No | Boolean | Indicates whether the recipient supplies tabs in the document. |\n| signInEachLocation | No | Boolean | When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab (instead of adopting a signature/initial style or only drawing a signature/initial once). |\n| signatureInfo | No | String | Optional element only used with recipient types In Person Signers, Signers, and Witnesses.

Allows the sender to pre-specify the signature name, signature initials, and signature font used in the signature stamp for the recipient. |\n| signerEmail | No | String | Optional element. The email address for an In-Person Signer recipient Type.
Maximum Length: 100 characters. |\n| signerName | Yes | String | Required element with recipient type In Person Signers.
Maximum Length: 100 characters.

The full legal name of a signer for the envelope. |\n| tabs | No | Tab | Optional element only used with recipient types In Person Signers and Signers.

Specifies the Tabs associated with the recipient. See the the [EnvelopeRecipientTabs resource](https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/) for more information about tabs. |\n\n
\n\n[enotary-resources]: https://support.docusign.com/en/guides/ndse-user-guide-enotary-resources\n\n\n## Witness Recipient\n\nA witness is a recipient whose signature affirms that the identified signers have signed the documents in the envelope.\n\nIn addition to the [core parameters](#core-recipient-parameters), this recipient type adds the following parameters:\n\n
\n\n\n| Name | Required | Schema Type | Description |\n| :--- | :--- | :--- | :--- |\n| autoNavigation | No | Boolean |\tSpecifies whether auto navigation is set for the recipient. |\n| defaultRecipient | No | Boolean | When set to **true**, this is the default recipient for the envelope. This option is used when creating an envelope from a template. |\n| documentVisibility | No | documentVisibility | A complex type that specifies which documents are visible to this recipient. |\n| isBulkRecipient | No | Boolean | Indicates whether the recipient is a bulk send recipient or not. |\n| recipientSignatureProviders | Yes | String | Indicates which electronic seal to apply on documents when creating an envelope. |\n| recipientSuppliesTabs | No | Boolean | Indicates whether the recipient supplies tabs in the document. |\n| recipientType | Yes | String | Indicates the recipient type. |\n|requireSignerCertificate | No | Boolean | Indicates whether the envelope requires a signer certificate for this recipient. |\n| requireSignOnPaper | No | Boolean | Specifies whether the signer must print, sign, and upload or fax the signed documents to DocuSign. |\n| signatureInfo | No | Boolean | Optional element only used with recipient types In Person Signers, Signers, and Witnesses. Enables the sender to pre-specify the signature name, signature initials, and signature font used in the signature stamp for the recipient. |\n| signInEachLocation | No | Boolean | When set to **true** and the feature is enabled in the sender's account, specifies that the signing recipient is required to sign and initial at each signature/initial tab (instead of once). |\n| signingGroupId | No | String | The id of the [signing group](https://support.docusign.com/en/guides/ndse-user-guide-signing-groups). |\n| signingGroupName | No | String | The display name for the signing group. Maximum Length: 100 characters. |\n| signingGroupUsers | No | userInfo | A complex type that contains information about the users in the signing group. |\n| witnessFor | Yes | String | Indicates the person or party for whom the recipient is a witness. |\n| witnessForGuid | Yes | String | GUID identifying the person or party for whom the recipient is a witness. |\n\n\n[ListLang]: https://developers.docusign.com/docs/esign-rest-api/reference/Accounts/Accounts/listSupportedLanguages/\n" }, { "name": "EnvelopeRecipientTabs", - "description": "\n\n\nThe EnvelopeRecipientTabs resource provides methods that let you\nadd,\nupdate,\nand delete tabs\nfrom an envelope.\nTabs are associated with a specific recipient\nin an envelope\nand are only used by the recipient types\nIn Person Signers and Signers.\n\n\n\n**On this page**\n\n- [Tab Types](#tab-types)\n- [Sign Here Tab Alignment](#sign-here-tab-alignment)\n- [View Tab](#view-tab)\n- [Requesting Payments](#requesting-payments)\n- [Using Custom Tabs in Envelopes and Templates](#using-custom-tabs-in-envelopes-and-templates)\n- [Anchoring Tabs](#anchoring-tabs)\n- [Automatically Populating Tabs](#automatically-populating-tabs)\n\n\n\n\n## Tab Types\n\nSome tabs enable values to be entered by the signer. Those tabs' values can be preset either through the web browser or via the API. Other tab types use information that is already recognized by the DocuSign platform. These tabs cannot have their value updated on a per-tab basis by the API or via the browser. In some cases, the info might be settable using a different technique. For example, the Full name tab uses the signer's name, which is set elsewhere in the request.\n\nHere is the list of tabs and whether you can or cannot set their values in the tab definition:\n\n
\n\n| Tab Type | Description |\n| :--------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| Approve ([`approve`][approve]) | Allows the recipient to approve documents without placing a signature or initials on the document. If the recipient clicks the tab during the signing process, the recipient is considered to have signed the document. No information is shown on the document of the approval, but it is recorded as a signature in the envelope history. This value **can't** be set. |\n| Checkbox ([`checkbox`][checkbox]) | Allows the recipient to select a yes/no (on/off) option. This value can be set. |\n| Company ([`company`][company]) | Displays the recipient's company name. This value **can't** be set. |\n| Date Signed ([`dateSigned`][dateSigned]) | Displays the date that the recipient signed the document. This value **can't** be set. |\n| Date ([`date`][date]) | Allows the recipient to enter a date. Date tabs are one-line fields that allow date information to be entered in any format. The tooltip for this tab recommends entering the date as MM/DD/YYYY, but this is not enforced. The format entered by the signer is retained. If you need a particular date format enforced, DocuSign recommends using a Text tab with a validation pattern and a validation message to enforce the format. This value can be set. |\n| Decline ([`decline`][decline]) | Allows the recipient the option of declining an envelope. If the recipient clicks the tab during the signing process, the envelope is voided. This value **can't** be set. |\n| Email Address ([`emailAddress`][emailAddress]) | Displays the recipient's email as entered in the recipient information. This value **can't** be set. |\n| Email ([`email`][email]) | Allows the recipient to enter an email address. This is a one-line field that checks that a valid email address is entered. It uses the same parameters as a Text tab, with the validation message and pattern set for email information.

When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. This value can be set. |\n| Envelope ID ([`envelopeId`][envelopeId]) | Displays the envelope ID. Recipients cannot enter or change the information in this tab. This value **can't** be set. |\n| First Name ([`firstName`][firstName]) | Displays the recipient's first name. This tab takes the recipient's name as entered in the recipient information, splits it into sections based on spaces and uses the first section as the first name. This value **can't** be set. |\n| Formula Tab ([`formulaTab`][formulaTab]) | The value of a formula tab is calculated from the values of other number or date tabs in the document. When the recipient completes the underlying fields, the formula tab calculates and displays the result. This value can be set.The `formula` property of the tab contains the references to the underlying tabs. See [Calculated Fields][calculatedfields] in the DocuSign Support Center to learn more about formulas. If a formula tab contains a `paymentDetails` property, the tab is considered a payment item. See [Requesting Payments Along with Signatures][paymentguide] in the DocuSign Support Center to learn more about payments. |\n| Full Name ([`fullName`][fullName]) | Displays the recipient's full name. This value **can't** be set. |\n| Initial Here ([`initialHere`][initialHere]) | Allows the recipient to initial the document. May be optional. This value **can't** be set. |\n| Last Name ([`lastName`][lastName]) | Displays the recipient's last name. This tab takes the recipient's name as entered in the recipient information, splits it into sections based on spaces and uses the last section as the last name. This value **can't** be set. |\n| List ([`list`][list]) | This tab offers a list of options to choose from. The `listItems` property is used to specify the selectable options. This value can be set, |\n| Notarize ([`notarize`][notarize]) | Place this tab on a page to alert Notary recipients that they must take action. Only one notarize tab can appear on a page. This value can be set. |\n| Note ([`note`][note]) | Displays additional information, in the form of a note, for the recipient. This value can be set. |\n| Number ([`number`][number]) | Allows the recipient to enter numbers and decimal (.) points. This value can be set. |\n| Radio Group ([`radioGroup`][radioGroup]) | This group tab is used to place radio buttons on a document. The `radios` property is used to add and place the radio buttons associated with the group. Only one radio button can be selected in a group. This value can be set. |\n| Sign Here ([`signHere`][signHere]) | Allows the recipient to sign a document. May be optional. This value **can't** be set.
**Note**: `signHere` tabs can also be used to add a visual representation for an electronic seal in a document. |\n| Signer Attachment ([`signerAttachment`][signerAttachment]) | Allows the recipient to attach supporting documents to an envelope. This value **can't** be set. |\n| SSN ([`ssn`][ssn]) | A one-line field that allows the recipient to enter a Social Security Number. The SSN can be typed with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for SSN information. This value can be set. |\n| Text ([`text`][text]) | Allows the recipient to enter any type of text. This value can be set. |\n| Title ([`title`][title]) | Displays the recipient's title. This value **can't** be set. |\n| View ([`view`][view]) | The View tab is used with the Approve tab to handle supplemental documents. This value can be set. |\n| Zip ([`zip`][zip]) | Allows the recipient to enter a ZIP code. The ZIP code can be five digits or nine digits in the ZIP+4 format. The zip code can be typed with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for ZIP code information. This value can be set. |\n\n\n[approve]:\t\t https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/approve\n[checkbox]:\t\t https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/checkbox\n[company]:\t\t https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/company\n[dateSigned]:\t\t https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/dateSigned\n[date]:\t\t https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/date\n[decline]:\t\t https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/decline\n[emailAddress]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/emailAddress\n[email]:\t\t https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/email\n[envelopeId]:\t \thttps://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/envelopeId\n[firstName]:\t \thttps://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/firstName\n[formulaTab]:\t \thttps://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/formulaTab\n[fullName]:\t\t https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/fullName\n[initialHere]:\t \thttps://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/initialHere\n[lastName]:\t\t https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/lastName\n[list]:\t \thttps://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/list\n[notarize]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/notarize\n[note]:\t\t https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/note\n[number]:\t\t https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/number\n[radioGroup]:\t\t https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/radioGroup\n[signerAttachment]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/signerAttachment\n[signHere]:\t \thttps://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/signHere\n[ssn]:\t \thttps://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/ssn\n[text]:\t \thttps://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/text\n[title]:\t \thttps://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/title\n[view]:\t\t https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/view\n[zip]:\t \thttps://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/zip\n\n[calculatedfields]: https://support.docusign.com/en/guides/ndse-user-guide-calculated-fields\n[paymentguide]: https://support.docusign.com/en/guides/requesting-payments-along-with-signatures\n\n\n## Sign Here Tab Alignment\n\nWhen you provide an x- and y-coordinate for the\nsign here tab,\nthe tab appears 21 points *lower*\nthan the value you provide for the y-coordinate.\nTo align the tab as expected,\nsubtract 21 from the expected y-value.\n\n![Sign Here Tab Alignment](/img/signherealign.png)\n\n\n\n\n\n## View Tab\n\nThe View tab is used on supplemental documents.\nTo learn more about using the View tab with\nsupplemental documents, see\n[Using Supplemental Documents][usingsupdocs]\nin the [Sending Documents][sendenvelopes] section of\nthe [Envelope: create][envelopecreate] method.\n\n[sendenvelopes]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/create/#sending-envelopes\n[usingsupdocs]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/create/#using-supplemental-documents\n[envelopecreate]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/create/\n\n
\n\n| Name | Required | Type | Description |\n| :---- | :---- | :---- | :---- |\n| documentId | Yes | String | The document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. |\n| pageNumber | Yes | String | Must be set to 1. |\n| recipientId | Yes | String | The recipient associated with the tab. Must refer to an existing recipient's ID attribute. |\n| required | No | Boolean | If **true**, the recipient is required to select the supplemental document View button during signing. |\n| tabLabel | No | String | The label used for the tab. If an empty string is provided for this, an empty sting is used. If no value is provided, the tab type is used as the value. Maximum of 500 characters. |\n| templateLocked | No | Boolean | Optional. Used only when working with template tabs. If **true**, the attributes of the tab cannot be changed by the sender. |\n| templateRequired | No | Boolean | Optional. Used only when working with template tabs. If **true**, the tab cannot be removed by the sender. |\n| xPosition | Yes | String | Required, but can be 0. |\n| yPosition | Yes | String | Required, but can be 0. |\n\n\n## Requesting Payments\n\nThe Payments feature of the DocuSign eSignature REST API\nlets you collect payments\nalong with signatures and other information.\n\nTo send a request for payment\nand collect payments,\nyou need a payment gateway account,\nwhich is the destination for the payments.\nCreate a payment account\nwith a supported payment gateway,\nand then connect the payment gateway account\nto your DocuSign account.\nTo learn how to connect a payment gateway account\nto your DocuSign account\nsee [Managing Payment Gateways][paymentgateways]\nin the DocuSign Support Center.\nYou must connect and manage payment gateway accounts manually\nthrough the DocuSign Admin console\nand through your chosen payment gateway.\nThere is no public API\nfor connecting payment gateway accounts\nto DocuSign accounts\nor for managing payment gateway accounts.\n\nCurrently\n[Stripe][stripe],\n[Braintree](https://www.braintreepayments.com/), and\n[Authorize.net](https://www.authorize.net/)\nare the supported payment gateways.\n\n### How Payments Work\n\nTo make a request for payment,\nuse a [`formulaTab`][formulatab]\nthat has a\n[`paymentDetails`][paymentdetails] object.\nThis object includes\na list of [`paymentLineItem`][paymentlineitem] objects.\nEach line item refers to a [`number`][numbertab] tab\nthat contains the value of the each item.\nThe purpose of the line items\nis to transmit them to the payment gateway\nas metadata, so that you can use the information\nin the payment processor.\n\n**Note**: If the fileExtension parameter is not added in an API call, only base64 converted pdf files will be accepted.\nAny attempt to send a non pdf file without using fileExtension results in an error.\n\nThis is an example request for two books.\nEach book is specified in the `number` tabs\nlabeled \"Hamlet\" and \"Tempest\".\nThe books are referenced as line items\nby their tab labels\nwithin the `paymentDetails` object\nof a `formula` tab.\nThe formula of the `formula` tab\nadd the values of the same two `number` tabs.\n\n```json\n{\n \"documents\": [\n {\n \"documentBase64\": \"\",\n \"documentId\": \"1\",\n \"fileExtension\": \"pdf\",\n \"name\": \"payment.pdf\"\n }\n ],\n \"emailSubject\": \"Order Some Books\",\n \"recipients\": {\n \"signers\": [\n {\n \"email\": \"vreader@example.com\",\n \"name\": \"Voracious Reader\",\n \"recipientId\": \"1\",\n \"routingOrder\": \"1\",\n \"tabs\": {\n . . .\n \"numberTabs\": [\n {\n \"value\": \"10.00\",\n \"width\": 78,\n \"required\": \"true\",\n \"locked\": \"true\",\n \"tabLabel\": \"Hamlet\",\n \"documentId\": \"1\",\n \"pageNumber\": \"1\",\n \"xPosition\": \"323\",\n \"yPosition\": \"134\"\n },\n {\n \"value\": \"10.00\",\n \"width\": 78,\n \"required\": \"true\",\n \"locked\": \"true\",\n \"tabLabel\": \"Tempest\",\n \"documentId\": \"1\",\n \"pageNumber\": \"1\",\n \"xPosition\": \"323\",\n \"yPosition\": \"154\"\n }\n ],\n \"formulaTabs\": [\n {\n \"required\": \"true\",\n \"formula\": \"([Hamlet] + [Tempest]) * 100\",\n \"roundDecimalPlaces\": \"2\",\n \"paymentDetails\": {\n \"currencyCode\": \"USD\",\n \"lineItems\": [\n {\n \"name\": \"Hamlet\",\n \"description\": \"The Danish Play\",\n \"itemCode\": \"SHAK1\",\n \"amountReference\": \"Hamlet\"\n },\n {\n \"name\": \"Othello\",\n \"description\": \"The one with Caliban in it\",\n \"itemCode\": \"SHAK2\",\n \"amountReference\": \"Tempest\"\n }\n ],\n \"gatewayAccountId\": \"e76668b4-53a9-4413-b551-a208d659e490\"\n },\n \"tabLabel\": \"Payment1\",\n \"documentId\": \"1\",\n \"pageNumber\": \"1\",\n \"xPosition\": 300,\n \"yPosition\": 200\n }\n ]\n }\n }\n ]\n },\n \"status\": \"sent\"\n}\n```\n\nUse the\n[EnvelopeRecipients: list][enveloperecipientslist] method\nto check the status of a payment.\nWhen the payment is successful,\nthe `status` property of\nthe [`paymentDetails`][paymentdetails] object\nis `payment_complete`.\n\n```json\n{\n \"signers\": [\n {\n \"tabs\": {\n . . .\n \"numberTabs\": [\n {\n \"value\": \"10.00\",\n \"tabLabel\": \"Hamlet\",\n \"documentId\": \"1\",\n \"recipientId\": \"1\",\n \"pageNumber\": \"1\",\n \"xPosition\": \"323\",\n \"yPosition\": \"134\",\n },\n {\n \"value\": \"10.00\",\n \"tabLabel\": \"Tempest\",\n \"documentId\": \"1\",\n \"recipientId\": \"1\",\n \"pageNumber\": \"1\",\n }\n ],\n \"formulaTabs\": [\n {\n \"formula\": \"([Hamlet] + [Tempest]) * 100\",\n \"roundDecimalPlaces\": \"2\",\n \"paymentDetails\": {\n \"status\": \"payment_complete\",\n \"currencyCode\": \"USD\",\n \"lineItems\": [\n {\n \"name\": \"Hamlet\",\n \"description\": \"The Danish Play\",\n \"itemCode\": \"SHAK1\",\n \"amountReference\": \"Hamlet\"\n },\n {\n \"name\": \"Tempest\",\n \"description\": \"The one with Caliban in it\",\n \"itemCode\": \"SHAK2\",\n \"amountReference\": \"Tempest\"\n }\n ],\n \"gatewayAccountId\": \"e76668b4-53a9-4413-b551-a208d659e490\"\n },\n \"value\": \"20\",\n \"required\": \"true\",\n \"locked\": \"false\",\n \"tabLabel\": \"Payment1\",\n \"documentId\": \"1\",\n \"recipientId\": \"1\",\n \"pageNumber\": \"1\",\n }\n ]\n },\n \"creationReason\": \"sender\",\n \"email\": \"vreader@example.com\",\n \"name\": \"Voracious Reader\",\n \"recipientId\": \"1\",\n \"requireIdLookup\": \"false\",\n \"status\": \"completed\",\n }\n ],\n . . .\n}\n```\n\n### Some Things to Keep in Mind About Payments\n\n* An envelope is not completed until all payments are completed.\n\n* If a DocuSign account Administrator\n deletes a payment gateway account connection\n DocuSign cancels all in-process envelopes\n that reference the deleted payment gateway account.\n\n* If the sender voids an envelope,\n all payment authorizations are canceled.\n\n* If a required recipient refuses to sign,\n all authorized payments are canceled.\n\n* If a required recipient's payment fails authorization,\n DocuSign attempts to recover\n by sending the recipient\n notification about the failed payment authorization.\n The recipient has the opportunity\n to correct the payment method information.\n\n* Each recipient's payment is authorized separately.\n Accounts are charged and payment made\n after all required tabs are completed,\n and all payments in an envelope for all recipients are authorized.\n\n* Refunds are not supported.\n Conduct refunds or payment changes\n with the payment gateway separately from DocuSign.\n\n* At this time, DocuSign does not charge a per-transaction fee.\n\n\n[enveloperecipientslist]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipients/list/\n[formulatab]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/formulaTab\n[ISO4217]: https://en.wikipedia.org/wiki/ISO_4217\n[numbertab]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/number\n[paymentgateways]: https://support.docusign.com/en/guides/managing-payment-gateways\n[paymentguide]: https://support.docusign.com/en/guides/requesting-payments-along-with-signatures\n[paymentlineitem]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/paymentLineItem\n[paymentdetails]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/paymentDetails\n[stripe]: https://stripe.com/\n\n\n## Using Custom Tabs in Envelopes and Templates\n\nCustom Tabs can be added to envelopes and templates\nby setting the `customTabId` property\nwhen creating an envelope or template recipient\nor when adding a new tab for an existing recipient.\nThe custom tab must be added as the correct tab type.\nFor example if the custom tab type is text, it cannot be used as a number tab.\n\nWhen the `customTabId` property is set,\nthe new tab inherits all the custom tab properties.\nRequired information that is not included in the custom tab,\nsuch as document ID and page ID, must be included when adding the tab.\nIf the custom tab does not have anchor settings, the X and Y positions must be included.\n\nAfter the tab is created,\nit is treated as any other tab for updating or deleting.\n\n## Anchoring Tabs\n\nThe tab anchoring option\nallows you to send documents for signature\nthat do not have a fixed layout or format.\nIn these documents you might not know\nthe absolute location of the tabs\nwhen you design your API client application because the tabs must move with text.\nAs an alternative to sending X and Y coordinates for tabs,\nthe DocuSign Service can derive an anchor location for the tab\nby correlating anchor information to data within the document.\n\nWhen the DocuSign Service receives a request that contains tabs\nwith anchor information,\nit searches the document for instances of the `anchorString` property.\nWhen found,\nit places a tab of the specified type for the designated recipient.\nTab positions are established by setting offsets for the tab.\n\nWhen you apply tabs to the document,\nDocuSign does not remove or replace the text in the `anchorString` property. You can hide codified anchors by using the same font color as the background of the document. So the anchor can be used by DocuSign processes and it will not be visible on the document.\n\nTo use an anchoring option:\n\n1. Identify the location in the document by text string. You can use a pre-existing text string or add a new one.\nFor best performance DocuSign recommends using single word anchor strings when possible, especially when there are a large number of pages in the envelope.\nFor example, you might want to add a Sign Here tab to the \"Borrower's Signature\" lines in a document, but that phrase might occur in places in the document where you don't want to tab to appear. In this case, you could add the text \"BorrowerSignHere\" in white font color (so that isn't visible in the document) to all the places you want Sign Here tabs to appear and use \"BorrowerSignHere\" as the anchor string.\n1. Reference the anchor through the `anchorString` property of the tab.\n1. Determine the offset from the anchor string location to where the tab should be placed.\n\nSetting a positive value in the `anchorXOffset` property moves the tab right on the page and positive values in the `anchorYoffset` prove moves the tab down the page. The `anchorUnits` property specifies the units used for the offsets.\nFor Sign Here and Initial Here tabs the bottom-left of the anchor string is equivalent to position (0,0), and the bottom-left of the tab graphic is placed relative to that.\nFor all other tabs the bottom-left of the anchor string is equivalent to position (0,0), and the top-left of the tab graphic is placed relative to that.\nDocuSign does not currently provide tools to derive the offset values. Determination of the proper offset will likely require some trial-and-error.\n\n### Rules for working with anchor tags\n\nWhen anchor tabs are used, all documents in the envelope are searched for the `anchorString` property.\n\n* You set the text of the anchor string in the `anchorString` property. DocuSign tabs are created for each instance of the `anchorString` property within the document, so special care must be taken to establish unique anchor strings that do not result in unintentional tabs.\n* You cannot use the same anchored tab for different recipients for the same document.\n* The DocuSign system cannot search for text that is embedded in an image when checking for anchor strings.\n* X or Y offsets supplied for a tab apply to all instances of the tab in the document. To use different offsets at different locations in the document for the same recipient, create multiple, unique anchor tabs.\n* If the Y offset value of an anchor string would force a tab outside of the page boundaries, the tag is placed at the page boundary. If the X offset value places a tab outside of the page boundaries, the error message `Invalid_User_Offset` is sent. The error message includes the X offset that resulted in the error.\n* The system does not support an anchor string embedded in the form of a PDF X-object in the document.\n* The system does not re-flow the text that surrounds the anchor tabs. It is the responsibility of the document author to provide sufficient white space to contain the potential width of the ultimate tab value.\n\n### Tips and Tricks\n\nThe following are tips for effective use of anchor tags:\n* In order to avoid unintentional conflicts between text contained in an `anchorString` property and the text that naturally exists in documents, establish a codified syntax for the anchor string text that is unlikely to appear elsewhere in a document.\n* Develop an extensible and consistent syntax that can be used across multiple document types.\n* Especially for documents that have variable numbers of tabs or signers, author the source document to include hidden anchor tabs for all potential signers/permutations. Then, control the tabs that are actually placed by including/excluding the anchor tabs in the request. This approach allows a single document to be used for all use cases instead of maintaining separate documents for each scenario.\n\n## Automatically Populating Tabs\n\nIf you want similar tab types\nto automatically populate with the same data,\nyou must follow these guidelines:\n\n* Each `tabLabel` entry must have the characters\n `\\\\*` in front of the label.\n If you omit the `\\\\*` prefix,\n only the first occurrence of the tab is populated.\n\n When automatically populating tabs,\n the `tabLabel` must not contain any spaces.\n In the JSON example below,\n the Text tabs properties `StudentLastName` and `StudentFirstName`\n will be auto-populated as specified (\"Doe\" and \"John\")\n each place they appear throughout the envelope.\n\n ```\n \"tabs\": {\n \"textTabs\": [\n {\n \"tabLabel\": \"\\\\*StudentLastName\",\n \"value\": \"Doe\"\n },\n {\n \"tabLabel\": \"\\\\*StudentFirstName\",\n \"value\": \"John\"\n }]\n }\n ```\n\n* Each occurrence of the tab must have identical properties.\n\n For example, suppose there are two Text tabs in a document,\n each with `tabLabel` set to `Name`.\n If one tab has the `bold` property set to **true**,\n and the other has the `bold` property set to **false**,\n only the first one will be populated.\n In order to automatically populate both occurrences\n of the `Name` Text tabs,\n the `bold` property must be set to the same value for both tabs.\n" + "description": "The EnvelopeRecipientTabs resource provides methods that enable you\nto add,\nupdate,\nand delete tabs\nfrom an envelope.\nTabs are associated with a specific recipient\nin an envelope\nand are only used by the recipient types\nIn Person Signers and Signers.\n\n\n\n**On this page**\n\n- [Tab Types](#tab-types)\n- [View Tab](#view-tab)\n- [Requesting Payments](#requesting-payments)\n- [Using Custom Tabs in Envelopes and Templates](#using-custom-tabs-in-envelopes-and-templates)\n- [Anchoring Tabs](#anchoring-tabs)\n- [Automatically Populating Tabs](#automatically-populating-tabs)\n\n\n\n\n## Tab Types\n\nSome tabs enable values to be entered by the signer.\nThose tabs' values can be preset either through the web browser\nor via the API. Other tab types use information that is already\nrecognized by the DocuSign platform.\nThese tabs cannot have their value updated on a per-tab basis\nby the API or via the browser. In some cases, the info might be\nsettable using a different technique.\nFor example, the Full name tab uses the signer's name,\nwhich is set elsewhere in the request.\n\nHere is the list of tabs and whether you can or cannot set their values in the tab definition:\n\n
\n\n| Tab Type | Description |\n| :------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| Approve (`approve`) | Allows the recipient to approve documents without placing a signature or initials on the document. If the recipient clicks the tab during the signing process, the recipient is considered to have signed the document. No information is shown on the document of the approval, but it is recorded as a signature in the envelope history. This value **can't** be set. |\n| Checkbox (`checkbox`) | Allows the recipient to select a yes/no (on/off) option. This value can be set. |\n| Company (`company`) | Displays the recipient's company name. This value **can't** be set. |\n| Date Signed (`dateSigned`) | Displays the date that the recipient signed the document. This value **can't** be set. |\n| Date (`date`) | Allows the recipient to enter a date. Date tabs are one-line fields that allow date information to be entered in any format. The tooltip for this tab recommends entering the date as MM/DD/YYYY, but this is not enforced. The format entered by the signer is retained. If you need a particular date format enforced, DocuSign recommends using a Text tab with a validation pattern and a validation message to enforce the format. This value can be set. |\n| Decline (`decline`) | Allows the recipient the option of declining an envelope. If the recipient clicks the tab during the signing process, the envelope is voided. This value **can't** be set. |\n| Email Address (`emailAddress`) | Displays the recipient's email as entered in the recipient information. This value **can't** be set. |\n| Email (`email`) | Allows the recipient to enter an email address. This is a one-line field that checks that a valid email address is entered. It uses the same parameters as a Text tab, with the validation message and pattern set for email information.

When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. This value can be set. |\n| Envelope ID (`envelopeId`) | Displays the envelope ID. Recipients cannot enter or change the information in this tab. This value **can't** be set. |\n| First Name (`firstName`) | Displays the recipient's first name. This tab takes the recipient's name as entered in the recipient information, splits it into sections based on spaces and uses the first section as the first name. This value **can't** be set. |\n| Formula Tab (`formulaTab`) | The value of a formula tab is calculated from the values of other number or date tabs in the document. When the recipient completes the underlying fields, the formula tab calculates and displays the result. This value can be set.The `formula` property of the tab contains the references to the underlying tabs. See [Calculated Fields] in the DocuSign Support Center to learn more about formulas. If a formula tab contains a `paymentDetails` property, the tab is considered a payment item. See [Requesting Payments Along with Signatures] in the DocuSign Support Center to learn more about payments. |\n| Full Name (`fullName`) | Displays the recipient's full name. This value **can't** be set. |\n| Initial Here (`initialHere`) | Allows the recipient to initial the document. May be optional. This value **can't** be set. |\n| Last Name (`lastName`) | Displays the recipient's last name. This tab takes the recipient's name as entered in the recipient information, splits it into sections based on spaces and uses the last section as the last name. This value **can't** be set. |\n| List (`list`) | This tab offers a list of options to choose from. The `listItems` property is used to specify the selectable options. This value can be set, |\n| Notarize (`notarize`) | Place this tab on a page to alert Notary recipients that they must take action. Only one notarize tab can appear on a page. This value can be set. |\n| Note (`note`) | Displays additional information, in the form of a note, for the recipient. This value can be set. |\n| Number (`number`) | Allows the recipient to enter numbers and decimal (.) points. This value can be set. |\n| Radio Group (`radioGroup`) | This group tab is used to place radio buttons on a document. The `radios` property is used to add and place the radio buttons associated with the group. Only one radio button can be selected in a group. This value can be set. |\n| Sign Here (`signHere`) | Allows the recipient to sign a document. May be optional. This value **can't** be set.
**Note**: `signHere` tabs can also be used to add a visual representation for an electronic seal in a document. |\n| Signer Attachment (`signerAttachment`) | Allows the recipient to attach supporting documents to an envelope. This value **can't** be set. |\n| SSN (`ssn`) | A one-line field that allows the recipient to enter a Social Security Number. The SSN can be typed with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for SSN information. This value can be set. |\n| Text (`text`) | Allows the recipient to enter any type of text. This value can be set. |\n| Title (`title`) | Displays the recipient's title. This value **can't** be set. |\n| View (`view`) | The View tab is used with the Approve tab to handle supplemental documents. This value can be set. |\n| Zip (`zip`) | Allows the recipient to enter a ZIP code. The ZIP code can be five digits or nine digits in the ZIP+4 format. The zip code can be typed with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for ZIP code information. This value can be set. |\n\n\n[approve]:\t\t https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/#tab-types\n[checkbox]:\t\t https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/#tab-types\n[company]:\t\t https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/#tab-types\n[dateSigned]:\t\t https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/#tab-types\n[date]:\t\t https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/#tab-types\n[decline]:\t\t https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/#tab-types\n[emailAddress]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/#tab-types\n[email]:\t\t https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/#tab-types\n[envelopeId]:\t \thttps://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/#tab-types\n[firstName]:\t \thttps://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/#tab-types\n[formulaTab]:\t \thttps://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/#tab-types\n[fullName]:\t\t https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/#tab-types\n[initialHere]:\t \thttps://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/#tab-types\n[lastName]:\t\t https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/#tab-types\n[list]:\t \thttps://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/#tab-types\n[notarize]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/#tab-types\n[note]:\t\t https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/#tab-types\n[number]:\t\t https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/#tab-types\n[radioGroup]:\t\t https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/#tab-types\n[signerAttachment]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/#tab-types\n[signHere]:\t \thttps://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/#tab-types\n[ssn]:\t \thttps://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/#tab-types\n[text]:\t \thttps://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/#tab-types\n[title]:\t \thttps://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/#tab-types\n[view]:\t\t https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/#tab-types\n[zip]:\t \thttps://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/#tab-types\n\n[calculatedfields]: https://support.docusign.com/en/guides/ndse-user-guide-calculated-fields\n[paymentguide]: https://support.docusign.com/en/guides/requesting-payments-along-with-signatures\n\n\n\n\n\n\n## View Tab\n\nThe View tab is used on supplemental documents.\nTo learn more about using the View tab with\nsupplemental documents, see\n[Using Supplemental Documents][usingsupdocs]\nin the [Sending Documents][sendenvelopes] section of\nthe [Envelope: create][envelopecreate] method.\n\n[sendenvelopes]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/Envelopes/create/\n[usingsupdocs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/documents/supplemental/\n[envelopecreate]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/Envelopes/create/\n\n
\n\n| Name | Required | Type | Description |\n| :---- | :---- | :---- | :---- |\n| documentId | Yes | String | The document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. |\n| pageNumber | Yes | String | Must be set to 1. |\n| recipientId | Yes | String | The recipient associated with the tab. Must refer to an existing recipient's ID attribute. |\n| required | No | Boolean | If **true**, the recipient is required to select the supplemental document View button during signing. |\n| tabLabel | No | String | The label used for the tab. If an empty string is provided for this, an empty sting is used. If no value is provided, the tab type is used as the value. Maximum of 500 characters. |\n| templateLocked | No | Boolean | Optional. Used only when working with template tabs. If **true**, the attributes of the tab cannot be changed by the sender. |\n| templateRequired | No | Boolean | Optional. Used only when working with template tabs. If **true**, the tab cannot be removed by the sender. |\n| xPosition | Yes | String | Required, but can be 0. |\n| yPosition | Yes | String | Required, but can be 0. |\n\n\n## Requesting Payments\n\nThe Payments feature of the DocuSign eSignature REST API\nlets you collect payments\nalong with signatures and other information.\n\nTo send a request for payment\nand collect payments,\nyou need a payment gateway account,\nwhich is the destination for the payments.\nCreate a payment account\nwith a supported payment gateway,\nand then connect the payment gateway account\nto your DocuSign account.\nTo learn how to connect a payment gateway account\nto your DocuSign account\nsee [Managing Payment Gateways][paymentgateways]\nin the DocuSign Support Center.\nYou must connect and manage payment gateway accounts manually\nthrough the DocuSign Admin console\nand through your chosen payment gateway.\nThere is no public API\nfor connecting payment gateway accounts\nto DocuSign accounts\nor for managing payment gateway accounts.\n\nCurrently\n[Stripe][stripe],\n[Braintree](https://www.braintreepayments.com/), and\n[Authorize.net](https://www.authorize.net/)\nare the supported payment gateways.\n\n### How Payments Work\n\nTo make a request for payment,\nuse a [`formulaTab`][formulatab]\nthat has a\n[`paymentDetails`][paymentdetails] object.\nThis object includes\na list of [`paymentLineItem`][paymentlineitem] objects.\nEach line item refers to a [`number`][numbertab] tab\nthat contains the value of the each item.\nThe purpose of the line items\nis to transmit them to the payment gateway\nas metadata, so that you can use the information\nin the payment processor.\n\n**Note**: If the fileExtension parameter is not added in an API call, only base64 converted pdf files will be accepted.\nAny attempt to send a non pdf file without using fileExtension results in an error.\n\nThis is an example request for two books.\nEach book is specified in the `number` tabs\nlabeled \"Hamlet\" and \"Tempest\".\nThe books are referenced as line items\nby their tab labels\nwithin the `paymentDetails` object\nof a `formula` tab.\nThe formula of the `formula` tab\nadd the values of the same two `number` tabs.\n\n```json\n{\n \"documents\": [\n {\n \"documentBase64\": \"\",\n \"documentId\": \"1\",\n \"fileExtension\": \"pdf\",\n \"name\": \"payment.pdf\"\n }\n ],\n \"emailSubject\": \"Order Some Books\",\n \"recipients\": {\n \"signers\": [\n {\n \"email\": \"vreader@example.com\",\n \"name\": \"Voracious Reader\",\n \"recipientId\": \"1\",\n \"routingOrder\": \"1\",\n \"tabs\": {\n . . .\n \"numberTabs\": [\n {\n \"value\": \"10.00\",\n \"width\": 78,\n \"required\": \"true\",\n \"locked\": \"true\",\n \"tabLabel\": \"Hamlet\",\n \"documentId\": \"1\",\n \"pageNumber\": \"1\",\n \"xPosition\": \"323\",\n \"yPosition\": \"134\"\n },\n {\n \"value\": \"10.00\",\n \"width\": 78,\n \"required\": \"true\",\n \"locked\": \"true\",\n \"tabLabel\": \"Tempest\",\n \"documentId\": \"1\",\n \"pageNumber\": \"1\",\n \"xPosition\": \"323\",\n \"yPosition\": \"154\"\n }\n ],\n \"formulaTabs\": [\n {\n \"required\": \"true\",\n \"formula\": \"([Hamlet] + [Tempest]) * 100\",\n \"roundDecimalPlaces\": \"2\",\n \"paymentDetails\": {\n \"currencyCode\": \"USD\",\n \"lineItems\": [\n {\n \"name\": \"Hamlet\",\n \"description\": \"The Danish Play\",\n \"itemCode\": \"SHAK1\",\n \"amountReference\": \"Hamlet\"\n },\n {\n \"name\": \"Othello\",\n \"description\": \"The one with Caliban in it\",\n \"itemCode\": \"SHAK2\",\n \"amountReference\": \"Tempest\"\n }\n ],\n \"gatewayAccountId\": \"e76668b4-xxxx-xxxx-xxxx-a208d659e490\"\n },\n \"tabLabel\": \"Payment1\",\n \"documentId\": \"1\",\n \"pageNumber\": \"1\",\n \"xPosition\": 300,\n \"yPosition\": 200\n }\n ]\n }\n }\n ]\n },\n \"status\": \"sent\"\n}\n```\n\nUse the\n[EnvelopeRecipients: list][enveloperecipientslist] method\nto check the status of a payment.\nWhen the payment is successful,\nthe `status` property of\nthe [`paymentDetails`][paymentdetails] object\nis `payment_complete`.\n\n```json\n{\n \"signers\": [\n {\n \"tabs\": {\n . . .\n \"numberTabs\": [\n {\n \"value\": \"10.00\",\n \"tabLabel\": \"Hamlet\",\n \"documentId\": \"1\",\n \"recipientId\": \"1\",\n \"pageNumber\": \"1\",\n \"xPosition\": \"323\",\n \"yPosition\": \"134\",\n },\n {\n \"value\": \"10.00\",\n \"tabLabel\": \"Tempest\",\n \"documentId\": \"1\",\n \"recipientId\": \"1\",\n \"pageNumber\": \"1\",\n }\n ],\n \"formulaTabs\": [\n {\n \"formula\": \"([Hamlet] + [Tempest]) * 100\",\n \"roundDecimalPlaces\": \"2\",\n \"paymentDetails\": {\n \"status\": \"payment_complete\",\n \"currencyCode\": \"USD\",\n \"lineItems\": [\n {\n \"name\": \"Hamlet\",\n \"description\": \"The Danish Play\",\n \"itemCode\": \"SHAK1\",\n \"amountReference\": \"Hamlet\"\n },\n {\n \"name\": \"Tempest\",\n \"description\": \"The one with Caliban in it\",\n \"itemCode\": \"SHAK2\",\n \"amountReference\": \"Tempest\"\n }\n ],\n \"gatewayAccountId\": \"e76668b4-xxxx-xxxx-xxxx-a208d659e490\"\n },\n \"value\": \"20\",\n \"required\": \"true\",\n \"locked\": \"false\",\n \"tabLabel\": \"Payment1\",\n \"documentId\": \"1\",\n \"recipientId\": \"1\",\n \"pageNumber\": \"1\",\n }\n ]\n },\n \"creationReason\": \"sender\",\n \"email\": \"vreader@example.com\",\n \"name\": \"Voracious Reader\",\n \"recipientId\": \"1\",\n \"requireIdLookup\": \"false\",\n \"status\": \"completed\",\n }\n ],\n . . .\n}\n```\n\n#### How to make a request for future payments\n\nUse the following steps to make a request to collect a signer's payment method for future use:\n\n1. Add a text tab with a descriptive `tabLabel` such as `FuturePayment`.\n2. In the formula tab's `paymentDetails` object, add a `lineItem` object that references the `tabLabel` from step 1.\n\n**Note**: Do not include this new `lineItem` in formula calculations.\n\nThe following example builds on the previous code block to also collect a payment method for future use:\n\n```\n{\n \"documents\": [\n {\n \"documentBase64\": \"\",\n \"documentId\": \"1\",\n \"fileExtension\": \"pdf\",\n \"name\": \"payment.pdf\"\n }\n ],\n \"emailSubject\": \"Order Some Books\",\n \"recipients\": {\n \"signers\": [\n {\n \"email\": \"vreader@example.com\",\n \"name\": \"Voracious Reader\",\n \"recipientId\": \"1\",\n \"routingOrder\": \"1\",\n \"tabs\": {\n \"numberTabs\": [\n {\n \"value\": \"10.00\",\n \"width\": 78,\n \"required\": \"true\",\n \"locked\": \"true\",\n \"tabLabel\": \"Hamlet\",\n \"documentId\": \"1\",\n \"pageNumber\": \"1\",\n \"xPosition\": \"323\",\n \"yPosition\": \"134\"\n },\n {\n \"value\": \"10.00\",\n \"width\": 78,\n \"required\": \"true\",\n \"locked\": \"true\",\n \"tabLabel\": \"Tempest\",\n \"documentId\": \"1\",\n \"pageNumber\": \"1\",\n \"xPosition\": \"323\",\n \"yPosition\": \"154\"\n }\n ],\n \"textTabs\": [\n {\n \"value\": \"\",\n \"width\": 78,\n \"required\": \"true\",\n \"locked\": \"true\",\n \"tabLabel\": \"FuturePayment\",\n \"documentId\": \"1\",\n \"pageNumber\": \"1\",\n \"xPosition\": \"323\",\n \"yPosition\": \"174\"\n }\n ],\n \"formulaTabs\": [\n {\n \"required\": \"true\",\n \"formula\": \"([Hamlet] + [Tempest]) * 100\",\n \"roundDecimalPlaces\": \"2\",\n \"paymentDetails\": {\n \"currencyCode\": \"USD\",\n \"paymentOption\": \"save_and_authorize\",\n \"lineItems\": [\n {\n \"name\": \"Hamlet\",\n \"description\": \"The Danish Play\",\n \"itemCode\": \"SHAK1\",\n \"amountReference\": \"Hamlet\"\n },\n {\n \"name\": \"Othello\",\n \"description\": \"The one with Caliban in it\",\n \"itemCode\": \"SHAK2\",\n \"amountReference\": \"Tempest\"\n },\n {\n \"name\": \"Request books\",\n \"description\": \"collect Payment method\",\n \"itemCode\": \"\",\n \"amountReference\": \"FuturePayment\"\n }\n ],\n \"gatewayAccountId\": \"e76668b4-xxxx-xxxx-xxxx-a208d659e490\"\n },\n \"tabLabel\": \"Payment1\",\n \"documentId\": \"1\",\n \"pageNumber\": \"1\",\n \"xPosition\": 300,\n \"yPosition\": 200\n }\n ]\n }\n }\n ]\n },\n \"status\": \"sent\"\n}\n```\n\n### Some Things to Keep in Mind About Payments\n\n* An envelope is not completed until all payments are completed.\n\n* If a DocuSign account Administrator\n deletes a payment gateway account connection\n DocuSign cancels all in-process envelopes\n that reference the deleted payment gateway account.\n\n* If the sender voids an envelope,\n all payment authorizations are canceled.\n\n* If a required recipient refuses to sign,\n all authorized payments are canceled.\n\n* If a required recipient's payment fails authorization,\n DocuSign attempts to recover\n by sending the recipient\n notification about the failed payment authorization.\n The recipient has the opportunity\n to correct the payment method information.\n\n* Each recipient's payment is authorized separately.\n Accounts are charged and payment made\n after all required tabs are completed,\n and all payments in an envelope for all recipients are authorized.\n\n* Refunds are not supported.\n Conduct refunds or payment changes\n with the payment gateway separately from DocuSign.\n\n* At this time, DocuSign does not charge a per-transaction fee.\n\n\n[enveloperecipientslist]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipients/list/\n[formulatab]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/\n[ISO4217]: https://en.wikipedia.org/wiki/ISO_4217\n[numbertab]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/\n[paymentgateways]: https://support.docusign.com/en/guides/managing-payment-gateways\n[paymentguide]: https://support.docusign.com/en/guides/requesting-payments-along-with-signatures\n[paymentlineitem]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/\n[paymentdetails]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/\n[stripe]: https://stripe.com/\n\n\n## Using Custom Tabs in Envelopes and Templates\n\nCustom Tabs can be added to envelopes and templates\nby setting the `customTabId` property\nwhen creating an envelope or template recipient\nor when adding a new tab for an existing recipient.\nThe custom tab must be added as the correct tab type.\nFor example if the custom tab type is text, it cannot be used as a number tab.\n\nWhen the `customTabId` property is set,\nthe new tab inherits all the custom tab properties.\nRequired information that is not included in the custom tab,\nsuch as document ID and page ID, must be included when adding the tab.\nIf the custom tab does not have anchor settings, the X and Y positions must be included.\n\nAfter the tab is created,\nit is treated as any other tab for updating or deleting.\n\n## Anchoring Tabs\n\nThe tab anchoring option\nallows you to send documents for signature\nthat do not have a fixed layout or format.\nIn these documents you might not know\nthe absolute location of the tabs\nwhen you design your API client application because the tabs must move with text.\nAs an alternative to sending X and Y coordinates for tabs,\nthe DocuSign Service can derive an anchor location for the tab\nby correlating anchor information to data within the document.\n\nWhen the DocuSign Service receives a request that contains tabs\nwith anchor information,\nit searches the document for instances of the `anchorString` property.\nWhen found,\nit places a tab of the specified type for the designated recipient.\nTab positions are established by setting offsets for the tab.\n\nWhen you apply tabs to the document,\nDocuSign does not remove or replace the text in the `anchorString` property. You can hide codified anchors by using the same font color as the background of the document. So the anchor can be used by DocuSign processes and it will not be visible on the document.\n\nTo use an anchoring option:\n\n1. Identify the location in the document by text string. You can use a pre-existing text string or add a new one.\nFor best performance DocuSign recommends using single word anchor strings when possible, especially when there are a large number of pages in the envelope.\nFor example, you might want to add a Sign Here tab to the \"Borrower's Signature\" lines in a document, but that phrase might occur in places in the document where you don't want to tab to appear. In this case, you could add the text \"BorrowerSignHere\" in white font color (so that isn't visible in the document) to all the places you want Sign Here tabs to appear and use \"BorrowerSignHere\" as the anchor string.\n1. Reference the anchor through the `anchorString` property of the tab.\n1. Determine the offset from the anchor string location to where the tab should be placed.\n\nSetting a positive value in the `anchorXOffset` property moves the tab right on the page and positive values in the `anchorYoffset` prove moves the tab down the page. The `anchorUnits` property specifies the units used for the offsets.\nFor Sign Here and Initial Here tabs the bottom-left of the anchor string is equivalent to position (0,0), and the bottom-left of the tab graphic is placed relative to that.\nFor all other tabs the bottom-left of the anchor string is equivalent to position (0,0), and the top-left of the tab graphic is placed relative to that.\nDocuSign does not currently provide tools to derive the offset values. Determination of the proper offset will likely require some trial-and-error.\n\n### Rules for working with anchor tags\n\nWhen anchor tabs are used, all documents in the envelope are searched for the `anchorString` property.\n\n* You set the text of the anchor string in the `anchorString` property. DocuSign tabs are created for each instance of the `anchorString` property within the document, so special care must be taken to establish unique anchor strings that do not result in unintentional tabs.\n* You cannot use the same anchored tab for different recipients for the same document.\n* The DocuSign system cannot search for text that is embedded in an image when checking for anchor strings.\n* X or Y offsets supplied for a tab apply to all instances of the tab in the document. To use different offsets at different locations in the document for the same recipient, create multiple, unique anchor tabs.\n* If the Y offset value of an anchor string would force a tab outside of the page boundaries, the tag is placed at the page boundary. If the X offset value places a tab outside of the page boundaries, the error message `Invalid_User_Offset` is sent. The error message includes the X offset that resulted in the error.\n* The system does not support an anchor string embedded in the form of a PDF X-object in the document.\n* The system does not re-flow the text that surrounds the anchor tabs. It is the responsibility of the document author to provide sufficient white space to contain the potential width of the ultimate tab value.\n\n### Tips and Tricks\n\nThe following are tips for effective use of anchor tags:\n* In order to avoid unintentional conflicts between text contained in an `anchorString` property and the text that naturally exists in documents, establish a codified syntax for the anchor string text that is unlikely to appear elsewhere in a document.\n* Develop an extensible and consistent syntax that can be used across multiple document types.\n* Especially for documents that have variable numbers of tabs or signers, author the source document to include hidden anchor tabs for all potential signers/permutations. Then, control the tabs that are actually placed by including/excluding the anchor tabs in the request. This approach allows a single document to be used for all use cases instead of maintaining separate documents for each scenario.\n\n## Automatically Populating Tabs\n\nIf you want similar tab types\nto automatically populate with the same data,\nyou must follow these guidelines:\n\n* Each `tabLabel` entry must have the characters\n `\\\\*` in front of the label.\n If you omit the `\\\\*` prefix,\n only the first occurrence of the tab is populated.\n\n When automatically populating tabs,\n the `tabLabel` must not contain any spaces.\n In the JSON example below,\n the Text tabs properties `StudentLastName` and `StudentFirstName`\n will be auto-populated as specified (\"Doe\" and \"John\")\n each place they appear throughout the envelope.\n\n ```\n \"tabs\": {\n \"textTabs\": [\n {\n \"tabLabel\": \"\\\\*StudentLastName\",\n \"value\": \"Doe\"\n },\n {\n \"tabLabel\": \"\\\\*StudentFirstName\",\n \"value\": \"John\"\n }]\n }\n ```\n\n* Note that `\\\\*` matches _anything_. If you were to add\n another tab with the `tabLabel` set to `\\\\*Name` to the\n example above, it would end up matching the other two\n labels as well.\n\n* Each occurrence of the tab must have identical properties.\n\n For example, suppose there are two Text tabs in a document,\n each with `tabLabel` set to `Name`.\n If one tab has the `bold` property set to **true**,\n and the other has the `bold` property set to **false**,\n only the first one will be populated.\n In order to automatically populate both occurrences\n of the `Name` Text tabs,\n the `bold` property must be set to the same value for both tabs.\n" }, { "name": "EnvelopeDocumentTabs", @@ -54970,7 +66909,7 @@ }, { "name": "EnvelopeViews", - "description": "The EnvelopeViews provides methods that return URLs that you can embed into your application to provide access to the DocuSign UI.\n\nThe following views are available:\n\n* Console View - The authentication view of the DocuSign UI.\n* Correct View - The correction view of the DocuSign UI.\n* Edit View - The editing view of the DocuSign UI. \n###### Note: This provides the same functionality as the sender view.\n* Recipient View - The view the recipient sees in the DocuSign UI.\n* Sender View - The sending view of the DocuSign UI." + "description": "The `EnvelopeViews` resource provides methods that return URLs that you can embed into your application to provide access to the DocuSign UI.\n\nThe following Envelope Views are available:\n\n- Console View: The authentication view of the DocuSign UI.\n- Correct View: The correction view of the DocuSign UI.\n- Edit View: The editing view of the DocuSign UI.\n **Note**: This provides the same functionality as the sender view.\n- Recipient View: The view the recipient sees in the DocuSign UI.\n- Shared Recipient View: The view a user sees of a shared envelope in the DocuSign UI.\n- Sender View: The sending view of the DocuSign UI." }, { "name": "AccountSealProviders", @@ -54982,7 +66921,7 @@ }, { "name": "AccountSignatureProviders", - "description": "This resource provides information on the Standards Based Signature providers that have been provisioned for this account." + "description": "Standards-Based Signatures (SBS) is the label used to describe DocuSign's suite of signatures that comply with regional and industry regulations, such as the electronic IDentification, Authentication and trust Services (eIDAS) regulation in Europe.\n\n## Feature Differences When Using Standards-Based Signatures\n\nSome DocuSign features are not compatible with Standards-Based Signatures, while others work somewhat differently. It's important to understand these key differences.\n\n### DocuSign Features Not Compatible with SBS\n\n- Attachment by fax\n- Concatenation of signer attachments\n- Legacy digital signatures\n- Markup\n- Notary\n\n### DocuSign Features That Change with SBS\n\nThe following features work slightly differently with SBS:\n\n- **Advanced Correct**: After the first signature, adding or deleting a field is not allowed. This behavior occurs because SBS does not allow adding or removing form fields after a digital signature has already been applied to a PDF.\n- **Downloading Combined Envelopes**: A combined PDF is not digitally signed. This behavior occurs because concatenating digitally signed PDFs breaks the digital signatures on the PDFs.\n- **Freeform Signing**: After someone has signed, allows only signature and initials on free-form. This behavior occurs because if another signer has already signed the document, adding fields other than signature fields will break the existing digital signatures on the document.\n- **Watermarks**: All watermarks are added as PDF annotations. This behavior occurs because burning the watermark into the PDF will break the digital signatures on the document.\n- **Wet Signing**: Wet-signed documents are added as new documents to envelopes. This behavior results in the uploaded or faxed, physically signed document being added as a new document to the envelope. This new document gets only a platform seal.\n\nFor more information, see [Standards Based Signatures](https://developers.docusign.com/esign-rest-api/guides/standards-based-signatures)." }, { "name": "BillingPlans", @@ -54996,21 +66935,17 @@ "name": "Payments", "description": "The Payments resource provides methods that allow you to manage payments for an account.\n\nThese calls can only be used by users with account administrator privileges." }, - { - "name": "BulkEnvelopes", - "description": "The BulkEnvelope resource provides methods that allow you to send the same document to a large number of recipients and get the status of the envelope.\n\n**Using Bulk Send**\n\n* Create the bulk recipient CSV (Comma Separated Value) file that contains the list of recipient names and email addresses.\nThe required and optional information that can be included the file is described in the [BulkEnvelopes::updateRecipients](https://developers.docusign.com/esign-rest-api/reference/BulkEnvelopes/EnvelopeBulkRecipients/update) method.\n* Create draft envelope by calling the [Envelopes::createEnvelope](https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeCustomFields/create) method and add a bulk recipient signer. You can create the draft envelope from a template that has a bulk recipient. A bulk recipient signer is a Signer recipient type where `isBulkRecipient` property is set to **true**. Each envelope can have only one bulk recipient signer. You can save templates and draft envelopes with a bulk recipient signer, but you must upload a bulk recipient file before you send an envelope with a bulk recipient signer.\n* Add the bulk recipient file to the envelope by calling the [BulkEnvelopes::updateRecipients](https://developers.docusign.com/esign-rest-api/reference/BulkEnvelopes/EnvelopeBulkRecipients/update) method.\n* Send the draft envelope by setting the `status` property on the envelope to `sent` and call the [Envelopes::update](https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/update) method. Transitioning an envelope with a bulk recipient signer from `created` to `sent` triggers the sending of an envelope for each recipient in the associated bulk recipient file. The original (draft) envelope is discarded. The response returned from sending the envelope includes the following properties:\n * `bulkRecipientsBatchId`: Contains the batch identifier used to query the status of the entire bulk send operation.\n * `bulkRecipientTransactions`: Contains an array with identifying information about each envelope sent. The information included in this response:\n * `transactionId`: The ID used to reference the queued envelope transaction.\n * `name`: The name of the recipient assigned to this envelope transaction.\n * `email`: The email address of the recipient assigned to this envelope transaction.\n\nAfter you send an envelope with a bulk recipient file, DocuSign creates a separate envelope for each recipient in the bulk recipient file, eliminating the need to separately create and send an envelope for each signer. You can get the status of the bulk send by calling [BulkEnvelopes::get](https://developers.docusign.com/esign-rest-api/reference/BulkEnvelopes/BulkEnvelopes/get) or [BulkEnvelopes::list](https://developers.docusign.com/esign-rest-api/reference/BulkEnvelopes/BulkEnvelopes/list) methods.\n\nYou can customize authentication (access code, ID check, phone authentication, or social network IDs), add notes and other custom information for each recipient in the list by adding the information to the file.\n\n**Bulk Send Requirements and Limitations**\n\n* Bulk send must be enabled for your account (`accountSettings enableBulkRecipient` set to **true**) and for the user sending the envelopes (the `allowBulkRecipients` property in `userSettings` set to **true**.)\n* Bulk send can only be used with [Signers](https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipients#signers-recipient) recipient types, and there can only be one bulk recipient in an envelope or template. An envelope or template can have other Signers and recipient types that are added to the envelope or template normally. When a bulk recipient file is added to an envelope, the single bulk recipient Signer is replaced with all recipients in the bulk recipient file. When you send an envelope, it can have only one associated bulk recipient file.\n* When you send an envelope with bulk recipients, envelopes are added to a bulk recipient queue and sent in a metered fashion. There is a limit of 2,000 envelopes in the bulk recipient queue. If this limit is reached, an error message is shown to the sender. If you receive this error, wait and resend the envelope at a later time.\n\nIf you frequently run into queue limits, contact your account manager to discuss modifying the queue limits for your account." - }, { "name": "CloudStorage", "description": "The CloudStorage resource provides methods that allow you to list files stored on your cloud storage provider." }, { "name": "CloudStorageProviders", - "description": "The CloudStorageProviders resource provides methods that allow you to manage the cloud storage providers associate with an account.\n\nThe following providers are supported:\n\n* Google Drive\n* Dropbox\n* Box\n* Evernote\n* OneDrive\n\nTo use cloud storage files, you must first give DocuSign access to your cloud storage provider. You can disconnect authorized a cloud storage provider at any time." + "description": "The following providers are supported:\n\n* Google Drive\n* Dropbox\n* Box\n* Evernote\n* OneDrive\n\nTo use cloud storage files, you must first give DocuSign access to your cloud storage provider. You can disconnect authorized a cloud storage provider at any time." }, { "name": "ConnectConfigurations", - "description": "The ConnectConfigurations resource methods enable you to configure the DocuSign Connect service associated with an account." + "description": "The `ConnectConfigurations` resource enables you to configure the DocuSign Connect service for your account.\n\nYou can use this resource to configure account-level webhooks that send notifications about every envelope sent from your account. You can set account-level webhooks to listen for events for envelopes sent by a specific user on your account, by multiple specific users, or from any of the users on your account. These events will be tracked, and can be delivered to a listening application.\n\n**Note**: To use DocuSign Connect, it must be enabled in your DocuSign account. It is not enabled by default.\n\n## Aggregated Messages\n\nTo avoid duplicate simultaneous events, you can configure Connect to aggregate similar events into a single delivery. By default, aggregation is enabled on all Connect configurations. Similar or simultaneous events will be aggregated so your listener doesn't receive extraneous messages. \n\nFor example, when the final recipient signs an envelope, the system delivers a single, aggregated Connect event, rather than separate Recipient: complete and Envelope: complete messages. This aggregation process ensures that you only receive the minimal viable number of messages about an envelope's life cycle. \n\n## Send Individual Messages\n\nWhen you enable Send Individual Messages (SIM) mode on a Connect configuration, DocuSign will deliver notifications for all envelope events individually. In contrast with aggregated messages, when a final recipient completes an envelope, your listener will receive a single Recipient: complete event followed by a single Envelope: complete event for the final participating party on the agreement. If you need more granular control over event notifications, you can enable SIM mode in the Admin area of the RADmin console. For more information about SIM mode, see [Using Connect's New Send Individual Messages Feature](https://www.docusign.com/blog/dsdev-connect-send-individual-messages/).\n\n**Note**: To create an envelope-level webhook instead of using account-level webhooks, use the Envelopes::Create method and add an `eventNotification` object to an envelope object." }, { "name": "ConnectEvents", @@ -55034,11 +66969,11 @@ }, { "name": "EnvelopeConsumerDisclosures", - "description": "The EnvelopeConsumerDisclosures resource provides a method that allows you to retrieve the consumer disclosure for an envelope." + "description": "The `EnvelopeConsumerDisclosures` resource provides methods that enable you to retrieve the Electronic Record and Signature Disclosure (ERSD) for an envelope recipient. This is the disclosure that displays to each new recipient who is going to sign or add other information, or who is required to view the documents you send to them. The recipient must read and agree to the terms of the disclosure before they can access and take action on the documents you send. The ERSD does not apply to copy-only recipients, but does apply to recipients who must sign or view your documents.\n\nYou can retrieve either the default ERSD that DocuSign provides for U.S.-based transactions, or a custom ERSD.\n\n## Languages\n\nYou specify the language of the disclosure version that you want to retrieve by using the `langCode` parameter.\n\n**Important**: The system does not translate the ERSD for you. An account administrator must create a version of the account-level disclosure for each language that your signers use. \n\nFor more information, see [Legal Disclosure](https://support.docusign.com/en/guides/ndse-admin-guide-legal-disclosure)." }, { "name": "EnvelopeDocuments", - "description": "\n\n\nThe EnvelopeDocuments resource provides methods\nthat manage documents in an envelope.\nYou can:\n* add one or more documents to the envelope\n* retrieve one or more documents from the envelope\n* delete documents from the envelope\n\nAll of the methods in this resource\noperate on on an existing envelope.\nBefore you can add documents\nto an envelope,\nyou must first create it\nwith the [Envelopes: create][envelopescreate] method. \n\n\n[envelopescreate]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/create/\n\n" + "description": "\n\n\nThe EnvelopeDocuments resource provides methods\nthat manage documents in an envelope.\nYou can:\n* add one or more documents to the envelope\n* retrieve one or more documents from the envelope\n* delete documents from the envelope\n\nAll of the methods in this resource\noperate on on an existing envelope.\nBefore you can add documents\nto an envelope,\nyou must first create it\nwith the [Envelopes: create][envelopescreate] method.\n\n\n[envelopescreate]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/Envelopes/create/\n\n" }, { "name": "EnvelopeEmailSettings", @@ -55058,7 +66993,7 @@ }, { "name": "GroupBrands", - "description": "The GroupBrands resource provides methods that allow you to manage " + "description": "For the custom groups you define for your account, you can assign brands to specify the ones that group members can use. Group members can use the available brands when they send envelopes or create templates. For more information, see [Assign Brands to Groups](https://support.docusign.com/en/guides/ndse-admin-guide-assign-brands-to-groups)." }, { "name": "Groups", @@ -55070,7 +67005,7 @@ }, { "name": "SigningGroups", - "description": "The SigningGroups resource provides methods that allow you manage signing groups.\n\nSigning Groups allow you to create a group of people to which an envelope is sent. Any member of that group can open an envelope and sign the documents in the envelope with their own signature, even though a signature field was not directly assigned to them. When the Signing Group option is used, group members that open and sign the envelope are tracked in the envelope history and certificate.\n\nWhen one group member opens the envelope, it is temporarily locked and if other members try to open the envelope they will see a message saying the envelope is currently opened. If the group member exits the envelope without finishing the lock expires, allowing other group members to open and complete the envelope.\n\nWhen the envelope is complete, all members of the group will receive a completed notification and can access the completed envelope. \nThe envelope history and Certificate of Completion will show that the envelope was sent to a signing group and record which members viewed and signed the envelope.\n\nAn account can have a maximum of 50 signing groups. Each signing group can have a maximum of 50 group members.\n\nThe Signing Groups feature is only supported in certain DocuSign Enterprise and System Automated Premium plans. Your account might not support this option. To access this functionality, contact your Account Manager or DocuSign Support (support@docusign.com) for assistance." + "description": "The SigningGroups resource provides methods that allow you manage signing groups.\n\nSigning Groups allow you to create a group of people to which an envelope is sent. Any member of that group can open an envelope and sign the documents in the envelope with their own signature, even though a signature field was not directly assigned to them. When the Signing Group option is used, group members that open and sign the envelope are tracked in the envelope history and certificate.\n\nWhen one group member opens the envelope, it is temporarily locked and if other members try to open the envelope they will see a message saying the envelope is currently opened. If the group member exits the envelope without finishing the lock expires, allowing other group members to open and complete the envelope.\n\nWhen the envelope is complete, all members of the group will receive a completed notification and can access the completed envelope. \nThe envelope history and Certificate of Completion will show that the envelope was sent to a signing group and record which members viewed and signed the envelope.\n\nAn account can have a maximum of 50 signing groups. Each signing group can have a maximum of 50 group members.\n\nThe Signing Groups feature is only supported in certain DocuSign Enterprise and System Automated Premium plans. Your account might not support this option. To access this functionality, contact your Account Manager or DocuSign Support (support@docusign.com) for assistance.\n\nFor more information, see [Signing Groups](https://support.docusign.com/en/guides/ndse-user-guide-signing-groups)." }, { "name": "SigningGroupUsers", @@ -55078,7 +67013,7 @@ }, { "name": "TemplateRecipients", - "description": "The TemplateRecipients resource allows you manage the recipients of an template.\n\nThe exact parameters associated with a recipient depend on the recipient type. There are seven recipient types: Agents, Carbon Copies, Certified Deliveries, Editors, In Person Signers, Intermediaries, and Signers.\n\nNot all recipients are are available to all account types, review you account plan to determine which recipient types are available to you. If you are working in the Demo environment, all recipient types are available.\n\nEach recipient type is described below:\n\n[Agents](#agents): This recipient can add name and email information for recipients that appear after the recipient in routing order.\n\n[Carbon Copies](#carboncopies): Use this action if the recipient should get a copy of the template, but the recipient does not need to sign, initial, date or add information to any of the documents. This type of recipient can be placed in any order in the recipient list. The recipient receives a copy of the template when the template reaches the recipient's order in the process flow and when the template is completed.\n\n[Certified Deliveries](#certifiedDeliveries): Use this action if the recipient must receive the completed documents for the template to be completed, but the recipient does not need to sign, initial, date or add information to any of the documents.\n\n[Editors](#editors): This recipient has the same management and access rights for the template as the sender and can make changes to the template as if they were using the Advanced Correct feature. This recipient can add name and email information, add or change the routing order and set authentication options for the remaining recipients. Additionally, this recipient can edit signature/initial tabs and data fields for the remaining recipients. The recipient must have a DocuSign account to be an editor.\n\n[In Person Signers](#inPerson): Use this action if the signer is in the same physical location as a DocuSign user who will act as a Signing Host for the transaction. The recipient added is the Signing Host and new separate Signer Name field appears after Sign in person is selected.\n\n[Intermediaries](#intermediaries): This recipient can, but is not required to, add name and email information for recipients at the same or subsequent level in the routing order (until subsequent Agents, Editors or Intermediaries recipient types are added).\n\n[Signers](#signers): Use this action if your recipient must sign, initial, date or add data to form fields on the documents in the template.\n\n### Core JSON Layout\n\nThe following shows the core JSON layout for a recipient.\n\n```\n\"email\": \"email.name@company.com\",\n \"name\": \"recipient name\",\n \"accessCode\": \"\",\n \"addAccessCodeToEmail\": false,\n \"clientUserIs\": null,\n \"embeddedRecipientStartURL\": \"string\",\n \"customFields\": {\n \"sample string 1\",\n \"sample string 2\"\n },\n \"emailNotification\"{\n \"emailBody\":\"email text\",\n \"emailSubject\":\"Subject text\",\n \"supportedLanguage\":\"en\",\n },\n \"excludedDocuments\": [\"2\", \"4\"],\n \"idCheckConfigurationName\": null,\n \"idCheckInformationInput\": {\n \"addressInformationInput\": {\n \"addressInformation\": {\n \"street1\": \"sample string 1\",\n \"street2\": \"sample string 2\",\n \"city\": \"sample string 3\",\n \"state\": \"sample string 4\",\n \"zip\": \"sample string 5\",\n \"zipPlus4\": \"sample string 6\"\n },\n \"displayLevelCode\": \"sample string 1\",\n \"receiveInResponse\": \"sample string 2\"\n },\n \"dobInformationInput\": {\n \"dateOfBirth\": \"sample string 1\",\n \"displayLevelCode\": \"sample string 2\",\n \"receiveInResponse\": \"sample string 3\"\n },\n \"ssn4InformationInput\": {\n \"ssn4\": \"sample string 1\",\n \"displayLevelCode\": \"sample string 2\",\n \"receiveInResponse\": \"sample string 3\"\n },\n \"ssn9InformationInput\": {\n \"ssn9\": \"sample string 1\",\n \"displayLevelCode\": \"sample string 2\"\n }\n },\n \"inheritEmailNotificationConfiguration\": false,\n \"note\": \"\",\n \"phoneAuthentication\": {\n \"recipMayProvideNumber\": \"sample string 1\",\n \"validateRecipProvidedNumber\": \"sample string 2\",\n \"recordVoicePrint\": \"sample string 3\",\n \"senderProvidedNumbers\": [\n \"sample string 1\",\n \"sample string 2\"\n ]\n },\n \"recipientAttachment\": null,\n \"recipientCaptiveInfo\": null,\n \"recipientId\": \"1\",\n \"requireIdLookup\": false,\n \"roleName\": \"\",\n \"routingOrder\": 1,\n \"samlAuthentication\": {\n \"samlAssertionAttributes\": [\n {\n \"name\": \"string\",\n \"value\": \"string\"\n },\n {\n \"name\": \"string\",\n \"value\": \"string\"\n }\n ]\n },\n \"smsAuthentication\": {\n \"senderProvidedNumbers\":[\n \"sample string 1\",\n \"sample string 2\"\n ]\n },\n \"socialAuthentications\": null,\n \"templateAccessCodeRequired\": false,\n \"templateLocked\": false,\n \"templateRequired\": false,\n...\n```\n\n### Core Recipient Parameters\n\nThe following table contains the descriptions for the core properties for a recipient.\n\n| Name | Required? | Schema Type | Description |\n| --- | --- | --- | --- |\n| email | Yes | Email | Email of the recipient. Notification will be sent to this email id.
Maximum Length: 100 characters. |\n| name | Yes | String | Full legal name of the recipient.
Maximum Length: 100 characters. |\n| accessCode | No | String | This optional element specifies the access code a recipient has to enter to validate the identity.
Maximum Length: 50 characters. |\n| addAccessCodeToEmail | No | Boolean | This optional attribute indicates that the access code is added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient. |\n| clientUserId | No | String | This specifies whether the recipient is embedded or remote.

If the `clientUserId` property is not null then the recipient is embedded. Note that if the `ClientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true**, an error is generated on sending. |\n| embeddedRecipientStartURL | No | String | This is a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would, but when the document link in the email is clicked the recipient is redirected, through DocuSign, to this URL to complete their actions. When routing to the URL, it is up to the sender's system (the server responding to the URL) to then request a recipient token to launch a signing session.

If the value `SIGN_AT_DOCUSIGN` is used for this node, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that would be launched by any partner.

It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application and DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets the `EmbeddedRecipientStartURL` property to `SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) be used to verify the identity of the recipient.

If the `clientUserId` property is NOT set and the `embeddedRecipientStartURL` property is set, DocuSign ignores the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the `embeddedRecipientStartURL` property using merge fields. The available merge fields items are: templateId, recipientId, recipientName, recipientEmail, and customFields. The customFields must be part of the recipient or template. The merge fields are enclosed in double brackets.

_Example_:
`http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` |\n| customFields | No | customField |An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the template status but otherwise not used by DocuSign. String `customField` properties have a maximum length of 100 characters. |\n| emailNotification | No | emailNotification | An optional complex type that has information for setting the language for the recipient's email information. It is composed of three elements:

*emailBody*: a string with the email message sent to the recipient.
Maximum Length: 10000 characters.

*emailSubject*: a string with the subject of the email sent to the recipient.
Maximum Length: 100 characters.

*supportedLanguage*: The simple type enumeration of the language used. The supported languages, with the language value shown in parenthesis, are: Arabic (ar), Bahasa Indonesia (id), Bahasa Melayu (ms) Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro),Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi).

**IMPORTANT**: If this is enabled for one recipient, it overrides the Template Subject and `EmailBlurb` property settings. Also, you must set the `emailNotification` property for all recipients. |\n| excludedDocuments | No | Array of Strings | Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the enforceSignerVisibility property must be set to true for the template to use this.

When the enforceSignerVisibility property is set to **true**, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an template, unless they are specifically excluded using this setting when an template is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an template is sent. |\n| idCheckConfigurationName | No | String |Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account (these name can also be found in the web console sending interface in the Identify list for a recipient). This overrides any default authentication setting.

_Example_:
Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as 'ID Check $' and 'SMS Auth $'. To use ID check in an template, the `idCheckConfigurationName` property must be set to `ID Check $`. To use SMS, it must be set to `SMS Auth $` and you must add phone number information to the `smsAuthentication` node.|\n| iDCheckInformationInput | No | IdCheckInformationInput | This complex element contains input information related to a recipient ID check. It can include the following information.

*addressInformationInput*: Used to set recipient address information and consists of:

*addressInformation*: consists of six elements, with street2 and zipPlus4 being optional. The elements are: street1, street2, city, state, zip, zipPlus4\\. The maximum number of characters in each element are: street1/street2 = 150 characters, city = 50 characters, state = 2 characters, and zip/zipPlus4 = 20 characters.

displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.

*receiveInResponse*: A Boolean element that specifies if the information needs to be returned in the response.

*dobInformationInput*: Used to set recipient date of birth information and consists of:

*dateOfBirth*: Specifies the recipient's date, month and year of birth.

*displayLevelCode*: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.

*receiveInResponse*: A Boolean element that specifies if the information needs to be returned in the response.

*ssn4InformationInput*: Used to set the last four digits of the recipient's SSN information and consists of:

*ssn4*: Specifies the last four digits of the recipient's SSN.

*displayLevelCode*: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.

*receiveInResponse*: A Boolean element that specifies if the information needs to be returned in the response.

*ssn9InformationInput*: Used to set the recipient's SSN information. Note that the ssn9 information can never be returned in the response. The ssn9 input consists of:



*ssn9*: Specifies the recipient's SSN.

*displayLevelCode*: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. |\n| inheritEmailNotificationConfiguration | No | Boolean | Optional element. If true and the template recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account. |\n| note | No | String | A note that is unique to this recipient. This note is sent to the recipient via the signing email. The note displays in the signing UI near the upper left corner of the document on the signing screen.
Maximum Length: 1000 characters. |\n| phoneAuthentication | No | RecipientPhoneAuthentication | Optional element. Contains the elements:

*recipMayProvideNumber*:Boolean. When set to **true** thenrecipient can use whatever phone number they choose to.

*senderProvidedNumbers*: ArrayOfString. A list of phone numbers the recipient can use.

*recordVoicePrint* - Reserved

*validateRecipProvidedNumber* - Reserved| |\n| recipientAttachment | No | Attachment | Reserved |\n| recipientId | No | String | Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. |\n| requireIdLookup | No | Boolean | When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. |\n| roleName | No* | String | Optional element. Specifies the role name associated with the recipient.

This is required when working with template recipients. |\n| routingOrder | Yes | String | This element specifies the routing order of the recipient in the template. |\n| samlAuthentication | No | samlAssertionAttributes | Optional element, account must be set up to use SSO to use this. Contains the name/value pair information for the SAML assertion attributes:

*name*: The name of the SAML assertion attribute.

*value*: The value associated with the named SAML assertion attribute. |\n| smsAuthentication | No | senderProvidedNumbers | Optional element. Contains the element:

*senderProvidedNumbers*: Array that contains a list of phone numbers the recipient can use for SMS text authentication. |\n| socialAuthentications | No | Boolean | Lists the social ID type that can be used for recipient authentication. |\n| templateAccessCodeRequired | No | Boolean | Optional element. Used only when working with template recipients. When set to **true** and the `TemplateLocked` parameter is set to **true**, the sender must enter an access code. |\n| templateLocked | No | Boolean | Optional element. Used only when working with template recipients. When set to **true**, the sender cannot change any attributes of the recipient. |\n| templateRequired | No | Boolean | Optional element. Used only when working with template recipients. When set to **true**, the sender may not remove the recipient. |\n\n## Agents Recipient\n\nThis recipient can add name and email information for recipients that appear after the recipient in routing order.\n\n#### Example Agents layout\n\n```\n\"agents\": [{\n \n \"canEditRecipientEmails\": false,\n \"canEditRecipientNames\": false\n}],\n```\n\nThe additional parameters for Agents recipient are shown below:\n\n| Name | Required? | Schema Type | Description |\n| --- | --- | --- | --- |\n| canEditRecipientEmails | No | Boolean | Optional element. When set to **true**, the Agents Recipient associated with this Recipient can change the Recipient's pre-populated Email address. This element is only active if enabled for the account. |\n| canEditRecipientNames | No | Boolean | Optional element. When set to **true**, the Agents Recipient associated with this recipient can change the recipient's pre-populated name (`UserName`). This element is only active if enabled for the account. |\n\n## Carbon Copies Recipient\n\nUse this type if the recipient should get a copy of the template, but the recipient does not need to sign, initial, date, or add information to any of the documents. This type of recipient can be placed in any order in the recipient list. The recipient receives a copy of the template when the template reaches the recipient's order in the process flow and when the template is completed.\n\n#### Example Carbon Copies layout\n\n```\n\"carbonCopies\": [{\n \n```\n\nThe Carbon Copies recipient uses only the core parameters.\n\n## Certified Deliveries Recipient\n\nUse this action if the recipient must receive the completed documents for the template to be completed, but the recipient does not need to sign, initial, date, or add information to any of the documents.\n\n#### Example Certified Deliveries layout\n\n```\n\"certifiedDeliveries\": [{\n\n}],\n```\nThe Certified Deliveries recipient uses only the core parameters.\n\n## Editors Recipient\n\nThis recipient has the same management and access rights for the template as the sender and can make changes to the template as if they were using the Advanced Correct feature. This recipient can add name and email information, add or change the routing order and set authentication options for the remaining recipients. Additionally, this recipient can edit signature/initial tabs and data fields for the remaining recipients. The recipient must have a DocuSign account to be an editor.\n\n#### Example Editors layout\n\n```\n\"editors\": [{\n \n \"canEditRecipientEmails\": false,\n \"canEditRecipientNames\": false\n}],\n```\n\nThe additional parameters for Editors recipient are shown below:\n\n| Name | Required? | Schema Type | Description |\n| --- | --- | --- | --- |\n| canEditRecipientEmails | No | Boolean | Optional element. When set to **true**, the Editors Recipient associated with this Recipient can change the Recipient's pre-populated Email address. This element is only active if enabled for the account. |\n| canEditRecipientNames | No | Boolean | Optional element. When set to **true**, the Editors Recipient associated with this recipient can change the recipient's pre-populated name (`UserName`). This element is only active if enabled for the account. |\n\n## In Person Signers Recipient\n\nUse this type if the signer is in the same physical location as a DocuSign user who will act as a Signing Host for the transaction. The recipient added is the Signing Host and new separate Signer Name field appears after Sign in person is selected.\n\n#### Example In Person Signers layout\n\n```\n\"inPersonSigners\": [{\n \"hostEmail\": \"signing.host@company.com\",\n \"hostName\": \"Mike Host\",\n \n \"autoNavigation\": false,\n \"defaultRecipient\": false,\n \"signInEachLocation\": false,\n \"signatureInfo\": null,\n \"signerEmail\": \"signer.name@company.com\",\n \"signerName\": \"MC Clap Your Hands\",\n \"tabs\": {\n \"approveTabs\": null,\n \"checkboxTabs\": null,\n \"companyTabs\": null,\n \"dateSignedTabs\": null,\n \"dateTabs\": null,\n \"declineTabs\": null,\n \"emailTabs\": null,\n \"templateIdTabs\": null,\n \"fullNameTabs\": null,\n \"initialHereTabs\": null,\n \"listTabs\": null,\n \"noteTabs\": null,\n \"numberTabs\": null,\n \"radioGroupTabs\": null,\n \"signHereTabs\": [{\n \"signerAttachmentTabs\": null,\n \"ssnTabs\": null,\n \"textTabs\": null,\n \"titleTabs\": null,\n \"zipTabs\": null\n }\n}],\n```\n\nThe additional and changed parameters for In Person Signers recipient are shown below:\n\n| Name | Required? | Schema Type | Description |\n| --- | --- | --- | --- |\n| hostEmail | Yes | Email | Required element for In Person Signers recipient Type.
Maximum Length: 100 characters.

Specifies the email for the signing host. |\n| hostName | Yes | String | Required element for In Person Signers recipient Type.
Maximum Length: 100 characters.

Specifies the email for the signing host.|\n| autoNavigation | No | Boolean | Specifies whether auto navigation is set for the recipient.|\n| defaultRecipient | No | Boolean | When set to **true**, this is the default recipient for the template. This option is used with the CreateTemplateFromTemplatesAndForms method. |\n| signInEachLocation | No | Boolean | When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab (instead of adopting a signature/initial style or only drawing a signature/initial once). |\n| signatureInfo | No | String | Optional element only used with recipient types In Person Signers and Signers.

Allows the sender to pre-specify the signature name, signature initials, and signature font used in the signature stamp for the recipient. |\n| signerEmail | No | String | Optional element. The email address for an InPersonSigner recipient Type.
Maximum Length: 100 characters. |\n| signerName | Yes | String | Required element with recipient type In Person Signers.
Maximum Length: 100 characters.

The full legal name of a signer for the template. |\n| tabs | No | Tab | Optional element only used with recipient types In Person Signers and Signers.

Specifies the Tabs associated with the recipient. See the See the the [EnvelopeRecipientTabs resource](https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs) for more information about tabs. for more information about tabs. |\n\n## Intermediaries Recipient\n\nThis recipient can, but is not required to, add name and email information for recipients at the same or subsequent level in the routing order (until subsequent Agents, Editors or Intermediaries recipient types are added).\n\n#### Example Intermediaries layout\n\n```\n\"intermediaries\": [{\n\n \"canEditRecipientEmails\": false,\n \"canEditRecipientNames\": false\n}],\n```\n\nThe parameters for Intermediaries recipient are shown below:\n\n| Name | Required? | Schema Type | Description |\n| --- | --- | --- | --- |\n| canEditRecipientEmails | No | Boolean | Optional element. When set to **true**, the Agents Recipient associated with this Recipient can change the Recipient's pre-populated Email address. This element is only active if enabled for the account. |\n| canEditRecipientNames | No | Boolean | Optional element. When set to **true**, the Agents Recipient associated with this recipient can change the recipient's pre-populated name (`UserName`). This element is only active if enabled for the account. |\n\n## Signers Recipient\n\nUse this action if your recipient must sign, initial, date, or add data to form fields on the documents in the template.\n\n#### Example Signers layout\n\n```\n\"Signers\": [{\n\n \"autoNavigation\": false,\n \"defaultRecipient\": false,\n \"signInEachLocation\": false,\n \"signatureInfo\": null,\n \"tabs\": {\n \"approveTabs\": null,\n \"checkboxTabs\": null,\n \"companyTabs\": null,\n \"dateSignedTabs\": null,\n \"dateTabs\": null,\n \"declineTabs\": null,\n \"emailTabs\": null,\n \"templateIdTabs\": null,\n \"fullNameTabs\": null,\n \"initialHereTabs\": null,\n \"listTabs\": null,\n \"noteTabs\": null,\n \"numberTabs\": null,\n \"radioGroupTabs\": null,\n \"signHereTabs\": [{\n \"signerAttachmentTabs\": null,\n \"ssnTabs\": null,\n \"textTabs\": null,\n \"titleTabs\": null,\n \"zipTabs\": null\n }\n \"deliveryMethod\":\"\",\n \"deliveredDateTime\":\"String Content\",\n \"signedDateTime\":\"String Content\",\n \"offlineAttributes\":{\n \"deviceName\":\"String Content\",\n \"deviceModel\":\"String Content\",\n \"gpsLatitude\":\"String Content\",\n \"gpsLongitude\":\"String Content\",\n \"accountEsignId\":\"String Content\"\n }\n}],\n```\n\nThe additional parameters for Signers recipient are shown below:\n\n| Name | Required? | Schema Type | Description |\n| --- | --- | --- | --- |\n| autoNavigation | No | Boolean | Specifies whether auto navigation is set for the recipient.|\n| defaultRecipient | No | Boolean | When set to **true**, this is the default recipient for the template. This option is used with the CreateTemplateFromTemplatesAndForms method. |\n| signInEachLocation | No | Boolean | When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab (instead of adopting a signature/initial style or only drawing a signature/initial once). |\n| signatureInfo | No | String | Optional element only used with recipient types In Person Signers and Signers.

Allows the sender to pre-specify the signature name, signature initials, and signature font used in the signature stamp for the recipient. |\n| signerEmail | No | String | Optional element. The email address for an InPersonSigner recipient Type.
Maximum Length: 100 characters. |\n| signerName | Yes | String | Required element with recipient type In Person Signers.
Maximum Length: 100 characters.

The full legal name of a signer for the template. |\n| tabs | No | Tab | Optional element only used with recipient types In Person Signers and Signers.

Specifies the Tabs associated with the recipient. See the See the [EnvelopeRecipientTabs resource](https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs) for more information about tabs. section for more information about tabs. |\n| deliveryMethod | No | String | Reserved: For DocuSign use only.|\n| deliveredDateTime | No | DateTime | Reserved: For DocuSign use only. |\n| signedDateTime | No | DateTime | Reserved: For DocuSign use only. |\n| offlineAttributes | No |   | Reserved: For DocuSign use only.|\n" + "description": "The TemplateRecipients resource allows you manage the recipients of an template.\n\nThe exact parameters associated with a recipient depend on the recipient type. There are seven recipient types: Agents, Carbon Copies, Certified Deliveries, Editors, In Person Signers, Intermediaries, and Signers.\n\nNot all recipients are are available to all account types, review you account plan to determine which recipient types are available to you. If you are working in the Demo environment, all recipient types are available.\n\nEach recipient type is described below:\n\n[Agents](#agents): This recipient can add name and email information for recipients that appear after the recipient in routing order.\n\n[Carbon Copies](#carboncopies): Use this action if the recipient should get a copy of the template, but the recipient does not need to sign, initial, date or add information to any of the documents. This type of recipient can be placed in any order in the recipient list. The recipient receives a copy of the template when the template reaches the recipient's order in the process flow and when the template is completed.\n\n[Certified Deliveries](#certifiedDeliveries): Use this action if the recipient must receive the completed documents for the template to be completed, but the recipient does not need to sign, initial, date or add information to any of the documents.\n\n[Editors](#editors): This recipient has the same management and access rights for the template as the sender and can make changes to the template as if they were using the Advanced Correct feature. This recipient can add name and email information, add or change the routing order and set authentication options for the remaining recipients. Additionally, this recipient can edit signature/initial tabs and data fields for the remaining recipients. The recipient must have a DocuSign account to be an editor.\n\n[In Person Signers](#inPerson): Use this action if the signer is in the same physical location as a DocuSign user who will act as a Signing Host for the transaction. The recipient added is the Signing Host and new separate Signer Name field appears after Sign in person is selected.\n\n[Intermediaries](#intermediaries): This recipient can, but is not required to, add name and email information for recipients at the same or subsequent level in the routing order (until subsequent Agents, Editors or Intermediaries recipient types are added).\n\n[Signers](#signers): Use this action if your recipient must sign, initial, date or add data to form fields on the documents in the template.\n\n### Core JSON Layout\n\nThe following shows the core JSON layout for a recipient.\n\n```\n\"email\": \"email.name@company.com\",\n \"name\": \"recipient name\",\n \"accessCode\": \"\",\n \"addAccessCodeToEmail\": false,\n \"clientUserIs\": null,\n \"embeddedRecipientStartURL\": \"string\",\n \"customFields\": {\n \"sample string 1\",\n \"sample string 2\"\n },\n \"emailNotification\"{\n \"emailBody\":\"email text\",\n \"emailSubject\":\"Subject text\",\n \"supportedLanguage\":\"en\",\n },\n \"excludedDocuments\": [\"2\", \"4\"],\n \"idCheckConfigurationName\": null,\n \"idCheckInformationInput\": {\n \"addressInformationInput\": {\n \"addressInformation\": {\n \"street1\": \"sample string 1\",\n \"street2\": \"sample string 2\",\n \"city\": \"sample string 3\",\n \"state\": \"sample string 4\",\n \"zip\": \"sample string 5\",\n \"zipPlus4\": \"sample string 6\"\n },\n \"displayLevelCode\": \"sample string 1\",\n \"receiveInResponse\": \"sample string 2\"\n },\n \"dobInformationInput\": {\n \"dateOfBirth\": \"sample string 1\",\n \"displayLevelCode\": \"sample string 2\",\n \"receiveInResponse\": \"sample string 3\"\n },\n \"ssn4InformationInput\": {\n \"ssn4\": \"sample string 1\",\n \"displayLevelCode\": \"sample string 2\",\n \"receiveInResponse\": \"sample string 3\"\n },\n \"ssn9InformationInput\": {\n \"ssn9\": \"sample string 1\",\n \"displayLevelCode\": \"sample string 2\"\n }\n },\n \"inheritEmailNotificationConfiguration\": false,\n \"note\": \"\",\n \"phoneAuthentication\": {\n \"recipMayProvideNumber\": \"sample string 1\",\n \"validateRecipProvidedNumber\": \"sample string 2\",\n \"recordVoicePrint\": \"sample string 3\",\n \"senderProvidedNumbers\": [\n \"sample string 1\",\n \"sample string 2\"\n ]\n },\n \"recipientAttachment\": null,\n \"recipientCaptiveInfo\": null,\n \"recipientId\": \"1\",\n \"requireIdLookup\": false,\n \"roleName\": \"\",\n \"routingOrder\": 1,\n \"samlAuthentication\": {\n \"samlAssertionAttributes\": [\n {\n \"name\": \"string\",\n \"value\": \"string\"\n },\n {\n \"name\": \"string\",\n \"value\": \"string\"\n }\n ]\n },\n \"smsAuthentication\": {\n \"senderProvidedNumbers\":[\n \"sample string 1\",\n \"sample string 2\"\n ]\n },\n \"socialAuthentications\": null,\n \"templateAccessCodeRequired\": false,\n \"templateLocked\": false,\n \"templateRequired\": false,\n...\n```\n\n### Core Recipient Parameters\n\nThe following table contains the descriptions for the core properties for a recipient.\n\n| Name | Required? | Schema Type | Description |\n| --- | --- | --- | --- |\n| email | Yes | Email | Email of the recipient. Notification will be sent to this email id.
Maximum Length: 100 characters. |\n| name | Yes | String | Full legal name of the recipient.
Maximum Length: 100 characters. |\n| accessCode | No | String | This optional element specifies the access code a recipient has to enter to validate the identity.
Maximum Length: 50 characters. |\n| addAccessCodeToEmail | No | Boolean | This optional attribute indicates that the access code is added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient. |\n| clientUserId | No | String | This specifies whether the recipient is embedded or remote.

If the `clientUserId` property is not null then the recipient is embedded. Note that if the `ClientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true**, an error is generated on sending. |\n| embeddedRecipientStartURL | No | String | This is a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would, but when the document link in the email is clicked the recipient is redirected, through DocuSign, to this URL to complete their actions. When routing to the URL, it is up to the sender's system (the server responding to the URL) to then request a recipient token to launch a signing session.

If the value `SIGN_AT_DOCUSIGN` is used for this node, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that would be launched by any partner.

It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application and DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets the `EmbeddedRecipientStartURL` property to `SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) be used to verify the identity of the recipient.

If the `clientUserId` property is NOT set and the `embeddedRecipientStartURL` property is set, DocuSign ignores the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the `embeddedRecipientStartURL` property using merge fields. The available merge fields items are: templateId, recipientId, recipientName, recipientEmail, and customFields. The customFields must be part of the recipient or template. The merge fields are enclosed in double brackets.

_Example_:
`http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` |\n| customFields | No | customField |An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the template status but otherwise not used by DocuSign. String `customField` properties have a maximum length of 100 characters. |\n| emailNotification | No | emailNotification | An optional complex type that has information for setting the language for the recipient's email information. It is composed of three elements:

*emailBody*: a string with the email message sent to the recipient.
Maximum Length: 10000 characters.

*emailSubject*: a string with the subject of the email sent to the recipient.
Maximum Length: 100 characters.

*supportedLanguage*: The simple type enumeration of the language used. The supported languages, with the language value shown in parenthesis, are: Arabic (ar), Bahasa Indonesia (id), Bahasa Melayu (ms) Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro),Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi).

**IMPORTANT**: If this is enabled for one recipient, it overrides the Template Subject and `EmailBlurb` property settings. Also, you must set the `emailNotification` property for all recipients. |\n| excludedDocuments | No | Array of Strings | Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the enforceSignerVisibility property must be set to true for the template to use this.

When the enforceSignerVisibility property is set to **true**, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an template, unless they are specifically excluded using this setting when an template is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an template is sent. |\n| idCheckConfigurationName | No | String |Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account (these name can also be found in the web console sending interface in the Identify list for a recipient). This overrides any default authentication setting.

_Example_:
Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as 'ID Check $' and 'SMS Auth $'. To use ID check in an template, the `idCheckConfigurationName` property must be set to `ID Check $`. To use SMS, it must be set to `SMS Auth $` and you must add phone number information to the `smsAuthentication` node.|\n| iDCheckInformationInput | No | IdCheckInformationInput | This complex element contains input information related to a recipient ID check. It can include the following information.

*addressInformationInput*: Used to set recipient address information and consists of:

*addressInformation*: consists of six elements, with street2 and zipPlus4 being optional. The elements are: street1, street2, city, state, zip, zipPlus4\\. The maximum number of characters in each element are: street1/street2 = 150 characters, city = 50 characters, state = 2 characters, and zip/zipPlus4 = 20 characters.

displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.

*receiveInResponse*: A Boolean element that specifies if the information needs to be returned in the response.

*dobInformationInput*: Used to set recipient date of birth information and consists of:

*dateOfBirth*: Specifies the recipient's date, month and year of birth.

*displayLevelCode*: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.

*receiveInResponse*: A Boolean element that specifies if the information needs to be returned in the response.

*ssn4InformationInput*: Used to set the last four digits of the recipient's SSN information and consists of:

*ssn4*: Specifies the last four digits of the recipient's SSN.

*displayLevelCode*: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.

*receiveInResponse*: A Boolean element that specifies if the information needs to be returned in the response.

*ssn9InformationInput*: Used to set the recipient's SSN information. Note that the ssn9 information can never be returned in the response. The ssn9 input consists of:



*ssn9*: Specifies the recipient's SSN.

*displayLevelCode*: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. |\n| inheritEmailNotificationConfiguration | No | Boolean | Optional element. If true and the template recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account. |\n| note | No | String | A note that is unique to this recipient. This note is sent to the recipient via the signing email. The note displays in the signing UI near the upper left corner of the document on the signing screen.
Maximum Length: 1000 characters. |\n| phoneAuthentication | No | RecipientPhoneAuthentication | Optional element. Contains the elements:

*recipMayProvideNumber*:Boolean. When set to **true** thenrecipient can use whatever phone number they choose to.

*senderProvidedNumbers*: ArrayOfString. A list of phone numbers the recipient can use.

*recordVoicePrint* - Reserved

*validateRecipProvidedNumber* - Reserved| |\n| recipientAttachment | No | Attachment | Reserved |\n| recipientId | No | String | Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. |\n| requireIdLookup | No | Boolean | When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. |\n| roleName | No* | String | Optional element. Specifies the role name associated with the recipient.

This is required when working with template recipients. |\n| routingOrder | Yes | String | This element specifies the routing order of the recipient in the template. |\n| samlAuthentication | No | samlAssertionAttributes | Optional element, account must be set up to use SSO to use this. Contains the name/value pair information for the SAML assertion attributes:

*name*: The name of the SAML assertion attribute.

*value*: The value associated with the named SAML assertion attribute. |\n| smsAuthentication | No | senderProvidedNumbers | Optional element. Contains the element:

*senderProvidedNumbers*: Array that contains a list of phone numbers the recipient can use for SMS text authentication. |\n| socialAuthentications | No | Boolean | Lists the social ID type that can be used for recipient authentication. |\n| templateAccessCodeRequired | No | Boolean | Optional element. Used only when working with template recipients. When set to **true** and the `TemplateLocked` parameter is set to **true**, the sender must enter an access code. |\n| templateLocked | No | Boolean | Optional element. Used only when working with template recipients. When set to **true**, the sender cannot change any attributes of the recipient. |\n| templateRequired | No | Boolean | Optional element. Used only when working with template recipients. When set to **true**, the sender may not remove the recipient. |\n\n## Agents Recipient\n\nThis recipient can add name and email information for recipients that appear after the recipient in routing order.\n\n#### Example Agents layout\n\n```\n\"agents\": [{\n \n \"canEditRecipientEmails\": false,\n \"canEditRecipientNames\": false\n}],\n```\n\nThe additional parameters for Agents recipient are shown below:\n\n| Name | Required? | Schema Type | Description |\n| --- | --- | --- | --- |\n| canEditRecipientEmails | No | Boolean | Optional element. When set to **true**, the Agents Recipient associated with this Recipient can change the Recipient's pre-populated Email address. This element is only active if enabled for the account. |\n| canEditRecipientNames | No | Boolean | Optional element. When set to **true**, the Agents Recipient associated with this recipient can change the recipient's pre-populated name (`UserName`). This element is only active if enabled for the account. |\n\n## Carbon Copies Recipient\n\nUse this type if the recipient should get a copy of the template, but the recipient does not need to sign, initial, date, or add information to any of the documents. This type of recipient can be placed in any order in the recipient list. The recipient receives a copy of the template when the template reaches the recipient's order in the process flow and when the template is completed.\n\n#### Example Carbon Copies layout\n\n```\n\"carbonCopies\": [{\n \n```\n\nThe Carbon Copies recipient uses only the core parameters.\n\n## Certified Deliveries Recipient\n\nUse this action if the recipient must receive the completed documents for the template to be completed, but the recipient does not need to sign, initial, date, or add information to any of the documents.\n\n#### Example Certified Deliveries layout\n\n```\n\"certifiedDeliveries\": [{\n\n}],\n```\nThe Certified Deliveries recipient uses only the core parameters.\n\n## Editors Recipient\n\nThis recipient has the same management and access rights for the template as the sender and can make changes to the template as if they were using the Advanced Correct feature. This recipient can add name and email information, add or change the routing order and set authentication options for the remaining recipients. Additionally, this recipient can edit signature/initial tabs and data fields for the remaining recipients. The recipient must have a DocuSign account to be an editor.\n\n#### Example Editors layout\n\n```\n\"editors\": [{\n \n \"canEditRecipientEmails\": false,\n \"canEditRecipientNames\": false\n}],\n```\n\nThe additional parameters for Editors recipient are shown below:\n\n| Name | Required? | Schema Type | Description |\n| --- | --- | --- | --- |\n| canEditRecipientEmails | No | Boolean | Optional element. When set to **true**, the Editors Recipient associated with this Recipient can change the Recipient's pre-populated Email address. This element is only active if enabled for the account. |\n| canEditRecipientNames | No | Boolean | Optional element. When set to **true**, the Editors Recipient associated with this recipient can change the recipient's pre-populated name (`UserName`). This element is only active if enabled for the account. |\n\n## In Person Signers Recipient\n\nUse this type if the signer is in the same physical location as a DocuSign user who will act as a Signing Host for the transaction. The recipient added is the Signing Host and new separate Signer Name field appears after Sign in person is selected.\n\n#### Example In Person Signers layout\n\n```\n\"inPersonSigners\": [{\n \"hostEmail\": \"signing.host@company.com\",\n \"hostName\": \"Mike Host\",\n \n \"autoNavigation\": false,\n \"defaultRecipient\": false,\n \"signInEachLocation\": false,\n \"signatureInfo\": null,\n \"signerEmail\": \"signer.name@company.com\",\n \"signerName\": \"MC Clap Your Hands\",\n \"tabs\": {\n \"approveTabs\": null,\n \"checkboxTabs\": null,\n \"companyTabs\": null,\n \"dateSignedTabs\": null,\n \"dateTabs\": null,\n \"declineTabs\": null,\n \"emailTabs\": null,\n \"templateIdTabs\": null,\n \"fullNameTabs\": null,\n \"initialHereTabs\": null,\n \"listTabs\": null,\n \"noteTabs\": null,\n \"numberTabs\": null,\n \"radioGroupTabs\": null,\n \"signHereTabs\": [{\n \"signerAttachmentTabs\": null,\n \"ssnTabs\": null,\n \"textTabs\": null,\n \"titleTabs\": null,\n \"zipTabs\": null\n }\n}],\n```\n\nThe additional and changed parameters for In Person Signers recipient are shown below:\n\n| Name | Required? | Schema Type | Description |\n| --- | --- | --- | --- |\n| hostEmail | Yes | Email | Required element for In Person Signers recipient Type.
Maximum Length: 100 characters.

Specifies the email for the signing host. |\n| hostName | Yes | String | Required element for In Person Signers recipient Type.
Maximum Length: 100 characters.

Specifies the email for the signing host.|\n| autoNavigation | No | Boolean | Specifies whether auto navigation is set for the recipient.|\n| defaultRecipient | No | Boolean | When set to **true**, this is the default recipient for the template. This option is used with the CreateTemplateFromTemplatesAndForms method. |\n| signInEachLocation | No | Boolean | When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab (instead of adopting a signature/initial style or only drawing a signature/initial once). |\n| signatureInfo | No | String | Optional element only used with recipient types In Person Signers and Signers.

Allows the sender to pre-specify the signature name, signature initials, and signature font used in the signature stamp for the recipient. |\n| signerEmail | No | String | Optional element. The email address for an InPersonSigner recipient Type.
Maximum Length: 100 characters. |\n| signerName | Yes | String | Required element with recipient type In Person Signers.
Maximum Length: 100 characters.

The full legal name of a signer for the template. |\n| tabs | No | Tab | Optional element only used with recipient types In Person Signers and Signers.

Specifies the Tabs associated with the recipient. See the See the the [EnvelopeRecipientTabs resource](https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/) for more information about tabs. for more information about tabs. |\n\n## Intermediaries Recipient\n\nThis recipient can, but is not required to, add name and email information for recipients at the same or subsequent level in the routing order (until subsequent Agents, Editors or Intermediaries recipient types are added).\n\n#### Example Intermediaries layout\n\n```\n\"intermediaries\": [{\n\n \"canEditRecipientEmails\": false,\n \"canEditRecipientNames\": false\n}],\n```\n\nThe parameters for Intermediaries recipient are shown below:\n\n| Name | Required? | Schema Type | Description |\n| --- | --- | --- | --- |\n| canEditRecipientEmails | No | Boolean | Optional element. When set to **true**, the Agents Recipient associated with this Recipient can change the Recipient's pre-populated Email address. This element is only active if enabled for the account. |\n| canEditRecipientNames | No | Boolean | Optional element. When set to **true**, the Agents Recipient associated with this recipient can change the recipient's pre-populated name (`UserName`). This element is only active if enabled for the account. |\n\n## Signers Recipient\n\nUse this action if your recipient must sign, initial, date, or add data to form fields on the documents in the template.\n\n#### Example Signers layout\n\n```\n\"Signers\": [{\n\n \"autoNavigation\": false,\n \"defaultRecipient\": false,\n \"signInEachLocation\": false,\n \"signatureInfo\": null,\n \"tabs\": {\n \"approveTabs\": null,\n \"checkboxTabs\": null,\n \"companyTabs\": null,\n \"dateSignedTabs\": null,\n \"dateTabs\": null,\n \"declineTabs\": null,\n \"emailTabs\": null,\n \"templateIdTabs\": null,\n \"fullNameTabs\": null,\n \"initialHereTabs\": null,\n \"listTabs\": null,\n \"noteTabs\": null,\n \"numberTabs\": null,\n \"radioGroupTabs\": null,\n \"signHereTabs\": [{\n \"signerAttachmentTabs\": null,\n \"ssnTabs\": null,\n \"textTabs\": null,\n \"titleTabs\": null,\n \"zipTabs\": null\n }\n \"deliveryMethod\":\"\",\n \"deliveredDateTime\":\"String Content\",\n \"signedDateTime\":\"String Content\",\n \"offlineAttributes\":{\n \"deviceName\":\"String Content\",\n \"deviceModel\":\"String Content\",\n \"gpsLatitude\":\"String Content\",\n \"gpsLongitude\":\"String Content\",\n \"accountEsignId\":\"String Content\"\n }\n}],\n```\n\nThe additional parameters for Signers recipient are shown below:\n\n| Name | Required? | Schema Type | Description |\n| --- | --- | --- | --- |\n| autoNavigation | No | Boolean | Specifies whether auto navigation is set for the recipient.|\n| defaultRecipient | No | Boolean | When set to **true**, this is the default recipient for the template. This option is used with the CreateTemplateFromTemplatesAndForms method. |\n| signInEachLocation | No | Boolean | When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab (instead of adopting a signature/initial style or only drawing a signature/initial once). |\n| signatureInfo | No | String | Optional element only used with recipient types In Person Signers and Signers.

Allows the sender to pre-specify the signature name, signature initials, and signature font used in the signature stamp for the recipient. |\n| signerEmail | No | String | Optional element. The email address for an InPersonSigner recipient Type.
Maximum Length: 100 characters. |\n| signerName | Yes | String | Required element with recipient type In Person Signers.
Maximum Length: 100 characters.

The full legal name of a signer for the template. |\n| tabs | No | Tab | Optional element only used with recipient types In Person Signers and Signers.

Specifies the Tabs associated with the recipient. See the See the [EnvelopeRecipientTabs resource](https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/) for more information about tabs. section for more information about tabs. |\n| deliveryMethod | No | String | Reserved: For DocuSign use only.|\n| deliveredDateTime | No | DateTime | Reserved: For DocuSign use only. |\n| signedDateTime | No | DateTime | Reserved: For DocuSign use only. |\n| offlineAttributes | No |   | Reserved: For DocuSign use only.|\n" }, { "name": "TemplateBulkRecipients", @@ -55086,7 +67021,7 @@ }, { "name": "TemplateCustomFields", - "description": "The TemplateCustomFields resource provides methods that allow you manage custom fields in an template. \n\nCustom fields can be used in the templates for your account to record information about the template, help search for templates and track information. The template custom fields are shown in the Template Settings section when a user is creating an template in the DocuSign member console. The template custom fields are not seen by the template recipients.\n\nThere are two types of template custom fields, text and list. A text custom field lets the sender enter the value for the field. With a list custom field, the sender selects the value of the field from a pre-made list." + "description": "The TemplateCustomFields resource provides methods that allow you manage custom fields in an template. \n\nCustom fields can be used in the templates for your account to record information about the template, help search for templates and track information. The template custom fields are shown in the Template Settings section when a user is creating an template in the DocuSign member console. The template custom fields are not seen by the template recipients.\n\nThere are two types of custom fields:\n\n- `text`: Enables the sender to enter the value for the field. \n- `list`: Enables the sender to select the value of the field from a predetermined list." }, { "name": "TemplateDocumentFields", @@ -55094,11 +67029,11 @@ }, { "name": "TemplateDocuments", - "description": "\n\n\nThe TemplateDocuments resource provides methods\nthat manage documents in a template.\nYou can:\n* add one or more documents to the template\n* retrieve one or more documents from the template\n* delete documents from the template\n\nAll of the methods in this resource\noperate on on an existing template.\nBefore you can add documents\nto a template,\nyou must first create it\nwith the [Templates: create][templatescreate] method. \n\n[templatescreate]: https://developers.docusign.com/esign-rest-api/reference/Templates/Templates/create/\n" + "description": "\n\n\nThe TemplateDocuments resource provides methods\nthat manage documents in a template.\nYou can:\n* Add one or more documents to the template\n* Retrieve one or more documents from the template\n* Delete documents from the template\n\nAll of the methods associated with this resource\noperate on an existing template.\nBefore you can add documents\nto a template,\nyou must first create it\nwith the [Templates:: Create][templatescreate] method.\n\n[templatescreate]: https://developers.docusign.com/docs/esign-rest-api/reference/Templates/Templates/create/\n" }, { "name": "TemplateLocks", - "description": "The TemplateLocks resource provides methods that allow you to manage locks on an template.\n\nYou can lock the template, and set the time until the lock expires, to prevent users from accessing and changing the template.\n\nUsers must have envelope locking capability enabled to use these functions." + "description": "The TemplateLocks resource provides methods that allow you to\nmanage locks on a template.\n\nTo prevent users from changing a template while another user is\nmodifying it, you can lock the template and set the time until\nthe lock expires.\n\nFor example, you would use the following flow:\n\n1. Lock the template.\n2. Make changes to template.\n3. Delete the template lock and save the changes. If the template has a password, you must supply the template password to save the changes.\n\n**Note**: To use template locks, the user must have envelope locking capability enabled." }, { "name": "Templates", @@ -55106,11 +67041,11 @@ }, { "name": "TemplateRecipientTabs", - "description": "\n\n\nThe TemplateRecipientTabs resource provides methods that let you\nadd,\nupdate,\nand delete tabs\nfrom an envelope.\nTabs are associated with a specific recipient\nin an envelope\nand are only used by the recipient types\nIn Person Signers and Signers. \n\n\n## Tab Types\n\nThis table lists the available tab types.\n\n
\n\n\n| Tab Type | Description |\n| :------- | :---------- |\n| Approve Tab | Place this tab on the document if you want the recipient to approve documents in an envelope without placing a signature or initials on the document. If the recipient clicks the Approve tab during the signing process, the recipient is considered to have signed the document. No information is shown on the document for the approval, but it is recorded as a signature in the envelope history. |\n| Checkbox Tab | Place this tab on the document in a location where the recipient can select a yes/no (on/off) type option. |\n| Company Tab | Place this tab on the document where you want the recipient's company name to appear. |\n| Date Signed Tab | Place this tab on the document where you want the date the recipient signed the document to appear. |\n| Date Tab | Place this tab on the document where you want the recipient to enter a date. Date tabs are single-line fields that allow date information to be entered in any format. The tooltip for this tab recommends entering the date as MM/DD/YYYY, but this is not enforced. The format entered by the signer is retained. If you need a particular date format enforced, DocuSign recommends using a Text tab with a Validation Pattern and Validation Message to enforce the format. |\n| Decline Tab | Place this tab on the document where you want to give the recipient the option of declining an envelope. If the recipient clicks the Decline tab during the signing process, the envelope is voided. |\n| Email Address Tab | Place this tab on a document where you want the recipient's email, as entered in the recipient information, to appear. |\n| Email Tab | This is a single-line field that accepts any characters. |\n| Envelope ID Tab | Place this tab on the document where you want the envelope ID for to appear. Recipients cannot enter or change the information in this tab. It is for informational purposes only. |\n| First Name Tab | Place this tab on a document where you want the recipient's first name to appear. This tab takes the recipient's name, as entered in the recipient information, splits it into sections based on spaces and uses the first section as the first name. |\n| Formula Tab | This tab is used to add a calculated field to a document. Envelope recipients cannot directly enter information into the tab. The formula tab calculates and displays a new value when changes are made to the reference tab values. The reference tab information and calculation operations are entered in the \"formula\" element. See the Using the Calculated Fields Feature quick start guide or DocuSign Service User Guide for more information about formulas. |\n| Full Name Tab | Place this tab on the document where you want the recipient's full name to appear. |\n| Initial Here Tab | Place this tab where the recipient must initial the document. This tab can be set to be optional. |\n| Last Name Tab | Place this tab on a document where you want the recipient's last name to appear. This tab takes the recipient's name, as entered in the recipient information, splits it into sections based on spaces and uses the last section as the last name. |\n| List Tab | This tab has a list of options that a recipient can select. The `listItems` parameter is used to set the options that can be selected. |\n| Note Tab | Place this tab on the document where you want to add a note for the recipient on a document. |\n| Number Tab | This tab is a field where the recipient can enter numbers and decimal (.) points. |\n| Radio Group Tab | This group tab is used to place radio buttons on a document. The `radios` parameter is used to add and place the radio buttons associated with the group. Only one radio button can be selected in a group. |\n| Sign Here Tab | Place this tab where the recipient must sign the document. This tab can be set to be optional. |\n| Signer Attachment Tab | The signer attachment is where the recipient initiates the process of adding supporting documents to an envelope. |\n| SSN Tab | This tab is a single-line field where the recipient can enter numbers. A Social Security Number can be typed with or without dashes. |\n| Text Tab | This tab is a field where the recipient can enter any type of characters. |\n| Title Tab | Place this tab on the document where you want the recipient's title to appear. |\n| Zip Tab | This tab is a single-line field where the recipient can enter numbers. |\n\n\n## Using Custom Tabs in Envelopes and Templates \n\nCustom Tabs can be added to envelopes and templates\nby setting the `customTabId` property\nwhen creating an envelope or template recipient\nor when adding a new tab for an existing recipient.\nThe custom tab must be added as the correct tab type.\nFor example if the custom tab type is text, it cannot be used as a number tab.\n\nWhen the `customTabId` property is set,\nthe new tab inherits all the custom tab properties.\nRequired information that is not included in the custom tab,\nsuch as document ID and page ID, must be included when adding the tab.\nIf the custom tab does not have anchor settings, the X and Y positions must be included.\n\nAfter the tab is created,\nit is treated as any other tab for updating or deleting. \n\n## Anchoring Tabs\n\nThe tab anchoring option\nallows you to send documents for signature\nthat do not have a fixed layout or format.\nIn these documents you might not know\nthe absolute location of the tabs\nwhen you design your API client application because the tabs must move with text.\nAs an alternative to sending X and Y coordinates for tabs,\nthe DocuSign Service can derive an anchor location for the tab\nby correlating anchor information to data within the document.\n\nWhen the DocuSign Service receives a request that contains tabs\nwith anchor information,\nit searches the document for instances of the `anchorString` property.\nWhen found,\nit places a tab of the specified type for the designated recipient.\nTab positions are established by setting offsets for the tab.\n\nWhen you apply tabs to the document,\nDocuSign does not remove or replace the text in the `anchorString` property. You can hide codified anchors by using the same font color as the background of the document. So the anchor can be used by DocuSign processes and it will not be visible on the document.\n\nTo use an anchoring option:\n\n1. Identify the location in the document by text string. You can use a pre-existing text string or add a new one.\nFor best performance DocuSign recommends using single word anchor strings when possible, especially when there are a large number of pages in the envelope. \nFor example, you might want to add a Sign Here tab to the \"Borrower's Signature\" lines in a document, but that phrase might occur in places in the document where you don't want to tab to appear. In this case, you could add the text \"BorrowerSignHere\" in white font color (so that isn't visible in the document) to all the places you want Sign Here tabs to appear and use \"BorrowerSignHere\" as the anchor string. \n1. Reference the anchor through the `anchorString` property of the tab.\n1. Determine the offset from the anchor string location to where the tab should be placed. \n\nSetting a positive value in the `anchorXOffset` property moves the tab right on the page and positive values in the `anchorYoffset` prove moves the tab down the page. The `anchorUnits` property specifies the units used for the offsets.\nFor Sign Here and Initial Here tabs the bottom-left of the anchor string is equivalent to position (0,0), and the bottom-left of the tab graphic is placed relative to that.\nFor all other tabs the bottom-left of the anchor string is equivalent to position (0,0), and the top-left of the tab graphic is placed relative to that.\nDocuSign does not currently provide tools to derive the offset values. Determination of the proper offset will likely require some trial-and-error.\n\n### Rules for working with anchor tags\n\nWhen anchor tabs are used, all documents in the envelope are searched for the `anchorString` property.\n\n* You set the text of the anchor string in the `anchorString` property. DocuSign tabs are created for each instance of the `anchorString` property within the document, so special care must be taken to establish unique anchor strings that do not result in unintentional tabs.\n* You cannot use the same anchored tab for different recipients for the same document.\n* The DocuSign system cannot search for text that is embedded in an image when checking for anchor strings.\n* X or Y offsets supplied for a tab apply to all instances of the tab in the document. To use different offsets at different locations in the document for the same recipient, create multiple, unique anchor tabs.\n* If the Y offset value of an anchor string would force a tab outside of the page boundaries, the tag is placed at the page boundary. If the X offset value places a tab outside of the page boundaries, the error message `Invalid_User_Offset` is sent. The error message includes the X offset that resulted in the error.\n* The system does not support an anchor string embedded in the form of a PDF X-object in the document.\n* The system does not re-flow the text that surrounds the anchor tabs. It is the responsibility of the document author to provide sufficient white space to contain the potential width of the ultimate tab value.\n\n### Tips and Tricks\n\nThe following are tips for effective use of anchor tags:\n* In order to avoid unintentional conflicts between text contained in an `anchorString` property and the text that naturally exists in documents, establish a codified syntax for the anchor string text that is unlikely to appear elsewhere in a document.\n* Develop an extensible and consistent syntax that can be used across multiple document types.\n* Especially for documents that have variable numbers of tabs or signers, author the source document to include hidden anchor tabs for all potential signers/permutations. Then, control the tabs that are actually placed by including/excluding the anchor tabs in the request. This approach allows a single document to be used for all use cases instead of maintaining separate documents for each scenario.\n\n## Automatically Populating Tabs\n\nIf you want similar tab types\nto automatically populate with the same data,\nyou must follow these guidelines:\n\n* Each `tabLabel` entry must have the characters\n `\\\\*` in front of the label.\n If you omit the `\\\\*` prefix,\n only the first occurrence of the tab is populated.\n\n When automatically populating tabs,\n the `tabLabel` must not contain any spaces.\n In the JSON example below,\n the Text tabs properties `StudentLastName` and `StudentFirstName`\n will be auto-populated as specified (\"Doe\" and \"John\")\n each place they appear throughout the envelope.\n\n ```\n \"tabs\": {\n \"textTabs\": [\n {\n \"tabLabel\": \"\\\\*StudentLastName\",\n \"value\": \"Doe\"\n },\n {\n \"tabLabel\": \"\\\\*StudentFirstName\",\n \"value\": \"John\"\n }]\n }\n ```\n\n* Each occurrence of the tab must have identical properties.\n\n For example, suppose there are two Text tabs in a document,\n each with `tabLabel` set to `Name`.\n If one tab has the `bold` property set to **true**,\n and the other has the `bold` property set to **false**,\n only the first one will be populated.\n In order to automatically populate both occurrences\n of the `Name` Text tabs,\n the `bold` property must be set to the same value for both tabs.\n" + "description": "\n\n\nThe TemplateRecipientTabs resource provides methods that let you\nadd,\nupdate,\nand delete tabs\nfrom an envelope.\nTabs are associated with a specific recipient\nin an envelope\nand are only used by the recipient types\nIn Person Signers and Signers. \n\n\n## Tab Types\n\nThis table lists the available tab types.\n\n
\n\n\n| Tab Type | Description |\n| :------- | :---------- |\n| Approve Tab | Place this tab on the document if you want the recipient to approve documents in an envelope without placing a signature or initials on the document. If the recipient clicks the Approve tab during the signing process, the recipient is considered to have signed the document. No information is shown on the document for the approval, but it is recorded as a signature in the envelope history. |\n| Checkbox Tab | Place this tab on the document in a location where the recipient can select a yes/no (on/off) type option. |\n| Company Tab | Place this tab on the document where you want the recipient's company name to appear. |\n| Date Signed Tab | Place this tab on the document where you want the date the recipient signed the document to appear. |\n| Date Tab | Place this tab on the document where you want the recipient to enter a date. Date tabs are single-line fields that allow date information to be entered in any format. The tooltip for this tab recommends entering the date as MM/DD/YYYY, but this is not enforced. The format entered by the signer is retained. If you need a particular date format enforced, DocuSign recommends using a Text tab with a Validation Pattern and Validation Message to enforce the format. |\n| Decline Tab | Place this tab on the document where you want to give the recipient the option of declining an envelope. If the recipient clicks the Decline tab during the signing process, the envelope is voided. |\n| Email Address Tab | Place this tab on a document where you want the recipient's email, as entered in the recipient information, to appear. |\n| Email Tab | This is a single-line field that accepts all characters. |\n| Envelope ID Tab | Place this tab on the document where you want the envelope ID for to appear. Recipients cannot enter or change the information in this tab. It is for informational purposes only. |\n| First Name Tab | Place this tab on a document where you want the recipient's first name to appear. This tab splits the recipient's name (as entered in the recipient information) into sections based on spaces and uses the first section as the first name. |\n| Formula Tab | This tab is used to add a calculated field to a document. Envelope recipients cannot directly enter information into the tab. The formula tab calculates and displays a new value when changes are made to the reference tab values. The reference tab information and calculation operations are entered in the \"formula\" element. See the Using the Calculated Fields Feature quick start guide or DocuSign Service User Guide for more information about formulas. |\n| Full Name Tab | Place this tab on the document where you want the recipient's full name to appear. |\n| Initial Here Tab | Place this tab where the recipient must initial the document. This tab can be set to be optional. |\n| Last Name Tab | Place this tab on a document where you want the recipient's last name to appear. This tab splits the recipient's name (as entered in the recipient information) into sections based on spaces and uses the last section as the last name. |\n| List Tab | This tab has a list of options that a recipient can select. The `listItems` parameter is used to set the options that can be selected. |\n| Note Tab | Place this tab on the document where you want to add a note for the recipient on a document. |\n| Number Tab | This tab is a field where the recipient can enter numbers and decimal (.) points. |\n| Radio Group Tab | This group tab is used to place radio buttons on a document. The `radios` parameter is used to add and place the radio buttons associated with the group. Only one radio button can be selected in a group. |\n| Sign Here Tab | Place this tab where the recipient must sign the document. This tab can be set to be optional. |\n| Signer Attachment Tab | The signer attachment is where the recipient initiates the process of adding supporting documents to an envelope. |\n| SSN Tab | This tab is a single-line field where the recipient can enter numbers. A Social Security Number can be typed with or without dashes. |\n| Text Tab | This tab is a field where the recipient can enter any type of characters. |\n| Title Tab | Place this tab on the document where you want the recipient's title to appear. |\n| Zip Tab | This tab is a single-line field where the recipient can enter numbers. |\n\n\n## Using Custom Tabs in Envelopes and Templates \n\nCustom Tabs can be added to envelopes and templates\nby setting the `customTabId` property\nwhen creating an envelope or template recipient\nor when adding a new tab for an existing recipient.\nThe custom tab must be added as the correct tab type.\nFor example if the custom tab type is text, it cannot be used as a number tab.\n\nWhen the `customTabId` property is set,\nthe new tab inherits all the custom tab properties.\nRequired information that is not included in the custom tab,\nsuch as document ID and page ID, must be included when adding the tab.\nIf the custom tab does not have anchor settings, the X and Y positions must be included.\n\nAfter the tab is created,\nit is treated as any other tab for updating or deleting. \n\n## Anchoring Tabs\n\nThe tab anchoring option\nallows you to send documents for signature\nthat do not have a fixed layout or format.\nIn these documents you might not know\nthe absolute location of the tabs\nwhen you design your API client application because the tabs must move with text.\nAs an alternative to sending X and Y coordinates for tabs,\nthe DocuSign Service can derive an anchor location for the tab\nby correlating anchor information to data within the document.\n\nWhen the DocuSign Service receives a request that contains tabs\nwith anchor information,\nit searches the document for instances of the `anchorString` property.\nWhen found,\nit places a tab of the specified type for the designated recipient.\nTab positions are established by setting offsets for the tab.\n\nWhen you apply tabs to the document,\nDocuSign does not remove or replace the text in the `anchorString` property. You can hide codified anchors by using the same font color as the background of the document. So the anchor can be used by DocuSign processes and it will not be visible on the document.\n\nTo use an anchoring option:\n\n1. Identify the location in the document by text string. You can use a pre-existing text string or add a new one.\nFor best performance DocuSign recommends using single word anchor strings when possible, especially when there are a large number of pages in the envelope. \nFor example, you might want to add a Sign Here tab to the \"Borrower's Signature\" lines in a document, but that phrase might occur in places in the document where you don't want to tab to appear. In this case, you could add the text \"BorrowerSignHere\" in white font color (so that isn't visible in the document) to all the places you want Sign Here tabs to appear and use \"BorrowerSignHere\" as the anchor string. \n1. Reference the anchor through the `anchorString` property of the tab.\n1. Determine the offset from the anchor string location to where the tab should be placed. \n\nSetting a positive value in the `anchorXOffset` property moves the tab right on the page and positive values in the `anchorYoffset` prove moves the tab down the page. The `anchorUnits` property specifies the units used for the offsets.\nFor Sign Here and Initial Here tabs the bottom-left of the anchor string is equivalent to position (0,0), and the bottom-left of the tab graphic is placed relative to that.\nFor all other tabs the bottom-left of the anchor string is equivalent to position (0,0), and the top-left of the tab graphic is placed relative to that.\nDocuSign does not currently provide tools to derive the offset values. Determination of the proper offset will likely require some trial-and-error.\n\n### Rules for working with anchor tags\n\nWhen anchor tabs are used, all documents in the envelope are searched for the `anchorString` property.\n\n* You set the text of the anchor string in the `anchorString` property. DocuSign tabs are created for each instance of the `anchorString` property within the document, so special care must be taken to establish unique anchor strings that do not result in unintentional tabs.\n* You cannot use the same anchored tab for different recipients for the same document.\n* The DocuSign system cannot search for text that is embedded in an image when checking for anchor strings.\n* X or Y offsets supplied for a tab apply to all instances of the tab in the document. To use different offsets at different locations in the document for the same recipient, create multiple, unique anchor tabs.\n* If the Y offset value of an anchor string would force a tab outside of the page boundaries, the tag is placed at the page boundary. If the X offset value places a tab outside of the page boundaries, the error message `Invalid_User_Offset` is sent. The error message includes the X offset that resulted in the error.\n* The system does not support an anchor string embedded in the form of a PDF X-object in the document.\n* The system does not re-flow the text that surrounds the anchor tabs. It is the responsibility of the document author to provide sufficient white space to contain the potential width of the ultimate tab value.\n\n### Tips and Tricks\n\nThe following are tips for effective use of anchor tags:\n* In order to avoid unintentional conflicts between text contained in an `anchorString` property and the text that naturally exists in documents, establish a codified syntax for the anchor string text that is unlikely to appear elsewhere in a document.\n* Develop an extensible and consistent syntax that can be used across multiple document types.\n* Especially for documents that have variable numbers of tabs or signers, author the source document to include hidden anchor tabs for all potential signers/permutations. Then, control the tabs that are actually placed by including/excluding the anchor tabs in the request. This approach allows a single document to be used for all use cases instead of maintaining separate documents for each scenario.\n\n## Automatically Populating Tabs\n\nIf you want similar tab types\nto automatically populate with the same data,\nyou must follow these guidelines:\n\n* Each `tabLabel` entry must have the characters\n `\\\\*` in front of the label.\n If you omit the `\\\\*` prefix,\n only the first occurrence of the tab is populated.\n\n When automatically populating tabs,\n the `tabLabel` must not contain any spaces.\n In the JSON example below,\n the Text tabs properties `StudentLastName` and `StudentFirstName`\n will be auto-populated as specified (\"Doe\" and \"John\")\n each place they appear throughout the envelope.\n\n ```\n \"tabs\": {\n \"textTabs\": [\n {\n \"tabLabel\": \"\\\\*StudentLastName\",\n \"value\": \"Doe\"\n },\n {\n \"tabLabel\": \"\\\\*StudentFirstName\",\n \"value\": \"John\"\n }]\n }\n ```\n\n* Each occurrence of the tab must have identical properties.\n\n For example, suppose there are two Text tabs in a document,\n each with `tabLabel` set to `Name`.\n If one tab has the `bold` property set to **true**,\n and the other has the `bold` property set to **false**,\n only the first one will be populated.\n In order to automatically populate both occurrences\n of the `Name` Text tabs,\n the `bold` property must be set to the same value for both tabs.\n" }, { "name": "TemplateViews", - "description": "The TemplateViews resource\nprovides a method returns a URL\nthat you can embed into your application\nto provide access to the DocuSign UI.\n\nOne template view is available:\n\n* Edit View - the DocuSign UI for editing a template.\n\nThis resource is related to the [EnvelopeViews][envelopeviews] resource.\nBoth enable you to embed the DocuSign UI into your application.\n\n\n[envelopeviews]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeViews/\n" + "description": "The TemplateViews resource\nprovides a method that returns a URL\nthat you can embed in your application\nto generate a template view that uses the DocuSign UI.\n\nOne template view is available:\n\n* Edit View: The DocuSign UI for editing a template.\n\nThis resource is related to the [EnvelopeViews][envelopeviews] resource.\nBoth resources enable you to embed the DocuSign UI into your application.\n\n\n[envelopeviews]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeViews/\n" }, { "name": "UserCustomSettings", @@ -55122,7 +67057,7 @@ }, { "name": "Users", - "description": "The Users resource provides methods that allow you to manage users for an account. The \"title\" field in the Users object – used in the Users:create, delete, deleteProfile Image, get, getProfileImage, getSettings, list, update, updateList, updateProfileImage, updateSettings calls is not used. Instead, the user's job title may be retrieved and set using the UserProfiles: get and update methods. See [UserProfiles](https://developers.docusign.com/esign-rest-api/reference/Users/UserProfiles) for more information." + "description": "The Users resource provides methods that enable you to manage users for an account.\n\nThe following User methods do not use the `title` property in the Users object:\n\n- create\n- delete\n- deleteProfileImage\n- get\n- getProfileImage\n- getSettings\n- list\n- update\n- updateList\n- updateProfileImag\n- updateSettings\n\nInstead, you can retrieve and set the user's job title by using the UserProfiles:Get and UserProfiles:Update methods. For more information, see [UserProfiles](https://developers.docusign.com/docs/esign-rest-api/reference/Users/UserProfiles)." }, { "name": "UserSignatures", @@ -55130,7 +67065,7 @@ }, { "name": "Contacts", - "description": "The Contacts resource provides methods that allow you to manage contacts.\n" + "description": "DocuSign eSignature includes a contacts list (also referred to as an address book) to help make sending envelopes even easier. When you send an envelope, the recipients' names and email addresses are automatically added to your contacts list. You can use the contacts list to quickly add recipients to the envelopes you send. The `Contacts` resource provides methods that enable you to manage your contacts.\n\n" }, { "name": "EnvelopeAttachments", @@ -55158,15 +67093,15 @@ }, { "name": "WorkspaceItems", - "description": "The WorkspaceItems resource provides methods that allow you to manage\nworkspace items.\n" + "description": "The WorkspaceItems resource provides methods that enable you to manage\nworkspace items.\n" }, { "name": "Workspaces", - "description": "The Workspaces resource provides methods that allow you to manage workspaces.\n" + "description": "A workspace is a collaborative space for sharing documents and managing workflows. A workspace has a single owner who must be a DocuSign user. The owner can invite others to the workspace as collaborators. Individuals who are not DocuSign users must create a DocuSign account to join a workspace as a collaborator.\n \nYou can create an envelope directly from a workspace.\n\nWorkspaces store the following information:\n\n- **Files**: Files uploaded to a workspace for storage or reuse.\n- **Documents**: A document is a component of a transaction, template, or workspace. When a file is added to a transaction, template, or workspace, it is copied as a document. Each document in a workspace has a single owner.\n- **Templates**: A set of documents that you can use to create a transaction or a workspace.\n- **Transactions**: A transaction is a series of workflow events related to one or more documents. These events route the documents to one or more individuals for the purposes of doing business. Each transaction has a single owner (the sender).\n\n**Note**: Documents in a template are not individually listed as files." }, { "name": "ChunkedUploads", - "description": "A chunked upload is a temporary file that you upload in parts and stage at DocuSign, then refer to as the content for other API calls. For example, you might use it for document content when assembling an envelope or template. \n\nA chunked upload is linked to the DocuSign account member who initiated the API call. This user is the only user who is able to reference the chunked upload.\n\nA ChunkedUpload is intended to be an area for briefly staging data for use with other DocuSign API calls. The ChunkedUpload API endpoints do not provide an action to download the ChunkedUpload's content.\n\nThe typical flow for using a chunked upload involves the following steps:\n\n1) Initiate the chunked upload with content representing part 0.\n\n2) Add more parts to the chunked upload until you have transmitted the entirety of the content.\n\n3) Commit the chunked upload, preparing it for use with other API calls.\n\n4) Assemble a DocuSign envelope with a document that includes a reference to the chunked upload as the content.\n\n5) Continue with envelope-related processes.\n\nAfter the chunked upload has been correctly referenced within another API call, it becomes unavailable for any further use and is promptly removed from the system.\n\nChunked uploads have the following limits, which are configured per DocuSign environment, account, or integrator:\n\n- The maximum number of all of a member's unexpired, unconsumed ChunkedUploads. The default value is 10. \n- The maximum total size of all of a member's unexpired, unconsumed ChunkedUploads. The default value is 1 GB. \n- The amount of time that a chunked upload is active. The default value is 20 minutes.\n" + "description": "A chunked upload is a temporary file that you upload in parts and stage at DocuSign, then refer to as the content for other API calls. For example, you might use it for document content when assembling an envelope or template. \n\nA chunked upload is linked to the DocuSign account member who initiated the API call. This user is the only user who is able to reference the chunked upload.\n\nA ChunkedUpload is intended to be an area for briefly staging data for use with other DocuSign API calls. The ChunkedUpload API endpoints do not provide an action to download the ChunkedUpload's content.\n\nThe typical flow for using a chunked upload involves the following steps:\n\n1) Initiate the chunked upload with content representing part 0.\n\n2) Add more parts to the chunked upload until you have transmitted the entirety of the content.\n\n3) Commit the chunked upload, preparing it for use with other API calls.\n\n4) Assemble a DocuSign envelope with a document that includes a reference to the chunked upload as the content.\n\n5) Continue with envelope-related processes.\n\n**Note**: You must fully upload and use a chunked upload within 20 minutes of initializing it.\n\nAfter the chunked upload has been correctly referenced within another API call, it becomes unavailable for any further use and is promptly removed from the system.\n\nChunked uploads have the following limits, which are configured per DocuSign environment, account, or integrator:\n\n- The maximum number of all of a member's unexpired, unconsumed ChunkedUploads. The default value is 10. \n- The maximum total size of all of a member's unexpired, unconsumed ChunkedUploads. The default value is 1 GB. \n- The amount of time that a chunked upload is active after you initialize it. The default value is 20 minutes.\n" }, { "name": "EnvelopeFormData", @@ -55198,7 +67133,7 @@ }, { "name": "IdentityVerifications", - "description": "" + "description": "The DocuSign Identity Verification process requires a signer to submit an image of their valid government ID and wait for the image to be uploaded and verified before they can access a document. \n\nIdentity Verification supports government photo IDs and European eIDs, analyzing the document security features and matching the name on the agreement against the name on the ID. After a successful verification, the signer can view the agreement and sign as usual.\n\nTo use Identity Verification, the [DocuSign Identity Verification](https://www.docusign.com/products/identify) product must be enabled for your account.\n\nFor more information, see [Can I see (a photo of) your ID? Digital verification of real-world IDs](https://www.docusign.com/blog/can-i-see-a-photo-of-your-id-digital-verification-of-real-world-ids/)." }, { "name": "EnvelopeDocumentHtmlDefinitions", @@ -55206,7 +67141,7 @@ }, { "name": "DocumentResponsiveHtmlPreview", - "description": "" + "description": "**Note**: Responsive Signing is disabled by default. To use this functionality, an account administrator must switch the account setting `enableResponsiveSigning` to **true**. \nAlso note that Smart Sections (creating a signable HTML document that uses collapsible sections and rotating tables) are premium features. To request them, contact your DocuSign account manager." }, { "name": "EnvelopeHtmlDefinitions", @@ -55214,15 +67149,15 @@ }, { "name": "ResponsiveHtmlPreview", - "description": "" + "description": "**Note**: Responsive Signing is disabled by default. To use this functionality, an account administrator must switch the account setting `enableResponsiveSigning` to **true**. \nAlso note that Smart Sections (creating a signable HTML document that uses collapsible sections and rotating tables) are premium features. To request them, contact your DocuSign account manager." }, { "name": "TemplateDocumentResponsiveHtmlPreview", - "description": "" + "description": "**Note**: Responsive Signing is disabled by default. To use this functionality, an account administrator must switch the account setting `enableResponsiveSigning` to **true**. \nAlso note that Smart Sections (creating a signable HTML document that uses collapsible sections and rotating tables) are premium features. To request them, contact your DocuSign account manager." }, { "name": "TemplateResponsiveHtmlPreview", - "description": "" + "description": "**Note**: Responsive Signing is disabled by default. To use this functionality, an account administrator must switch the account setting `enableResponsiveSigning` to **true**. \nAlso note that Smart Sections (creating a signable HTML document that uses collapsible sections and rotating tables) are premium features. To request them, contact your DocuSign account manager." }, { "name": "TemplateDocumentHtmlDefinitions", @@ -55234,10 +67169,58 @@ }, { "name": "EnvelopeTransferRules", - "description": "" + "description": "Envelope transfer rules enable administrators to transfer envelopes and templates from user to another. For example, you might do this when an employee leaves the company. To transfer ownership of envelopes and templates, the **Transfer Custody** feature must be enabled for your account.\n\nFor more information about this functionality, see [Transfer Envelopes and Templates](https://support.docusign.com/en/guides/ndse-admin-guide-transfer-envelopes-templates)." }, { "name": "NotificationDefaults", + "description": "DocuSign eSignature provides email notifications to senders and recipients for many different scenarios. By default, all notification options are turned on. Notification preferences give you control over the communications that you receive. For more information, see [Manage Notifications](https://support.docusign.com/en/guides/ndse-user-guide-manage-notifications)." + }, + { + "name": "BulkSend", + "description": "You can use bulk send lists for anything that you need to send to a large number of recipients on a\nrecurring basis, such as:\n\n- Compliance letters (privacy, security, and ethics consent forms)\n- New hire onboarding documents (benefits, transit, and parking information and payroll forms)\n- Other Human Resources documents\n- Event-related forms\n\nThe API creates a separate copy of the envelope for each recipient that you specify. Each instance of the envelope is called a\n`BulkCopy`. You can use a bulk send list to send up to 1,000 copies per call.\n\nAfter you create a bulk send list, it persists and can be reused and edited any number of times.\n\n## Customizing Bulk Send Lists\n\nYou can customize individual copies of the envelope. For example, you can customize the email notification and\nlanguage and add personalized notes.\n\nFor example, if one recipient prefers to access their DocuSign envelopes behind an access code, and another prefers her\nemail in French, you can implement those customizations.\n\n## Using Bulk Send\n\nThe bulk send feature uses the following flow:\n\n1. Create a draft envelope by calling the [Envelopes::createEnvelope][createEnvelope] method. Add placeholders for bulk send information to the envelope, including:\n - Email address placeholders.\n - Tab placeholders. Assign `tabLabels` to these placeholders that will make sense for matching the tabs to values in the bulk send list. For example, if you're sending a field trip permission slip to parents, you might create a placeholder text tab called `StudentName` that will you will then populate with the names of individual students in the bulk send list. You can use the following types of text tabs, radio group tabs, and list tabs to match bulk send recipients to an envelope.\n - Any envelope custom fields. These fields must match the envelope custom fields in envelope copies in the bulk send list.\n2. Create a bulk send list by using the [BulkSend::createBulkSendList][create_list] method.\n3. (Optional) Test compatibility. Use the [BulkSend::createBulkSendTestRequest][create_test] method to test your bulk\n send list for compatibility with the envelope or template that you want to send. For example, a template that has\n three roles is not compatible with a bulk send list that has only two recipients. For this reason, you might want to\n test compatibility first. A successful test result returns the Boolean value `true`. An unsuccessful test returns a\n JSON response that contains information about the errors that occurred.\n4. Send your envelope to the list by using the [BulkSend::createBulkSendRequest][create_request] method. The response\n returns a `batchId` that you can use for tracking and other purposes.\n\nThe API creates and queues your envelopes asynchronously behind the scenes. You can get the status of the batch by\nusing the [BulkEnvelopes_GetBulkEnvelopesBatchId][getbulkenv] method, passing in the `batchId`.\n\nTo get the envelopes generated for the `batchId`, use the [Envelopes:listStatusChanges][GetEnvelopes] method, passing in\na `custom_field` named `BulkBatchId` where the value is the `batchId` that was returned in step 4.\n\nExample:\n\n`custom_field=BulkBatchId={{batchId}}`\n\n**Bulk Send Requirements and Limitations**\n\n* Bulk send must be enabled for your account (in the `accountSettingsInformation` object, `enableBulkRecipient` must be set to **true**) and for the user sending the envelopes (the `allowBulkRecipients` property in `userSettings` must be set to **true**).\n* You can include up to 1,000 bulk recipients in each request.\n* When you send an envelope with bulk recipients, envelopes are added to a bulk recipient queue and sent in a metered fashion. An account can have a total of 2,000 total envelopes in the queue at a time. If this limit is reached, an error message displays to the sender. If you receive this error, wait and resend the envelope at a later time.\n\nIf you frequently run into queue limits, contact your account manager to discuss modifying the queue limits for your account.\n\n[create_list]: https://developers.docusign.com/docs/esign-rest-api/reference/BulkEnvelopes/BulkSend/createBulkSendList/\n[create_test]: https://developers.docusign.com/docs/esign-rest-api/reference/BulkEnvelopes/BulkSend/createBulkSendTestRequest/\n[create_request]: https://developers.docusign.com/docs/esign-rest-api/reference/BulkEnvelopes/BulkSend/createBulkSendRequest/\n[getbulkenv]: https://developers.docusign.com/docs/esign-rest-api/reference/BulkEnvelopes/BulkSend/getBulkSendLists/\n[GetEnvelopes]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/Envelopes/listStatusChanges/\n\n[createEnvelope]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeCustomFields/create/\n\n\nFor more information about using bulk send, see [Bulk Sending Envelopes](https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/envelopes/bulk-send/).\n" + }, + { + "name": "BCCEmailArchive", + "description": "You can configure automatic archiving of emails sent from all of your DocuSign accounts.\n\nFor more information, see [Email Archive Configuration](https://support.docusign.com/en/guides/ndse-admin-guide-email-archive-configuration).\n\n**Note**: This feature is only available for certain account plans and must be enabled by DocuSign." + }, + { + "name": "TabsBlob", + "description": "" + }, + { + "name": "Comments", + "description": "The comments resource provides a method that enables you to download a PDF file containing all of the comments that recipients and the sender have added to the documents in an envelope.\n\nComments are disabled by default. To use the comments feature, an account administrator must enable comments on the account (in the `accountSettingsInformation` object, set the `enableSigningExtensionComments` property to **true**). \n\nFor more information, see [Comments Settings](https://support.docusign.com/en/guides/ndse-admin-guide-comments-settings)." + }, + { + "name": "FavoriteTemplates", + "description": "" + }, + { + "name": "Notary", + "description": "DocuSign eNotary makes the notarization process fully digital\nfor senders, signers, and notaries.\nIt enables a notary public to act as an in-person witness\nto electronic signing of documents.\nCheck the [DocuSign eNotary support documentation](https://support.docusign.com/en/guides/ndse-user-guide-enotary-resources)\nto see which jurisdictions are supported.\n\n" + }, + { + "name": "NotaryJurisdiction", + "description": "Creating, updating, and deleting notary jurisdiction objects." + }, + { + "name": "EnvelopeWorkflowDefinition", + "description": "" + }, + { + "name": "Reports", + "description": "" + }, + { + "name": "AccountSignatures", + "description": "" + }, + { + "name": "ApplianceInfo", + "description": "" + }, + { + "name": "ConnectSecret", "description": "" } ], @@ -55245,33 +67228,28 @@ { "name": "Envelopes", "summary": "This section shows you how to create and send envelopes.", - "description": "The DocuSign API Envelope category includes the resources and methods for sending and managing envelopes and envelope data.\n\nEnvelopes are the key objects within the DocuSign eSignature system. As a result, they are complex data structures with few required fields. See the [Code Examples](https://developers.docusign.com/esign-rest-api/code-examples) for examples and solutions.\n\nTo learn more about envelopes, see [Envelopes and Template](https://developers.docusign.com/esign-rest-api/guides/concepts/envelopes).\n" + "description": "The eSignature API Envelope category includes the resources and methods for sending and managing envelopes and envelope data.\n\nEnvelopes are the key objects in the DocuSign platform. As a result, they are complex data structures with few required fields. See the [How-to guides](https://developers.docusign.com/docs/esign-rest-api/how-to/) for examples and solutions.\n\nTo learn more about envelopes, see [Envelopes](https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/envelopes/).\n" }, { "name": "Connect", - "summary": "Connect configuration and logging", - "description": "The Connect category enables your application to be called via HTTPS when an event of interest occurs.\n\nUse the Connect service to \"end the polling madness.\" With Connect, there is no need for your application to poll DocuSign every 15 minutes to learn the latest about your envelopes.\n\nInstead, you register your interest in one or more types of envelope or recipient events. Then, when an interesting event occurs, the DocuSign platform will contact your application with the event's details and data. You can register interest in envelopes sent by particular users in your account, or for envelopes sent by any user.\n\n## Incoming Connect Calls\nTo use the Connect service, your application needs to provide an https url that can be called from the public internet. If your application runs on a server behind your organization's firewall, then you will need to create a \"pinhole\" in the firewall to allow the incoming Connect calls from DocuSign to reach your application. Other techniques for receiving the incoming calls including proxy servers and DMZ networking can also be used. \n\n## Per-envelope Connect Configuration\nInstead of registering a general Connect configuration and listener, an individual envelope can have its own Connect configuration. See the `eventNotification` field for envelopes.\n\n## Categories\nUse the Connect category for:\n\n* Programmatically creating Connect configurations. Connect configurations can be created manually by using the DocuSign web service, or programmatically via the API. Configurations created via the API can be seen and updated from the web service.\n* Retrieving and managing the event log for your Connect configurations. \n* Requesting that an event be re-published to the listener." + "summary": "DocuSign Connect is the DocuSign platform notification service. The service uses webhooks to proactively notify your application when an event occurs that your application wants to know about. DocuSign recommends that all applications use Connect instead of polling the DocuSign Signature Service. This section provides information about Connect configuration and logging. \n\nFor more information about Connect, see [DocuSign Connect](https://developers.docusign.com/esign-rest-api/guides/connect) and [Custom Connect Configuration](https://support.docusign.com/guides/ndse-admin-guide-custom-connect-configuration-htm).", + "description": "The Connect service enables your application to be called via HTTPS when an event of interest occurs.\n\nUse the Connect service to \"end the polling madness.\" With Connect, there is no need for your application to poll DocuSign every 15 minutes to learn the latest about your envelopes.\n\nInstead, you register your interest in one or more types of envelope or recipient events. Then, when an interesting event occurs, the DocuSign platform will contact your application with the event's details and data. You can register interest in envelopes sent by particular users in your account, or for envelopes sent by any user.\n\nConnect can empower your organization to manage document actions as they occur, and allows you to track their changes within your own systems. Upon completion, envelope information, including document content, can be stored in your own databases or CMS systems, and these events can be triggered via webhooks delivering messages to your application.\n\n## Incoming Connect Calls\n\nTo use the Connect service, your application needs to provide an HTTPS URL that can be called from the public Internet. If your application runs on a server behind your organization's firewall, then you will need to create a \"pinhole\" in the firewall to allow the incoming Connect calls from DocuSign to reach your application. You can also use other techniques such as proxy servers and DMZ networking for receiving the incoming calls.\n\nConnect delivers events over HTTP requests in the form of XML. DocuSign sends an XML object to the secure URL entered on the configuration page for every event and user selected. \n\nIf your application is not configured to accept post messages, DocuSign will NOT return an additional post error response to your listener application. If you've enabled logging on your configuration, it will be logged in Admin under the configuration failure log.\n\n## Per-envelope Connect Configuration\nInstead of registering a general Connect configuration and listener, an individual envelope can have its own Connect configuration. See the `eventNotification` field for envelopes.\n\n## Categories\nUse the Connect category for:\n\n* Programmatically creating Connect configurations. Connect configurations can be created manually by using the DocuSign web service, or programmatically via the API. Configurations created via the API can be seen and updated from the web service.\n* Retrieving and managing the event log for your Connect configurations. \n* Requesting that an event be re-published to the listener." }, { "name": "Templates", "summary": "Template creation and management", - "description": "Use the Templates category to manage your account's templates.\n\nYou can:\n\n* Create, list, get, update, and delete templates.\n* Manage templates' notification and group sharing settings.\n* Fetch and rotate pages from a document used by a template.\n\nTemplates can be created programmatically or can be created via the DocuSign web interface and then used by your application." + "description": "Use the Templates category to manage your account's templates.\n\nThis section shows you how to perform the following tasks:\n\n* Create, list, get, update, and delete templates.\n* Manage the notification and group sharing settings for templates.\n* Fetch and rotate pages from a document used by a template.\n\nYou can create templates either programmatically or through the DocuSign web interface and then used by your application." }, { "name": "SigningGroups", - "summary": "Send a signing request to a group of potential signers", - "description": "Use the SigningGroup category to manage signing groups that allow you anyone in the group to sign a document.\n\nThe category allows you create the signing group and manage the users in the group." + "summary": "Send a signing request to a group of potential signers.", + "description": "Use the Signing Group category to manage signing groups that allow anyone in the group to sign a document. When you send an envelope to a signing group, anyone in the group can open it and sign it with their own signature.\n\nThis category shows account administrators how to create a signing group and manage the users in the group.\n\n**Note**: To create and manage signing groups, you must be an account administrator.\n\nFor more information about this topic, see [Signing Groups](https://support.docusign.com/en/guides/ndse-user-guide-signing-groups)." }, { "name": "Folders", "summary": "Folders for completed envelopes", "description": "Use the Folders category to manage envelopes in your folders. \n\nYou can list the folder contents and move envelopes between folders." }, - { - "name": "BulkEnvelopes", - "summary": "Bulk envelopes", - "description": "Use the BulkEnvelopes category to manage the sending of envelopes to multiple recipients." - }, { "name": "CustomTabs", "summary": "Custom tabs", @@ -55279,7 +67257,7 @@ }, { "name": "CloudStorage", - "summary": "Cloud storage providers and user management", + "summary": "This section shows you how to manage your cloud storage providers and users.", "description": "Use the Cloud Storage category to list the user's cloud storage document contents.\n\nIt is also used to manage the user's authentication/accounts with cloud storage service providers." }, { @@ -55292,10 +67270,15 @@ "summary": "Group users for common permissions and branding", "description": "Use the User Groups category to manage your permissions groups.\n\nYou can:\n\n* Create and delete groups.\n* Add users to, and delete users from, your groups.\n* Manage the brand information associated with a group." }, + { + "name": "BulkEnvelopes", + "summary": "Bulk envelopes", + "description": "Use the BulkEnvelopes category to manage the sending of envelopes to multiple recipients." + }, { "name": "Accounts", "summary": "Account management", - "description": "Use the Account category for various account management tasks including:\n\n* Programmatically creating and deleting accounts.\n* Getting information about an account and its capabilities.\n* Branding the account with custom colors, message text, and more.\n* Account charges.\n\nThe Account category also includes end points for listing the recipient names associated with an email address that was used by the account. For example, a single email address is often shared by mulitple members of a family.\n\n\n" + "description": "Use the Account category for various account management tasks including:\n\n* Programmatically creating and deleting accounts.\n* Getting information about an account and its capabilities.\n* Branding the account with custom colors, message text, and more.\n* Account charges.\n\nThe Accounts category also includes end points for listing the recipient names associated with an email address that was used by the account. For example, a single email address is often shared by multiple members of a family.\n\n\n" }, { "name": "Billing", @@ -55309,18 +67292,28 @@ }, { "name": "PowerForms", - "summary": "The PowerForms category provides methods that enable you to create and manage PowerForms.", + "summary": "The PowerForms category provides methods that enable you to create and manage fillable forms.", "description": "The PowerForms category enables you to create and manage PowerForms that you can use for self service and email forms." }, { "name": "Workspaces", - "summary": "Workspace creation and management", - "description": "Workspaces creation and management.\n\n" + "summary": "A DocuSign workspace is a collaboration area for sharing files and data.", + "description": "A workspace is a collaborative space for sharing documents and managing workflows. A workspace has a single owner who must be a DocuSign user. The owner can invite others to the workspace as collaborators. Individuals who are not DocuSign users must create a DocuSign account to join a workspace as a collaborator.\n \nYou can create an envelope directly from a workspace.\n\nWorkspaces store the following information:\n\n- **Files**: Files uploaded to a workspace for storage or reuse.\n- **Documents**: A document is a component of a transaction, template, or workspace. When a file is added to a transaction, template, or workspace, it is copied as a document. Each document in a workspace has a single owner.\n- **Templates**: A set of documents that you can use to create a transaction or a workspace.\n- **Transactions**: A transaction is a series of workflow events related to one or more documents. These events route the documents to one or more individuals for the purposes of doing business. Each transaction has a single owner (the sender).\n\n**Note**: Documents in a template are not individually listed as files." }, { "name": "Payments", "summary": "Manage Payments", "description": "This category includes resources for managing payment gateways. Payment information is added to envelopes via methods in the Envelopes category." + }, + { + "name": "EmailArchive", + "summary": "This section shows you how to set and manage the BCC email addresses that you want to use to archive the emails that DocSign sends.", + "description": "Email archives enable DocuSign partners and other multi-account customers to easily archive emails sent through DocuSign. The `EmailArchive` resource provides methods for managing your email archive configuration, which consists of the BCC email address or addresses that you want to use to archive DocuSign emails. Each account can use up to five BCC email addresses for archiving purposes.\n\nFor more information, see [Email Archive Configuration](https://support.docusign.com/en/guides/ndse-admin-guide-email-archive-configuration).\n\n**Note**: This feature is only available for certain account plans and must be enabled by DocuSign." + }, + { + "name": "Notary", + "summary": "DocuSign eNotary makes the notarization process fully digital\nfor senders, signers, and notaries.\nIt enables a notary public to act as an in-person witness\nto electronic signing of documents.\n", + "description": "DocuSign eNotary makes the notarization process fully digital\nfor senders, signers, and notaries.\nIt enables a notary public to act as an in-person witness\nto electronic signing of documents.\n" } ] -} \ No newline at end of file +} diff --git a/gen-esign/overrides.go b/gen-esign/overrides.go index 15cee8a..7f76468 100644 --- a/gen-esign/overrides.go +++ b/gen-esign/overrides.go @@ -83,6 +83,9 @@ func GetFieldOverrides() map[string]map[string]string { "witness": { "offlineAttributes": "interface{}", }, + "notaryRecipient": { + "offlineAttributes": "interface{}", + }, "newAccountDefinition": { "socialAccountInformation": "*SocialAccountInformation", }, diff --git a/go.sum b/go.sum index 8dd8837..1963f5f 100644 --- a/go.sum +++ b/go.sum @@ -28,7 +28,6 @@ github.com/googleapis/gax-go/v2 v2.0.4/go.mod h1:0Wqv26UfaUD9n4G6kQubkQ+KchISgw+ github.com/googleapis/gax-go/v2 v2.0.5 h1:sjZBwGj9Jlw33ImPtvFviGYvseOtDM7hkSKB7+Tv3SM= github.com/googleapis/gax-go/v2 v2.0.5/go.mod h1:DWXyrwAJ9X0FpwwEdw+IPEYBICEFu5mhpdKc/us6bOk= github.com/hashicorp/golang-lru v0.5.0/go.mod h1:/m3WP610KZHVQ1SGc6re/UDhFvYD7pJ4Ao+sR/qLZy8= -github.com/hashicorp/golang-lru v0.5.1 h1:0hERBMJE1eitiLkihrMvRVBYAkpHzc/J3QdDN+dAcgU= github.com/hashicorp/golang-lru v0.5.1/go.mod h1:/m3WP610KZHVQ1SGc6re/UDhFvYD7pJ4Ao+sR/qLZy8= github.com/hashicorp/golang-lru v0.5.3 h1:YPkqC67at8FYaadspW/6uE0COsBxS2656RLEr8Bppgk= github.com/hashicorp/golang-lru v0.5.3/go.mod h1:iADmTwqILo4mZ8BN3D2Q6+9jd8WM5uGBxy+E8yxSoD4= diff --git a/v2.1/accounts/accounts.go b/v2.1/accounts/accounts.go index 689bc30..e027eb6 100644 --- a/v2.1/accounts/accounts.go +++ b/v2.1/accounts/accounts.go @@ -15,7 +15,7 @@ // * Branding the account with custom colors, message text, and more. // * Account charges. // -// The Account category also includes end points for listing the recipient names associated with an email address that was used by the account. For example, a single email address is often shared by mulitple members of a family. +// The Accounts category also includes end points for listing the recipient names associated with an email address that was used by the account. For example, a single email address is often shared by multiple members of a family. // // Service Api documentation may be found at: // https://developers.docusign.com/esign-rest-api/reference/Accounts @@ -187,7 +187,7 @@ func (op *BrandsGetOp) IncludeLogos() *BrandsGetOp { return op } -// BrandsGetExportFile export a brand. +// BrandsGetExportFile exports a brand. // // https://developers.docusign.com/esign-rest-api/reference/accounts/accountbrands/getexportfile // @@ -308,7 +308,7 @@ func (op *BrandsListOp) ExcludeDistributorBrand() *BrandsListOp { return op } -// IncludeLogos when **true**, the URIs for the logos associated with the brand are included in the response. +// IncludeLogos when set to **true**, returns the logos associated with the brand. func (op *BrandsListOp) IncludeLogos() *BrandsListOp { if op != nil { op.QueryOpts.Set("include_logos", "true") @@ -415,7 +415,7 @@ func (op *BrandsUpdateResourceOp) Do(ctx context.Context) (*model.BrandResources return res, ((*esign.Op)(op)).Do(ctx, &res) } -// ConsumerDisclosuresGet gets the Electronic Record and Signature Disclosure. +// ConsumerDisclosuresGet gets the Electronic Record and Signature Disclosure for an account. // // https://developers.docusign.com/esign-rest-api/reference/accounts/accountconsumerdisclosures/get // @@ -439,7 +439,7 @@ func (op *ConsumerDisclosuresGetOp) Do(ctx context.Context) (*model.ConsumerDisc return res, ((*esign.Op)(op)).Do(ctx, &res) } -// ConsumerDisclosuresGetDefault gets the Electronic Record and Signature Disclosure for the account. +// ConsumerDisclosuresGetDefault gets the default Electronic Record and Signature Disclosure for an account. // // https://developers.docusign.com/esign-rest-api/reference/accounts/accountconsumerdisclosures/getdefault // @@ -463,9 +463,53 @@ func (op *ConsumerDisclosuresGetDefaultOp) Do(ctx context.Context) (*model.Consu return res, ((*esign.Op)(op)).Do(ctx, &res) } -// LangCode specifies the language used in the response. The supported languages, with the language value shown in parenthesis, are: Arabic (ar), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk), and Vietnamese (vi). -// -// Additionally, the value can be set to `browser` to automatically detect the browser language being used by the viewer and display the disclosure in that language. +// LangCode (Optional) The code for the signer language version of the disclosure that you want to retrieve. The following languages are supported: +// +// - Arabic (`ar`) +// - Bulgarian (`bg`) +// - Czech (`cs`) +// - Chinese Simplified (`zh_CN`) +// - Chinese Traditional (`zh_TW`) +// - Croatian (`hr`) +// - Danish (`da`) +// - Dutch (`nl`) +// - English US (`en`) +// - English UK (`en_GB`) +// - Estonian (`et`) +// - Farsi (`fa`) +// - Finnish (`fi`) +// - French (`fr`) +// - French Canadian (`fr_CA`) +// - German (`de`) +// - Greek (`el`) +// - Hebrew (`he`) +// - Hindi (`hi`) +// - Hungarian (`hu`) +// - Bahasa Indonesian (`id`) +// - Italian (`it`) +// - Japanese (`ja`) +// - Korean (`ko`) +// - Latvian (`lv`) +// - Lithuanian (`lt`) +// - Bahasa Melayu (`ms`) +// - Norwegian (`no`) +// - Polish (`pl`) +// - Portuguese (`pt`) +// - Portuguese Brazil (`pt_BR`) +// - Romanian (`ro`) +// - Russian (`ru`) +// - Serbian (`sr`) +// - Slovak (`sk`) +// - Slovenian (`sl`) +// - Spanish (`es`) +// - Spanish Latin America (`es_MX`) +// - Swedish (`sv`) +// - Thai (`th`) +// - Turkish (`tr`) +// - Ukrainian (`uk`) +// - Vietnamese (`vi`) +// +// Additionally, you can automatically detect the browser language being used by the viewer and display the disclosure in that language by setting the value to `browser`. func (op *ConsumerDisclosuresGetDefaultOp) LangCode(val string) *ConsumerDisclosuresGetDefaultOp { if op != nil { op.QueryOpts.Set("langCode", val) @@ -473,17 +517,17 @@ func (op *ConsumerDisclosuresGetDefaultOp) LangCode(val string) *ConsumerDisclos return op } -// ConsumerDisclosuresUpdate update Consumer Disclosure. +// ConsumerDisclosuresUpdate updates the Electronic Record and Signature Disclosure for an account. // // https://developers.docusign.com/esign-rest-api/reference/accounts/accountconsumerdisclosures/update // // SDK Method Accounts::updateConsumerDisclosure -func (s *Service) ConsumerDisclosuresUpdate(langCode string, envelopeConsumerDisclosures *model.ConsumerDisclosure) *ConsumerDisclosuresUpdateOp { +func (s *Service) ConsumerDisclosuresUpdate(langCode string, consumerDisclosure *model.ConsumerDisclosure) *ConsumerDisclosuresUpdateOp { return &ConsumerDisclosuresUpdateOp{ Credential: s.credential, Method: "PUT", Path: strings.Join([]string{"consumer_disclosure", langCode}, "/"), - Payload: envelopeConsumerDisclosures, + Payload: consumerDisclosure, QueryOpts: make(url.Values), Version: esign.VersionV21, } @@ -498,7 +542,7 @@ func (op *ConsumerDisclosuresUpdateOp) Do(ctx context.Context) (*model.ConsumerD return res, ((*esign.Op)(op)).Do(ctx, &res) } -// IncludeMetadata when set to **true**, the response includes metadata indicating which properties are editable. +// IncludeMetadata (Optional) When set to true, the response includes metadata indicating which properties are editable. func (op *ConsumerDisclosuresUpdateOp) IncludeMetadata(val string) *ConsumerDisclosuresUpdateOp { if op != nil { op.QueryOpts.Set("include_metadata", val) @@ -506,7 +550,7 @@ func (op *ConsumerDisclosuresUpdateOp) IncludeMetadata(val string) *ConsumerDisc return op } -// CustomFieldsCreate creates an acount custom field. +// CustomFieldsCreate creates an account custom field. // // https://developers.docusign.com/esign-rest-api/reference/accounts/accountcustomfields/create // @@ -531,7 +575,7 @@ func (op *CustomFieldsCreateOp) Do(ctx context.Context) (*model.CustomFields, er return res, ((*esign.Op)(op)).Do(ctx, &res) } -// ApplyToTemplates set the call query parameter apply_to_templates +// ApplyToTemplates (Optional) When set to **true**, the new custom field is applied to all of the templates on the account. func (op *CustomFieldsCreateOp) ApplyToTemplates() *CustomFieldsCreateOp { if op != nil { op.QueryOpts.Set("apply_to_templates", "true") @@ -539,7 +583,7 @@ func (op *CustomFieldsCreateOp) ApplyToTemplates() *CustomFieldsCreateOp { return op } -// CustomFieldsDelete delete an existing account custom field. +// CustomFieldsDelete deletes an account custom field. // // https://developers.docusign.com/esign-rest-api/reference/accounts/accountcustomfields/delete // @@ -570,7 +614,7 @@ func (op *CustomFieldsDeleteOp) ApplyToTemplates() *CustomFieldsDeleteOp { return op } -// CustomFieldsList gets a list of custom fields associated with the account. +// CustomFieldsList gets a list of custom fields. // // https://developers.docusign.com/esign-rest-api/reference/accounts/accountcustomfields/list // @@ -594,7 +638,7 @@ func (op *CustomFieldsListOp) Do(ctx context.Context) (*model.CustomFields, erro return res, ((*esign.Op)(op)).Do(ctx, &res) } -// CustomFieldsUpdate updates an existing account custom field. +// CustomFieldsUpdate updates an account custom field. // // https://developers.docusign.com/esign-rest-api/reference/accounts/accountcustomfields/update // @@ -627,7 +671,7 @@ func (op *CustomFieldsUpdateOp) ApplyToTemplates() *CustomFieldsUpdateOp { return op } -// PasswordRulesGet get the password rules +// PasswordRulesGet gets the password rules for an account. // // https://developers.docusign.com/esign-rest-api/reference/accounts/accountpasswordrules/get // @@ -651,7 +695,7 @@ func (op *PasswordRulesGetOp) Do(ctx context.Context) (*model.AccountPasswordRul return res, ((*esign.Op)(op)).Do(ctx, &res) } -// PasswordRulesGetForUser get membership account password rules +// PasswordRulesGetForUser gets membership account password rules. // // https://developers.docusign.com/esign-rest-api/reference/accounts/accountpasswordrules/getforuser // @@ -675,7 +719,7 @@ func (op *PasswordRulesGetForUserOp) Do(ctx context.Context) (*model.UserPasswor return res, ((*esign.Op)(op)).Do(ctx, &res) } -// PasswordRulesUpdate update the password rules +// PasswordRulesUpdate updates the password rules for an account. // // https://developers.docusign.com/esign-rest-api/reference/accounts/accountpasswordrules/update // @@ -705,12 +749,12 @@ func (op *PasswordRulesUpdateOp) Do(ctx context.Context) (*model.AccountPassword // https://developers.docusign.com/esign-rest-api/reference/accounts/accountpermissionprofiles/create // // SDK Method Accounts::createPermissionProfile -func (s *Service) PermissionProfilesCreate(accountPermissionProfiles *model.PermissionProfile) *PermissionProfilesCreateOp { +func (s *Service) PermissionProfilesCreate(permissionProfile *model.PermissionProfile) *PermissionProfilesCreateOp { return &PermissionProfilesCreateOp{ Credential: s.credential, Method: "POST", Path: "permission_profiles", - Payload: accountPermissionProfiles, + Payload: permissionProfile, QueryOpts: make(url.Values), Version: esign.VersionV21, } @@ -756,6 +800,14 @@ func (op *PermissionProfilesDeleteOp) Do(ctx context.Context) error { return ((*esign.Op)(op)).Do(ctx, nil) } +// MoveUsersTo set the call query parameter move_users_to +func (op *PermissionProfilesDeleteOp) MoveUsersTo(val string) *PermissionProfilesDeleteOp { + if op != nil { + op.QueryOpts.Set("move_users_to", val) + } + return op +} + // PermissionProfilesGet returns a permission profile for an account. // // https://developers.docusign.com/esign-rest-api/reference/accounts/accountpermissionprofiles/get @@ -832,12 +884,12 @@ func (op *PermissionProfilesListOp) Include(val string) *PermissionProfilesListO // https://developers.docusign.com/esign-rest-api/reference/accounts/accountpermissionprofiles/update // // SDK Method Accounts::updatePermissionProfile -func (s *Service) PermissionProfilesUpdate(permissionProfileID string, accountPermissionProfiles *model.PermissionProfile) *PermissionProfilesUpdateOp { +func (s *Service) PermissionProfilesUpdate(permissionProfileID string, permissionProfile *model.PermissionProfile) *PermissionProfilesUpdateOp { return &PermissionProfilesUpdateOp{ Credential: s.credential, Method: "PUT", Path: strings.Join([]string{"permission_profiles", permissionProfileID}, "/"), - Payload: accountPermissionProfiles, + Payload: permissionProfile, QueryOpts: make(url.Values), Version: esign.VersionV21, } @@ -860,7 +912,7 @@ func (op *PermissionProfilesUpdateOp) Include(val ...string) *PermissionProfiles return op } -// SignatureProvidersList returns Account available signature providers for specified account. +// SignatureProvidersList gets the available signature providers for an account. // // https://developers.docusign.com/esign-rest-api/reference/accounts/accountsignatureproviders/list // @@ -913,12 +965,12 @@ func (op *TabSettingsGetOp) Do(ctx context.Context) (*model.TabAccountSettings, // https://developers.docusign.com/esign-rest-api/reference/accounts/accounttabsettings/update // // SDK Method Accounts::updateAccountTabSettings -func (s *Service) TabSettingsUpdate(accountTabSettings *model.TabAccountSettings) *TabSettingsUpdateOp { +func (s *Service) TabSettingsUpdate(tabAccountSettings *model.TabAccountSettings) *TabSettingsUpdateOp { return &TabSettingsUpdateOp{ Credential: s.credential, Method: "PUT", Path: "settings/tabs", - Payload: accountTabSettings, + Payload: tabAccountSettings, QueryOpts: make(url.Values), Version: esign.VersionV21, } @@ -962,12 +1014,12 @@ func (op *WatermarksGetOp) Do(ctx context.Context) (*model.Watermark, error) { // https://developers.docusign.com/esign-rest-api/reference/accounts/accountwatermarks/preview // // SDK Method Accounts::getWatermarkPreview -func (s *Service) WatermarksPreview(accountWatermarks *model.Watermark) *WatermarksPreviewOp { +func (s *Service) WatermarksPreview(watermark *model.Watermark) *WatermarksPreviewOp { return &WatermarksPreviewOp{ Credential: s.credential, Method: "PUT", Path: "watermark/preview", - Payload: accountWatermarks, + Payload: watermark, QueryOpts: make(url.Values), Version: esign.VersionV21, } @@ -987,12 +1039,12 @@ func (op *WatermarksPreviewOp) Do(ctx context.Context) (*model.Watermark, error) // https://developers.docusign.com/esign-rest-api/reference/accounts/accountwatermarks/update // // SDK Method Accounts::updateWatermark -func (s *Service) WatermarksUpdate(accountWatermarks *model.Watermark) *WatermarksUpdateOp { +func (s *Service) WatermarksUpdate(watermark *model.Watermark) *WatermarksUpdateOp { return &WatermarksUpdateOp{ Credential: s.credential, Method: "PUT", Path: "watermark", - Payload: accountWatermarks, + Payload: watermark, QueryOpts: make(url.Values), Version: esign.VersionV21, } @@ -1032,14 +1084,6 @@ func (op *CreateOp) Do(ctx context.Context) (*model.NewAccountSummary, error) { return res, ((*esign.Op)(op)).Do(ctx, &res) } -// PreviewBillingPlan when set to **true**, creates the account using a preview billing plan. -func (op *CreateOp) PreviewBillingPlan() *CreateOp { - if op != nil { - op.QueryOpts.Set("preview_billing_plan", "true") - } - return op -} - // Delete deletes the specified account. // // https://developers.docusign.com/esign-rest-api/reference/accounts/accounts/delete @@ -1112,7 +1156,8 @@ func (op *GetOp) Do(ctx context.Context) (*model.AccountInformation, error) { return res, ((*esign.Op)(op)).Do(ctx, &res) } -// IncludeAccountSettings when set to **true**, includes account settings (defined by the [`accountSettings`](https://developers.docusign.com/esign-rest-api/reference/Accounts/Accounts/create/#account-settings) property) in the response. If you omit this parameter, the default behavior is **false**. +// IncludeAccountSettings when set to **true**, includes account settings +// in the response. If you omit this parameter, the default behavior is **false**. func (op *GetOp) IncludeAccountSettings() *GetOp { if op != nil { op.QueryOpts.Set("include_account_settings", "true") @@ -1180,7 +1225,7 @@ func (op *GetProvisioningOp) Do(ctx context.Context) (*model.ProvisioningInforma return res, ((*esign.Op)(op)).Do(ctx, &res) } -// ListRecipientNamesByEmail gets recipient names associated with an email address. +// ListRecipientNamesByEmail gets the recipient names associated with an email address. // // https://developers.docusign.com/esign-rest-api/reference/accounts/accounts/listrecipientnamesbyemail // @@ -1204,7 +1249,7 @@ func (op *ListRecipientNamesByEmailOp) Do(ctx context.Context) (*model.Recipient return res, ((*esign.Op)(op)).Do(ctx, &res) } -// Email is the email address for the user +// Email is the email address for which you want to retrieve recipient names. func (op *ListRecipientNamesByEmailOp) Email(val string) *ListRecipientNamesByEmailOp { if op != nil { op.QueryOpts.Set("email", val) @@ -1343,7 +1388,7 @@ func (op *ListSharedAccessOp) UserIds(val ...string) *ListSharedAccessOp { return op } -// ListSupportedLanguages list supported languages for the recipient language setting +// ListSupportedLanguages gets the supported languages for envelope recipients. // // https://developers.docusign.com/esign-rest-api/reference/accounts/accounts/listsupportedlanguages // @@ -1519,12 +1564,12 @@ func (op *ENoteConfigurationsGetOp) Do(ctx context.Context) (*model.ENoteConfigu // https://developers.docusign.com/esign-rest-api/reference/accounts/enoteconfigurations/update // // SDK Method Accounts::updateENoteConfiguration -func (s *Service) ENoteConfigurationsUpdate(eNoteConfigurations *model.ENoteConfiguration) *ENoteConfigurationsUpdateOp { +func (s *Service) ENoteConfigurationsUpdate(eNoteConfiguration *model.ENoteConfiguration) *ENoteConfigurationsUpdateOp { return &ENoteConfigurationsUpdateOp{ Credential: s.credential, Method: "PUT", Path: "settings/enote_configuration", - Payload: eNoteConfigurations, + Payload: eNoteConfiguration, QueryOpts: make(url.Values), Version: esign.VersionV21, } @@ -1539,7 +1584,7 @@ func (op *ENoteConfigurationsUpdateOp) Do(ctx context.Context) (*model.ENoteConf return res, ((*esign.Op)(op)).Do(ctx, &res) } -// PaymentGatewayAccountsList list payment gateway account information +// PaymentGatewayAccountsList list payment gateway accounts // // https://developers.docusign.com/esign-rest-api/reference/accounts/paymentgatewayaccounts/list // @@ -1563,9 +1608,11 @@ func (op *PaymentGatewayAccountsListOp) Do(ctx context.Context) (*model.PaymentG return res, ((*esign.Op)(op)).Do(ctx, &res) } -// SealProvidersList is SDK Method Accounts::getSealProviders +// SealProvidersList returns available seals for specified account. +// +// https://developers.docusign.com/esign-rest-api/reference/accounts/accountsealproviders/list // -// https://developers.docusign.com/esign/restapi/Accounts/AccountSealProviders/list +// SDK Method Accounts::getSealProviders func (s *Service) SealProvidersList() *SealProvidersListOp { return &SealProvidersListOp{ Credential: s.credential, @@ -1585,7 +1632,7 @@ func (op *SealProvidersListOp) Do(ctx context.Context) (*model.AccountSeals, err return res, ((*esign.Op)(op)).Do(ctx, &res) } -// IdentityVerificationsList retrieves the list of identity verification workflows available to an account +// IdentityVerificationsList retrieves the Identity Verification workflows available to an account. // // https://developers.docusign.com/esign-rest-api/reference/accounts/identityverifications/list // diff --git a/v2.1/billing/billing.go b/v2.1/billing/billing.go index c5f670a..0dd95ce 100644 --- a/v2.1/billing/billing.go +++ b/v2.1/billing/billing.go @@ -47,7 +47,7 @@ func New(cred esign.Credential) *Service { return &Service{credential: cred} } -// PlansGet get the billing plan details. +// PlansGet gets billing plan details. // // https://developers.docusign.com/esign-rest-api/reference/billing/billingplans/get // @@ -143,7 +143,7 @@ func (op *PlansGetCreditCardOp) Do(ctx context.Context) (*model.CreditCardInform return res, ((*esign.Op)(op)).Do(ctx, &res) } -// PlansList gets the list of available billing plans. +// PlansList gets a list of available billing plans. // // https://developers.docusign.com/esign-rest-api/reference/billing/billingplans/list // @@ -191,7 +191,7 @@ func (op *PlansPurchaseEnvelopesOp) Do(ctx context.Context) error { return ((*esign.Op)(op)).Do(ctx, nil) } -// PlansUpdate updates the account billing plan. +// PlansUpdate updates an account billing plan. // // https://developers.docusign.com/esign-rest-api/reference/billing/billingplans/update // diff --git a/v2.1/cloudstorage/cloudstorage.go b/v2.1/cloudstorage/cloudstorage.go index dcd05cf..1590b8c 100644 --- a/v2.1/cloudstorage/cloudstorage.go +++ b/v2.1/cloudstorage/cloudstorage.go @@ -45,7 +45,7 @@ func New(cred esign.Credential) *Service { return &Service{credential: cred} } -// List gets a list of all the items from the specified cloud storage provider. +// List gets a list of items from a cloud storage provider. // // https://developers.docusign.com/esign-rest-api/reference/cloudstorage/cloudstorage/list // @@ -69,7 +69,7 @@ func (op *ListOp) Do(ctx context.Context) (*model.ExternalFolder, error) { return res, ((*esign.Op)(op)).Do(ctx, &res) } -// CloudStorageFolderPath set the call query parameter cloud_storage_folder_path +// CloudStorageFolderPath is the file path to a cloud storage folder. func (op *ListOp) CloudStorageFolderPath(val string) *ListOp { if op != nil { op.QueryOpts.Set("cloud_storage_folder_path", val) @@ -77,7 +77,7 @@ func (op *ListOp) CloudStorageFolderPath(val string) *ListOp { return op } -// CloudStorageFolderidPlain set the call query parameter cloud_storage_folderid_plain +// CloudStorageFolderidPlain is a plain-text folder id that you can use as an alternative to the existing folder id. This property is mainly used for rooms. Enter multiple folder ids as a comma-separated list. func (op *ListOp) CloudStorageFolderidPlain(val string) *ListOp { if op != nil { op.QueryOpts.Set("cloud_storage_folderid_plain", val) @@ -122,7 +122,7 @@ func (op *ListOp) OrderBy(val string) *ListOp { return op } -// SearchText set the call query parameter search_text +// SearchText use this parameter to search for specific text. func (op *ListOp) SearchText(val string) *ListOp { if op != nil { op.QueryOpts.Set("search_text", val) @@ -130,7 +130,7 @@ func (op *ListOp) SearchText(val string) *ListOp { return op } -// StartPosition indicates the starting point of the first item included in the response set. It uses a 0-based index. The default setting for this is 0. +// StartPosition is the starting index position in the result set from which to start returning values. The default setting is `0`. func (op *ListOp) StartPosition(val int) *ListOp { if op != nil { op.QueryOpts.Set("start_position", fmt.Sprintf("%d", val)) @@ -207,7 +207,7 @@ func (op *ListFoldersOp) OrderBy(val string) *ListFoldersOp { return op } -// SearchText set the call query parameter search_text +// SearchText use this parameter to search for specific text. func (op *ListFoldersOp) SearchText(val string) *ListFoldersOp { if op != nil { op.QueryOpts.Set("search_text", val) diff --git a/v2.1/connect/connect.go b/v2.1/connect/connect.go index f5e6c17..84f0592 100644 --- a/v2.1/connect/connect.go +++ b/v2.1/connect/connect.go @@ -8,14 +8,21 @@ // Package connect implements the DocuSign SDK // category Connect. // -// The Connect category enables your application to be called via HTTPS when an event of interest occurs. +// The Connect service enables your application to be called via HTTPS when an event of interest occurs. // // Use the Connect service to "end the polling madness." With Connect, there is no need for your application to poll DocuSign every 15 minutes to learn the latest about your envelopes. // // Instead, you register your interest in one or more types of envelope or recipient events. Then, when an interesting event occurs, the DocuSign platform will contact your application with the event's details and data. You can register interest in envelopes sent by particular users in your account, or for envelopes sent by any user. // +// Connect can empower your organization to manage document actions as they occur, and allows you to track their changes within your own systems. Upon completion, envelope information, including document content, can be stored in your own databases or CMS systems, and these events can be triggered via webhooks delivering messages to your application. +// // ## Incoming Connect Calls -// To use the Connect service, your application needs to provide an https url that can be called from the public internet. If your application runs on a server behind your organization's firewall, then you will need to create a "pinhole" in the firewall to allow the incoming Connect calls from DocuSign to reach your application. Other techniques for receiving the incoming calls including proxy servers and DMZ networking can also be used. +// +// To use the Connect service, your application needs to provide an HTTPS URL that can be called from the public Internet. If your application runs on a server behind your organization's firewall, then you will need to create a "pinhole" in the firewall to allow the incoming Connect calls from DocuSign to reach your application. You can also use other techniques such as proxy servers and DMZ networking for receiving the incoming calls. +// +// Connect delivers events over HTTP requests in the form of XML. DocuSign sends an XML object to the secure URL entered on the configuration page for every event and user selected. +// +// If your application is not configured to accept post messages, DocuSign will NOT return an additional post error response to your listener application. If you've enabled logging on your configuration, it will be logged in Admin under the configuration failure log. // // ## Per-envelope Connect Configuration // Instead of registering a general Connect configuration and listener, an individual envelope can have its own Connect configuration. See the `eventNotification` field for envelopes. @@ -67,12 +74,12 @@ func New(cred esign.Credential) *Service { // https://developers.docusign.com/esign-rest-api/reference/connect/connectconfigurations/create // // SDK Method Connect::createConfiguration -func (s *Service) ConfigurationsCreate(connectConfigurations *model.ConnectCustomConfiguration) *ConfigurationsCreateOp { +func (s *Service) ConfigurationsCreate(connectCustomConfiguration *model.ConnectCustomConfiguration) *ConfigurationsCreateOp { return &ConfigurationsCreateOp{ Credential: s.credential, Method: "POST", Path: "connect", - Payload: connectConfigurations, + Payload: connectCustomConfiguration, QueryOpts: make(url.Values), Version: esign.VersionV21, } @@ -110,7 +117,7 @@ func (op *ConfigurationsDeleteOp) Do(ctx context.Context) error { return ((*esign.Op)(op)).Do(ctx, nil) } -// ConfigurationsGet get information on a Connect Configuration +// ConfigurationsGet gets the details about a Connect configuration. // // https://developers.docusign.com/esign-rest-api/reference/connect/connectconfigurations/get // @@ -230,7 +237,9 @@ func (op *ConfigurationsListUsersOp) Status(val ...string) *ConfigurationsListUs return op } -// UserNameSubstring filters returned user records by full user name or a substring of user name. +// UserNameSubstring filters results based on a full or partial user name. +// +// **Note**: When you enter a partial user name, you do not use a wildcard character. func (op *ConfigurationsListUsersOp) UserNameSubstring(val string) *ConfigurationsListUsersOp { if op != nil { op.QueryOpts.Set("user_name_substring", val) @@ -243,12 +252,12 @@ func (op *ConfigurationsListUsersOp) UserNameSubstring(val string) *Configuratio // https://developers.docusign.com/esign-rest-api/reference/connect/connectconfigurations/update // // SDK Method Connect::updateConfiguration -func (s *Service) ConfigurationsUpdate(connectConfigurations *model.ConnectCustomConfiguration) *ConfigurationsUpdateOp { +func (s *Service) ConfigurationsUpdate(connectCustomConfiguration *model.ConnectCustomConfiguration) *ConfigurationsUpdateOp { return &ConfigurationsUpdateOp{ Credential: s.credential, Method: "PUT", Path: "connect", - Payload: connectConfigurations, + Payload: connectCustomConfiguration, QueryOpts: make(url.Values), Version: esign.VersionV21, } @@ -309,7 +318,7 @@ func (op *EventsDeleteFailureOp) Do(ctx context.Context) error { return ((*esign.Op)(op)).Do(ctx, nil) } -// EventsDeleteList gets a list of Connect log entries. +// EventsDeleteList deletes a list of Connect log entries. // // https://developers.docusign.com/esign-rest-api/reference/connect/connectevents/deletelist // @@ -332,7 +341,7 @@ func (op *EventsDeleteListOp) Do(ctx context.Context) error { return ((*esign.Op)(op)).Do(ctx, nil) } -// EventsGet get the specified Connect log entry. +// EventsGet gets a Connect log entry. // // https://developers.docusign.com/esign-rest-api/reference/connect/connectevents/get // @@ -356,7 +365,7 @@ func (op *EventsGetOp) Do(ctx context.Context) (*model.ConnectLog, error) { return res, ((*esign.Op)(op)).Do(ctx, &res) } -// AdditionalInfo when true, the connectDebugLog information is included in the response. +// AdditionalInfo when set to **true**, the response includes the `connectDebugLog` information. func (op *EventsGetOp) AdditionalInfo() *EventsGetOp { if op != nil { op.QueryOpts.Set("additional_info", "true") @@ -398,7 +407,9 @@ func (op *EventsListOp) FromDate(val time.Time) *EventsListOp { return op } -// ToDate end of the search date range. Only returns templates created up to this date/time. If no value is provided, this defaults to the current date. +// ToDate is the end of a search date range in UTC DateTime format. When you use this parameter, only templates created up to this date and time are returned. +// +// **Note**: If this property is null, the value defaults to the current date. func (op *EventsListOp) ToDate(val time.Time) *EventsListOp { if op != nil { op.QueryOpts.Set("to_date", val.Format(time.RFC3339)) @@ -440,7 +451,9 @@ func (op *EventsListFailuresOp) FromDate(val time.Time) *EventsListFailuresOp { return op } -// ToDate end of the search date range. Only returns templates created up to this date/time. If no value is provided, this defaults to the current date. +// ToDate is the end of a search date range in UTC DateTime format. When you use this parameter, only templates created up to this date and time are returned. +// +// **Note**: If this property is null, the value defaults to the current date. func (op *EventsListFailuresOp) ToDate(val time.Time) *EventsListFailuresOp { if op != nil { op.QueryOpts.Set("to_date", val.Format(time.RFC3339)) diff --git a/v2.1/customtabs/customtabs.go b/v2.1/customtabs/customtabs.go index 5e08a64..397c2e1 100644 --- a/v2.1/customtabs/customtabs.go +++ b/v2.1/customtabs/customtabs.go @@ -49,12 +49,12 @@ func New(cred esign.Credential) *Service { // https://developers.docusign.com/esign-rest-api/reference/customtabs/customtabs/create // // SDK Method CustomTabs::create -func (s *Service) Create(customTabs *model.TabMetadata) *CreateOp { +func (s *Service) Create(tabMetadata *model.TabMetadata) *CreateOp { return &CreateOp{ Credential: s.credential, Method: "POST", Path: "tab_definitions", - Payload: customTabs, + Payload: tabMetadata, QueryOpts: make(url.Values), Version: esign.VersionV21, } @@ -155,12 +155,12 @@ func (op *ListOp) CustomTabOnly() *ListOp { // https://developers.docusign.com/esign-rest-api/reference/customtabs/customtabs/update // // SDK Method CustomTabs::update -func (s *Service) Update(customTabID string, customTabs *model.TabMetadata) *UpdateOp { +func (s *Service) Update(customTabID string, tabMetadata *model.TabMetadata) *UpdateOp { return &UpdateOp{ Credential: s.credential, Method: "PUT", Path: strings.Join([]string{"tab_definitions", customTabID}, "/"), - Payload: customTabs, + Payload: tabMetadata, QueryOpts: make(url.Values), Version: esign.VersionV21, } diff --git a/v2.1/diagnostics/diagnostics.go b/v2.1/diagnostics/diagnostics.go index 49d0600..c370f40 100644 --- a/v2.1/diagnostics/diagnostics.go +++ b/v2.1/diagnostics/diagnostics.go @@ -142,7 +142,7 @@ func (op *RequestLogsListOp) Do(ctx context.Context) (*model.APIRequestLogsResul return res, ((*esign.Op)(op)).Do(ctx, &res) } -// Encoding set the call query parameter encoding +// Encoding reserved for DocuSign. func (op *RequestLogsListOp) Encoding(val string) *RequestLogsListOp { if op != nil { op.QueryOpts.Set("encoding", val) @@ -169,12 +169,12 @@ func (op *RequestLogsListOp) Zip(ctx context.Context) (*esign.Download, error) { // https://developers.docusign.com/esign-rest-api/reference/diagnostics/requestlogs/updatesettings // // SDK Method Diagnostics::updateRequestLogSettings -func (s *Service) RequestLogsUpdateSettings(requestLogs *model.DiagnosticsSettingsInformation) *RequestLogsUpdateSettingsOp { +func (s *Service) RequestLogsUpdateSettings(diagnosticsSettingsInformation *model.DiagnosticsSettingsInformation) *RequestLogsUpdateSettingsOp { return &RequestLogsUpdateSettingsOp{ Credential: s.credential, Method: "PUT", Path: "/v2.1/diagnostics/settings", - Payload: requestLogs, + Payload: diagnosticsSettingsInformation, QueryOpts: make(url.Values), Version: esign.VersionV21, } diff --git a/v2.1/envelopedocumentvisibility/envelopedocumentvisibility.go b/v2.1/envelopedocumentvisibility/envelopedocumentvisibility.go new file mode 100644 index 0000000..fd0c044 --- /dev/null +++ b/v2.1/envelopedocumentvisibility/envelopedocumentvisibility.go @@ -0,0 +1,68 @@ +// Copyright 2019 James Cote +// All rights reserved. +// Use of this source code is governed by a BSD-style +// license that can be found in the LICENSE file. + +// Code generated by gen-esign; DO NOT EDIT. + +// Package envelopedocumentvisibility implements the DocuSign SDK +// category EnvelopeDocumentVisibility. +// +// +// +// Service Api documentation may be found at: +// https://developers.docusign.com/esign-rest-api/reference/EnvelopeDocumentVisibility +// Usage example: +// +// import ( +// "github.com/jfcote87/esign" +// "github.com/jfcote87/esign/v2.1/envelopedocumentvisibility" +// "github.com/jfcote87/esign/v2.1/model" +// ) +// ... +// envelopedocumentvisibilityService := envelopedocumentvisibility.New(esignCredential) +package envelopedocumentvisibility // import "github.com/jfcote87/esign/v2.1/envelopedocumentvisibility" + +import ( + "context" + "net/url" + "strings" + + "github.com/jfcote87/esign" + "github.com/jfcote87/esign/v2.1/model" +) + +// Service implements DocuSign EnvelopeDocumentVisibility Category API operations +type Service struct { + credential esign.Credential +} + +// New initializes a envelopedocumentvisibility service using cred to authorize ops. +func New(cred esign.Credential) *Service { + return &Service{credential: cred} +} + +// EnvelopeRecipientsUpdateRecipientsDocumentVisibility updates document visibility for recipients +// +// https://developers.docusign.com/esign-rest-api/reference/envelopedocumentvisibility/enveloperecipients/updaterecipientsdocumentvisibility +// +// SDK Method EnvelopeDocumentVisibility::updateRecipientsDocumentVisibility +func (s *Service) EnvelopeRecipientsUpdateRecipientsDocumentVisibility(envelopeID string, documentVisibilityList *model.DocumentVisibilityList) *EnvelopeRecipientsUpdateRecipientsDocumentVisibilityOp { + return &EnvelopeRecipientsUpdateRecipientsDocumentVisibilityOp{ + Credential: s.credential, + Method: "PUT", + Path: strings.Join([]string{"envelopes", envelopeID, "recipients", "document_visibility"}, "/"), + Payload: documentVisibilityList, + QueryOpts: make(url.Values), + Version: esign.VersionV21, + } +} + +// EnvelopeRecipientsUpdateRecipientsDocumentVisibilityOp implements DocuSign API SDK EnvelopeDocumentVisibility::updateRecipientsDocumentVisibility +type EnvelopeRecipientsUpdateRecipientsDocumentVisibilityOp esign.Op + +// Do executes the op. A nil context will return error. +func (op *EnvelopeRecipientsUpdateRecipientsDocumentVisibilityOp) Do(ctx context.Context) (*model.DocumentVisibilityList, error) { + var res *model.DocumentVisibilityList + return res, ((*esign.Op)(op)).Do(ctx, &res) +} diff --git a/v2.1/envelopes/envelopes.go b/v2.1/envelopes/envelopes.go index 6418cb7..5bf8166 100644 --- a/v2.1/envelopes/envelopes.go +++ b/v2.1/envelopes/envelopes.go @@ -8,11 +8,11 @@ // Package envelopes implements the DocuSign SDK // category Envelopes. // -// The DocuSign API Envelope category includes the resources and methods for sending and managing envelopes and envelope data. +// The eSignature API Envelope category includes the resources and methods for sending and managing envelopes and envelope data. // -// Envelopes are the key objects within the DocuSign eSignature system. As a result, they are complex data structures with few required fields. See the [Code Examples](https://developers.docusign.com/esign-rest-api/code-examples) for examples and solutions. +// Envelopes are the key objects in the DocuSign platform. As a result, they are complex data structures with few required fields. See the [How-to guides](https://developers.docusign.com/docs/esign-rest-api/how-to/) for examples and solutions. // -// To learn more about envelopes, see [Envelopes and Template](https://developers.docusign.com/esign-rest-api/guides/concepts/envelopes). +// To learn more about envelopes, see [Envelopes](https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/envelopes/). // // Service Api documentation may be found at: // https://developers.docusign.com/esign-rest-api/reference/Envelopes @@ -312,7 +312,7 @@ func (op *AttachmentsUpdateOp) Do(ctx context.Context) (*model.EnvelopeAttachmen return res, ((*esign.Op)(op)).Do(ctx, &res) } -// ConsumerDisclosuresGet reserved: Gets the Electronic Record and Signature Disclosure associated with the account. +// ConsumerDisclosuresGet gets the Electronic Record and Signature Disclosure for a specific envelope recipient. // // https://developers.docusign.com/esign-rest-api/reference/envelopes/envelopeconsumerdisclosures/get // @@ -336,7 +336,53 @@ func (op *ConsumerDisclosuresGetOp) Do(ctx context.Context) (*model.ConsumerDisc return res, ((*esign.Op)(op)).Do(ctx, &res) } -// LangCode set the call query parameter langCode +// LangCode (Optional) The code for the signer language version of the disclosure that you want to retrieve, as a query parameter. The following languages are supported: +// +// - Arabic (`ar`) +// - Bulgarian (`bg`) +// - Czech (`cs`) +// - Chinese Simplified (`zh_CN`) +// - Chinese Traditional (`zh_TW`) +// - Croatian (`hr`) +// - Danish (`da`) +// - Dutch (`nl`) +// - English US (`en`) +// - English UK (`en_GB`) +// - Estonian (`et`) +// - Farsi (`fa`) +// - Finnish (`fi`) +// - French (`fr`) +// - French Canadian (`fr_CA`) +// - German (`de`) +// - Greek (`el`) +// - Hebrew (`he`) +// - Hindi (`hi`) +// - Hungarian (`hu`) +// - Bahasa Indonesian (`id`) +// - Italian (`it`) +// - Japanese (`ja`) +// - Korean (`ko`) +// - Latvian (`lv`) +// - Lithuanian (`lt`) +// - Bahasa Melayu (`ms`) +// - Norwegian (`no`) +// - Polish (`pl`) +// - Portuguese (`pt`) +// - Portuguese Brazil (`pt_BR`) +// - Romanian (`ro`) +// - Russian (`ru`) +// - Serbian (`sr`) +// - Slovak (`sk`) +// - Slovenian (`sl`) +// - Spanish (`es`) +// - Spanish Latin America (`es_MX`) +// - Swedish (`sv`) +// - Thai (`th`) +// - Turkish (`tr`) +// - Ukrainian (`uk`) +// - Vietnamese (`vi`) +// +// Additionally, you can automatically detect the browser language being used by the viewer and display the disclosure in that language by setting the value to `browser`. func (op *ConsumerDisclosuresGetOp) LangCode(val string) *ConsumerDisclosuresGetOp { if op != nil { op.QueryOpts.Set("langCode", val) @@ -344,7 +390,7 @@ func (op *ConsumerDisclosuresGetOp) LangCode(val string) *ConsumerDisclosuresGet return op } -// ConsumerDisclosuresGetDefault gets the Electronic Record and Signature Disclosure associated with the account. +// ConsumerDisclosuresGetDefault gets the default Electronic Record and Signature Disclosure for an envelope. // // https://developers.docusign.com/esign-rest-api/reference/envelopes/envelopeconsumerdisclosures/getdefault // @@ -368,7 +414,53 @@ func (op *ConsumerDisclosuresGetDefaultOp) Do(ctx context.Context) (*model.Consu return res, ((*esign.Op)(op)).Do(ctx, &res) } -// LangCode set the call query parameter langCode +// LangCode (Optional) The code for the signer language version of the disclosure that you want to retrieve. The following languages are supported: +// +// - Arabic (`ar`) +// - Bulgarian (`bg`) +// - Czech (`cs`) +// - Chinese Simplified (`zh_CN`) +// - Chinese Traditional (`zh_TW`) +// - Croatian (`hr`) +// - Danish (`da`) +// - Dutch (`nl`) +// - English US (`en`) +// - English UK (`en_GB`) +// - Estonian (`et`) +// - Farsi (`fa`) +// - Finnish (`fi`) +// - French (`fr`) +// - French Canadian (`fr_CA`) +// - German (`de`) +// - Greek (`el`) +// - Hebrew (`he`) +// - Hindi (`hi`) +// - Hungarian (`hu`) +// - Bahasa Indonesian (`id`) +// - Italian (`it`) +// - Japanese (`ja`) +// - Korean (`ko`) +// - Latvian (`lv`) +// - Lithuanian (`lt`) +// - Bahasa Melayu (`ms`) +// - Norwegian (`no`) +// - Polish (`pl`) +// - Portuguese (`pt`) +// - Portuguese Brazil (`pt_BR`) +// - Romanian (`ro`) +// - Russian (`ru`) +// - Serbian (`sr`) +// - Slovak (`sk`) +// - Slovenian (`sl`) +// - Spanish (`es`) +// - Spanish Latin America (`es_MX`) +// - Swedish (`sv`) +// - Thai (`th`) +// - Turkish (`tr`) +// - Ukrainian (`uk`) +// - Vietnamese (`vi`) +// +// Additionally, you can automatically detect the browser language being used by the viewer and display the disclosure in that language by setting the value to `browser`. func (op *ConsumerDisclosuresGetDefaultOp) LangCode(val string) *ConsumerDisclosuresGetDefaultOp { if op != nil { op.QueryOpts.Set("langCode", val) @@ -376,7 +468,7 @@ func (op *ConsumerDisclosuresGetDefaultOp) LangCode(val string) *ConsumerDisclos return op } -// CustomFieldsCreate updates envelope custom fields for an envelope. +// CustomFieldsCreate creates envelope custom fields for an envelope. // // https://developers.docusign.com/esign-rest-api/reference/envelopes/envelopecustomfields/create // @@ -598,6 +690,14 @@ func (op *DocumentTabsGetOp) Do(ctx context.Context) (*model.Tabs, error) { return res, ((*esign.Op)(op)).Do(ctx, &res) } +// IncludeMetadata when set to **true**, the response includes metadata indicating which properties are editable. +func (op *DocumentTabsGetOp) IncludeMetadata(val string) *DocumentTabsGetOp { + if op != nil { + op.QueryOpts.Set("include_metadata", val) + } + return op +} + // PageNumbers filters for tabs that occur on the pages that you specify. Enter as a comma-separated list of page GUIDs. // // Example: `page_numbers=2,6` @@ -663,12 +763,12 @@ func (op *DocumentVisibilityGetOp) Do(ctx context.Context) (*model.DocumentVisib // https://developers.docusign.com/esign-rest-api/reference/envelopes/envelopedocumentvisibility/update // // SDK Method Envelopes::updateRecipientDocumentVisibility -func (s *Service) DocumentVisibilityUpdate(envelopeID string, recipientID string, envelopeDocumentVisibility *model.DocumentVisibilityList) *DocumentVisibilityUpdateOp { +func (s *Service) DocumentVisibilityUpdate(envelopeID string, recipientID string, documentVisibilityList *model.DocumentVisibilityList) *DocumentVisibilityUpdateOp { return &DocumentVisibilityUpdateOp{ Credential: s.credential, Method: "PUT", Path: strings.Join([]string{"envelopes", envelopeID, "recipients", recipientID, "document_visibility"}, "/"), - Payload: envelopeDocumentVisibility, + Payload: documentVisibilityList, QueryOpts: make(url.Values), Version: esign.VersionV21, } @@ -683,31 +783,6 @@ func (op *DocumentVisibilityUpdateOp) Do(ctx context.Context) (*model.DocumentVi return res, ((*esign.Op)(op)).Do(ctx, &res) } -// DocumentVisibilityUpdateList updates document visibility for recipients -// -// https://developers.docusign.com/esign-rest-api/reference/envelopes/envelopedocumentvisibility/updatelist -// -// SDK Method Envelopes::updateRecipientsDocumentVisibility -func (s *Service) DocumentVisibilityUpdateList(envelopeID string, envelopeDocumentVisibility *model.DocumentVisibilityList) *DocumentVisibilityUpdateListOp { - return &DocumentVisibilityUpdateListOp{ - Credential: s.credential, - Method: "PUT", - Path: strings.Join([]string{"envelopes", envelopeID, "recipients", "document_visibility"}, "/"), - Payload: envelopeDocumentVisibility, - QueryOpts: make(url.Values), - Version: esign.VersionV21, - } -} - -// DocumentVisibilityUpdateListOp implements DocuSign API SDK Envelopes::updateRecipientsDocumentVisibility -type DocumentVisibilityUpdateListOp esign.Op - -// Do executes the op. A nil context will return error. -func (op *DocumentVisibilityUpdateListOp) Do(ctx context.Context) (*model.DocumentVisibilityList, error) { - var res *model.DocumentVisibilityList - return res, ((*esign.Op)(op)).Do(ctx, &res) -} - // DocumentsDelete deletes documents from a draft envelope. // // https://developers.docusign.com/esign-rest-api/reference/envelopes/envelopedocuments/delete @@ -774,7 +849,7 @@ func (op *DocumentsGetOp) DocumentsByUserid(val string) *DocumentsGetOp { return op } -// Encoding set the call query parameter encoding +// Encoding reserved for DocuSign. func (op *DocumentsGetOp) Encoding(val string) *DocumentsGetOp { if op != nil { op.QueryOpts.Set("encoding", val) @@ -782,7 +857,7 @@ func (op *DocumentsGetOp) Encoding(val string) *DocumentsGetOp { return op } -// Encrypt when set to **true**, the PDF bytes returned in the response are encrypted for all the key managers configured on your DocuSign account. The documents can be decrypted with the KeyManager Decrypt Document API. +// Encrypt when set to **true**, the PDF bytes returned in the response are encrypted for all the key managers configured on your DocuSign account. You can decrypt the documents by using the Key Manager DecryptDocument API method. For more information about Key Manager, see the DocuSign Security Appliance Installation Guide that your organization received from DocuSign. func (op *DocumentsGetOp) Encrypt() *DocumentsGetOp { if op != nil { op.QueryOpts.Set("encrypt", "true") @@ -822,7 +897,7 @@ func (op *DocumentsGetOp) ShowChanges() *DocumentsGetOp { return op } -// Watermark when set to **true**, the account has the watermark feature enabled, and the envelope is not complete, the watermark for the account is added to the PDF documents. This option can remove the watermark. +// Watermark when set to **true**, the account has the watermark feature enabled, and the envelope is not complete, then the watermark for the account is added to the PDF documents. This option can remove the watermark. func (op *DocumentsGetOp) Watermark() *DocumentsGetOp { if op != nil { op.QueryOpts.Set("watermark", "true") @@ -862,6 +937,14 @@ func (op *DocumentsListOp) DocumentsByUserid(val string) *DocumentsListOp { return op } +// IncludeDocumentSize set the call query parameter include_document_size +func (op *DocumentsListOp) IncludeDocumentSize(val string) *DocumentsListOp { + if op != nil { + op.QueryOpts.Set("include_document_size", val) + } + return op +} + // IncludeMetadata when set to **true**, the response includes metadata that indicates which properties the sender can edit. func (op *DocumentsListOp) IncludeMetadata(val string) *DocumentsListOp { if op != nil { @@ -950,12 +1033,12 @@ func (op *DocumentsUpdateListOp) Do(ctx context.Context) (*model.EnvelopeDocumen // https://developers.docusign.com/esign-rest-api/reference/envelopes/envelopeemailsettings/create // // SDK Method Envelopes::createEmailSettings -func (s *Service) EmailSettingsCreate(envelopeID string, envelopeEmailSettings *model.EmailSettings) *EmailSettingsCreateOp { +func (s *Service) EmailSettingsCreate(envelopeID string, emailSettings *model.EmailSettings) *EmailSettingsCreateOp { return &EmailSettingsCreateOp{ Credential: s.credential, Method: "POST", Path: strings.Join([]string{"envelopes", envelopeID, "email_settings"}, "/"), - Payload: envelopeEmailSettings, + Payload: emailSettings, QueryOpts: make(url.Values), Version: esign.VersionV21, } @@ -1023,12 +1106,12 @@ func (op *EmailSettingsGetOp) Do(ctx context.Context) (*model.EmailSettings, err // https://developers.docusign.com/esign-rest-api/reference/envelopes/envelopeemailsettings/update // // SDK Method Envelopes::updateEmailSettings -func (s *Service) EmailSettingsUpdate(envelopeID string, envelopeEmailSettings *model.EmailSettings) *EmailSettingsUpdateOp { +func (s *Service) EmailSettingsUpdate(envelopeID string, emailSettings *model.EmailSettings) *EmailSettingsUpdateOp { return &EmailSettingsUpdateOp{ Credential: s.credential, Method: "PUT", Path: strings.Join([]string{"envelopes", envelopeID, "email_settings"}, "/"), - Payload: envelopeEmailSettings, + Payload: emailSettings, QueryOpts: make(url.Values), Version: esign.VersionV21, } @@ -1067,7 +1150,7 @@ func (op *FormDataGetOp) Do(ctx context.Context) (*model.EnvelopeFormData, error return res, ((*esign.Op)(op)).Do(ctx, &res) } -// LocksCreate lock an envelope. +// LocksCreate locks an envelope. // // https://developers.docusign.com/esign-rest-api/reference/envelopes/envelopelocks/create // @@ -1239,7 +1322,7 @@ func (op *RecipientTabsListOp) Do(ctx context.Context) (*model.Tabs, error) { return res, ((*esign.Op)(op)).Do(ctx, &res) } -// IncludeAnchorTabLocations when set to **true**, all tabs with anchor tab properties are included in the response. If you do not specify this parameter, the effect is the default behavior (**false**). +// IncludeAnchorTabLocations when set to **true**, all tabs with anchor tab properties are included in the response. The default value is **false**. func (op *RecipientTabsListOp) IncludeAnchorTabLocations() *RecipientTabsListOp { if op != nil { op.QueryOpts.Set("include_anchor_tab_locations", "true") @@ -1412,7 +1495,7 @@ func (op *RecipientsListOp) IncludeMetadata(val string) *RecipientsListOp { return op } -// IncludeTabs when set to **true**, the tab information associated with the recipient is included in the response. If you do not specify this parameter, the effect is the default behavior (**false**). +// IncludeTabs when set to **true**, the tab information associated with the recipient is included in the response. func (op *RecipientsListOp) IncludeTabs() *RecipientsListOp { if op != nil { op.QueryOpts.Set("include_tabs", "true") @@ -1420,7 +1503,7 @@ func (op *RecipientsListOp) IncludeTabs() *RecipientsListOp { return op } -// RecipientsUpdate updates recipients in a draft envelope or corrects recipient information for an in process envelope. +// RecipientsUpdate updates recipients in a draft envelope or corrects recipient information for an in-process envelope. // // https://developers.docusign.com/esign-rest-api/reference/envelopes/enveloperecipients/update // @@ -1445,7 +1528,7 @@ func (op *RecipientsUpdateOp) Do(ctx context.Context) (*model.RecipientsUpdateSu return res, ((*esign.Op)(op)).Do(ctx, &res) } -// CombineSameOrderRecipients when **true**, recipients are combined or merged with matching recipients. Recipient matching occurs as part of [template matching](https://docs.docusign.com/DocuSignHelp/Content/automatic-template-matching.htm), and is based on Recipient Role and Routing Order. +// CombineSameOrderRecipients when set to **true**, recipients are combined or merged with matching recipients. Recipient matching occurs as part of [template matching](https://docs.docusign.com/DocuSignHelp/Content/automatic-template-matching.htm), and is based on Recipient Role and Routing Order. func (op *RecipientsUpdateOp) CombineSameOrderRecipients(val string) *RecipientsUpdateOp { if op != nil { op.QueryOpts.Set("combine_same_order_recipients", val) @@ -1494,6 +1577,14 @@ func (op *TemplatesApplyOp) Do(ctx context.Context) (*model.DocumentTemplateList return res, ((*esign.Op)(op)).Do(ctx, &res) } +// PreserveTemplateRecipient set the call query parameter preserve_template_recipient +func (op *TemplatesApplyOp) PreserveTemplateRecipient(val string) *TemplatesApplyOp { + if op != nil { + op.QueryOpts.Set("preserve_template_recipient", val) + } + return op +} + // TemplatesApplyToDocument adds templates to a document in an envelope. // // https://developers.docusign.com/esign-rest-api/reference/envelopes/envelopetemplates/applytodocument @@ -1519,6 +1610,14 @@ func (op *TemplatesApplyToDocumentOp) Do(ctx context.Context) (*model.DocumentTe return res, ((*esign.Op)(op)).Do(ctx, &res) } +// PreserveTemplateRecipient set the call query parameter preserve_template_recipient +func (op *TemplatesApplyToDocumentOp) PreserveTemplateRecipient(val string) *TemplatesApplyToDocumentOp { + if op != nil { + op.QueryOpts.Set("preserve_template_recipient", val) + } + return op +} + // TemplatesDelete deletes a template from a document in an existing envelope. // // https://developers.docusign.com/esign-rest-api/reference/envelopes/envelopetemplates/delete @@ -1788,7 +1887,7 @@ func (op *CreateOp) CompletedDocumentsOnly(val string) *CreateOp { // MergeRolesOnDraft when set to **true**, template roles will be merged, and empty recipients will be removed. This parameter applies when you create a draft envelope with multiple templates. (To create a draft envelope, the `status` field is set to `created`.) // -// ###### Note: DocuSign recommends that this parameter should be set to **true** whenever you create a draft envelope with multiple templates. +// **Note**: DocuSign recommends that this parameter should be set to **true** whenever you create a draft envelope with multiple templates. func (op *CreateOp) MergeRolesOnDraft() *CreateOp { if op != nil { op.QueryOpts.Set("merge_roles_on_draft", "true") @@ -2144,7 +2243,7 @@ func (op *ListAuditEventsOp) Do(ctx context.Context) (*model.EnvelopeAuditEventR return res, ((*esign.Op)(op)).Do(ctx, &res) } -// ListStatus gets the envelope status for the specified envelopes. +// ListStatus gets envelope statuses for a set of envelopes. // // https://developers.docusign.com/esign-rest-api/reference/envelopes/envelopes/liststatus // @@ -2188,7 +2287,7 @@ func (op *ListStatusOp) AcStatus(val string) *ListStatusOp { return op } -// Block if **true** removes any results that match one of the provided `transaction_ids`. +// Block if set to **true**, removes any results that match one of the provided `transaction_ids`. func (op *ListStatusOp) Block(val string) *ListStatusOp { if op != nil { op.QueryOpts.Set("block", val) @@ -2204,7 +2303,7 @@ func (op *ListStatusOp) Count(val string) *ListStatusOp { return op } -// Email email address of the sender. +// Email is the email address of the sender. func (op *ListStatusOp) Email(val string) *ListStatusOp { if op != nil { op.QueryOpts.Set("email", val) @@ -2216,7 +2315,7 @@ func (op *ListStatusOp) Email(val string) *ListStatusOp { // // The value of this property can be: // - A comma-separated list of envelope IDs -// - The special value `request_body`. In this case, this method uses the envelope IDs in the request body. +// - The special value `request_body`. In this case, the method uses the envelope IDs in the request body. func (op *ListStatusOp) EnvelopeIds(val string) *ListStatusOp { if op != nil { op.QueryOpts.Set("envelope_ids", val) @@ -2259,7 +2358,7 @@ func (op *ListStatusOp) FromToStatus(val string) *ListStatusOp { return op } -// StartPosition starting position for search. +// StartPosition is the starting index position for search. func (op *ListStatusOp) StartPosition(val int) *ListStatusOp { if op != nil { op.QueryOpts.Set("start_position", fmt.Sprintf("%d", val)) @@ -2290,7 +2389,7 @@ func (op *ListStatusOp) Status(val string) *ListStatusOp { // that specifies the last date/time // or envelope status changes in the result set. // -// Default: "now", the time that you call the method. +// The default value is the time that you call the method. func (op *ListStatusOp) ToDate(val time.Time) *ListStatusOp { if op != nil { op.QueryOpts.Set("to_date", val.Format(time.RFC3339)) @@ -2310,7 +2409,7 @@ func (op *ListStatusOp) TransactionIds(val string) *ListStatusOp { return op } -// UserName limit results to envelopes +// UserName limits results to envelopes // sent by the account user // with this user name. // @@ -2348,18 +2447,7 @@ func (op *ListStatusChangesOp) Do(ctx context.Context) (*model.EnvelopesInformat return res, ((*esign.Op)(op)).Do(ctx, &res) } -// AcStatus specifies the Authoritative Copy Status for the envelopes. The possible values are: -// -// - `Unknown` -// - `Original` -// - `Transferred` -// - `AuthoritativeCopy` -// - `AuthoritativeCopyExportPending` -// - `AuthoritativeCopyExported` -// - `DepositPending` -// - `Deposited` -// - `DepositedEO` -// - `DepositFailed` +// AcStatus specifies the Authoritative Copy Status for the envelopes. The possible values are: Unknown, Original, Transferred, AuthoritativeCopy, AuthoritativeCopyExportPending, AuthoritativeCopyExported, DepositPending, Deposited, DepositedEO, or DepositFailed. func (op *ListStatusChangesOp) AcStatus(val string) *ListStatusChangesOp { if op != nil { op.QueryOpts.Set("ac_status", val) @@ -2488,24 +2576,9 @@ func (op *ListStatusChangesOp) FromDate(val time.Time) *ListStatusChangesOp { return op } -// FromToStatus is the envelope status that you are checking for. Possible values are: -// -// -// - `Changed` (default) -// - `Completed` -// - `Created` -// - `Declined` -// - `Deleted` -// - `Delivered` -// - `Processing` -// - `Sent` -// - `Signed` -// - `TimedOut` -// - `Voided` +// FromToStatus this is the status type checked for in the `from_date`/`to_date` period. If `changed` is specified, then envelopes that changed status during the period are found. If for example, `created` is specified, then envelopes created during the period are found. Default is `changed`. // -// For example, if you specify `Changed`, this method -// returns a list of envelopes that changed status -// during the `from_date` to `to_date` time period. +// Possible values are: Voided, Changed, Created, Deleted, Sent, Delivered, Signed, Completed, Declined, TimedOut and Processing. func (op *ListStatusChangesOp) FromToStatus(val string) *ListStatusChangesOp { if op != nil { op.QueryOpts.Set("from_to_status", val) @@ -2522,7 +2595,6 @@ func (op *ListStatusChangesOp) FromToStatus(val string) *ListStatusChangesOp { // - `folders`: The folders where the envelope exists. // - `recipients`: The recipients associated with the envelope. // - `powerform`: The PowerForms associated with the envelope. -// - `tabs`: The tabs associated with the envelope. // - `payment_tabs`: The payment tabs associated with the envelope. func (op *ListStatusChangesOp) Include(val string) *ListStatusChangesOp { if op != nil { @@ -2531,7 +2603,7 @@ func (op *ListStatusChangesOp) Include(val string) *ListStatusChangesOp { return op } -// IncludePurgeInformation when **true**, information about envelopes that the sender has deleted are included in the response. +// IncludePurgeInformation when set to **true**, information about envelopes that have been deleted is included in the response. func (op *ListStatusChangesOp) IncludePurgeInformation(val string) *ListStatusChangesOp { if op != nil { op.QueryOpts.Set("include_purge_information", val) @@ -2609,6 +2681,14 @@ func (op *ListStatusChangesOp) QueryBudget(val string) *ListStatusChangesOp { return op } +// RequesterDateFormat set the call query parameter requester_date_format +func (op *ListStatusChangesOp) RequesterDateFormat(val string) *ListStatusChangesOp { + if op != nil { + op.QueryOpts.Set("requester_date_format", val) + } + return op +} + // SearchText free text search criteria that you can use to filter the list of envelopes that is returned. func (op *ListStatusChangesOp) SearchText(val string) *ListStatusChangesOp { if op != nil { @@ -2656,8 +2736,11 @@ func (op *ListStatusChangesOp) ToDate(val time.Time) *ListStatusChangesOp { return op } -// TransactionIds is a comma-separated list of envelope transaction IDs. -// Transaction IDs are only valid for seven days. +// TransactionIds if included in the query string, this is a comma separated list of envelope `transactionId`s. +// +// If included in the `request_body`, this is a list of envelope `transactionId`s. +// +// ###### Note: `transactionId`s are only valid in the DocuSign system for seven days. func (op *ListStatusChangesOp) TransactionIds(val ...string) *ListStatusChangesOp { if op != nil { op.QueryOpts.Set("transaction_ids", strings.Join(val, ",")) @@ -2728,12 +2811,12 @@ func (op *RotateDocumentPageOp) Do(ctx context.Context) error { // https://developers.docusign.com/esign-rest-api/reference/envelopes/envelopes/update // // SDK Method Envelopes::update -func (s *Service) Update(envelopeID string, envelopes *model.Envelope) *UpdateOp { +func (s *Service) Update(envelopeID string, envelope *model.Envelope) *UpdateOp { return &UpdateOp{ Credential: s.credential, Method: "PUT", Path: strings.Join([]string{"envelopes", envelopeID}, "/"), - Payload: envelopes, + Payload: envelope, QueryOpts: make(url.Values), Version: esign.VersionV21, } @@ -2868,12 +2951,12 @@ func (op *TemplateDocumentVisibilityGetOp) Do(ctx context.Context) (*model.Docum // https://developers.docusign.com/esign-rest-api/reference/envelopes/templatedocumentvisibility/update // // SDK Method Envelopes::updateTemplateRecipientDocumentVisibility -func (s *Service) TemplateDocumentVisibilityUpdate(recipientID string, templateID string, templateDocumentVisibility *model.TemplateDocumentVisibilityList) *TemplateDocumentVisibilityUpdateOp { +func (s *Service) TemplateDocumentVisibilityUpdate(recipientID string, templateID string, templateDocumentVisibilityList *model.TemplateDocumentVisibilityList) *TemplateDocumentVisibilityUpdateOp { return &TemplateDocumentVisibilityUpdateOp{ Credential: s.credential, Method: "PUT", Path: strings.Join([]string{"templates", templateID, "recipients", recipientID, "document_visibility"}, "/"), - Payload: templateDocumentVisibility, + Payload: templateDocumentVisibilityList, QueryOpts: make(url.Values), Version: esign.VersionV21, } @@ -2893,12 +2976,12 @@ func (op *TemplateDocumentVisibilityUpdateOp) Do(ctx context.Context) (*model.Te // https://developers.docusign.com/esign-rest-api/reference/envelopes/templatedocumentvisibility/updatelist // // SDK Method Envelopes::updateTemplateRecipientsDocumentVisibility -func (s *Service) TemplateDocumentVisibilityUpdateList(templateID string, templateDocumentVisibility *model.TemplateDocumentVisibilityList) *TemplateDocumentVisibilityUpdateListOp { +func (s *Service) TemplateDocumentVisibilityUpdateList(templateID string, templateDocumentVisibilityList *model.TemplateDocumentVisibilityList) *TemplateDocumentVisibilityUpdateListOp { return &TemplateDocumentVisibilityUpdateListOp{ Credential: s.credential, Method: "PUT", Path: strings.Join([]string{"templates", templateID, "recipients", "document_visibility"}, "/"), - Payload: templateDocumentVisibility, + Payload: templateDocumentVisibilityList, QueryOpts: make(url.Values), Version: esign.VersionV21, } @@ -2913,9 +2996,11 @@ func (op *TemplateDocumentVisibilityUpdateListOp) Do(ctx context.Context) (*mode return res, ((*esign.Op)(op)).Do(ctx, &res) } -// NotaryJournalsList is SDK Method Envelopes::listNotaryJournals +// NotaryJournalsList gets notary jurisdictions for a user. // -// https://developers.docusign.com/esign/restapi/Envelopes/NotaryJournals/list +// https://developers.docusign.com/esign-rest-api/reference/envelopes/notaryjournals/list +// +// SDK Method Envelopes::listNotaryJournals func (s *Service) NotaryJournalsList() *NotaryJournalsListOp { return &NotaryJournalsListOp{ Credential: s.credential, @@ -2943,7 +3028,7 @@ func (op *NotaryJournalsListOp) Count(val string) *NotaryJournalsListOp { return op } -// SearchText set the call query parameter search_text +// SearchText use this parameter to search for specific text. func (op *NotaryJournalsListOp) SearchText(val string) *NotaryJournalsListOp { if op != nil { op.QueryOpts.Set("search_text", val) @@ -2959,9 +3044,11 @@ func (op *NotaryJournalsListOp) StartPosition(val string) *NotaryJournalsListOp return op } -// ViewsCreateSharedRecipient is SDK Method Envelopes::createEnvelopeRecipientSharedView +// ViewsCreateSharedRecipient returns a URL to the shared recipient view UI for an envelope. +// +// https://developers.docusign.com/esign-rest-api/reference/envelopes/envelopeviews/createsharedrecipient // -// https://developers.docusign.com/esign/restapi/Envelopes/EnvelopeViews/createSharedRecipient +// SDK Method Envelopes::createEnvelopeRecipientSharedView func (s *Service) ViewsCreateSharedRecipient(envelopeID string, recipientViewRequest *model.RecipientViewRequest) *ViewsCreateSharedRecipientOp { return &ViewsCreateSharedRecipientOp{ Credential: s.credential, diff --git a/v2.1/model/model.go b/v2.1/model/model.go index 64b07d5..d66fefa 100644 --- a/v2.1/model/model.go +++ b/v2.1/model/model.go @@ -87,15 +87,15 @@ type TabBase struct { ConditionalParentValue string `json:"conditionalParentValue,omitempty"` // Metadata that indicates whether the `conditionalParentValue` property is editable. ConditionalParentValueMetadata *PropertyMetadata `json:"conditionalParentValueMetadata,omitempty"` - // Integer that identifies the document in the envelope. + // Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. DocumentID string `json:"documentId,omitempty"` // Metadata that indicates whether the `documentId` property is editable. DocumentIDMetadata *PropertyMetadata `json:"documentIdMetadata,omitempty"` - // A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`. + // Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. RecipientID string `json:"recipientId,omitempty"` // Metadata that indicates whether the `recipientId` property is editable. RecipientIDMetadata *PropertyMetadata `json:"recipientIdMetadata,omitempty"` - // The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. + // The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only. RecipientIDGUID string `json:"recipientIdGuid,omitempty"` // Metadata that indicates whether the `recipientIdGuid` property is editable. RecipientIDGUIDMetadata *PropertyMetadata `json:"recipientIdGuidMetadata,omitempty"` @@ -127,32 +127,91 @@ type TabGuidedForm struct { // TabPosition contains common fields for all tabs that can position themselves on document type TabPosition struct { - // Reserved for DocuSign. - // + // This property controls how [anchor tabs][AnchorTabs] are placed. When **true**, the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false**. + // + // For example, when set to **true**, if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When set to **false**, `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. + // + // This functionality uses the following rules: + // + // - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: + // + // $~><|^+= + // + // For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` + // + // - Strings embedded in other strings are ignored during the matching process. + // + // - In words that have dashes, the parts separated by dashes are treated as distinct words. + // + // Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**. + // + // - Letters with accent marks are treated as distinct characters from their unaccented counterparts. + // + // - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. + // + // Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. + // + // - Unlike punctuation, numbers are not ignored when finding anchor words. + // + // Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). + // + // **Note**: You can only specify the value of this property in POST requests. + // + // [AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place AnchorCaseSensitive DSBool `json:"anchorCaseSensitive,omitempty"` - // Reserved for DocuSign. + // Metadata that indicates whether the `anchorCaseSensitive` property is editable. AnchorCaseSensitiveMetadata *PropertyMetadata `json:"anchorCaseSensitiveMetadata,omitempty"` - // Reserved for DocuSign. - // + // This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are : + // + // - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. + // - `right`: Aligns the tab’s left side with the last character of the matching anchor word. + // + // **Note**: You can only specify the value of this property in POST requests. + // + // [AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place // AnchorHorizontalAlignment string `json:"anchorHorizontalAlignment,omitempty"` - // Reserved for DocuSign. + // Metadata that indicates whether the `anchorHorizontalAlignment` property is editable. AnchorHorizontalAlignmentMetadata *PropertyMetadata `json:"anchorHorizontalAlignmentMetadata,omitempty"` // When set to **true**, this tab is ignored if the `anchorString` is not found in the document. AnchorIgnoreIfNotPresent DSBool `json:"anchorIgnoreIfNotPresent,omitempty"` // Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable. AnchorIgnoreIfNotPresentMetadata *PropertyMetadata `json:"anchorIgnoreIfNotPresentMetadata,omitempty"` - // Reserved for DocuSign. - // + // When set to **true**, the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false**. + // + // For example, when set to **true**, if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When set to **false**, if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. + // + // This functionality uses the following rules: + // + // - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: + // + // $~><|^+= + // + // For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` + // + // - Strings embedded in other strings are ignored during the matching process. + // + // - In words that have dashes, the parts separated by dashes are treated as distinct words. + // + // Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**. + // + // - Letters with accent marks are treated as distinct characters from their unaccented counterparts. + // + // - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. + // + // Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. + // + // - Unlike punctuation, numbers are not ignored when finding anchor words. + // + // Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). + // + // + // **Note**: You can only specify the value of this property in POST requests. + // + // [AnchorTab]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place // AnchorMatchWholeWord DSBool `json:"anchorMatchWholeWord,omitempty"` - // Reserved for DocuSign. + // Metadata that indicates whether the `anchorMatchWholeWord` property is editable. AnchorMatchWholeWordMetadata *PropertyMetadata `json:"anchorMatchWholeWordMetadata,omitempty"` // Specifies the string to find in the document and use as the basis for tab placement. AnchorString string `json:"anchorString,omitempty"` @@ -162,19 +221,30 @@ type TabPosition struct { AnchorTabProcessorVersion string `json:"anchorTabProcessorVersion,omitempty"` // Reserved for DocuSign. AnchorTabProcessorVersionMetadata *PropertyMetadata `json:"anchorTabProcessorVersionMetadata,omitempty"` - // Specifies the units of the X and Y offset. Units may be pixels, millimeters, centimeters, or inches. + // Specifies units of the + // `anchorXOffset` and + // `anchorYOffset`. + // Valid units are: + // + // - `pixels` + // - `inches` + // - `mms` + // - `cms` + // AnchorUnits string `json:"anchorUnits,omitempty"` // Metadata that indicates whether the `anchorUnits` property is editable. AnchorUnitsMetadata *PropertyMetadata `json:"anchorUnitsMetadata,omitempty"` // Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. + // AnchorXOffset string `json:"anchorXOffset,omitempty"` // Metadata that indicates whether the `anchorXOffset` property is editable. AnchorXOffsetMetadata *PropertyMetadata `json:"anchorXOffsetMetadata,omitempty"` // Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. + // AnchorYOffset string `json:"anchorYOffset,omitempty"` // Metadata that indicates whether the `anchorYOffset` property is editable. AnchorYOffsetMetadata *PropertyMetadata `json:"anchorYOffsetMetadata,omitempty"` - // The DocuSign-generated custom tab id for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. + // The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. CustomTabID string `json:"customTabId,omitempty"` // Metadata that indicates whether the `customTabId` property is editable. CustomTabIDMetadata *PropertyMetadata `json:"customTabIdMetadata,omitempty"` @@ -199,11 +269,10 @@ type TabPosition struct { TabID string `json:"tabId,omitempty"` // Metadata that indicates whether the `tabId` property is editable. TabIDMetadata *PropertyMetadata `json:"tabIdMetadata,omitempty"` - // The label string associated with the tab. - // The string may be the empty string. + // The label associated with the tab. This value may be an empty string. // If no value is provided, the tab type is used as the value. // - // Maximum of 500 characters. + // Maximum Length: 500 characters. // TabLabel string `json:"tabLabel,omitempty"` // Metadata that indicates whether the `tabLabel` property is editable. @@ -226,10 +295,27 @@ type TabPosition struct { // DocuSign uses 72 DPI when determining position. // Required. May be zero. // + // To improve the tab's position on the document, + // DocuSign recommends + // adjusting `xPosition` + // and `yPosition` + // coordinates + // by (-3, -2) + // XPosition string `json:"xPosition,omitempty"` // Metadata that indicates whether the `xPosition` property is editable. XPositionMetadata *PropertyMetadata `json:"xPositionMetadata,omitempty"` - // This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. + // This property indicates the vertical offset of the object on the page. + // DocuSign uses 72 DPI when determining position. + // Required. May be zero. + // + // To improve the tab's position on the document, + // DocuSign recommends + // adjusting `xPosition` + // and `yPosition` + // coordinates + // by (-3, -2) + // YPosition string `json:"yPosition,omitempty"` // Metadata that indicates whether the `yPosition` property is editable. YPositionMetadata *PropertyMetadata `json:"yPositionMetadata,omitempty"` @@ -307,7 +393,7 @@ type TabStyle struct { ItalicMetadata *PropertyMetadata `json:"italicMetadata,omitempty"` // The name of the tab. For example, `Sign Here` or `Initial Here`. Name string `json:"name,omitempty"` - // Metadata that indicates whether the `name` property is editable. + // Metadata that indicates whether the `name` property is editable. Read only. NameMetadata *PropertyMetadata `json:"nameMetadata,omitempty"` // When set to **true**, the information in the tab is underlined. Underline DSBool `json:"underline,omitempty"` @@ -347,34 +433,31 @@ type AccessCodeFormat struct { SpecialCharacterRequiredMetadata *SettingsMetadata `json:"specialCharacterRequiredMetadata,omitempty"` } -// AccountAddress contains information about an account address. +// AccountAddress contains information about the address associated with the account. type AccountAddress struct { - // The first line of the user's address. - // Maximum length: 100 characters. + // The first line of the address. Maximum length: 100 characters. Address1 string `json:"address1,omitempty"` - // The second line of the user's address. - // Maximum length: 100 characters. + // The second line of the address. Maximum length: 100 characters. Address2 string `json:"address2,omitempty"` - // The city value of the address. + // The city associated with the address. Maximum length: 40 characters. City string `json:"city,omitempty"` - // Specifies the country associated with the address. + // The country associated with the address. Maximum length: 50 characters. Country string `json:"country,omitempty"` - // Filters returned user records by the specified email address. + // The email address associated with the account. Email string `json:"email,omitempty"` - // + // The fax number associated with the account. Fax string `json:"fax,omitempty"` - // The user's first name. - // Maximum Length: 50 characters. + // The first name of the user associated with the account. Maximum Length: 50 characters. FirstName string `json:"firstName,omitempty"` - // + // The last name of the user associated with the account. LastName string `json:"lastName,omitempty"` - // + // The phone number associated with the account. Phone string `json:"phone,omitempty"` - // The postal code associated with the address. + // The postal code associated with the address. Maximum length: 20 characters. PostalCode string `json:"postalCode,omitempty"` - // The state or province associated with the address. + // The state or province associated with the address. Maximum length: 40 characters. State string `json:"state,omitempty"` - // Contains an array of countries supported by the billing plan. + // An array of supported countries associated with the account. SupportedCountries []Country `json:"supportedCountries,omitempty"` } @@ -382,27 +465,40 @@ type AccountAddress struct { type AccountBillingPlan struct { // Reserved for DocuSign. AddOns []AddOn `json:"addOns,omitempty"` + // + AppStoreReceiptExpirationDate string `json:"appStoreReceiptExpirationDate,omitempty"` + // + AppStoreReceiptPurchaseDate string `json:"appStoreReceiptPurchaseDate,omitempty"` // Reserved for DocuSign. CanCancelRenewal string `json:"canCancelRenewal,omitempty"` // When set to **true**, specifies that you can upgrade the account through the API. For GET methods, you must set the `include_metadata` query parameter to **true** for this property to appear in the response. CanUpgrade DSBool `json:"canUpgrade,omitempty"` - // Specifies the ISO currency code for the account. + // Specifies the ISO currency code to use for the account. CurrencyCode string `json:"currencyCode,omitempty"` - // When set to **true**, then customer support is provided as part of the account plan. + // + DowngradePlanInformation *DowngradePlanUpdateResponse `json:"downgradePlanInformation,omitempty"` + // When set to **true**, customer support is provided as part of the account plan. EnableSupport DSBool `json:"enableSupport,omitempty"` - // The number of seats (users) included. + // The number of seats (users) included in the plan. IncludedSeats string `json:"includedSeats,omitempty"` // Reserved for DocuSign. IncrementalSeats string `json:"incrementalSeats,omitempty"` // When **true**, the account has been downgraded from a premium account type. Otherwise **false**. IsDowngrade DSBool `json:"isDowngrade,omitempty"` + // + NotificationType string `json:"notificationType,omitempty"` // Any other percentage discount for the plan. OtherDiscountPercent string `json:"otherDiscountPercent,omitempty"` + // The payment cycle associated with the plan. The possible values are: // + // - `Monthly` + // - `Annually` PaymentCycle string `json:"paymentCycle,omitempty"` // The payment method used with the plan. The possible values are: CreditCard, PurchaseOrder, Premium, or Freemium. PaymentMethod string `json:"paymentMethod,omitempty"` + // The per-seat price associated with the plan. // + // Example: `"456.0000"` PerSeatPrice string `json:"perSeatPrice,omitempty"` // Identifies the type of plan. Examples include: // @@ -411,34 +507,49 @@ type AccountBillingPlan struct { // - `enterprise` // - `free` PlanClassification string `json:"planClassification,omitempty"` - // Reserved for DocuSign. + // A complex type that sets the feature sets for the account. It contains the following information (all string content): + // + // * currencyFeatureSetPrices - Contains the currencyCode and currencySymbol for the alternate currency values for envelopeFee, fixedFee, seatFee that are configured for this plan feature set. + // * envelopeFee - An incremental envelope cost for plans with envelope overages (when isEnabled=true). + // * featureSetId - A unique ID for the feature set. + // * fixedFee - A one-time fee associated with the plan (when isEnabled=true). + // * isActive - Specifies whether the feature set is actively set as part of the plan. + // * isEnabled - Specifies whether the feature set is actively enabled as part of the plan. + // * name - The name of the feature set. + // * seatFee - An incremental seat cost for seat-based plans (when isEnabled=true). + // PlanFeatureSets []FeatureSet `json:"planFeatureSets,omitempty"` - // The DocuSign plan id for the account. + // DocuSign's id for the account plan. PlanID string `json:"planId,omitempty"` - // The name of the billing plan. + // The name of the billing plan used for the account. + // + // Examples: + // + // - `Personal - Annual` + // - `Unlimited Envelope Subscription - Annual Billing` PlanName string `json:"planName,omitempty"` // The renewal status for the account. Valid values are: // - // * auto - The account automatically renews. - // * queued_for_close - The account will be closed at the `billingPeriodEndDate`. - // * queued_for_downgrade - The account will be downgraded at the `billingPeriodEndDate`. + // * `auto`: The account automatically renews. + // * `queued_for_close`: The account will be closed at the `billingPeriodEndDate`. + // * `queued_for_downgrade`: The account will be downgraded at the `billingPeriodEndDate`. // // **Note**: For GET methods, you must set the `include_metadata` query parameter to **true** for this property to appear in the response. RenewalStatus string `json:"renewalStatus,omitempty"` - // A complex type that contains any seat discount information. Valid values are: // - // - `BeginSeatCount` - // - `EndSeatCount` - // - `SeatDiscountPercent` // SeatDiscounts []SeatDiscount `json:"seatDiscounts,omitempty"` // The support incident fee charged for each support incident. + // + // Example: `"$0.00"` SupportIncidentFee string `json:"supportIncidentFee,omitempty"` // The support plan fee charged for this plan. + // + // Example: `"$0.00"` SupportPlanFee string `json:"supportPlanFee,omitempty"` } -// AccountBillingPlanResponse billing plans +// AccountBillingPlanResponse defines an account billing plan response object. type AccountBillingPlanResponse struct { // The billing address for the account. BillingAddress *AccountAddress `json:"billingAddress,omitempty"` @@ -450,6 +561,8 @@ type AccountBillingPlanResponse struct { CreditCardInformation *CreditCardInformation `json:"creditCardInformation,omitempty"` // Information about the bank that processes direct debits for the payment plan. DirectDebitProcessorInformation *DirectDebitProcessorInformation `json:"directDebitProcessorInformation,omitempty"` + // + DowngradePlanInformation *DowngradePlanUpdateResponse `json:"downgradePlanInformation,omitempty"` // The payment method used for the billing plan. Valid values are: // // - `NotSupported` @@ -464,55 +577,64 @@ type AccountBillingPlanResponse struct { PaymentMethod string `json:"paymentMethod,omitempty"` // Information about the entity that processes payments for the billing plan. PaymentProcessorInformation *PaymentProcessorInformation `json:"paymentProcessorInformation,omitempty"` - // Contains information describing discounts and promotions. + // A complex type that contains properties for entering referral and discount information. ReferralInformation *ReferralInformation `json:"referralInformation,omitempty"` - // + // A list of billing plans that the current billing plan can be rolled into. SuccessorPlans []BillingPlan `json:"successorPlans,omitempty"` } -// AccountIdentityVerificationResponse identity verification workflows available to an account +type AccountIdentityInputOption struct { + // + IsRequired bool `json:"isRequired,omitempty"` + // + OptionName string `json:"optionName,omitempty"` + // + ValueType string `json:"valueType,omitempty"` +} + type AccountIdentityVerificationResponse struct { // IdentityVerification []AccountIdentityVerificationWorkflow `json:"identityVerification,omitempty"` } -// AccountIdentityVerificationStep identity verification step +// AccountIdentityVerificationStep information about a specific step in an Identity Verification workflow. type AccountIdentityVerificationStep struct { - // Name of the identity verification step + // The name of the Identity Verification workflow step. Name string `json:"name,omitempty"` - // Type of user: - // - `type_owner` - // - `type_participant` + // Reserved for DocuSign. Type string `json:"type,omitempty"` } -// AccountIdentityVerificationWorkflow specifies an identity verification workflow +// AccountIdentityVerificationWorkflow specifies an Identity Verification workflow. type AccountIdentityVerificationWorkflow struct { - // Text describing the purpose of the ID Verification workflow + // Text describing the purpose of the Identity Verification workflow. DefaultDescription string `json:"defaultDescription,omitempty"` - // Name of the ID Verification workflow + // The name of the Identity Verification workflow. DefaultName string `json:"defaultName,omitempty"` - // Signature provider associated with the identity verification workflow + // + InputOptions []AccountIdentityInputOption `json:"inputOptions,omitempty"` + // The signature provider associated with the Identity Verification workflow. SignatureProvider *AccountSignatureProvider `json:"signatureProvider,omitempty"` - // Workflow unique ID
This is the ID you must specify when [setting ID Verification in an envelope](https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipients) + // Workflow unique ID
This is the ID you must specify when setting ID Verification in an envelope using the `identityVerification` + // [core recipient parameter](https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipients#core-recipient-parameters) WorkflowID string `json:"workflowId,omitempty"` - // Key for translated resources + // Reserved for DocuSign. WorkflowResourceKey string `json:"workflowResourceKey,omitempty"` } +// AccountInformation contains account Information. type AccountInformation struct { // The GUID associated with the account ID. AccountIDGUID string `json:"accountIdGuid,omitempty"` - // The name of the account associated with the current workspace user. + // The name on the account. AccountName string `json:"accountName,omitempty"` // The list of - // [account settings][accountsettings] + // account settings accountsettings // that determine // the features available for the account. // Note that some features are determined // by the plan used to create the account and cannot be overridden. // - // [accountsettings]: https://developers.docusign.com/esign-rest-api/reference/Accounts/Accounts/create/#account-settings // AccountSettings *AccountSettingsInformation `json:"accountSettings,omitempty"` // When set to **true**, the transaction rooms feature exposed through the Workspaces API is enabled. @@ -527,7 +649,10 @@ type AccountInformation struct { BillingPeriodEnvelopesSent string `json:"billingPeriodEnvelopesSent,omitempty"` // The billing period start date in UTC timedate format. BillingPeriodStartDate string `json:"billingPeriodStartDate,omitempty"` - // The type of billing method on the account; for example `direct` or `web`. + // The type of billing method on the account. Valid values are: + // + // - `direct` + // - `web` BillingProfile string `json:"billingProfile,omitempty"` // When set to **true**, specifies that you can upgrade the account through the API. For GET methods, you must set the `include_metadata` query parameter to **true** for this property to appear in the response. CanUpgrade DSBool `json:"canUpgrade,omitempty"` @@ -539,10 +664,16 @@ type AccountInformation struct { CurrencyCode string `json:"currencyCode,omitempty"` // ID of the plan used to create this account. CurrentPlanID string `json:"currentPlanId,omitempty"` + // + DisplayApplianceStartURL string `json:"displayApplianceStartUrl,omitempty"` + // + DisplayApplianceURL string `json:"displayApplianceUrl,omitempty"` // The code that identifies the billing plan groups and plans for the new account. DistributorCode string `json:"distributorCode,omitempty"` // URL of the landing page used to create the account. DocuSignLandingURL string `json:"docuSignLandingUrl,omitempty"` + // + DssValues map[string]string `json:"dssValues,omitempty"` // When **true**, the ability to send envelopes is blocked. When **false**, envelopes can be sent. EnvelopeSendingBlocked string `json:"envelopeSendingBlocked,omitempty"` // The price of sending an envelope, represented in the account's local currency. @@ -575,6 +706,11 @@ type AccountInformation struct { // The date that the current plan will end. PlanEndDate string `json:"planEndDate,omitempty"` // The name of the billing plan used for the account. + // + // Examples: + // + // - `Personal - Annual` + // - `Unlimited Envelope Subscription - Annual Billing` PlanName string `json:"planName,omitempty"` // The date that the Account started using the current plan. PlanStartDate string `json:"planStartDate,omitempty"` @@ -590,10 +726,12 @@ type AccountInformation struct { SuspensionDate string `json:"suspensionDate,omitempty"` // Indicates whether the account is currently suspended. SuspensionStatus string `json:"suspensionStatus,omitempty"` + // + UseDisplayAppliance bool `json:"useDisplayAppliance,omitempty"` } type AccountMinimumPasswordLength struct { - // + // The maximum number of entry characters supported by the custom tab. MaximumLength string `json:"maximumLength,omitempty"` // Minimum length of the access code string. MinimumLength string `json:"minimumLength,omitempty"` @@ -635,57 +773,82 @@ type AccountPasswordMinimumPasswordAgeDays struct { MinimumAge string `json:"minimumAge,omitempty"` } +// AccountPasswordQuestionsRequired information about the number of password questions required (0 to 4) to confirm a user's identity when a user needs to reset their password. type AccountPasswordQuestionsRequired struct { - // + // The maximum number of password reset questions allowed for the account. This number must be between `0` and `4`, and equal to or greater than `minimumQuestions`. MaximumQuestions string `json:"maximumQuestions,omitempty"` - // + // The minimum number of password reset questions allowed for the account. This number must be between `0` and `4`, and equal to or less than `maximumQuestions`. MinimumQuestions string `json:"minimumQuestions,omitempty"` } type AccountPasswordRules struct { - // + // When set to **true**, passwords expire. The default value is `false`. ExpirePassword string `json:"expirePassword,omitempty"` - // + // The number of days before passwords expire. To use this property, the `expirePassword` property must be set to **true**. ExpirePasswordDays string `json:"expirePasswordDays,omitempty"` // Metadata that indicates whether the `expirePasswordDays` property is editable. // ExpirePasswordDaysMetadata *AccountPasswordExpirePasswordDays `json:"expirePasswordDaysMetadata,omitempty"` - // + // The number of minutes a user is locked out of the system after three (?) failed login attempts. The default value is `2`. LockoutDurationMinutes string `json:"lockoutDurationMinutes,omitempty"` // Metadata that indicates whether the `lockoutDurationMinutes` property is editable. // LockoutDurationMinutesMetadata *AccountPasswordLockoutDurationMinutes `json:"lockoutDurationMinutesMetadata,omitempty"` + // The interval associated with the user lockout after a failed login attempt. // + // Possible values are: (?????) + // + // - `minutes` (default) + // - `hours` + // - `days` LockoutDurationType string `json:"lockoutDurationType,omitempty"` // Metadata that indicates whether the `lockoutDurationType` property is editable. // LockoutDurationTypeMetadata *AccountPasswordLockoutDurationType `json:"lockoutDurationTypeMetadata,omitempty"` - // + // The minimum number of days after a password is set before it can be changed. This value can be `0` or more days. The default value is `0`. MinimumPasswordAgeDays string `json:"minimumPasswordAgeDays,omitempty"` // Metadata that indicates whether the `minimumPasswordAgeDays` property is editable. // MinimumPasswordAgeDaysMetadata *AccountPasswordMinimumPasswordAgeDays `json:"minimumPasswordAgeDaysMetadata,omitempty"` - // + // The minimum number of characters in the password. This value must be a number between `6` and `15`. The default value is `6`. MinimumPasswordLength string `json:"minimumPasswordLength,omitempty"` // Metadata that indicates whether the `minimumPasswordLength` property is editable. // MinimumPasswordLengthMetadata *AccountMinimumPasswordLength `json:"minimumPasswordLengthMetadata,omitempty"` - // + // When set to **true**, passwords must include a digit. The default value is `false`. PasswordIncludeDigit string `json:"passwordIncludeDigit,omitempty"` + // When set to **true**, passwords must include either a digit or a special character. The default value is `false`. // + // **Note**: Passwords cannot include angle brackets (`<` `>`) or spaces. PasswordIncludeDigitOrSpecialCharacter string `json:"passwordIncludeDigitOrSpecialCharacter,omitempty"` - // + // When set to **true**, passwords must include a lowercase letter. The default value is `false`. PasswordIncludeLowerCase string `json:"passwordIncludeLowerCase,omitempty"` + // When set to **true**, passwords must include a special character. The default value is `false`. // + // **Note**: Passwords cannot include angle brackets (`<` `>`) or spaces. PasswordIncludeSpecialCharacter string `json:"passwordIncludeSpecialCharacter,omitempty"` - // + // When set to **true**, passwords must include an uppercase letter. The default value is `false`. PasswordIncludeUpperCase string `json:"passwordIncludeUpperCase,omitempty"` - // + // The type of password strength. Possible values are: + // + // - `basic`: The minimum password length is 6 characters with no other password requirements. + // - `medium`: The minimum password length is 7 characters. Passwords must also have one uppercase letter, one lowercase letter, and one number or special character. + // - `strong`: The minimum password length is 9 characters. Passwords must also have one uppercase letter, one lowercase letter, one number, and one special character. + // - `custom`: This option enables you to customize password requirements, including the following properties: + // + // - `minimumPasswordLength` + // - `minimumPasswordAgeDays` + // - `passwordIncludeDigit` + // - `passwordIncludeDigitOrSpecialCharacter` + // - `passwordIncludeLowerCase` + // - `passwordIncludeSpecialCharacter` + // - `passwordIncludeUpperCase` + // - `questionsRequired` PasswordStrengthType string `json:"passwordStrengthType,omitempty"` // Metadata that indicates whether the `passwordStrengthType` property is editable. // PasswordStrengthTypeMetadata *AccountPasswordStrengthType `json:"passwordStrengthTypeMetadata,omitempty"` - // + // The number of security questions required to confirm the user’s identity before the user can reset their password. The default value is `0`. QuestionsRequired string `json:"questionsRequired,omitempty"` // Metadata that indicates whether the `questionsRequired` property is editable. // @@ -702,15 +865,19 @@ type AccountPasswordStrengthTypeOption struct { MinimumLength string `json:"minimumLength,omitempty"` // Name string `json:"name,omitempty"` - // + // When set to **true**, passwords must include a digit. The default value is `false`. PasswordIncludeDigit string `json:"passwordIncludeDigit,omitempty"` + // When set to **true**, passwords must include either a digit or a special character. The default value is `false`. // + // **Note**: Passwords cannot include angle brackets (`<` `>`) or spaces. PasswordIncludeDigitOrSpecialCharacter string `json:"passwordIncludeDigitOrSpecialCharacter,omitempty"` - // + // When set to **true**, passwords must include a lowercase letter. The default value is `false`. PasswordIncludeLowerCase string `json:"passwordIncludeLowerCase,omitempty"` + // When set to **true**, passwords must include a special character. The default value is `false`. // + // **Note**: Passwords cannot include angle brackets (`<` `>`) or spaces. PasswordIncludeSpecialCharacter string `json:"passwordIncludeSpecialCharacter,omitempty"` - // + // When set to **true**, passwords must include an uppercase letter. The default value is `false`. PasswordIncludeUpperCase string `json:"passwordIncludeUpperCase,omitempty"` } @@ -741,6 +908,10 @@ type AccountRoleSettings struct { // Metadata that indicates whether the `allowApiSequentialSigning` property is editable. // AllowAPISequentialSigningMetadata *SettingsMetadata `json:"allowApiSequentialSigningMetadata,omitempty"` + // If **true**, auto-tagging is enabled for the account. + AllowAutoTagging string `json:"allowAutoTagging,omitempty"` + // Metadata that indicates whether the `allowAutoTagging` property is editable. + AllowAutoTaggingMetadata *SettingsMetadata `json:"allowAutoTaggingMetadata,omitempty"` // When **true**, bulk sending is enabled for users. AllowBulkSending DSBool `json:"allowBulkSending,omitempty"` // Metadata that indicates whether the `allowBulkSending` property is editable. @@ -804,6 +975,10 @@ type AccountRoleSettings struct { // Metadata that indicates whether the `allowedAddressBookAccess` property is editable. // AllowedAddressBookAccessMetadata *SettingsMetadata `json:"allowedAddressBookAccessMetadata,omitempty"` + // + AllowedClickwrapsAccess string `json:"allowedClickwrapsAccess,omitempty"` + // + AllowedClickwrapsAccessMetadata *SettingsMetadata `json:"allowedClickwrapsAccessMetadata,omitempty"` // Specifies the level of access that users have to account templates. Valid values are: // // - `none` @@ -913,13 +1088,21 @@ type AccountSettingsInformation struct { AccountDateTimeFormat string `json:"accountDateTimeFormat,omitempty"` // Metadata that indicates whether the `accountDateTimeFormat` property is editable. AccountDateTimeFormatMetadata *SettingsMetadata `json:"accountDateTimeFormatMetadata,omitempty"` - // The name of the account associated with the current workspace user. + // + AccountDefaultLanguage string `json:"accountDefaultLanguage,omitempty"` + // + AccountDefaultLanguageMetadata *SettingsMetadata `json:"accountDefaultLanguageMetadata,omitempty"` + // The name on the account. AccountName string `json:"accountName,omitempty"` // Metadata that indicates whether the `accountName` property is editable. AccountNameMetadata *SettingsMetadata `json:"accountNameMetadata,omitempty"` // An object that specifies notifications (expirations and reminders) for the envelope. AccountNotification *AccountNotification `json:"accountNotification,omitempty"` - // If **true**, [Signature Adoption Configuration](https://support.docusign.com/en/guides/ndse-admin-guide-signature-adopt-config) is enabled. + // An object that defines the settings to use in the UI. + AccountUISettings *AccountUISettings `json:"accountUISettings,omitempty"` + // When set to **true**, [Signature Adoption Configuration](https://support.docusign.com/en/guides/ndse-admin-guide-signature-adopt-config) is enabled. + // + // **Note**: Only Admin users can change this setting. AdoptSigConfig string `json:"adoptSigConfig,omitempty"` // Metadata that indicates whether the `adoptSigConfig` property is editable. // @@ -929,12 +1112,16 @@ type AccountSettingsInformation struct { // Metadata that indicates whether the `advancedCorrect` property is editable. // AdvancedCorrectMetadata *SettingsMetadata `json:"advancedCorrectMetadata,omitempty"` - // Boolean that specifies whether the configured [access code format](https://developers.docusign.com/esign-rest-api/reference/Accounts/Accounts/get#accessCodeFormat) is enabled for the account. + // When **true**, the configured [Access Code Format](https://developers.docusign.com/docs/esign-rest-api/reference/Accounts/Accounts/get#accessCodeFormat) page is enabled for account administrators. + // + // **Note**: Only Admin users can change this setting. AllowAccessCodeFormat string `json:"allowAccessCodeFormat,omitempty"` // Metadata that indicates whether the `allowAccessCodeFormat` property is editable. // AllowAccessCodeFormatMetadata *SettingsMetadata `json:"allowAccessCodeFormatMetadata,omitempty"` - // Boolean that specifies whether the account can be managed on a per-user basis. + // When **true**, the account can be managed on a per-user basis. + // + // **Note**: Only Admin users can change this setting. AllowAccountManagementGranular string `json:"allowAccountManagementGranular,omitempty"` // Metadata that indicates whether the `allowAccountManagementGranular` property is editable. // @@ -944,47 +1131,64 @@ type AccountSettingsInformation struct { // Metadata that indicates whether the `allowAccountMemberNameChange` property is editable. // AllowAccountMemberNameChangeMetadata *SettingsMetadata `json:"allowAccountMemberNameChangeMetadata,omitempty"` + // When set to **true**, [Conditional Routing](https://support.docusign.com/en/guides/ndse-user-guide-conditional-recipients) is enabled for the account as part of DocuSign's Advanced Recipient Routing feature. + AllowAdvancedRecipientRoutingConditional string `json:"allowAdvancedRecipientRoutingConditional,omitempty"` + // Metadata that indicates whether the ` allowAdvancedRecipientRoutingConditional` property is editable. + AllowAdvancedRecipientRoutingConditionalMetadata *SettingsMetadata `json:"allowAdvancedRecipientRoutingConditionalMetadata,omitempty"` // If **true**, an agent recipient can change the email addresses of recipients later in the signing order. // AllowAgentNameEmailEdit string `json:"allowAgentNameEmailEdit,omitempty"` // Metadata that indicates whether the `allowAgentNameEmailEdit` property is editable. // AllowAgentNameEmailEditMetadata *SettingsMetadata `json:"allowAgentNameEmailEditMetadata,omitempty"` + // + AllowAgreementActions string `json:"allowAgreementActions,omitempty"` + // Metadata about the `allowAgreementActions` property. + AllowAgreementActionsMetadata *SettingsMetadata `json:"allowAgreementActionsMetadata,omitempty"` // If **true**, auto-navigation can be enabled for this account. // AllowAutoNavSettings string `json:"allowAutoNavSettings,omitempty"` // Metadata that indicates whether the `allowAutoNavSettings` property is editable. // AllowAutoNavSettingsMetadata *SettingsMetadata `json:"allowAutoNavSettingsMetadata,omitempty"` - // If **true**, the account is able to bulk send. + // If **true**, auto-tagging is enabled for the account. + AllowAutoTagging string `json:"allowAutoTagging,omitempty"` + // Metadata that indicates whether the `allowAutoTagging` property is editable. + AllowAutoTaggingMetadata *SettingsMetadata `json:"allowAutoTaggingMetadata,omitempty"` + // When set to **true**, bulk send functionality is enabled for the account. + // + // **Note**: Only Admin users can change this setting. AllowBulkSend string `json:"allowBulkSend,omitempty"` // Metadata that indicates whether the `allowBulkSend` property is editable. // AllowBulkSendMetadata *SettingsMetadata `json:"allowBulkSendMetadata,omitempty"` - // Indicates whether the customer can withdraw their acceptance of the consumer disclosure. + // When set to **true**, indicates that the customer can withdraw their consent to the consumer disclosure when they decline to sign documents. If these recipients sign documents sent to them from your account in the future, they will be required to agree to the terms in the disclosure. The default value is **false**. + // **Note**: Only Admin users can change this setting. AllowCDWithdraw string `json:"allowCDWithdraw,omitempty"` // Metadata that indicates whether the `allowCDWithdraw` property is editable. // AllowCDWithdrawMetadata *SettingsMetadata `json:"allowCDWithdrawMetadata,omitempty"` // Boolean that specifies whether a Connect configuration can use HTTP listeners. AllowConnectHTTPListenerConfigs string `json:"allowConnectHttpListenerConfigs,omitempty"` - // If **true**, Connect will send FinishLater messages - // + // Reserved for DocuSign. AllowConnectSendFinishLater string `json:"allowConnectSendFinishLater,omitempty"` // Metadata that indicates whether the `allowConnectSendFinishLater` property is editable. // AllowConnectSendFinishLaterMetadata *SettingsMetadata `json:"allowConnectSendFinishLaterMetadata,omitempty"` + // + AllowConnectUnifiedPayloadUI string `json:"allowConnectUnifiedPayloadUI,omitempty"` // If **true**, // the account has the ability to change the // [Consumer Disclosure](https://support.docusign.com/en/guides/ndse-admin-guide-legal-disclosure) - // settin. + // setting. // AllowConsumerDisclosureOverride string `json:"allowConsumerDisclosureOverride,omitempty"` // Metadata that indicates whether the `allowConsumerDisclosureOverride` property is editable. // AllowConsumerDisclosureOverrideMetadata *SettingsMetadata `json:"allowConsumerDisclosureOverrideMetadata,omitempty"` - // If **true**, - // senders can download form data from an envelope. + // When set to **true**, senders can download form data from the envelopes that they send. + // + // **Note**: Only Admin users can change this setting. // AllowDataDownload string `json:"allowDataDownload,omitempty"` // Metadata that indicates whether the `allowDataDownload` property is editable. @@ -1006,7 +1210,7 @@ type AccountSettingsInformation struct { // Metadata that indicates whether the `allowDocumentsOnSignedEnvelopes` property is editable. // AllowDocumentsOnSignedEnvelopesMetadata *SettingsMetadata `json:"allowDocumentsOnSignedEnvelopesMetadata,omitempty"` - // If **true**, + // When **true**, // [eHanko stamps](https://support.docusign.com/en/guides/ndse-user-guide-manage-your-stamps) // are enabled. // @@ -1020,7 +1224,9 @@ type AccountSettingsInformation struct { // Metadata that indicates whether the `allowENoteEOriginal` property is editable. // AllowENoteEOriginalMetadata *SettingsMetadata `json:"allowENoteEOriginalMetadata,omitempty"` - // Specifies whether the correction feature is enabled. + // When set to **true**, the envelope correction feature is enabled. + // + // **Note**: Only Admin users can change this setting. // AllowEnvelopeCorrect string `json:"allowEnvelopeCorrect,omitempty"` // Metadata that indicates whether the `allowEnvelopeCorrect` property is editable. @@ -1028,7 +1234,7 @@ type AccountSettingsInformation struct { AllowEnvelopeCorrectMetadata *SettingsMetadata `json:"allowEnvelopeCorrectMetadata,omitempty"` // Specifies whether the account is able to // manage rules that [transfer ownership](https://support.docusign.com/en/guides/ndse-admin-guide-custody-transfer) - // of envelopes wthin the same account. + // of envelopes within the same account. // // // @@ -1045,7 +1251,9 @@ type AccountSettingsInformation struct { // Metadata that indicates whether the `allowEnvelopeCustomFields` property is editable. // AllowEnvelopeCustomFieldsMetadata *SettingsMetadata `json:"allowEnvelopeCustomFieldsMetadata,omitempty"` - // Specifies whether envelope publishing reporting is enabled. + // When set to **true**, envelope publishing reporting is enabled. + // + // **Note**: Only Admin users can change this setting. // AllowEnvelopePublishReporting string `json:"allowEnvelopePublishReporting,omitempty"` // Metadata that indicates whether the `allowEnvelopePublishReporting` property is editable. @@ -1057,8 +1265,9 @@ type AccountSettingsInformation struct { // Metadata that indicates whether the `allowEnvelopeReporting` property is editable. // AllowEnvelopeReportingMetadata *SettingsMetadata `json:"allowEnvelopeReportingMetadata,omitempty"` - // Specifies whether signers - // are required to use Express Digital Signatures. + // When set to **true**, signers are required to use Express Digital Signatures. + // + // **Note**: Only Admin users can change this setting. // AllowExpressSignerCertificate string `json:"allowExpressSignerCertificate,omitempty"` // Metadata that indicates whether the `allowExpressSignerCertificate` property is editable. @@ -1076,42 +1285,64 @@ type AccountSettingsInformation struct { // Metadata that indicates whether the `allowExtendedSendingResourceFile` property is editable. // AllowExtendedSendingResourceFileMetadata *SettingsMetadata `json:"allowExtendedSendingResourceFileMetadata,omitempty"` - // Specifies whether the account can + // When set to **true**, the account can // configure and use signature pads for their recipients. // + // **Note**: Only Admin users can change this setting. + // AllowExternalSignaturePad string `json:"allowExternalSignaturePad,omitempty"` // Metadata that indicates whether the `allowExternalSignaturePad` property is editable. // AllowExternalSignaturePadMetadata *SettingsMetadata `json:"allowExternalSignaturePadMetadata,omitempty"` - // Specifies whether the account administrator can - // enable - // in person signing. + // When set to **true**, IDV Level 1 is allowed. The default value is **false**. + AllowIDVLevel1 string `json:"allowIDVLevel1,omitempty"` + // Metadata that indicates whether the `allowIDVLevel1` property is editable. + AllowIDVLevel1Metadata *SettingsMetadata `json:"allowIDVLevel1Metadata,omitempty"` + // + AllowIDVLevel2 string `json:"allowIDVLevel2,omitempty"` + // + AllowIDVLevel2Metadata *SettingsMetadata `json:"allowIDVLevel2Metadata,omitempty"` + // + AllowIDVLevel3 string `json:"allowIDVLevel3,omitempty"` + // + AllowIDVLevel3Metadata *SettingsMetadata `json:"allowIDVLevel3Metadata,omitempty"` + // + AllowIDVPlatform string `json:"allowIDVPlatform,omitempty"` + // Metadata that indicates whether the `allowIDVPlatform` property is editable. + AllowIDVPlatformMetadata *SettingsMetadata `json:"allowIDVPlatformMetadata,omitempty"` + // When set to **true**, the account administrator can enable in-person signing. + // + // **Note**: Only SysAdmin users can change this setting. // // AllowInPerson string `json:"allowInPerson,omitempty"` // Metadata that indicates whether the `allowInPerson` property is editable. // AllowInPersonMetadata *SettingsMetadata `json:"allowInPersonMetadata,omitempty"` - // Boolean that specifies whether managed stamps can be used in the account. + // When **true**, [Managed Stamps](https://support.docusign.com/en/guides/ndse-admin-guide-managed-stamps) are enabled. AllowManagedStamps string `json:"allowManagedStamps,omitempty"` // Metadata that indicates whether the `allowManagedStamps` property is editable. // AllowManagedStampsMetadata *SettingsMetadata `json:"allowManagedStampsMetadata,omitempty"` - // When **true**, Document Markup is enabled for envelope. The account must have Document Markup enabled to use this. + // When set to **true**, the Document Markup feature is enabled. + // + // **Note**: To use this feature, Document Markup must be enabled at both the account and envelope levels. Only Admin users can change this setting for at the account level. AllowMarkup string `json:"allowMarkup,omitempty"` // Metadata that indicates whether the `allowMarkup` property is editable. // AllowMarkupMetadata *SettingsMetadata `json:"allowMarkupMetadata,omitempty"` - // Specifies whether users can set their own + // When set to **true**, account users can set their own // [time zone settings](https://support.docusign.com/en/articles/How-do-I-modify-time-zone-settings-for-my-account). // + // **Note**: Only Admin users can change this setting. + // AllowMemberTimeZone string `json:"allowMemberTimeZone,omitempty"` // Metadata that indicates whether the `allowMemberTimeZone` property is editable. // AllowMemberTimeZoneMetadata *SettingsMetadata `json:"allowMemberTimeZoneMetadata,omitempty"` - // Specified whether + // When set to **true**, the account can use // [merge fields](https://support.docusign.com/en/guides/dfs-user-guide-merge-fields-user) - // are enabled for the account. + // with DocuSign for Salesforce. // AllowMergeFields string `json:"allowMergeFields,omitempty"` // Metadata that indicates whether the `allowMergeFields` property is editable. @@ -1123,9 +1354,10 @@ type AccountSettingsInformation struct { // Metadata that indicates whether the `allowMultipleBrandProfiles` property is editable. // AllowMultipleBrandProfilesMetadata *SettingsMetadata `json:"allowMultipleBrandProfilesMetadata,omitempty"` - // Specifies whether recipients are able to + // When set to **true**, recipients can // upload multiple signer attachments with a single attachment. // + // **Note**: Only Admin users can change this setting. AllowMultipleSignerAttachments string `json:"allowMultipleSignerAttachments,omitempty"` // Metadata that indicates whether the `allowMultipleSignerAttachments` property is editable. // @@ -1138,30 +1370,41 @@ type AccountSettingsInformation struct { // Metadata that indicates whether the `allowNonUSPhoneAuth` property is editable. // AllowNonUSPhoneAuthMetadata *SettingsMetadata `json:"allowNonUSPhoneAuthMetadata,omitempty"` - // Specifies whether + // + AllowOcrOfEnvelopeDocuments string `json:"allowOcrOfEnvelopeDocuments,omitempty"` + // + AllowOcrOfEnvelopeDocumentsMetadata *SettingsMetadata `json:"allowOcrOfEnvelopeDocumentsMetadata,omitempty"` + // When set to **true**, // [offline signing](https://support.docusign.com/articles/Offline-access-with-the-DocuSign-Mobile-App-for-iOS-iPad-iPhone-iPod-Touch) // is enabled for the account. // + // **Note**: Only Admin users can change this setting. AllowOfflineSigning string `json:"allowOfflineSigning,omitempty"` // Metadata that indicates whether the `allowOfflineSigning` property is editable. // AllowOfflineSigningMetadata *SettingsMetadata `json:"allowOfflineSigningMetadata,omitempty"` - // Boolean that specifies whether OpenTrust signer certificates can be used in the account. + // When set to **true**, senders can use OpenTrust signer certificates. + // + // **Note**: Only Admin users can change this setting. AllowOpenTrustSignerCertificate string `json:"allowOpenTrustSignerCertificate,omitempty"` // Metadata that indicates whether the `allowOpenTrustSignerCertificate` property is editable. // AllowOpenTrustSignerCertificateMetadata *SettingsMetadata `json:"allowOpenTrustSignerCertificateMetadata,omitempty"` - // Boolean that specifies whether [Organization Administration](https://developers.docusign.com/orgadmin-api) is enabled for the account. + // Boolean that specifies whether [DocuSign Admin](https://developers.docusign.com/orgadmin-api) is enabled for the account. AllowOrganizations string `json:"allowOrganizations,omitempty"` // Metadata that indicates whether the `allowOrganizations` property is editable. // AllowOrganizationsMetadata *SettingsMetadata `json:"allowOrganizationsMetadata,omitempty"` - // Boolean that specifies whether payment processing is enabled for the account. + // When set to **true**, payment processing is enabled for the account. + // + // **Note**: Only Admin users can change this setting. AllowPaymentProcessing string `json:"allowPaymentProcessing,omitempty"` // Metadata that indicates whether the `allowPaymentProcessing` property is editable. // AllowPaymentProcessingMetadata *SettingsMetadata `json:"allowPaymentProcessingMetadata,omitempty"` - // Boolean that specifies whether a signer certificate is allowed to be used for signing on the account. + // When set to **true**, signers can use personal signer certificates. + // + // **Note**: Only Admin users can change this setting. AllowPersonalSignerCertificate string `json:"allowPersonalSignerCertificate,omitempty"` // Metadata that indicates whether the `allowPersonalSignerCertificate` property is editable. // @@ -1176,19 +1419,29 @@ type AccountSettingsInformation struct { // Metadata that indicates whether the `allowPhoneAuthentication` property is editable. // AllowPhoneAuthenticationMetadata *SettingsMetadata `json:"allowPhoneAuthenticationMetadata,omitempty"` - // Boolean that specifies whether the account allows private signing groups. + // Reserved for DocuSign. This property returns the value **false** when listing account settings. Read only. AllowPrivateSigningGroups string `json:"allowPrivateSigningGroups,omitempty"` // Metadata that indicates whether the `allowPrivateSigningGroups` property is editable. // AllowPrivateSigningGroupsMetadata *SettingsMetadata `json:"allowPrivateSigningGroupsMetadata,omitempty"` - // If **true**, - // allows an account administrator to turn on reminders + // + AllowRecipientConnect string `json:"allowRecipientConnect,omitempty"` + // + AllowRecipientConnectMetadata *SettingsMetadata `json:"allowRecipientConnectMetadata,omitempty"` + // When set to **true**, + // an account administrator can to turn on reminders // and expiration defaults for the account. // + // **Note**: Only Admin users can change this setting. + // AllowReminders string `json:"allowReminders,omitempty"` // Metadata that indicates whether the `allowReminders` property is editable. // AllowRemindersMetadata *SettingsMetadata `json:"allowRemindersMetadata,omitempty"` + // + AllowRemoteNotary string `json:"allowRemoteNotary,omitempty"` + // + AllowRemoteNotaryMetadata *SettingsMetadata `json:"allowRemoteNotaryMetadata,omitempty"` // If **true**, // resource files can be uploaded in branding. // @@ -1196,10 +1449,16 @@ type AccountSettingsInformation struct { // Metadata that indicates whether the `allowResourceFileBranding` property is editable. // AllowResourceFileBrandingMetadata *SettingsMetadata `json:"allowResourceFileBrandingMetadata,omitempty"` - // If **true**, - // allows the account administrator - // to specify that signers are - // required to use SAFE digital signatures. + // + AllowSMSDelivery string `json:"allowSMSDelivery,omitempty"` + // + AllowSMSDeliveryMetadata *SettingsMetadata `json:"allowSMSDeliveryMetadata,omitempty"` + // When set to **true**, + // account administrators can + // specify that signers are + // required to use SAFE-BioPharma digital signatures. + // + // **Note**: Only Admin users can change this setting. // AllowSafeBioPharmaSignerCertificate string `json:"allowSafeBioPharmaSignerCertificate,omitempty"` // Metadata that indicates whether the `allowSafeBioPharmaSignerCertificate` property is editable. @@ -1234,14 +1493,22 @@ type AccountSettingsInformation struct { // Metadata that indicates whether the `allowServerTemplates` property is editable. // AllowServerTemplatesMetadata *SettingsMetadata `json:"allowServerTemplatesMetadata,omitempty"` - // If **true**, - // the account can use shared tabs. + // + AllowSetEmbeddedRecipientStartURL string `json:"allowSetEmbeddedRecipientStartURL,omitempty"` + // + AllowSetEmbeddedRecipientStartURLMetadata *SettingsMetadata `json:"allowSetEmbeddedRecipientStartURLMetadata,omitempty"` + // When set to **true**, + // shared tabs are enabled for the account. + // + // **Note**: Only Admin users can change this setting. // AllowSharedTabs string `json:"allowSharedTabs,omitempty"` // Metadata that indicates whether the `allowSharedTabs` property is editable. // AllowSharedTabsMetadata *SettingsMetadata `json:"allowSharedTabsMetadata,omitempty"` - // Boolean that specifies whether recipients can sign documents from the homepage. + // When set to **true**, recipients can sign documents from the home page. + // + // **Note**: Only Admin users can change this setting. AllowSignDocumentFromHomePage string `json:"allowSignDocumentFromHomePage,omitempty"` // Metadata that indicates whether the `allowSignDocumentFromHomePage` property is editable. // @@ -1254,18 +1521,24 @@ type AccountSettingsInformation struct { // Metadata that indicates whether the `allowSignNow` property is editable. // AllowSignNowMetadata string `json:"allowSignNowMetadata,omitempty"` - // Boolean that specifies whether signature stamps can be used with the account. + // When set to **true**, Signature Stamps are enabled. + // + // **Note**: Only Admin users can change this setting. AllowSignatureStamps string `json:"allowSignatureStamps,omitempty"` // Metadata that indicates whether the `allowSignatureStamps` property is editable. // AllowSignatureStampsMetadata *SettingsMetadata `json:"allowSignatureStampsMetadata,omitempty"` - // Account setting that determines whether the recipient of an envelope sent from this account can reassign it to another person. + // When set to **true**, the recipient of an envelope sent from this account can reassign it to another person. + // + // **Note**: Only Admin users can change this setting. // AllowSignerReassign string `json:"allowSignerReassign,omitempty"` // Metadata that indicates whether the `allowSignerReassign` property is editable. // AllowSignerReassignMetadata *SettingsMetadata `json:"allowSignerReassignMetadata,omitempty"` - // Account setting that determines whether an account administrator can override the ability of an envelope recipient to reassign it to another person. + // When set to **true**, an account administrator can override the ability of an envelope recipient to reassign it to another person. + // + // **Note**: Only Admin users can change this setting. AllowSignerReassignOverride string `json:"allowSignerReassignOverride,omitempty"` // Metadata that indicates whether the `allowSignerReassignOverride` property is editable. // @@ -1275,56 +1548,73 @@ type AccountSettingsInformation struct { // Metadata that indicates whether the `allowSigningExtensions` property is editable. // AllowSigningExtensionsMetadata *SettingsMetadata `json:"allowSigningExtensionsMetadata,omitempty"` - // Boolean that specifies whether the account allows signing groups. + // When set to **true**, the account allows signing groups. This setting is only shown in responses that list account settings. Read only. AllowSigningGroups string `json:"allowSigningGroups,omitempty"` // Metadata that indicates whether the `allowSigningGroups` property is editable. // AllowSigningGroupsMetadata *SettingsMetadata `json:"allowSigningGroupsMetadata,omitempty"` + // + AllowSigningInsights string `json:"allowSigningInsights,omitempty"` + // + AllowSigningInsightsMetadata *SettingsMetadata `json:"allowSigningInsightsMetadata,omitempty"` // Boolean that specifies whether the account supports radio buttons on tabs [Radio CustomTabType](https://developers.docusign.com/esign-soap-api/reference/Sending-Group/Tab). AllowSigningRadioDeselect string `json:"allowSigningRadioDeselect,omitempty"` // Metadata that indicates whether the `allowSigningRadioDeselect` property is editable. // AllowSigningRadioDeselectMetadata *SettingsMetadata `json:"allowSigningRadioDeselectMetadata,omitempty"` - // If **true**, - // the account administrator can enable [social id login](https://support.docusign.com/guides/signer-authentication) for the account. - // + // Deprecated. AllowSocialIDLogin string `json:"allowSocialIdLogin,omitempty"` - // Metadata that indicates whether the `allowSocialIdLogin` property is editable. - // + // Deprecated. AllowSocialIDLoginMetadata *SettingsMetadata `json:"allowSocialIdLoginMetadata,omitempty"` // When **true**, this user can include supplemental documents. AllowSupplementalDocuments string `json:"allowSupplementalDocuments,omitempty"` // Metadata that indicates whether the `allowSupplementalDocuments` property is editable. AllowSupplementalDocumentsMetadata *SettingsMetadata `json:"allowSupplementalDocumentsMetadata,omitempty"` + // + AllowUsersToAccessDirectory string `json:"allowUsersToAccessDirectory,omitempty"` + // + AllowUsersToAccessDirectoryMetadata *SettingsMetadata `json:"allowUsersToAccessDirectoryMetadata,omitempty"` + // + AllowValueInsights string `json:"allowValueInsights,omitempty"` + // + AllowValueInsightsMetadata *SettingsMetadata `json:"allowValueInsightsMetadata,omitempty"` + // This property determines how template anchor tabs are applied. + // // Valid values are: // - // - `document` - // - `envelope` + // - `document`: Anchor tabs are applied only to the document that you specify. + // - `envelope`: Anchor tabs are applied to all of the documents in the envelope associated with the template. + // + // **Note**: When you are using the `anchorPopulationScope` property with a Composite Template, the value `document` is supported only with a single server template and a single inline template. // // AnchorPopulationScope string `json:"anchorPopulationScope,omitempty"` // Metadata that indicates whether the `anchorPopulationScope` property is editable. // AnchorPopulationScopeMetadata *SettingsMetadata `json:"anchorPopulationScopeMetadata,omitempty"` - // Valid values are: - // - // - `system_default` - // - `off` - // - `on` + // Reserved for DocuSign. // AnchorTagVersionedPlacementEnabled string `json:"anchorTagVersionedPlacementEnabled,omitempty"` // AnchorTagVersionedPlacementMetadataEnabled *SettingsMetadata `json:"anchorTagVersionedPlacementMetadataEnabled,omitempty"` - // Boolean that specifies whether envelope documents are included as a PDF file attachment for signing completed emails. + // When set to **true**, envelope documents are included as a PDF file attachment to "signing completed" emails. + // + // **Note**: Only SysAdmin users can change this setting. AttachCompletedEnvelope string `json:"attachCompletedEnvelope,omitempty"` // Metadata that indicates whether the `attachCompletedEnvelope` property is editable. AttachCompletedEnvelopeMetadata *SettingsMetadata `json:"attachCompletedEnvelopeMetadata,omitempty"` - // Specifies how often - // to check authentication. - // Valid values are: + // Sets when authentication checks are applied for recipient envelope access. This setting only applies to the following ID checks: + // + // - Phone Authentication + // - SMS Authentication + // - Knowledge-Based ID // - // - `initial_access` - // - `each_access` + // This setting takes one of the following options: + // + // - `initial_access`: The authentication check always applies the first time a recipient accesses the documents. Recipients are not asked to authenticate again when they access the documents from the same browser on the same device. If the recipient attempts to access the documents from a different browser or a different device, the recipient must pass authentication again. Once authenticated, that recipient is not challenged again on the new device or browser. The ability for a recipient to skip authentication for documents is limited to documents sent from the same sending account. + // - `each_access`: Authentication checks apply every time a recipient attempts to access the envelope. However, you can configure the Authentication Expiration setting to allow recipients to skip authentication when they have recently passed authentication by setting a variable time frame. + // + // **Note**: Only Admin users can change this setting. // AuthenticationCheck string `json:"authenticationCheck,omitempty"` // Metadata that indicates whether the `authenticationCheck` property is editable. @@ -1358,8 +1648,7 @@ type AccountSettingsInformation struct { // Reserved for DocuSign. // BetaSwitchConfiguration string `json:"betaSwitchConfiguration,omitempty"` - // Metadata that indicates whether the `betaSwitchConfiguration` property is editable. - // + // Reserved for DocuSign. BetaSwitchConfigurationMetadata *SettingsMetadata `json:"betaSwitchConfigurationMetadata,omitempty"` // The billing address for the account. BillingAddress *AddressInformation `json:"billingAddress,omitempty"` @@ -1368,56 +1657,71 @@ type AccountSettingsInformation struct { BillingAddressMetadata *SettingsMetadata `json:"billingAddressMetadata,omitempty"` // When **true**, this user can use the bulk send feature for the account. BulkSend string `json:"bulkSend,omitempty"` + // + BulkSendMaxCopiesInBatch string `json:"bulkSendMaxCopiesInBatch,omitempty"` + // + BulkSendMaxUnprocessedEnvelopesCount string `json:"bulkSendMaxUnprocessedEnvelopesCount,omitempty"` // Metadata that indicates whether the `bulkSend` property is editable. // BulkSendMetadata *SettingsMetadata `json:"bulkSendMetadata,omitempty"` - // Boolean that specifies whether account administrators can self-brand their sending console through the DocuSign Console. + // When set to **true**, account administrators can self-brand their sending console through the DocuSign console. CanSelfBrandSend string `json:"canSelfBrandSend,omitempty"` // Metadata that indicates whether the `canSelfBrandSend` property is editable. // CanSelfBrandSendMetadata *SettingsMetadata `json:"canSelfBrandSendMetadata,omitempty"` - // Boolean that specifies whether account administrators can self-brand their signing console through the DocuSign Console. + // When set to **true**, account administrators can self-brand their signing console through the DocuSign console. CanSelfBrandSign string `json:"canSelfBrandSign,omitempty"` // Metadata that indicates whether the `canSelfBrandSign` property is editable. // CanSelfBrandSignMetadata *SettingsMetadata `json:"canSelfBrandSignMetadata,omitempty"` - // Boolean that specifies whether voice recording is supported for the account. - CaptureVoiceRecording string `json:"captureVoiceRecording,omitempty"` - // Metadata that indicates whether the `captureVoiceRecording` property is editable. // + CanUseSalesforceOAuth string `json:"canUseSalesforceOAuth,omitempty"` + // + CanUseSalesforceOAuthMetadata *SettingsMetadata `json:"canUseSalesforceOAuthMetadata,omitempty"` + // Reserved for DocuSign. + CaptureVoiceRecording string `json:"captureVoiceRecording,omitempty"` + // Reserved for DocuSign. CaptureVoiceRecordingMetadata *SettingsMetadata `json:"captureVoiceRecordingMetadata,omitempty"` // Boolean that specifies whether to use a shorter/wider format when generating the CFR Part 11 signature image. CfrUseWideImage string `json:"cfrUseWideImage,omitempty"` // Metadata that indicates whether the `cfrUseWideImage` property is editable. // CfrUseWideImageMetadata *SettingsMetadata `json:"cfrUseWideImageMetadata,omitempty"` + // + CheckForMultipleAdminsOnAccount string `json:"checkForMultipleAdminsOnAccount,omitempty"` + // Metadata that indicates whether the `checkForMultipleAdminsOnAccount` property is editable. + CheckForMultipleAdminsOnAccountMetadata *SettingsMetadata `json:"checkForMultipleAdminsOnAccountMetadata,omitempty"` // Boolean that specifies whether the signers of the envelopes from this account use a signature with a DocuSign chrome around it or not. ChromeSignatureEnabled string `json:"chromeSignatureEnabled,omitempty"` // Metadata that indicates whether the `chromeSignatureEnabled` property is editable. // ChromeSignatureEnabledMetadata *SettingsMetadata `json:"chromeSignatureEnabledMetadata,omitempty"` + // When set to **true**, the text of comments is included in email notifications when a comment is posted. // + // **Note**: If the envelope requires additional recipient authentication, comment text is not included. CommentEmailShowMessageText string `json:"commentEmailShowMessageText,omitempty"` // Metadata that indicates whether the `commentEmailShowMessageText` property is editable. // CommentEmailShowMessageTextMetadata *SettingsMetadata `json:"commentEmailShowMessageTextMetadata,omitempty"` - // Boolean that specifies whether recipients can make and respond to comments in documents belonging to the envelopes that they are sent. + // When set to **true** and comments are enabled for the account, senders can disable comments for an envelope through the **Advanced Options** menu that appears during the sending process. CommentsAllowEnvelopeOverride string `json:"commentsAllowEnvelopeOverride,omitempty"` // Metadata that indicates whether the `commentsAllowEnvelopeOverride` property is editable. // CommentsAllowEnvelopeOverrideMetadata *SettingsMetadata `json:"commentsAllowEnvelopeOverrideMetadata,omitempty"` - // Boolean that specifies whether conditional fields can be used in documents. + // When set to **true**, conditional fields can be used in documents. + // + // **Note**: Only Admin users can change this setting. ConditionalFieldsEnabled string `json:"conditionalFieldsEnabled,omitempty"` // Metadata that indicates whether the `conditionalFieldsEnabled` property is editable. // ConditionalFieldsEnabledMetadata *SettingsMetadata `json:"conditionalFieldsEnabledMetadata,omitempty"` - // Speficies how often to display - // the consumer disclosure. + // Speficies how often to display the consumer disclosure. + // // Valid values are: // - // - `once` - // - `always` - // - `each_access` + // - `once`: Per account, the supplemental document is displayed once only per `userId`. + // - `always`: Per envelope, the supplemental document is displayed once only per `userId`. + // - `each_access`: Per envelope, the supplemental document is displayed once only per `recipientId`. // ConsumerDisclosureFrequency string `json:"consumerDisclosureFrequency,omitempty"` // Metadata that indicates whether the `consumerDisclosureFrequency` property is editable. @@ -1428,37 +1732,58 @@ type AccountSettingsInformation struct { // Metadata that indicates whether the `convertPdfFields` property is editable. // ConvertPdfFieldsMetadata *SettingsMetadata `json:"convertPdfFieldsMetadata,omitempty"` - // Valid values are: + // Specifies how data is shared for tabs with the same tabLabel. Valid values are: // - // - `document` - // - `envelope` + // - `document`: Tabs in a document with the same label populate with the same data. + // - `envelope`: Tabs in all documents in the envelope with the same label populate with the same data. // + // This setting applies to the following tab types: + // + // - Check box + // - Company + // - Data field + // - Drop-down list + // - Full name + // - Formula + // - Note + // - Title + // + // **Note**: Only Admin users can change this setting. Changing this setting affects envelopes that have been sent but not completed. DataPopulationScope string `json:"dataPopulationScope,omitempty"` // Metadata that indicates whether the `dataPopulationScope` property is editable. // DataPopulationScopeMetadata *SettingsMetadata `json:"dataPopulationScopeMetadata,omitempty"` + // + DisableAutoTemplateMatching string `json:"disableAutoTemplateMatching,omitempty"` + // + DisableAutoTemplateMatchingMetadata *SettingsMetadata `json:"disableAutoTemplateMatchingMetadata,omitempty"` // When **true**, the mobile app distributor key is prevented from connecting for account users. DisableMobileApp string `json:"disableMobileApp,omitempty"` // Metadata that indicates whether the `disableMobileApp` property is editable. // DisableMobileAppMetadata *SettingsMetadata `json:"disableMobileAppMetadata,omitempty"` - // When **true**, push notifications are disabled for the account. + // When set to **true**, push notifications are disabled for the account. + // + // **Note**: Only Admin users can change this setting. DisableMobilePushNotifications string `json:"disableMobilePushNotifications,omitempty"` // Metadata that indicates whether the `disableMobilePushNotifications` property is editable. // DisableMobilePushNotificationsMetadata *SettingsMetadata `json:"disableMobilePushNotificationsMetadata,omitempty"` - // When **true**, sending from a mobile application is disabled. + // When set to **true**, sending from a mobile application is disabled. + // + // **Note**: Only Admin users can change this setting. DisableMobileSending string `json:"disableMobileSending,omitempty"` // Metadata that indicates whether the `disableMobileSending` property is editable. // DisableMobileSendingMetadata *SettingsMetadata `json:"disableMobileSendingMetadata,omitempty"` - // When **true**, account users cannot be logged into multiple sessions at the same time. + // When set to **true**, account users cannot be logged into multiple sessions at the same time. + // + // **Note**: Only Admin users can change this setting. DisableMultipleSessions string `json:"disableMultipleSessions,omitempty"` // Metadata that indicates whether the `disableMultipleSessions` property is editable. // DisableMultipleSessionsMetadata *SettingsMetadata `json:"disableMultipleSessionsMetadata,omitempty"` - // Metadata that indicates whether the `disablePurgeNotificationsForSender` property is editable. - // + // Reserved for DocuSign. DisablePurgeNotificationsForSenderMetadata *SettingsMetadata `json:"disablePurgeNotificationsForSenderMetadata,omitempty"` // When **true**, signers cannot view certificates of completion. DisableSignerCertView string `json:"disableSignerCertView,omitempty"` @@ -1475,7 +1800,9 @@ type AccountSettingsInformation struct { // Metadata that indicates whether the `disableStyleSignature` property is editable. // DisableStyleSignatureMetadata *SettingsMetadata `json:"disableStyleSignatureMetadata,omitempty"` - // When **true**, signers cannot upload custom image files of their signature and initials. + // When set to **true**, signers cannot upload custom image files of their signature and initials. + // + // **Note**: Only Admin users can change this setting. DisableUploadSignature string `json:"disableUploadSignature,omitempty"` // Metadata that indicates whether the `disableUploadSignature` property is editable. // @@ -1490,22 +1817,26 @@ type AccountSettingsInformation struct { // Metadata that indicates whether the `displayBetaSwitch` property is editable. // DisplayBetaSwitchMetadata *SettingsMetadata `json:"displayBetaSwitchMetadata,omitempty"` - // Valid values are: + // Sets the account document upload restriction for non-account administrators. Valid values are: + // + // - `no_restrictions`: There are no restrictions on the type of documents that can be uploaded. + // - `allow_pdf_only`: Non-administrators can only upload PDF files. + // - `no_upload`: Non-administrators cannot upload files. // - // - `no_restrictions` - // - `allow_pdf_only` - // - `no_upload` + // **Note**: Only Admin users can change this setting. // DocumentConversionRestrictions string `json:"documentConversionRestrictions,omitempty"` // Metadata that indicates whether the `documentConversionRestrictions` property is editable. // DocumentConversionRestrictionsMetadata *SettingsMetadata `json:"documentConversionRestrictionsMetadata,omitempty"` - // + // Sets a document retention period, which controls the number of days that DocuSign retains documents after they have reached a completed,declined, or voided state. When document retention is enabled for the account, the default value is `356` days. DocumentRetention string `json:"documentRetention,omitempty"` // Metadata that indicates whether the `documentRetention` property is editable. // DocumentRetentionMetadata *SettingsMetadata `json:"documentRetentionMetadata,omitempty"` - // Specifies when to purge tabs according to the Document Retention policy for the account. + // When set to **true** and `documentRetention` is set, document fields and metadata are also purged after the document retention period ends. The default value is **false**. + // + // **Note**: Only Admins can change this setting. DocumentRetentionPurgeTabs string `json:"documentRetentionPurgeTabs,omitempty"` // Configures the Document Visibility feature for the account. Valid values are: // @@ -1520,7 +1851,7 @@ type AccountSettingsInformation struct { // Metadata that indicates whether the `documentVisibility` property is editable. // DocumentVisibilityMetadata *SettingsMetadata `json:"documentVisibilityMetadata,omitempty"` - // Specifies the version of the email templates used in an account. If new signing is selected in a member's Admin page, the user is updated to the newest version (1.1), the minumum version of email supported for the account. + // Specifies the version of the email templates used in an account. If new signing is selected in a member's Admin page, the user is updated to the newest version (1.1), the minimum version of email supported for the account. EmailTemplateVersion string `json:"emailTemplateVersion,omitempty"` // Metadata that indicates whether the `emailTemplateVersion` property is editable. // @@ -1540,21 +1871,37 @@ type AccountSettingsInformation struct { // Metadata that indicates whether the `enableAdvancedPowerForms` property is editable. // EnableAdvancedPowerFormsMetadata *SettingsMetadata `json:"enableAdvancedPowerFormsMetadata,omitempty"` - // When **true**, enables the account to set the AutoNav rule setting, which allows a sender to override the auto navigation setting per envelope. + // + EnableAgreementActionsForCLM string `json:"enableAgreementActionsForCLM,omitempty"` + // + EnableAgreementActionsForCLMMetadata *SettingsMetadata `json:"enableAgreementActionsForCLMMetadata,omitempty"` + // + EnableAgreementActionsForESign string `json:"enableAgreementActionsForESign,omitempty"` + // + EnableAgreementActionsForESignMetadata *SettingsMetadata `json:"enableAgreementActionsForESignMetadata,omitempty"` + // When **true**, enables the account to set the AutoNav rule setting, which enables a sender to override the auto-navigation setting per envelope. + // + // **Note**: To change this setting, you must be a SysAdmin user or `EnableAutoNavByDSAdmin must be set. EnableAutoNav string `json:"enableAutoNav,omitempty"` // Metadata that indicates whether the `enableAutoNav` property is editable. // EnableAutoNavMetadata *SettingsMetadata `json:"enableAutoNavMetadata,omitempty"` - // When **true**, the account is enabled to use calculated fields (must be allowed at the account level for this setting to be changeable). + // When set to **true**, calculated fields are enabled for the account. + // + // **Note**: This setting can be changed only by Admin users, and only if the account-level setting `allowExpression` is set to **true**. EnableCalculatedFields string `json:"enableCalculatedFields,omitempty"` // Metadata that indicates whether the `enableCalculatedFields` property is editable. // EnableCalculatedFieldsMetadata *SettingsMetadata `json:"enableCalculatedFieldsMetadata,omitempty"` - // Boolean that specifies whether clickwraps are enabled in your app. A [clickwrap])(https://developers.docusign.com/click-api/guides/) is an iframe that you embed in your own website or app. + // Boolean that specifies whether clickwraps are enabled in your app. A [clickwrap](https://developers.docusign.com/click-api/guides/) is an iframe that you embed in your own website or app. EnableClickwraps string `json:"enableClickwraps,omitempty"` // Metadata that indicates whether the `enableClickwraps` property is editable. // EnableClickwrapsMetadata *SettingsMetadata `json:"enableClickwrapsMetadata,omitempty"` + // + EnableCommentsHistoryDownloadInSigning string `json:"enableCommentsHistoryDownloadInSigning,omitempty"` + // + EnableCommentsHistoryDownloadInSigningMetadata *SettingsMetadata `json:"enableCommentsHistoryDownloadInSigningMetadata,omitempty"` // When **true**, enables customer satisfaction metric tracking for the account. EnableCustomerSatisfactionMetricTracking string `json:"enableCustomerSatisfactionMetricTracking,omitempty"` // Metadata that indicates whether the `enableCustomerSatisfactionMetricTracking` property is editable. @@ -1565,24 +1912,40 @@ type AccountSettingsInformation struct { // Metadata that indicates whether the `enableDSPro` property is editable. // EnableDSProMetadata *SettingsMetadata `json:"enableDSProMetadata,omitempty"` - // When **true**, enables the account administrator to control envelope stamping for an account (placement of the EnvelopeID). + // When set to **true**, enables the account administrator to control envelope stamping for an account (stamping the `envelopeId` in the the document margins). + // + // **Note**: This setting can be changed only by Admin users, and only if the account-level setting `enableEnvelopeStampingByDSAdmin` is set to **true**. EnableEnvelopeStampingByAccountAdmin string `json:"enableEnvelopeStampingByAccountAdmin,omitempty"` // Metadata that indicates whether the `enableEnvelopeStampingByAccountAdmin` property is editable. // EnableEnvelopeStampingByAccountAdminMetadata *SettingsMetadata `json:"enableEnvelopeStampingByAccountAdminMetadata,omitempty"` - // When **true**, enables the DocuSign administrator to control envelope stamping for an account (placement of the EnvelopeID). + // When **true**, enables the DocuSign administrator to control envelope stamping for an account (placement of the `envelopeId`). EnableEnvelopeStampingByDSAdmin string `json:"enableEnvelopeStampingByDSAdmin,omitempty"` // Metadata that indicates whether the `enableEnvelopeStampingByDSAdmin` property is editable. // EnableEnvelopeStampingByDSAdminMetadata *SettingsMetadata `json:"enableEnvelopeStampingByDSAdminMetadata,omitempty"` - // When **true**, enables payment processing for this account. + // + EnableEsignCommunities string `json:"enableEsignCommunities,omitempty"` + // + EnableEsignCommunitiesMetadata *SettingsMetadata `json:"enableEsignCommunitiesMetadata,omitempty"` + // + EnableInBrowserEditor string `json:"enableInBrowserEditor,omitempty"` + // + EnableInBrowserEditorMetadata *SettingsMetadata `json:"enableInBrowserEditorMetadata,omitempty"` + // When set to **true**, payment processing is enabled for this account. + // + // **Note**: This setting can be changed only by Admin users, and only if the account-level setting `allowPaymentProcessing` is set. EnablePaymentProcessing string `json:"enablePaymentProcessing,omitempty"` // Metadata that indicates whether the `enablePaymentProcessing` property is editable. // EnablePaymentProcessingMetadata *SettingsMetadata `json:"enablePaymentProcessingMetadata,omitempty"` - // When **true**, enables PowerForms for an account. + // When set to **true**, enables PowerForms for the account. + // + // **Note**: Only SysAdmin users can change this setting. EnablePowerForm string `json:"enablePowerForm,omitempty"` - // When **true**, enables direct PowerForms for an account. Direct PowerForms are in-session PowerForms. + // When set to **true**, enables direct PowerForms for an account. Direct PowerForms are in-session PowerForms. + // + // **Note**: Only Admin users can change this setting. EnablePowerFormDirect string `json:"enablePowerFormDirect,omitempty"` // Metadata that indicates whether the `enablePowerFormDirect` property is editable. // @@ -1603,13 +1966,22 @@ type AccountSettingsInformation struct { // Metadata that indicates whether the `enableReportLinks` property is editable. // EnableReportLinksMetadata *SettingsMetadata `json:"enableReportLinksMetadata,omitempty"` - // When true, the account can use the `requireSignOnPaper` option. + // When set to **true**, the account can use the `requireSignOnPaper` option. + // + // **Note**: Only Admin users can change this setting. // EnableRequireSignOnPaper string `json:"enableRequireSignOnPaper,omitempty"` // Metadata that indicates whether the `enableRequireSignOnPaper` property is editable. // EnableRequireSignOnPaperMetadata *SettingsMetadata `json:"enableRequireSignOnPaperMetadata,omitempty"` - // When **true**, enables reserved domains for an account. This is configured by the account administrators on a page which they can specify reserved domain and reserved users in their domain. This allows them to lock down email address domains to exist only in their account and in no other location in DocuSign. + // When **true**, account administrators can reserve a web domain and users. Domains are organization-specific reserved internet domains, such as `@exampledomain.com`. You can define policy settings for users of each reserved domain within your organization, export lists of domain users for audit purposes, and manage domain users. + // + // - Domains may be claimed by an organization. + // - When a domain is claimed by an organization, all users within that domain are added to the organization, even if they have trial or free accounts. + // - You can set domain controls for all users of the domain. + // - You can export information about your organization’s users that are associated with your reserved domains. + // + // **Note**: Only SysAdmin users can change this setting. EnableReservedDomain string `json:"enableReservedDomain,omitempty"` // Metadata that indicates whether the `enableReservedDomain` property is editable. // @@ -1619,30 +1991,46 @@ type AccountSettingsInformation struct { // Metadata that indicates whether the `enableResponsiveSigning` property is editable. // EnableResponsiveSigningMetadata *SettingsMetadata `json:"enableResponsiveSigningMetadata,omitempty"` - // When **true**, the account can use SMS authentication. + // When set to **true**, the account can use SMS authentication. + // + // **Note**: Only Admin users can change this setting. // EnableSMSAuthentication string `json:"enableSMSAuthentication,omitempty"` // Metadata that indicates whether the `enableSMSAuthentication` property is editable. // EnableSMSAuthenticationMetadata *SettingsMetadata `json:"enableSMSAuthenticationMetadata,omitempty"` - // + // When set to **true**, scheduled releases are enabled. The default value is **false**. EnableScheduledRelease string `json:"enableScheduledRelease,omitempty"` // Metadata that indicates whether the `enableScheduledRelease` property is editable. // EnableScheduledReleaseMetadata *SettingsMetadata `json:"enableScheduledReleaseMetadata,omitempty"` - // When **true**, this account can use the agent recipient type. + // + EnableSearch string `json:"enableSearch,omitempty"` + // + EnableSearchMetadata *SettingsMetadata `json:"enableSearchMetadata,omitempty"` + // + EnableSearchUI string `json:"enableSearchUI,omitempty"` + // + EnableSearchUIMetadata *SettingsMetadata `json:"enableSearchUIMetadata,omitempty"` + // When **true**, this account can use the Agent recipient type. + // + // **Note**: Only SysAdmin users can change this setting. // EnableSendToAgent string `json:"enableSendToAgent,omitempty"` // Metadata that indicates whether the `enableSendToAgent` property is editable. // EnableSendToAgentMetadata *SettingsMetadata `json:"enableSendToAgentMetadata,omitempty"` - // When true, this account can use the intermediary recipient type. + // When set to **true**, this account can use the Intermediary recipient type. + // + // **Note**: Only Admin users can change this setting, and only if `allowSendToIntermediary` is set. // EnableSendToIntermediary string `json:"enableSendToIntermediary,omitempty"` // Metadata that indicates whether the `enableSendToIntermediary` property is editable. // EnableSendToIntermediaryMetadata *SettingsMetadata `json:"enableSendToIntermediaryMetadata,omitempty"` - // When true, this account can use the editor recipient type. + // When set to **true**, this account can use the Editor recipient type. + // + // **Note**: Only Admin users can change this setting. // EnableSendToManage string `json:"enableSendToManage,omitempty"` // Metadata that indicates whether the `enableSendToManage` property is editable. @@ -1653,42 +2041,53 @@ type AccountSettingsInformation struct { // Metadata that indicates whether the `enableSendingTagsFontSettings` property is editable. // EnableSendingTagsFontSettingsMetadata *SettingsMetadata `json:"enableSendingTagsFontSettingsMetadata,omitempty"` - // When **true**, the account can define the routing - // order of recipients for envelopes sent using the DocuSign API. + // When set to **true**, the account can define the routing + // order of recipients for envelopes sent by using the eSignature API. // + // **Note**: Only SysAdmin users can change this setting. EnableSequentialSigningAPI string `json:"enableSequentialSigningAPI,omitempty"` // Metadata that indicates whether the `enableSequentialSigningAPI` property is editable. // EnableSequentialSigningAPIMetadata *SettingsMetadata `json:"enableSequentialSigningAPIMetadata,omitempty"` - // When **true**, the account can define the routing order - // of recipients for envelopes sent using the DocuSign application. + // When set to **true**, the account can define the routing order + // of recipients for envelopes sent by using the DocuSign application. + // + // **Note**: Only SysAdmin users can change this setting. // EnableSequentialSigningUI string `json:"enableSequentialSigningUI,omitempty"` // Metadata that indicates whether the `enableSequentialSigningUI` property is editable. // EnableSequentialSigningUIMetadata *SettingsMetadata `json:"enableSequentialSigningUIMetadata,omitempty"` - // When **true**, a sender can allow signers to use the sign on paper option. + // When set to **true**, a sender can allow signers to use the sign on paper option. + // + // **Note**: Only Admin users can change this setting. // EnableSignOnPaper string `json:"enableSignOnPaper,omitempty"` // Metadata that indicates whether the `enableSignOnPaper` property is editable. // EnableSignOnPaperMetadata *SettingsMetadata `json:"enableSignOnPaperMetadata,omitempty"` - // When **true**, this user can override the Sign on Paper account setting, which specifies whether signers can sign documents on paper as an option to signing electronically. + // When set to **true**, a user can override the default default account setting for the Sign on Paper option, which specifies whether signers can sign documents on paper as an option to signing electronically. + // + // **Note**: Only Admin users can change this setting. EnableSignOnPaperOverride string `json:"enableSignOnPaperOverride,omitempty"` // Metadata that indicates whether the `enableSignOnPaperOverride` property is editable. // EnableSignOnPaperOverrideMetadata *SettingsMetadata `json:"enableSignOnPaperOverrideMetadata,omitempty"` - // When set to **true**, Sign with Notary functionality is enabled on the envelope. + // When set to **true**, Sign with Notary functionality is enabled for the account. + // + // **Note**: Only Admin users can change this setting. EnableSignWithNotary string `json:"enableSignWithNotary,omitempty"` // Metadata that indicates whether the `enableSignWithNotary` property is editable. // EnableSignWithNotaryMetadata *SettingsMetadata `json:"enableSignWithNotaryMetadata,omitempty"` - // When **true**, this user can use the signing attachments feature. + // When set to **true**, users can use the signing attachments feature to request attachments from signers. + // + // **Note**: Only Admin users can change this setting. EnableSignerAttachments string `json:"enableSignerAttachments,omitempty"` // Metadata that indicates whether the `enableSignerAttachments` property is editable. // EnableSignerAttachmentsMetadata *SettingsMetadata `json:"enableSignerAttachmentsMetadata,omitempty"` - // When **true**, enables commenting functionality. + // When set to **true**, enables comments for the account so that signers and recipients can make and respond to comments in documents belonging to the envelopes that they are sent. EnableSigningExtensionComments string `json:"enableSigningExtensionComments,omitempty"` // Metadata that indicates whether the `enableSigningExtensionComments` property is editable. // @@ -1703,10 +2102,13 @@ type AccountSettingsInformation struct { // Metadata that indicates whether the `enableSigningOrderSettingsForAccount` property is editable. // EnableSigningOrderSettingsForAccountMetadata *SettingsMetadata `json:"enableSigningOrderSettingsForAccountMetadata,omitempty"` - // When **true**, enables the ability to use social IDs to login to an account. + // When set to **true**, blockchain-based [Smart Contracts](https://www.docusign.com/products/blockchain) are enabled. The default value is **false**. + EnableSmartContracts string `json:"enableSmartContracts,omitempty"` + // Metadata that indicates whether the `enableSmartContracts` property is editable. + EnableSmartContractsMetadata *SettingsMetadata `json:"enableSmartContractsMetadata,omitempty"` + // Deprecated. EnableSocialIDLogin string `json:"enableSocialIdLogin,omitempty"` - // Metadata that indicates whether the `enableSocialIdLogin` property is editable. - // + // Deprecated. EnableSocialIDLoginMetadata *SettingsMetadata `json:"enableSocialIdLoginMetadata,omitempty"` // When **true**, enables strikethrough formatting in documents. EnableStrikeThrough string `json:"enableStrikeThrough,omitempty"` @@ -1715,15 +2117,14 @@ type AccountSettingsInformation struct { EnableStrikeThroughMetadata *SettingsMetadata `json:"enableStrikeThroughMetadata,omitempty"` // Reserved for DocuSign. EnableTransactionPoint string `json:"enableTransactionPoint,omitempty"` - // Metadata that indicates whether the `enableTransactionPoint` property is editable. - // + // Reserved for DocuSign. EnableTransactionPointMetadata *SettingsMetadata `json:"enableTransactionPointMetadata,omitempty"` - // When true, Vaulting is enabled for the account. + // When set to **true**, Vaulting is enabled for the account. EnableVaulting string `json:"enableVaulting,omitempty"` // Metadata that indicates whether the `enableVaulting` property is editable. // EnableVaultingMetadata *SettingsMetadata `json:"enableVaultingMetadata,omitempty"` - // When **true**, enables documents to be signed by a witness. + // Reserved for DocuSign. EnableWitnessing string `json:"enableWitnessing,omitempty"` // Metadata that indicates whether the `enableWitnessing` property is editable. // @@ -1733,17 +2134,24 @@ type AccountSettingsInformation struct { // Metadata that indicates whether the `enforceTemplateNameUniqueness` property is editable. // EnforceTemplateNameUniquenessMetadata *SettingsMetadata `json:"enforceTemplateNameUniquenessMetadata,omitempty"` - // When **true**, allows custom admins to enable Connect for their accounts. + // Shows the envelope integration rule for the account, which indicates whether custom admins can enable Connect for their accounts. Enumeration values are: + // + // - `not_allowed` + // - `full` + // + // **Note**: Only SysAdmin users can change this setting. EnvelopeIntegrationAllowed string `json:"envelopeIntegrationAllowed,omitempty"` // Metadata that indicates whether the `envelopeIntegrationAllowed` property is editable. // EnvelopeIntegrationAllowedMetadata *SettingsMetadata `json:"envelopeIntegrationAllowedMetadata,omitempty"` // When **true**, enables Connect for an account. Note that Connect integration requires additional configuration that must be set up for it to take effect; this switch is only the on/off control for the account. + // + // **Note**: Only Admin users can change this setting, and only when `envelopeIntegrationAllowed` is set. EnvelopeIntegrationEnabled string `json:"envelopeIntegrationEnabled,omitempty"` // Metadata that indicates whether the `envelopeIntegrationEnabled` property is editable. // EnvelopeIntegrationEnabledMetadata *SettingsMetadata `json:"envelopeIntegrationEnabledMetadata,omitempty"` - // Specifies the default value for Envelope ID stamping. + // When set to **true**, envelopes sent by this account automatically have the envelope ID stamped in the document margins, unless the sender selects not to have the documents stamped. EnvelopeStampingDefaultValue string `json:"envelopeStampingDefaultValue,omitempty"` // Metadata that indicates whether the `envelopeStampingDefaultValue` property is editable. // @@ -1769,15 +2177,23 @@ type AccountSettingsInformation struct { // - `e_pad_integrisign` // - `topaz_sigplusextlite` // + // **Note**: Only Admin users can change this setting. + // ExternalSignaturePadType string `json:"externalSignaturePadType,omitempty"` // Metadata that indicates whether the `externalSignaturePadType` property is editable. // ExternalSignaturePadTypeMetadata *SettingsMetadata `json:"externalSignaturePadTypeMetadata,omitempty"` - // Boolean that specifies whether fax delivery to recipients is allowed for the account. + // When set to **true**, fax delivery to recipients is allowed for the account. + // + // **Note**: Only Admin users can change this setting. FaxOutEnabled string `json:"faxOutEnabled,omitempty"` // Metadata that indicates whether the `faxOutEnabled` property is editable. // FaxOutEnabledMetadata *SettingsMetadata `json:"faxOutEnabledMetadata,omitempty"` + // When set to **true**, HTML used to implement [Guided Forms](https://www.docusign.com/products/guided-forms) is enabled for the account. + GUIDEDFormsHTMLAllowed string `json:"guidedFormsHtmlAllowed,omitempty"` + // + GUIDEDFormsHTMLAllowedMetadata *SettingsMetadata `json:"guidedFormsHtmlAllowedMetadata,omitempty"` // Boolean that specifies whether to hide the account address in the Certificate of Completion. HideAccountAddressInCoC string `json:"hideAccountAddressInCoC,omitempty"` // Metadata that indicates whether the `hideAccountAddressInCoC` property is editable. @@ -1794,8 +2210,12 @@ type AccountSettingsInformation struct { // // - `always`: Users are required to authenticate each time. // - `variable`: If the authentication for a user is valid and falls within the value for the `idCheckExpireDays` property, the user is not required to authenticate again. + // + // **Note**: Only Admin users can change this setting. IDCheckExpire string `json:"idCheckExpire,omitempty"` // The number of days before user authentication credentials expire. A value of `0` specifies that users must re-authenticate for each new session. + // + // **Note**: Only Admin users can change this setting. IDCheckExpireDays string `json:"idCheckExpireDays,omitempty"` // Metadata that indicates whether the `idCheckExpireDays` property is editable. // @@ -1808,11 +2228,13 @@ type AccountSettingsInformation struct { // Metadata that indicates whether the `idCheckExpireMinutes` property is editable. // IDCheckExpireMinutesMetadata *SettingsMetadata `json:"idCheckExpireMinutesMetadata,omitempty"` - // Determines how authentication is configured for the account. Valid values are: + // Indicates if authentication is configured for the account. Valid values are: // // - `always`: Authentication checks are performed on every envelope. // - `never`: Authentication checks are not performed on any envelopes. - // - `optional:` Authentication is configurable per envelope. + // - `optional`: Authentication is configurable per envelope. + // + // **Note**: Only Admin users can change this setting. IDCheckRequired string `json:"idCheckRequired,omitempty"` // Metadata that indicates whether the `idCheckRequired` property is editable. // @@ -1827,6 +2249,8 @@ type AccountSettingsInformation struct { // Reserved for DocuSign. IgnoreErrorIfAnchorTabNotFoundMetadataEnabled *SettingsMetadata `json:"ignoreErrorIfAnchorTabNotFoundMetadataEnabled,omitempty"` // A text field containing the question that an in-person signing host uses to collect personal information from the recipient. The recipient's response to this question is saved and can be viewed in the certificate associated with the envelope. + // + // **Note**: Only Admin users can change this setting. InPersonIDCheckQuestion string `json:"inPersonIDCheckQuestion,omitempty"` // Metadata that indicates whether the `inPersonIDCheckQuestion` property is editable. // @@ -1837,33 +2261,43 @@ type AccountSettingsInformation struct { // InPersonSigningEnabledMetadata *SettingsMetadata `json:"inPersonSigningEnabledMetadata,omitempty"` // When **true**, the account can send in-session (embedded) envelopes. + // + // **Note**: Only Admin users can change this setting. InSessionEnabled string `json:"inSessionEnabled,omitempty"` // Metadata that indicates whether the `inSessionEnabled` property is editable. // InSessionEnabledMetadata *SettingsMetadata `json:"inSessionEnabledMetadata,omitempty"` - // When **true**, emails cannot be sent to the in-session (embedded) recipients on an envelope. + // When set to **true**, emails are not sent to the in-session (embedded) recipients on an envelope. + // + // **Note**: Only Admin users can change this setting. InSessionSuppressEmails string `json:"inSessionSuppressEmails,omitempty"` // Metadata that indicates whether the `inSessionSuppressEmails` property is editable. // InSessionSuppressEmailsMetadata *SettingsMetadata `json:"inSessionSuppressEmailsMetadata,omitempty"` // The maximum number of custom stamps. MaxNumberOfCustomStamps string `json:"maxNumberOfCustomStamps,omitempty"` - // The maximum number of signing groups allowed for the account. + // The maximum number of signing groups allowed on the account. The default value is `50`. This setting is only shown in responses that list account settings. + // + // **Note**: Only SysAdmin users can change this setting. MaximumSigningGroups string `json:"maximumSigningGroups,omitempty"` // Metadata that indicates whether the `maximumSigningGroups` property is editable. // MaximumSigningGroupsMetadata *SettingsMetadata `json:"maximumSigningGroupsMetadata,omitempty"` - // The maximum number of users per signing group. + // The maximum number of users per signing group. The default value is `50`. This setting is only shown in responses that list account settings. + // + // **Note**: Only SysAdmin users can change this setting. MaximumUsersPerSigningGroup string `json:"maximumUsersPerSigningGroup,omitempty"` // Metadata that indicates whether the `maximumUsersPerSigningGroup` property is editable. // MaximumUsersPerSigningGroupMetadata *SettingsMetadata `json:"maximumUsersPerSigningGroupMetadata,omitempty"` // The number of minutes of inactivity before a mobile user is automatically logged out of the system. Valid values are `1` to `120` minutes. The default value is `20` minutes. + // + // **Note**: Only Admin users can change this setting. MobileSessionTimeout string `json:"mobileSessionTimeout,omitempty"` // Metadata that indicates whether the `mobileSessionTimeout` property is editable. // MobileSessionTimeoutMetadata *SettingsMetadata `json:"mobileSessionTimeoutMetadata,omitempty"` - // The number of custom stamps currently active. + // The number of active custom stamps associated with the account. DocuSign calculates this number automatically. This property is only visible to the DocuSign account manager. NumberOfActiveCustomStamps string `json:"numberOfActiveCustomStamps,omitempty"` // Boolean that specifies whether to opt in for Signing v02 on Mobile Devices functionality. OptInMobileSigningV02 string `json:"optInMobileSigningV02,omitempty"` @@ -1880,61 +2314,80 @@ type AccountSettingsInformation struct { // Metadata that indicates whether the `optOutNewPlatformSealPlatform` property is editable. // OptOutNewPlatformSealPlatformMetadata *SettingsMetadata `json:"optOutNewPlatformSealPlatformMetadata,omitempty"` - // Boolean that specifies whether to allow a recipient to provide a phone number, for an account that uses Phone Authentication. + // When set to **true**, senders can allow recipients to provide a phone number for the Phone Authentication process. + // + // **Note**: Only Admin users can change this setting. PhoneAuthRecipientMayProvidePhoneNumber string `json:"phoneAuthRecipientMayProvidePhoneNumber,omitempty"` // Metadata that indicates whether the `phoneAuthRecipientMayProvidePhoneNumber` property is editable. // PhoneAuthRecipientMayProvidePhoneNumberMetadata *SettingsMetadata `json:"phoneAuthRecipientMayProvidePhoneNumberMetadata,omitempty"` - // Always **true**. - // Specifies that PDF files - // downloaded from the platform - // are signed. + // The policy for adding a digital certificate to downloaded, printed, and emailed documents. + // + // Possible values are: + // + // - `no_sign` + // - `no_sign_allow_user_override` + // - `yes_sign` (Specifies that PDF files downloaded from the platform are signed.) + // + // **Note**: Only Admin users can change this setting. // PkiSignDownloadedPDFDocs string `json:"pkiSignDownloadedPDFDocs,omitempty"` // Metadata that indicates whether the `pkiSignDownloadedPDFDocs` property is editable. // PkiSignDownloadedPDFDocsMetadata *SettingsMetadata `json:"pkiSignDownloadedPDFDocsMetadata,omitempty"` - // Boolean that specifies whether recipients recieving envelopes from this account can override autonav functionality. + // When set to **true**, recipients receiving envelopes from this account can override auto-navigation functionality. + // + // **Note**: Only Admin users can change this setting. + // RecipientSigningAutoNavigationControl string `json:"recipientSigningAutoNavigationControl,omitempty"` // Metadata that indicates whether the `recipientSigningAutoNavigationControl` property is editable. // RecipientSigningAutoNavigationControlMetadata *SettingsMetadata `json:"recipientSigningAutoNavigationControlMetadata,omitempty"` - // If **true**, - // recipients recieving envelopes from this account + // When set to **true**, + // recipients receiving envelopes from this account // can sign offline. // + // **Note**: Only Admin users can change this setting. + // RecipientsCanSignOffline string `json:"recipientsCanSignOffline,omitempty"` // Metadata that indicates whether the `recipientsCanSignOffline` property is editable. // RecipientsCanSignOfflineMetadata *SettingsMetadata `json:"recipientsCanSignOfflineMetadata,omitempty"` - // If **true**, + // When set to **true**, // recipients are required // to use a 21 CFR part 11-compliant signing experience. // + // **Note**: Only Admin users can change this setting. + // Require21CFRpt11Compliance string `json:"require21CFRpt11Compliance,omitempty"` // Metadata that indicates whether the `require21CFRpt11Compliance` property is editable. // Require21CFRpt11ComplianceMetadata *SettingsMetadata `json:"require21CFRpt11ComplianceMetadata,omitempty"` - // If **true**, - // requires signers who decline to sign an envelope sent from this account - // to provide a reason for declining. + // When set to **true**, signers who decline to sign an envelope sent from this account + // are required to provide a reason for declining. + // + // **Note**: Only Admin users can change this setting. // RequireDeclineReason string `json:"requireDeclineReason,omitempty"` // Metadata that indicates whether the `requireDeclineReason` property is editable. // RequireDeclineReasonMetadata *SettingsMetadata `json:"requireDeclineReasonMetadata,omitempty"` - // Boolean that specifies whether to require external managing of users in an account. + // When set to **true**, the account requires external management of users. + // + // **Note**: Only Admin users can change this setting. + // RequireExternalUserManagement string `json:"requireExternalUserManagement,omitempty"` // Metadata that indicates whether the `requireExternalUserManagement` property is editable. // RequireExternalUserManagementMetadata *SettingsMetadata `json:"requireExternalUserManagementMetadata,omitempty"` + // Sets the Digital Signature certificate requirements for sending envelopes. // Valid values are: // - // - `none` - // - `docusign_express` - // - `docusign_personal` + // - `none`: A Digital Signature certificate is not required. + // - `docusign_express`: Signers must use a DocuSign Express certificate. + // - `docusign_personal`: Signers must use a DocuSign personal certificate. // - `safe` - // - `open_trust` + // - `open_trust`: Signers must use an OpenTrust certificate. // RequireSignerCertificateType string `json:"requireSignerCertificateType,omitempty"` // Metadata that indicates whether the `requireSignerCertificateType` property is editable. @@ -1942,50 +2395,55 @@ type AccountSettingsInformation struct { RequireSignerCertificateTypeMetadata *SettingsMetadata `json:"requireSignerCertificateTypeMetadata,omitempty"` // The RSA account name. // - // **Note:** - // Modifying this value may disrupt your ID Check capability. + // **Note**: + // Only Admin users can change this setting. Modifying this value may disrupt + // your ID Check capability. // Ensure you have the correct value before changing it. // RsaVeridAccountName string `json:"rsaVeridAccountName,omitempty"` - // The password used with the RSA account. + // The password for the RSA account. // // - // **Note:** - // Modifying this value may disrupt your ID Check capability. + // **Note**: + // Only Admin users can change this setting. Modifying this value may disrupt + // your ID Check capability. // Ensure you have the correct value before changing it. // - // - // RsaVeridPassword string `json:"rsaVeridPassword,omitempty"` // The RSA rule set used with the account. // - // **Note:** - // Modifying this value may disrupt your ID Check capability. + // **Note**: + // Only Admin users can change this setting. Modifying this value may disrupt + // your ID Check capability. // Ensure you have the correct value before changing it. // - // - // RsaVeridRuleset string `json:"rsaVeridRuleset,omitempty"` // The user ID for the RSA account. // - // **Note:** - // Modifying this value may disrupt your ID Check capability. + // **Note**: + // Only Admin users can change this setting. Modifying this value may disrupt + // your ID Check capability. // Ensure you have the correct value before changing it. // - // RsaVeridUserID string `json:"rsaVeridUserId,omitempty"` + // Sets how self-signed documents are presented to the email recipients. // Valid values are: // - // - `include_pdf` - // - `include_link` + // - `include_pdf`: A PDF of the completed document is attached to the email. + // - `include_link`: A secure link to the self-signed documents is included + // in the email. + // + // **Note**: Only Admin users can change this setting. // SelfSignedRecipientEmailDocument string `json:"selfSignedRecipientEmailDocument,omitempty"` // Metadata that indicates whether the `selfSignedRecipientEmailDocument` property is editable. // SelfSignedRecipientEmailDocumentMetadata *SettingsMetadata `json:"selfSignedRecipientEmailDocumentMetadata,omitempty"` - // When **true** the `selfSignedRecipientEmailDocument` user setting can be set for an individual user. - // The user setting overrides the account setting. + // When set to **true**, the `selfSignedRecipientEmailDocument` user setting + // can be set for an individual user. + // The user setting overrides the account setting. // + // **Note**: Only Admin users can change this account setting. // SelfSignedRecipientEmailDocumentUserOverride string `json:"selfSignedRecipientEmailDocumentUserOverride,omitempty"` // Metadata that indicates whether the `selfSignedRecipientEmailDocumentUserOverride` property is editable. @@ -1999,19 +2457,28 @@ type AccountSettingsInformation struct { // Metadata that indicates whether the `sendToCertifiedDeliveryEnabled` property is editable. // SendToCertifiedDeliveryEnabledMetadata *SettingsMetadata `json:"sendToCertifiedDeliveryEnabledMetadata,omitempty"` - // Boolean that specifies whether a signer can draw their signature in each location where a sign or initial tab exsts. This is typically used for mobile signing. + // When set to **true**, a signer can draw their signature in each + // location where a sign or initial tab exists. This functionality + // is typically used for mobile signing. + // + // **Note**: Only Admin users can change this setting. + // SenderCanSignInEachLocation string `json:"senderCanSignInEachLocation,omitempty"` // Metadata that indicates whether the `senderCanSignInEachLocation` property is editable. // SenderCanSignInEachLocationMetadata *SettingsMetadata `json:"senderCanSignInEachLocationMetadata,omitempty"` - // When *true*, a sender who is also a recipient of an envelope + // When set to **true**, a sender who is also a recipient of an envelope // must follow the authentication requirements for the envelope. // + // **Note**: Only Admin users can change this setting. + // SenderMustAuthenticateSigning string `json:"senderMustAuthenticateSigning,omitempty"` // Metadata that indicates whether the `senderMustAuthenticateSigning` property is editable. // SenderMustAuthenticateSigningMetadata *SettingsMetadata `json:"senderMustAuthenticateSigningMetadata,omitempty"` - // The account-wide default font color to use for the content of the tab: + // The account-wide default font color to use for the content of the tab. + // + // Valid values are: // // - `Black` // - `BrightBlue` @@ -2023,6 +2490,7 @@ type AccountSettingsInformation struct { // - `NavyBlue` // - `Purple` // - `White` + // SendingTagsFontColor string `json:"sendingTagsFontColor,omitempty"` // Metadata that indicates whether the `sendingTagsFontColor` property is editable. // @@ -2078,48 +2546,11 @@ type AccountSettingsInformation struct { // Metadata that indicates whether the `sessionTimeout` property is editable. // SessionTimeoutMetadata *SettingsMetadata `json:"sessionTimeoutMetadata,omitempty"` - // The language to be used for email to a recipient. If set for one recipient, this overrides the Envelope Subject and EmailBlurb. Supported languages, with the language value shown in parenthesis, are: - // - Arabic (ar) - // - Bahasa Indonesia (id) - // - Bahasa Melayu (ms) - // - Bulgarian (bg) - // - Czech (cs) - // - Chinese Simplified (zh_CN) - // - Chinese Traditional (zh_TW) - // - Croatian (hr) - // - Danish (da) - // - Dutch (nl) - // - English US (en) - // - English UK (en_GB) - // - Estonian (et) - // - Farsi (fa) - // - Finnish (fi) - // - French (fr) - // - French Canada (fr_CA) - // - German (de) - // - Greek (el) - // - Hebrew (he) - // - Hindi (hi) - // - Hungarian (hu) - // - Italian (it) - // - Japanese (ja) - // - Korean (ko) - // - Latvian (lv) - // - Lithuanian (lt) - // - Norwegian (no) - // - Polish (pl) - // - Portuguese (pt) - // - Portuguese Brazil (pt_BR) - // - Romanian (ro),Russian (ru) - // - Serbian (sr) - // - Slovak (sk) - // - Slovenian (sl) - // - Spanish (es),Spanish Latin America (es_MX) - // - Swedish (sv) - // - Thai (th) - // - Turkish (tr) - // - Ukrainian (uk) - // - Vietnamese (vi) + // When set to **true**, senders can set the email language to use for + // each recipient. + // + // **Note**: Only Admin users can change this setting. + // SetRecipEmailLang string `json:"setRecipEmailLang,omitempty"` // Metadata that indicates whether the `setRecipEmailLang` property is editable. // @@ -2128,8 +2559,10 @@ type AccountSettingsInformation struct { // setting a unique language for a recipient // not only affects the email language, but also the signing // language they are presented with. If **false**, only the email will - // be affected by the sender specifying a unique language for a - // recipient + // be affected when the sender specifies a unique language for a + // recipient. + // + // **Note**: Only Admin users can change this setting. // SetRecipSignLang string `json:"setRecipSignLang,omitempty"` // Metadata that indicates whether the `setRecipSignLang` property is editable. @@ -2145,6 +2578,10 @@ type AccountSettingsInformation struct { // Metadata that indicates whether the `showCompleteDialogInEmbeddedSession` property is editable. // ShowCompleteDialogInEmbeddedSessionMetadata *SettingsMetadata `json:"showCompleteDialogInEmbeddedSessionMetadata,omitempty"` + // When set to **true**, Conditional Routing options display to senders during the sending experience. + ShowConditionalRoutingOnSend string `json:"showConditionalRoutingOnSend,omitempty"` + // + ShowConditionalRoutingOnSendMetadata *SettingsMetadata `json:"showConditionalRoutingOnSendMetadata,omitempty"` // Boolean that specifies whether conditional field options are initially displayed (before a user makes entries). ShowInitialConditionalFields string `json:"showInitialConditionalFields,omitempty"` // Metadata that indicates whether the `showInitialConditionalFields` property is editable. @@ -2164,7 +2601,6 @@ type AccountSettingsInformation struct { ShowTutorialsMetadata *SettingsMetadata `json:"showTutorialsMetadata,omitempty"` // The format for the signature date. Valid values are: // - // // - `d/M/yyyy` // - `dd-MM-yy` // - `dd-MMM-yy` @@ -2184,7 +2620,7 @@ type AccountSettingsInformation struct { // - `yyyy/MM/dd` // - `yyyy MMMM d` // - // + // **Note**: Only Admin users can change this setting. // SignDateFormat string `json:"signDateFormat,omitempty"` // Metadata that indicates whether the `signDateFormat` property is editable. @@ -2214,69 +2650,98 @@ type AccountSettingsInformation struct { // Metadata that indicates whether the `signatureProviders` property is editable. // SignatureProvidersMetadata *SettingsMetadata `json:"signatureProvidersMetadata,omitempty"` - // If **true**, - // the certificate of completion is included in the envelope documents PDF when it is downloaded. + // When set to **true**, + // the Certificate of Completion is included in the PDF of the envelope documents + // when it is downloaded. + // + // **Note**: Only Admin users can change this setting. // SignerAttachCertificateToEnvelopePDF string `json:"signerAttachCertificateToEnvelopePDF,omitempty"` // Metadata that indicates whether the `signerAttachCertificateToEnvelopePDF` property is editable. // SignerAttachCertificateToEnvelopePDFMetadata *SettingsMetadata `json:"signerAttachCertificateToEnvelopePDFMetadata,omitempty"` - // If **true**, signer attachments are added to the parent document + // When set to **true**, signer attachments are added to the parent document // that contains the attachment. // The default behavior creates // a new document in the envelope for every signer attachment. // + // **Note**: Only Admin users can change this setting. + // SignerAttachConcat string `json:"signerAttachConcat,omitempty"` // Metadata that indicates whether the `signerAttachConcat` property is editable. // SignerAttachConcatMetadata *SettingsMetadata `json:"signerAttachConcatMetadata,omitempty"` - // If **true**, - // the signer can create a DocuSign account + // When set to **true**, + // a signer can create a DocuSign account // after signing. // + // **Note**: Only Admin users can change this setting. + // SignerCanCreateAccount string `json:"signerCanCreateAccount,omitempty"` // Metadata that indicates whether the `signerCanCreateAccount` property is editable. // SignerCanCreateAccountMetadata *SettingsMetadata `json:"signerCanCreateAccountMetadata,omitempty"` - // When set to **true**, the recipient can sign on a mobile device. + // When set to **true**, recipients can sign on a mobile device. + // + // **Note**: Only Admin users can change this setting. + // SignerCanSignOnMobile string `json:"signerCanSignOnMobile,omitempty"` // Metadata that indicates whether the `signerCanSignOnMobile` property is editable. // SignerCanSignOnMobileMetadata *SettingsMetadata `json:"signerCanSignOnMobileMetadata,omitempty"` - // If **true**, - // send only a completed email to an in-session signer - // and only if in-session emails are not supressed. + // When set to **true**, an "envelope complete" email is sent to an in-session + // (embedded) or offline signer after DocuSign processes the envelope + // if in-session emails are not suppressed. + // + // **Note**: Only Admin users can change this setting. // SignerInSessionUseEnvelopeCompleteEmail string `json:"signerInSessionUseEnvelopeCompleteEmail,omitempty"` // Metadata that indicates whether the `signerInSessionUseEnvelopeCompleteEmail` property is editable. // SignerInSessionUseEnvelopeCompleteEmailMetadata *SettingsMetadata `json:"signerInSessionUseEnvelopeCompleteEmailMetadata,omitempty"` - // Speficies whether a signer has - // to log in. Valid values are: + // Sets the login requirements for signers. Valid values are: + // + // - `login_not_required`: Signers are not required to log in. + // - `login_required_if_account_holder`: If the signer has a DocuSign account, + // they must log in to sign the document. + // - `login_required_per_session`: The sender cannot send an envelope to anyone + // who does not have a DocuSign account. + // - `login_required_per_envelope`: The sender cannot send an envelope to anyone + // who does not have a DocuSign account, and the signer must also log in for + // each envelope they will sign. // - // - `login_not_required` - // - `login_required_if_account_holder` - // - `login_required_per_session` - // - `login_required_per_envelope` + // + // **Note**: Only Admin users can change this setting. If you use Direct PowerForms + // or captive (embedded signers), the "Account required" settings are bypassed for + // those signers. If your workflow requires that the signer have an account, + // you should not use those methods. // SignerLoginRequirements string `json:"signerLoginRequirements,omitempty"` // Metadata that indicates whether the `signerLoginRequirements` property is editable. // SignerLoginRequirementsMetadata *SettingsMetadata `json:"signerLoginRequirementsMetadata,omitempty"` - // When **true**, senders can only send an envelope to a recipient that has a DocuSign account. + // When set to **true**, senders can only send an envelope to a recipient + // that has a DocuSign account. + // + // **Note**: Only Account Administrators can change this setting. // SignerMustHaveAccount string `json:"signerMustHaveAccount,omitempty"` // Metadata that indicates whether the `signerMustHaveAccount` property is editable. // SignerMustHaveAccountMetadata *SettingsMetadata `json:"signerMustHaveAccountMetadata,omitempty"` - // When **true**, + // When set to **true**, // signers must log in to the DocuSign platform to sign an envelope. // + // **Note**: Only Admin users can change this setting. + // SignerMustLoginToSign string `json:"signerMustLoginToSign,omitempty"` // Metadata that indicates whether the `signerMustLoginToSign` property is editable. // SignerMustLoginToSignMetadata *SettingsMetadata `json:"signerMustLoginToSignMetadata,omitempty"` - // When **true**, the initial value of all SecureFields is written to the document when sent. + // When set to **true**, the initial values of all SecureFields are written + // to the document when it is sent. + // + // **Note**: Only Admin users can change this setting. // SignerShowSecureFieldInitialValues string `json:"signerShowSecureFieldInitialValues,omitempty"` // Metadata that indicates whether the `signerShowSecureFieldInitialValues` property is editable. @@ -2295,7 +2760,7 @@ type AccountSettingsInformation struct { SigningUIVersion string `json:"signingUiVersion,omitempty"` // Reserved for DocuSign. SigningUIVersionMetadata *SettingsMetadata `json:"signingUiVersionMetadata,omitempty"` - // + // When set to **true**, simplified sending is enabled for the account. The default value is **false**. SimplifiedSendingEnabled string `json:"simplifiedSendingEnabled,omitempty"` // Metadata that indicates whether the `simplifiedSendingEnabled` property is editable. // @@ -2337,17 +2802,17 @@ type AccountSettingsInformation struct { // Metadata that indicates whether the `startInAdvancedCorrect` property is editable. // StartInAdvancedCorrectMetadata *SettingsMetadata `json:"startInAdvancedCorrectMetadata,omitempty"` - // When **true**, this user must accept supplemental documents. + // When set to **true**, account users must accept supplemental documents when signing. SupplementalDocumentsMustAccept string `json:"supplementalDocumentsMustAccept,omitempty"` // Metadata that indicates whether the `supplementalDocumentsMustAccept` property is editable. // SupplementalDocumentsMustAcceptMetadata *SettingsMetadata `json:"supplementalDocumentsMustAcceptMetadata,omitempty"` - // When **true**, this user must read supplemental documents. + // When set to **true**, account users must both view and accept supplemental documents when signing. SupplementalDocumentsMustRead string `json:"supplementalDocumentsMustRead,omitempty"` // Metadata that indicates whether the `supplementalDocumentsMustRead` property is editable. // SupplementalDocumentsMustReadMetadata *SettingsMetadata `json:"supplementalDocumentsMustReadMetadata,omitempty"` - // When **true**, this user must view supplemental documents. + // When set to **true**, account users must view supplemental documents when signing. SupplementalDocumentsMustView string `json:"supplementalDocumentsMustView,omitempty"` // Metadata that indicates whether the `supplementalDocumentsMustView` property is editable. // @@ -2580,12 +3045,16 @@ type AccountSettingsInformation struct { // Metadata that indicates whether the `useAccountLevelEmail` property is editable. // UseAccountLevelEmailMetadata *SettingsMetadata `json:"useAccountLevelEmailMetadata,omitempty"` - // Boolean that specifies whether the account uses an Electronic Record and Signature Disclosure Statement. + // When set to **true**, the account uses an Electronic Record and + // Signature Disclosure Statement. + // + // **Note**: Only Admin users can change this setting. + // UseConsumerDisclosure string `json:"useConsumerDisclosure,omitempty"` // Metadata that indicates whether the `useConsumerDisclosure` property is editable. // UseConsumerDisclosureMetadata *SettingsMetadata `json:"useConsumerDisclosureMetadata,omitempty"` - // Boolean that specifies whether recipients in the same account as the sender must agree to eSign an Electronic Record and Signature Disclosure Statement. + // When set to **true**, specifies that recipients in the same account as the sender must agree to eSign an Electronic Record and Signature Disclosure Statement. UseConsumerDisclosureWithinAccount string `json:"useConsumerDisclosureWithinAccount,omitempty"` // Metadata that indicates whether the `useConsumerDisclosureWithinAccount` property is editable. // @@ -2604,6 +3073,10 @@ type AccountSettingsInformation struct { // Metadata that indicates whether the `useDocuSignExpressSignerCertificate` property is editable. // UseDocuSignExpressSignerCertificateMetadata *SettingsMetadata `json:"useDocuSignExpressSignerCertificateMetadata,omitempty"` + // + UseMultiAppGroupsData string `json:"useMultiAppGroupsData,omitempty"` + // + UseMultiAppGroupsDataMetadata *SettingsMetadata `json:"useMultiAppGroupsDataMetadata,omitempty"` // Reserved for DocuSign. // UseNewBlobForPdf string `json:"useNewBlobForPdf,omitempty"` @@ -2623,9 +3096,11 @@ type AccountSettingsInformation struct { // Metadata that indicates whether the `useSignatureProviderPlatform` property is editable. // UseSignatureProviderPlatformMetadata *SettingsMetadata `json:"useSignatureProviderPlatformMetadata,omitempty"` - // If **true**, + // When set to **true**, // the account can use the API. // + // **Note**: Only SysAdmin users can change this setting. + // UsesAPI string `json:"usesAPI,omitempty"` // Metadata that indicates whether the `usesAPI` property is editable. // @@ -2695,7 +3170,7 @@ type AccountSettingsInformation struct { type AccountSharedAccess struct { // The account ID associated with the envelope. AccountID string `json:"accountId,omitempty"` - // The last position in the result set. + // The last index position in the result set. EndPosition string `json:"endPosition,omitempty"` // A complex type containing an errorCode and message identifying the error that occurred. ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` @@ -2703,73 +3178,328 @@ type AccountSharedAccess struct { NextURI string `json:"nextUri,omitempty"` // The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. PreviousURI string `json:"previousUri,omitempty"` - // The number of results returned in this response. Because you can filter which entries are included in the response, this value is always less than or equal to `totalSetSize`. + // The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`. ResultSetSize string `json:"resultSetSize,omitempty"` // A list of shared access information of envelope and templates for the users specified in the request. SharedAccess []MemberSharedItems `json:"sharedAccess,omitempty"` - // The starting position of the current result set. + // The starting index position of the current result set. StartPosition string `json:"startPosition,omitempty"` - // The total number of items in the search's result set. This value is always greater than or equal to the value of `resultSetSize`. + // The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`. TotalSetSize string `json:"totalSetSize,omitempty"` } -// AccountSignatureProvider signature provider associated with the identity verification workflow. -// If empty, then this specific workflow is not intended for signers +type AccountSignature struct { + // The UTC date and time when the user adopted the signature. + AdoptedDateTime string `json:"adoptedDateTime,omitempty"` + // The UTC DateTime when the item was created. + CreatedDateTime string `json:"createdDateTime,omitempty"` + // + CustomField string `json:"customField,omitempty"` + // Specifies the area in which a date stamp is placed. This parameter uses pixel positioning to draw a rectangle at the center of the stamp area. The stamp is superimposed on top of this central area. + // + // This property contains the following information about the central rectangle: + // + // - `DateAreaX`: The X axis position of the top-left corner. + // - `DateAreaY`: The Y axis position of the top-left corner. + // - `DateAreaWidth`: The width of the rectangle. + // - `DateAreaHeight`: The height of the rectangle. + DateStampProperties *DateStampProperties `json:"dateStampProperties,omitempty"` + // When set to **true**, users may not resize the stamp. + DisallowUserResizeStamp string `json:"disallowUserResizeStamp,omitempty"` + // This object describes errors that occur. It is only valid for responses and ignored in requests. + ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` + // Optionally specify an external identifier for the user's signature. + ExternalID string `json:"externalID,omitempty"` + // + ImageBase64 string `json:"imageBase64,omitempty"` + // Specificies the type of image. Valid values are: + // + // - `signature_image` + // - `initials_image` + ImageType string `json:"imageType,omitempty"` + // The ID of the user's initials image. + Initials150ImageID string `json:"initials150ImageId,omitempty"` + // The URI for retrieving the image of the user's initials. + InitialsImageURI string `json:"initialsImageUri,omitempty"` + // Boolean that specifies whether the signature is the default signature for the user. + IsDefault string `json:"isDefault,omitempty"` + // The date and time that the item was last modified. + LastModifiedDateTime string `json:"lastModifiedDateTime,omitempty"` + // The National Association of Realtors (NAR) membership ID for a user who is a realtor. + NrdsID string `json:"nrdsId,omitempty"` + // The realtor's last name. + NrdsLastName string `json:"nrdsLastName,omitempty"` + // The realtor's NAR membership status. The value `active` verifies that the user is a current NAR member. Valid values are: + // + // - `Active` + // - `Inactive` + // - `Terminate` + // - `Provisional` + // - `Deceased` + // - `Suspend` + // - `Unknown` + NrdsStatus string `json:"nrdsStatus,omitempty"` + // The phonetic spelling of the `signatureName`. + PhoneticName string `json:"phoneticName,omitempty"` + // The ID of the user's signature image. + Signature150ImageID string `json:"signature150ImageId,omitempty"` + // The font type to use for the signature if the signature is not drawn. The following font styles are supported. The quotes are to indicate that these values are strings, not `enums`. + // + // - `"1_DocuSign"` + // - `"2_DocuSign"` + // - `"3_DocuSign"` + // - `"4_DocuSign"` + // - `"5_DocuSign"` + // - `"6_DocuSign"` + // - `"7_DocuSign"` + // - `"8_DocuSign"` + // - `"Mistral"` + // - `"Rage Italic"` + // + SignatureFont string `json:"signatureFont,omitempty"` + // + SignatureGroups []SignatureGroup `json:"signatureGroups,omitempty"` + // Specifies the signature ID associated with the signature name. You can use the signature ID in the URI in place of the signature name, and the value stored in the `signatureName` property in the body is used. This allows the use of special characters (such as "&", "<", ">") in a the signature name. Note that with each update to signatures, the returned signature ID might change, so the caller will need to trigger off the signature name to get the new signature ID. + SignatureID string `json:"signatureId,omitempty"` + // An endpoint URI that you can use to retrieve the user's signature image. + SignatureImageURI string `json:"signatureImageUri,omitempty"` + // Specifies the user's signature in initials format. + SignatureInitials string `json:"signatureInitials,omitempty"` + // Specifies the user's signature name. + SignatureName string `json:"signatureName,omitempty"` + // The rights that the user has to the signature. Valid values are: + // + // - `none` + // - `read` + // - `admin` + SignatureRights string `json:"signatureRights,omitempty"` + // Specifies the type of signature. + SignatureType string `json:"signatureType,omitempty"` + // + SignatureUsers []SignatureUser `json:"signatureUsers,omitempty"` + // The format of a stamp. Valid values are: + // + // - `NameHanko`: The stamp represents only the signer's name. + // - `NameDateHanko`: The stamp represents the signer's name and the date. + StampFormat string `json:"stampFormat,omitempty"` + // The URI for retrieving the image of the user's stamp. + StampImageURI string `json:"stampImageUri,omitempty"` + // The physical height of the stamp image (in millimeters) that the stamp vendor recommends for displaying the image in PDF documents. + StampSizeMM string `json:"stampSizeMM,omitempty"` + // The type of stamp. Valid values are: + // + // - `signature`: A signature image. This is the default value. + // - `stamp`: A stamp image. + // - null + StampType string `json:"stampType,omitempty"` + // Indicates the envelope status. Valid values are: + // + // * sent - The envelope is sent to the recipients. + // * created - The envelope is saved as a draft and can be modified and sent later. + Status string `json:"status,omitempty"` +} + +type AccountSignatureDefinition struct { + // Specifies the area in which a date stamp is placed. This parameter uses pixel positioning to draw a rectangle at the center of the stamp area. The stamp is superimposed on top of this central area. + // + // This property contains the following information about the central rectangle: + // + // - `DateAreaX`: The X axis position of the top-left corner. + // - `DateAreaY`: The Y axis position of the top-left corner. + // - `DateAreaWidth`: The width of the rectangle. + // - `DateAreaHeight`: The height of the rectangle. + DateStampProperties *DateStampProperties `json:"dateStampProperties,omitempty"` + // When set to **true**, users may not resize the stamp. + DisallowUserResizeStamp string `json:"disallowUserResizeStamp,omitempty"` + // Optionally specify an external identifier for the user's signature. + ExternalID string `json:"externalID,omitempty"` + // Specificies the type of image. Valid values are: + // + // - `signature_image` + // - `initials_image` + ImageType string `json:"imageType,omitempty"` + // Boolean that specifies whether the signature is the default signature for the user. + IsDefault string `json:"isDefault,omitempty"` + // The National Association of Realtors (NAR) membership ID for a user who is a realtor. + NrdsID string `json:"nrdsId,omitempty"` + // The realtor's last name. + NrdsLastName string `json:"nrdsLastName,omitempty"` + // The phonetic spelling of the `signatureName`. + PhoneticName string `json:"phoneticName,omitempty"` + // The font type to use for the signature if the signature is not drawn. The following font styles are supported. The quotes are to indicate that these values are strings, not `enums`. + // + // - `"1_DocuSign"` + // - `"2_DocuSign"` + // - `"3_DocuSign"` + // - `"4_DocuSign"` + // - `"5_DocuSign"` + // - `"6_DocuSign"` + // - `"7_DocuSign"` + // - `"8_DocuSign"` + // - `"Mistral"` + // - `"Rage Italic"` + // + SignatureFont string `json:"signatureFont,omitempty"` + // + SignatureGroups []SignatureGroupDef `json:"signatureGroups,omitempty"` + // Specifies the signature ID associated with the signature name. You can use the signature ID in the URI in place of the signature name, and the value stored in the `signatureName` property in the body is used. This allows the use of special characters (such as "&", "<", ">") in a the signature name. Note that with each update to signatures, the returned signature ID might change, so the caller will need to trigger off the signature name to get the new signature ID. + SignatureID string `json:"signatureId,omitempty"` + // Specifies the user's signature in initials format. + SignatureInitials string `json:"signatureInitials,omitempty"` + // Specifies the user's signature name. + SignatureName string `json:"signatureName,omitempty"` + // + SignatureUsers []SignatureUserDef `json:"signatureUsers,omitempty"` + // The format of a stamp. Valid values are: + // + // - `NameHanko`: The stamp represents only the signer's name. + // - `NameDateHanko`: The stamp represents the signer's name and the date. + StampFormat string `json:"stampFormat,omitempty"` + // The physical height of the stamp image (in millimeters) that the stamp vendor recommends for displaying the image in PDF documents. + StampSizeMM string `json:"stampSizeMM,omitempty"` +} + +// AccountSignatureProvider contains information abotu the signature provider associated with the Identity Verification workflow. +// If empty, then this specific workflow is not intended for signers. // type AccountSignatureProvider struct { - // The name of an Electronic or Standards Based Signature (digital signature) provider for the signer to use. [The current provider list.](https://developers.docusign.com/esign-rest-api/guides/standards-based-signatures) + // Reserved for DocuSign. + IsRequired string `json:"isRequired,omitempty"` + // Reserved for DocuSign. + Priority string `json:"priority,omitempty"` + // Reserved for DocuSign. + SignatureProviderDisplayName string `json:"signatureProviderDisplayName,omitempty"` + // Reserved for DocuSign. + SignatureProviderID string `json:"signatureProviderId,omitempty"` + // The name of an Electronic or Standards Based Signature (digital signature) provider for the signer to use. For details, see [the current provider list](https://developers.docusign.com/esign-rest-api/guides/standards-based-signatures). You can also retrieve the list by using the [AccountSignatureProviders::List](https://developers.docusign.com/esign-rest-api/reference/Accounts/AccountSignatureProviders/list/) method. + // + // Example: `universalsignaturepen_default` + // + // SignatureProviderName string `json:"signatureProviderName,omitempty"` + // Reserved for DocuSign. + SignatureProviderOptionsMetadata []AccountSignatureProviderOption `json:"signatureProviderOptionsMetadata,omitempty"` + // Reserved for DocuSign. + SignatureProviderRequiredOptions []SignatureProviderRequiredOption `json:"signatureProviderRequiredOptions,omitempty"` } +// AccountSignatureProviderOption reserved for DocuSign. type AccountSignatureProviderOption struct { - // + // Reserved for DocuSign. SignatureProviderOptionDisplayName string `json:"signatureProviderOptionDisplayName,omitempty"` - // + // Reserved for DocuSign. SignatureProviderOptionID string `json:"signatureProviderOptionId,omitempty"` - // + // Reserved for DocuSign. SignatureProviderOptionName string `json:"signatureProviderOptionName,omitempty"` } -// AccountSignatureProviders account SBS Signature Providers +// AccountSignatureProviders this resource provides information on the Standards Based Signature providers that have been provisioned for an account. +// type AccountSignatureProviders struct { // Names of electronic or digital signature providers that can be used. SignatureProviders []AccountSignatureProvider `json:"signatureProviders,omitempty"` } -// AddOn contains information about add ons. -type AddOn struct { - // Reserved: - Active string `json:"active,omitempty"` - // Reserved: - AddOnID string `json:"addOnId,omitempty"` - // A unique ID for the Salesforce object. - ID string `json:"id,omitempty"` - // Reserved: - Name string `json:"name,omitempty"` -} - -// AddressInformation contains address information. -type AddressInformation struct { - // The first line of the user's address. - // Maximum length: 100 characters. - Address1 string `json:"address1,omitempty"` - // The second line of the user's address. - // Maximum length: 100 characters. - Address2 string `json:"address2,omitempty"` - // The user's city. - City string `json:"city,omitempty"` - // The user's country. - Country string `json:"country,omitempty"` - // A fax number associated with the address, if one is available. - Fax string `json:"fax,omitempty"` - // A phone number associated with the address. - Phone string `json:"phone,omitempty"` - // The user's postal code. - PostalCode string `json:"postalCode,omitempty"` - // The user's state or province. - StateOrProvince string `json:"stateOrProvince,omitempty"` +type AccountSignaturesInformation struct { + // + AccountSignatures []AccountSignature `json:"accountSignatures,omitempty"` } +// AccountUISettings is an object that defines the options that are available to non-administrators in the UI. +type AccountUISettings struct { + // + AdminMessage *AdminMessage `json:"adminMessage,omitempty"` + // + AskAnAdmin *AskAnAdmin `json:"askAnAdmin,omitempty"` + // + EnableAdminMessage string `json:"enableAdminMessage,omitempty"` + // + EnableAdminMessageMetadata *SettingsMetadata `json:"enableAdminMessageMetadata,omitempty"` + // + EnableAdvancedPaymentsReactEdit string `json:"enableAdvancedPaymentsReactEdit,omitempty"` + // + EnableEasySignCanUseMultiTemplateApply string `json:"enableEasySignCanUseMultiTemplateApply,omitempty"` + // + EnableEasySignCanUseMultiTemplateApplyMetadata *SettingsMetadata `json:"enableEasySignCanUseMultiTemplateApplyMetadata,omitempty"` + // + EnableEasySignTemplateUpload string `json:"enableEasySignTemplateUpload,omitempty"` + // + EnableEasySignTemplateUploadMetadata *SettingsMetadata `json:"enableEasySignTemplateUploadMetadata,omitempty"` + // + EnableEnvelopeCopyWithData string `json:"enableEnvelopeCopyWithData,omitempty"` + // + EnableEnvelopeCopyWithDataMetadata *SettingsMetadata `json:"enableEnvelopeCopyWithDataMetadata,omitempty"` + // + EnableLegacyHomepageLink string `json:"enableLegacyHomepageLink,omitempty"` + // + EnableLegacyHomepageLinkMetadata *SettingsMetadata `json:"enableLegacyHomepageLinkMetadata,omitempty"` + // + HideSendAnEnvelope string `json:"hideSendAnEnvelope,omitempty"` + // + HideSendAnEnvelopeMetadata *SettingsMetadata `json:"hideSendAnEnvelopeMetadata,omitempty"` + // When set to **true**, the **Templates** menu is hidden from account users who are not Admins. The default value is **false**. + HideUseATemplate string `json:"hideUseATemplate,omitempty"` + // + HideUseATemplateInPrepare string `json:"hideUseATemplateInPrepare,omitempty"` + // + HideUseATemplateInPrepareMetadata *SettingsMetadata `json:"hideUseATemplateInPrepareMetadata,omitempty"` + // + HideUseATemplateMetadata *SettingsMetadata `json:"hideUseATemplateMetadata,omitempty"` + // + OrderBasedRecipientIDGeneration string `json:"orderBasedRecipientIdGeneration,omitempty"` + // + OrderBasedRecipientIDGenerationMetadata *SettingsMetadata `json:"orderBasedRecipientIdGenerationMetadata,omitempty"` + // + RemoveEnvelopeForwarding string `json:"removeEnvelopeForwarding,omitempty"` + // + RemoveEnvelopeForwardingMetadata *SettingsMetadata `json:"removeEnvelopeForwardingMetadata,omitempty"` + // + ShouldRedactAccessCode string `json:"shouldRedactAccessCode,omitempty"` + // + ShouldRedactAccessCodeMetadata *SettingsMetadata `json:"shouldRedactAccessCodeMetadata,omitempty"` + // + UploadNewImageToSignOrInitial string `json:"uploadNewImageToSignOrInitial,omitempty"` + // + UploadNewImageToSignOrInitialMetadata *SettingsMetadata `json:"uploadNewImageToSignOrInitialMetadata,omitempty"` +} + +// AddOn contains information about add ons. +type AddOn struct { + // Reserved for DocuSign. + Active string `json:"active,omitempty"` + // Reserved for DocuSign. + AddOnID string `json:"addOnId,omitempty"` + // A unique ID for the Salesforce object. + ID string `json:"id,omitempty"` + // Reserved for DocuSign. + Name string `json:"name,omitempty"` +} + +// AddressInformation contains address information. +type AddressInformation struct { + // The first line of the user's address. + // Maximum length: 100 characters. + Address1 string `json:"address1,omitempty"` + // The second line of the user's address. + // Maximum length: 100 characters. + Address2 string `json:"address2,omitempty"` + // The user's city. Maximum length: 40 characters. + City string `json:"city,omitempty"` + // The user's country. Maximum length: 50 characters. + Country string `json:"country,omitempty"` + // A fax number associated with the address, if one is available. + Fax string `json:"fax,omitempty"` + // A phone number associated with the address. + Phone string `json:"phone,omitempty"` + // The user's postal code. Maximum length: 20 characters. + PostalCode string `json:"postalCode,omitempty"` + // The user's state or province. Maximum length: 40 characters. + StateOrProvince string `json:"stateOrProvince,omitempty"` + // + ZipPlus4 string `json:"zipPlus4,omitempty"` +} + +// AddressInformationInput contains address input information. type AddressInformationInput struct { // A complex type that contains the following information for the new account: `address1`, `address2`, `city`, `country`, `fax`, `phone`, `postalCode` and `stateOrProvince`. // @@ -2777,7 +3507,7 @@ type AddressInformationInput struct { // * `address1`, `address2`, `city`, `country` and `stateOrProvince`: 100 characters // * `postalCode`, `phone`, and `fax`: 20 characters // - // **Note:** If country is US (United States), `stateOrProvince` codes are validated. Otherwise, `stateOrProvince` is treated as a non-validated string used to specify a state, province, or region. + // **Note**: If country is US (United States), `stateOrProvince` codes are validated. Otherwise, `stateOrProvince` is treated as a non-validated string used to specify a state, province, or region. AddressInformation *AddressInformation `json:"addressInformation,omitempty"` // Specifies the display level for the recipient. Valid values are: // * `ReadOnly` @@ -2788,7 +3518,14 @@ type AddressInformationInput struct { ReceiveInResponse DSBool `json:"receiveInResponse,omitempty"` } -// Agent contains information about agent recipients. +type AdminMessage struct { + // + BaseMessage string `json:"baseMessage,omitempty"` + // + MoreInformation string `json:"moreInformation,omitempty"` +} + +// Agent contains information about an agent recipient. An agent is a recipient who can add name and email information for recipients that appear after the agent in routing order. type Agent struct { // If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. // @@ -2798,11 +3535,14 @@ type Agent struct { // // If blank and the signer `accessCode` property is not set, then the access code is not required. AccessCode string `json:"accessCode,omitempty"` - // Metadata that indicates whether the `accessCode` property is editable. - // + // Metadata that indicates whether the `accessCode` property is editable. Read only. AccessCodeMetadata *PropertyMetadata `json:"accessCodeMetadata,omitempty"` - // This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient. + // Optional. When set to **true**, the access code will be added to the email sent to the recipient. This nullifies the security measure of `accessCode` on the recipient. AddAccessCodeToEmail string `json:"addAccessCodeToEmail,omitempty"` + // An array of additional notification objects. + AdditionalNotifications []RecipientAdditionalNotification `json:"additionalNotifications,omitempty"` + // + AllowSystemOverrideForLockedRecipient string `json:"allowSystemOverrideForLockedRecipient,omitempty"` // Specifies whether the recipient is embedded or remote. // // If the `clientUserId` property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing. @@ -2811,36 +3551,37 @@ type Agent struct { // // Maximum length: 100 characters. ClientUserID string `json:"clientUserId,omitempty"` - // Indicates the number of times that the recipient has been through a signing completion for the envelope. - // - // If this number is greater than 0 for a signing group, only the user who previously completed may sign again. + // Indicates the number of times that the recipient has been through a signing completion for the envelope. If this number is greater than 0 for a signing group, only the user who previously completed may sign again. Read only. CompletedCount string `json:"completedCount,omitempty"` // An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters. CustomFields []string `json:"customFields,omitempty"` - // The date and time the recipient declined the document. + // The date and time the recipient declined the document. Read only. DeclinedDateTime *time.Time `json:"declinedDateTime,omitempty"` - // The reason the recipient declined the document. + // The reason the recipient declined the document. Read only. DeclinedReason string `json:"declinedReason,omitempty"` - // The date and time that the envelope was delivered to the recipient. + // The date and time that the envelope was delivered to the recipient. Read only. DeliveredDateTime *time.Time `json:"deliveredDateTime,omitempty"` // Reserved for DocuSign. DeliveryMethod string `json:"deliveryMethod,omitempty"` - // Metadata that indicates whether the `deliveryMethod` property is editable. - // + // Reserved for DocuSign. DeliveryMethodMetadata *PropertyMetadata `json:"deliveryMethodMetadata,omitempty"` - // A list of documentVisibility objects, which define a recipient's read/write access to a document. + // + DesignatorID string `json:"designatorId,omitempty"` + // + DesignatorIDGUID string `json:"designatorIdGuid,omitempty"` + // A list of `documentVisibility` objects. Each object in the list specifies whether a document in the envelope is visible to this recipient. For the envelope to use this functionality, Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true**. DocumentVisibility []DocumentVisibility `json:"documentVisibility,omitempty"` // The email id of the agent. Notification of the document to sign is sent to this email id. // // Maximum length: 100 characters. Email string `json:"email,omitempty"` - // Metadata that indicates if the sender can edit the email id of the agent. + // Metadata that indicates whether the `email` property is editable. Read only. EmailMetadata *PropertyMetadata `json:"emailMetadata,omitempty"` // An optional complex type that sets a specific email subject and body for this recipient's notification email. // - // **Note**: If you use this field to set a specific email notification for one recipient, you must also set the email notification for the other recipients. Using this field for one or more recipients negates the Envelope `Subject` and `EmailBlurb` property settings. + // **Note**: You can set the `emailNotification` property separately for each recipient. If you set the value only for certain recipients, the other recipients will inherit the this value from the top-level `emailSubject` and `emailBlurb`. EmailNotification *RecipientEmailNotification `json:"emailNotification,omitempty"` - // Specifies a sender-provided valid URL string for redirecting an embedded recipient. When this option is used, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the recipient clicks the document link in the email, the recipient is redirected through DocuSign to the specified URL to complete the required actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. + // Specifies a sender-provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. // // If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation launched by a partner. // @@ -2860,39 +3601,45 @@ type Agent struct { ExcludedDocuments DSBool `json:"excludedDocuments,omitempty"` // Reserved for DocuSign. FaxNumber string `json:"faxNumber,omitempty"` - // Metadata that indicates whether the `faxNumber` property is editable. - // + // Reserved for DocuSign. FaxNumberMetadata *PropertyMetadata `json:"faxNumberMetadata,omitempty"` - // The agent's first name. Maximum Length: 50 characters. + // The recipient's first name. Maximum Length: 50 characters. FirstName string `json:"firstName,omitempty"` - // Metadata that indicates if the sender can edit the agent's first name. + // Metadata that indicates whether the `firstame` property is editable. Read only. FirstNameMetadata *PropertyMetadata `json:"firstNameMetadata,omitempty"` // Reserved for DocuSign. FullName string `json:"fullName,omitempty"` // Reserved for DocuSign. FullNameMetadata *PropertyMetadata `json:"fullNameMetadata,omitempty"` - // The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. + // The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are: + // + // - `Phone Auth $`: The recipient must authenticate by using two-factor authentication (2FA). You provide the phone number to use for 2FA in the `phoneAuthentication` object. + // - `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object. + // - `ID Check $`: The recipient must answer detailed security questions. // // **Example**: Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node. IDCheckConfigurationName string `json:"idCheckConfigurationName,omitempty"` - // Metadata that indicates whether the `idCheckConfigurationName` property is editable. - // + // Metadata that indicates whether the `idCheckConfigurationName` property is editable. Read only. IDCheckConfigurationNameMetadata *PropertyMetadata `json:"idCheckConfigurationNameMetadata,omitempty"` // An object that contains input information related to a recipient ID check. IDCheckInformationInput *IDCheckInformationInput `json:"idCheckInformationInput,omitempty"` + // Specifies the ID Verification workflow applied on an envelope by workflow ID.
See the [list](https://developers.docusign.com/docs/esign-rest-api/reference/Accounts/IdentityVerifications/list) method in the [IdentityVerifications](https://developers.docusign.com/docs/esign-rest-api/reference/Accounts/IdentityVerifications) resource for more information on how to retrieve workflow IDs available for an account.
This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods.
Note that ID Verification and ID Check are two distinct methods. ID Verification checks recipients' identity by verifying their ID while ID Check relies on data available on public records (such as current and former address). + IdentityVerification *RecipientIdentityVerification `json:"identityVerification,omitempty"` // When set to **true** and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account. InheritEmailNotificationConfiguration DSBool `json:"inheritEmailNotificationConfiguration,omitempty"` - // The agent's last name. + // The recipient's last name. LastName string `json:"lastName,omitempty"` - // Metadata that indicates if the sender can edit the agent's last name. + // Metadata that indicates whether the `lastName` property is editable. Read only. LastNameMetadata *PropertyMetadata `json:"lastNameMetadata,omitempty"` // Reserved for DocuSign. LockedRecipientPhoneAuthEditable string `json:"lockedRecipientPhoneAuthEditable,omitempty"` // Reserved for DocuSign. LockedRecipientSmsEditable string `json:"lockedRecipientSmsEditable,omitempty"` - // The full legal name of the agent. + // The full legal name of the recipient. Maximum Length: 100 characters. + // + // **Note**: You must always set a value for this property in requests, even if `firstName` and `lastName` are set. Name string `json:"name,omitempty"` - // Metadata that indicates if the sender can edit the full legal name of the agent. + // Metadata that indicates whether the `name` property is editable. Read only. NameMetadata *PropertyMetadata `json:"nameMetadata,omitempty"` // A note sent to the recipient in the signing email. // This note is unique to this recipient. @@ -2904,82 +3651,92 @@ type Agent struct { // Maximum Length: 1000 characters. // Note string `json:"note,omitempty"` - // Metadata that indicates if the sender can edit the note sent to the recipient in the signing email. + // Metadata that indicates whether the `note` property is editable. Read only. NoteMetadata *PropertyMetadata `json:"noteMetadata,omitempty"` - // A complex type that contains the following elements: + // When `idCheckConfigurationName` is set to `Phone Auth $`, you use this complex type to provide the recipient authentication method details. It contains the following elements: + // + // * `recipMayProvideNumber`: Boolean. When set to **true**, the recipient can use whatever phone number they choose. + // * `senderProvidedNumbers`: ArrayOfStrings. A list of phone numbers the recipient can use. + // * `recordVoicePrint`: Reserved for DocuSign. + // * `validateRecipProvidedNumber`: Reserved for DocuSign. + // // - // * `recipMayProvideNumber` - Boolean. When set to **true**, the recipient can use whatever phone number they choose. - // * `senderProvidedNumbers` - ArrayOfString. A list of phone numbers the recipient can use. - // * `recordVoicePrint` - Reserved. - // * `validateRecipProvidedNumber` - Reserved. PhoneAuthentication DSBool `json:"phoneAuthentication,omitempty"` // Reserved for DocuSign. RecipientAttachments []RecipientAttachment `json:"recipientAttachments,omitempty"` - // Information about the recipient's authentication status. + // Information about the recipient's authentication status. Read only. RecipientAuthenticationStatus *AuthenticationStatus `json:"recipientAuthenticationStatus,omitempty"` - // Metadata that indicates whether the `recipientFeature` property is editable. - // + // Metadata about the features that are supported for the recipient type. Read only. RecipientFeatureMetadata []FeatureAvailableMetadata `json:"recipientFeatureMetadata,omitempty"` - // A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`. + // Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. RecipientID string `json:"recipientId,omitempty"` - // The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. + // The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only. RecipientIDGUID string `json:"recipientIdGuid,omitempty"` // The recipient type, as specified by the following values: - // - `agents`: Agent recipients can add name and email information for recipients that appear after the agent in routing order. - // - `carbonCopies`: Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date, or add information to any of the documents. This type of recipient can be used in any routing order. - // - `certifiedDeliveries`: Certified delivery recipients must receive the completed documents for the envelope to be completed. They don't need to sign, initial, date, or add information to any of the documents. - // - `editors`: Editors have the same management and access rights for the envelope as the sender. Editors can add name and email information, add or change the routing order, set authentication options, and can edit signature/initial tabs and data fields for the remaining recipients. - // - `inPersonSigners`: In-person recipients are DocuSign users who act as signing hosts in the same physical location as the signer. + // - `agent`: Agent recipients can add name and email information for recipients that appear after the agent in routing order. + // - `carbonCopy`: Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date, or add information to any of the documents. This type of recipient can be used in any routing order. + // - `certifiedDelivery`: Certified delivery recipients must receive the completed documents for the envelope to be completed. They don't need to sign, initial, date, or add information to any of the documents. + // - `editor`: Editors have the same management and access rights for the envelope as the sender. Editors can add name and email information, add or change the routing order, set authentication options, and can edit signature/initial tabs and data fields for the remaining recipients. + // - `inPersonSigner`: In-person recipients are DocuSign users who act as signing hosts in the same physical location as the signer. // - `intermediaries`: Intermediary recipients can optionally add name and email information for recipients at the same or subsequent level in the routing order. - // - `seals`: Electronic seal recipients represent legal entities. - // - `signers`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope. - // - `witnesses`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope. + // - `seal`: Electronic seal recipients represent legal entities. + // - `signer`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope. + // - `witness`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope. RecipientType string `json:"recipientType,omitempty"` - // Metadata that indicates whether the `recipientType` property is editable. - // + // Metadata that indicates whether the `recipientType` property is editable. Read only. RecipientTypeMetadata *PropertyMetadata `json:"recipientTypeMetadata,omitempty"` // When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. RequireIDLookup DSBool `json:"requireIdLookup,omitempty"` - // Metadata that indicates whether the `requireIdLookup` property is editable. - // + // Metadata that indicates whether the `requireIdLookup` property is editable. Read only. RequireIDLookupMetadata *PropertyMetadata `json:"requireIdLookupMetadata,omitempty"` - // Optional element. Specifies the role name associated with the recipient.

This is required when working with template recipients. + // Optional element. Specifies the role name associated with the recipient.

This property is required when you are working with template recipients. RoleName string `json:"roleName,omitempty"` // Specifies the routing order of the recipient in the envelope. RoutingOrder string `json:"routingOrder,omitempty"` - // Metadata that indicates if the sender can edit the routing order for the recipient. + // Metadata that indicates whether the `routingOrder` property is editable. Read only. RoutingOrderMetadata *PropertyMetadata `json:"routingOrderMetadata,omitempty"` - // The date and time the envelope was sent. + // The UTC DateTime when the envelope was sent. Read only. SentDateTime *time.Time `json:"sentDateTime,omitempty"` // Reserved for DocuSign. SignedDateTime *time.Time `json:"signedDateTime,omitempty"` - // The id of the signing group of which the agent is a member, if applicable. + // When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once). SigningGroupID string `json:"signingGroupId,omitempty"` - // Metadata that indicates whether the `signingGroupId` property is editable. - // + // Metadata that indicates whether the `signingGroupId` property is editable. Read only. SigningGroupIDMetadata *PropertyMetadata `json:"signingGroupIdMetadata,omitempty"` - // The display name for the signing group. + // Optional. The name of the signing group. // // Maximum Length: 100 characters. SigningGroupName string `json:"signingGroupName,omitempty"` // A complex type that contains information about users in the signing group. SigningGroupUsers []UserInfo `json:"signingGroupUsers,omitempty"` - // Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication. + // When `idCheckConfigurationName` is set to `SMS Auth $`, you use this complex type to provide the recipient authentication method details. It contains the element `senderProvidedNumbers`, which is an array of phone numbers that the recipient can use for SMS text authentication. + // // SmsAuthentication *RecipientSMSAuthentication `json:"smsAuthentication,omitempty"` - // Lists the social ID type that can be used for recipient authentication. + // Deprecated. SocialAuthentications []SocialAuthentication `json:"socialAuthentications,omitempty"` - // Recipient status. - // - // + // The recipient's status. Read only. + // + // Possible values: + // + // - `autoresponded`: The recipient's email system auto-responded to the email from DocuSign. This status is used in the web console to inform senders about the bounced-back email. This recipient status is only used if **Send-on-behalf-of** is turned off for the account. + // - `completed`: The recipient has completed their actions (signing or other required actions if not a signer) for an envelope. + // - `created`: The recipient is in a draft state. This value is only associated with draft envelopes (envelopes that have a status of `created`). + // - `declined`: The recipient declined to sign the document(s) in the envelope. + // - `delivered`: The recipient has viewed the document(s) in an envelope through the DocuSign signing website. This is not an email delivery of the documents in an envelope. + // - `faxPending`: The recipient has finished signing and the system is waiting for a fax attachment from the recipient before completing their signing step. + // - `sent`: The recipient has been sent an email notification that it is their turn to sign an envelope. + // - `signed`: The recipient has completed (signed) all required tags in an envelope. This is a temporary state during processing, after which the recipient's status automatically switches to `completed`. Status string `json:"status,omitempty"` - // Reserved for DocuSign. + // The code associated with the recipient's status. Read only. StatusCode string `json:"statusCode,omitempty"` + // When set to **true**, email notifications are suppressed for the recipient, and they must access envelopes and documents from their DocuSign inbox. + SuppressEmails string `json:"suppressEmails,omitempty"` // When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. TemplateLocked DSBool `json:"templateLocked,omitempty"` // When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. TemplateRequired DSBool `json:"templateRequired,omitempty"` - // The total number of tabs in the documents. + // The total number of tabs in the documents. Read only. TotalTabCount string `json:"totalTabCount,omitempty"` // The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing. // @@ -2988,14 +3745,17 @@ type Agent struct { // APIRequestLog contains API request log information. type APIRequestLog struct { - // The date and time the item was created. + // The UTC DateTime when the item was created. CreatedDateTime *time.Time `json:"createdDateTime,omitempty"` // A sender-defined description of the line item. // Description string `json:"description,omitempty"` // RequestLogID string `json:"requestLogId,omitempty"` - // The status of the item. + // Indicates the envelope status. Valid values are: + // + // * sent - The envelope is sent to the recipients. + // * created - The envelope is saved as a draft and can be modified and sent later. Status string `json:"status,omitempty"` } @@ -3029,6 +3789,10 @@ type Approve struct { TabBase TabGuidedForm TabPosition + // + AnchorAllowWhiteSpaceInCharacters string `json:"anchorAllowWhiteSpaceInCharacters,omitempty"` + // + AnchorAllowWhiteSpaceInCharactersMetadata *PropertyMetadata `json:"anchorAllowWhiteSpaceInCharactersMetadata,omitempty"` // When set to **true**, the information in the tab is bold. Bold string `json:"bold,omitempty"` // Metadata that indicates whether the `bold` property is editable. @@ -3107,6 +3871,10 @@ type Approve struct { ItalicMetadata *PropertyMetadata `json:"italicMetadata,omitempty"` // Reserved for DocuSign. LocalePolicy *LocalePolicyTab `json:"localePolicy,omitempty"` + // + MergeFieldXML string `json:"mergeFieldXml,omitempty"` + // + SmartContractInformation *SmartContractInformation `json:"smartContractInformation,omitempty"` // Metadata that indicates whether the `toolTip` property is editable. ToolTipMetadata *PropertyMetadata `json:"toolTipMetadata,omitempty"` // The text of a tooltip that appears when a user hovers over a form field or tab. @@ -3121,16 +3889,24 @@ type Approve struct { WidthMetadata *PropertyMetadata `json:"widthMetadata,omitempty"` } +type AskAnAdmin struct { + // + Email string `json:"email,omitempty"` + // + Message string `json:"message,omitempty"` + // + Name string `json:"name,omitempty"` + // + Phone string `json:"phone,omitempty"` +} + // Attachment contains information about an attachment. type Attachment struct { // Valid values are `sender` and `senderAndAllRecipients`. AccessControl string `json:"accessControl,omitempty"` // The unique identifier for the attachment. AttachmentID string `json:"attachmentId,omitempty"` - // Specifies the type of the attachment for the recipient. Possible values are: - // - // - `.htm` - // - `.xml` + // Specifies the type of the attachment for the recipient. AttachmentType string `json:"attachmentType,omitempty"` // A Base64-encoded representation of the attachment that is used to upload and download the file. File attachments may be up to 50 MB in size. Data []byte `json:"data,omitempty"` @@ -3148,15 +3924,7 @@ type Attachment struct { // AuthenticationMethod contains information about the method used for authentication. type AuthenticationMethod struct { - // Indicates the type of authentication. Valid values are: - // - // - `PhoneAuth` - // - `STAN` - // - `ISCheck` - // - `OFAC` - // - `AccessCode` - // - `AgeVerify` - // - `SSOAuth` + // Indicates the type of authentication. Valid values are: PhoneAuth, STAN, ISCheck, OFAC, AccessCode, AgeVerify, or SSOAuth. AuthenticationType string `json:"authenticationType,omitempty"` // The last provider that authenticated the user. LastProvider string `json:"lastProvider,omitempty"` @@ -3166,43 +3934,87 @@ type AuthenticationMethod struct { TotalCount string `json:"totalCount,omitempty"` } -// AuthenticationStatus is a complex element that contains information about the authentication status. +// AuthenticationStatus is a complex element that contains information about a user's authentication status. type AuthenticationStatus struct { - // Success/failure result of authentication using an access code. + // The result of a user's attempt to authenticate by using an access code. It returns: + // + // - `Status`: `Pass` or `Fail`. + // - `dateTime`: The date and time that the event occurred. + // - `FailureDescription`: A string containing the details about a failed authentication. + // - `VendorFailureStatusCode`: A string containing the vendor's status code for a failed authentication. AccessCodeResult *EventResult `json:"accessCodeResult,omitempty"` - // Success/failure result of authentication using age verification. + // The result of an age verification check. It returns: + // + // - `Status`: `Pass` or `Fail`. + // - `dateTime`: The date and time that the event occurred. + // - `FailureDescription`: A string containing the details about a failed authentication. + // - `VendorFailureStatusCode`: A string containing the vendor's status code for a failed authentication. AgeVerifyResult *EventResult `json:"ageVerifyResult,omitempty"` - // Success/failure result of authentication using sign-in with any social media account. + // Deprecated. AnySocialIDResult *EventResult `json:"anySocialIDResult,omitempty"` - // Success/failure result of authentication using sign-in with a Facebook account. + // Deprecated. FacebookResult *EventResult `json:"facebookResult,omitempty"` - // Success/failure result of authentication using sign-in with a Google+ account. + // Deprecated. GoogleResult *EventResult `json:"googleResult,omitempty"` - // Result of an ID lookup. + // The result of an ID lookup authentication check. It returns: + // + // - `Status`: `Pass` or `Fail`. + // - `dateTime`: The date and time that the event occurred. + // - `FailureDescription`: A string containing the details about a failed authentication. + // - `VendorFailureStatusCode`: A string containing the vendor's status code for a failed authentication. IDLookupResult *EventResult `json:"idLookupResult,omitempty"` - // Result of the user answering ID challenge questions. + // The result of the user's answers to ID challenge questions. It returns: + // + // - `Status`: `Pass` or `Fail`. + // - `dateTime`: The date and time that the event occurred. + // - `FailureDescription`: A string containing the details about a failed authentication. + // - `VendorFailureStatusCode`: A string containing the vendor's status code for a failed authentication. IDQuestionsResult *EventResult `json:"idQuestionsResult,omitempty"` - // Success/failure result of authentication using sign-in with a LinkedIn account. + // The result of an [Identity Verification][IDV] workflow. + // + // [IDV]: https://developers.docusign.com/docs/esign-rest-api/reference/Accounts/IdentityVerifications/ + IdentityVerificationResult *EventResult `json:"identityVerificationResult,omitempty"` + // Deprecated. LinkedinResult *EventResult `json:"linkedinResult,omitempty"` - // Success/failure result of authentication using sign-in with a Windows LiveID account. + // Deprecated. LiveIDResult *EventResult `json:"liveIDResult,omitempty"` + // The result of an Office of Foreign Asset Control (OFAC) check. It returns: // + // - `Status`: `Pass` or `Fail`. + // - `dateTime`: The date and time that the event occurred. + // - `FailureDescription`: A string containing the details about a failed authentication. + // - `VendorFailureStatusCode`: A string containing the vendor's status code for a failed authentication. OfacResult *EventResult `json:"ofacResult,omitempty"` - // Success/failure result of authentication using sign-in with a Yahoo OpenID account. + // Deprecated. OpenIDResult *EventResult `json:"openIDResult,omitempty"` - // Success/failure result of two-factor authentication (2FA) using phone messaging. + // The result of the user's attempt to authenticate by using two-factor authentication (2FA) through phone messaging. It returns: + // + // - `Status`: `Pass` or `Fail`. + // - `dateTime`: The date and time that the event occurred. + // - `FailureDescription`: A string containing the details about a failed authentication. + // - `VendorFailureStatusCode`: A string containing the vendor's status code for a failed authentication. PhoneAuthResult *EventResult `json:"phoneAuthResult,omitempty"` + // The result of a Student Authentication Network (STAN) authentication check. It returns: // + // - `Status`: `Pass` or `Fail`. + // - `dateTime`: The date and time that the event occurred. + // - `FailureDescription`: A string containing the details about a failed authentication. + // - `VendorFailureStatusCode`: A string containing the vendor's status code for a failed authentication. STANPinResult *EventResult `json:"sTANPinResult,omitempty"` - // Success/failure result of authentication using sign-in with a Salesforce account. + // Success/failure result of authentication using sign-in with a Salesforce account. It returns: + // + // - `Status`: `Pass` or `Fail`. + // - `dateTime`: The date and time that the event occurred. + // - `FailureDescription`: A string containing the details about a failed authentication. + // - `VendorFailureStatusCode`: A string containing the vendor's status code for a failed authentication. SalesforceResult *EventResult `json:"salesforceResult,omitempty"` - // Success/failure result of authentication using a signature provider. + // The result of the user's attempt to authenticate by using a signature provider. SignatureProviderResult *EventResult `json:"signatureProviderResult,omitempty"` - // Success/failure result of two-factor authentication (2FA) using phone SMS. + // The result of the user's attempt to authenticate by using two-factor authentication (2FA) through SMS messaging on a mobile phone. SmsAuthResult *EventResult `json:"smsAuthResult,omitempty"` - // Success/failure result of authentication using sign-in with a Twitter account. + // Deprecated. TwitterResult *EventResult `json:"twitterResult,omitempty"` - // Success/failure result of authentication using sign-in with a Yahoo account. + // Deprecated. YahooResult *EventResult `json:"yahooResult,omitempty"` } @@ -3218,6 +4030,99 @@ type BccEmailAddress struct { Email string `json:"email,omitempty"` } +// BccEmailArchive this object contains information abut a BCC email archive configuration (a BCC email address used to archive DocuSign-generated emails). +type BccEmailArchive struct { + // The id of the account that owns the BCC email archive configuration. + AccountID string `json:"accountId,omitempty"` + // The id of the BCC email archive configuration. + BccEmailArchiveID string `json:"bccEmailArchiveId,omitempty"` + // The UTC DateTime when the BCC email archive configuration was created. + Created string `json:"created,omitempty"` + // Details about the user who created the BCC email archive configuration. + CreatedBy *UserInfo `json:"createdBy,omitempty"` + // The BCC email address to use for archiving DocuSign messages. + // + // Example: customer_bcc@example.com + Email string `json:"email,omitempty"` + // The GUID of the activation email message sent to the BCC email address. + EmailNotificationID string `json:"emailNotificationId,omitempty"` + // The UTC DateTime when the BCC email archive configuration was last modified. + Modified string `json:"modified,omitempty"` + // Details about the user who last modified the BCC email archive configuration. + ModifiedBy *UserInfo `json:"modifiedBy,omitempty"` + // The status of the BCC email address. Possible values are: + // + // - `activation_sent`: An activation link has been sent to the BCC email address. + // - `active`: The BCC email address is actively used for archiving. + // - `closed`: The BCC email address is no longer used for archiving. + Status string `json:"status,omitempty"` + // The helper URI for retrieving the BCC email archive. + URI string `json:"uri,omitempty"` +} + +// BccEmailArchiveHistory contains details about the history of the BCC email archive configuration. +type BccEmailArchiveHistory struct { + // The id of the account that owns the BCC email archive configuration. + AccountID string `json:"accountId,omitempty"` + // The action taken on the BCC email archive configuration. + // + // Examples: + // + // - `CREATED`: The BCC email archive configuration has been created. + // - `UPDATED`: The BCC email address has been activated by clicking on the activation link in the activation email message. + // - `CLOSED`: The BCC email address has been marked as closed is no longer used for archiving. + Action string `json:"action,omitempty"` + // The BCC email address used to archive the emails that DocuSign generates. + // + // Example: customer_bcc@example.com + Email string `json:"email,omitempty"` + // The UTC DateTime when the BCC email address was last modified. + Modified string `json:"modified,omitempty"` + // Details about the user who last modified the BCC email archive configuration. + ModifiedBy *UserInfo `json:"modifiedBy,omitempty"` + // The status of the BCC email address. Possible values are: + // + // - `activation_sent`: An activation link has been sent to the BCC email address. + // - `active`: The BCC email address is actively used for archiving. + // - `closed`: The BCC email address is no longer used for archiving. + Status string `json:"status,omitempty"` +} + +type BccEmailArchiveHistoryList struct { + // A list of changes to the BCC email archive configuration. + BccEmailArchiveHistory []BccEmailArchiveHistory `json:"bccEmailArchiveHistory,omitempty"` + // The last index position in the result set. + EndPosition string `json:"endPosition,omitempty"` + // The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. + NextURI string `json:"nextUri,omitempty"` + // The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. + PreviousURI string `json:"previousUri,omitempty"` + // The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`. + ResultSetSize string `json:"resultSetSize,omitempty"` + // The starting index position of the current result set. + StartPosition string `json:"startPosition,omitempty"` + // The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`. + TotalSetSize string `json:"totalSetSize,omitempty"` +} + +// BccEmailArchiveList contains a list of BCC email archive configurations. +type BccEmailArchiveList struct { + // A list of BCC email archive configurations. + BccEmailArchives []BccEmailArchive `json:"bccEmailArchives,omitempty"` + // The last index position in the result set. + EndPosition string `json:"endPosition,omitempty"` + // The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. + NextURI string `json:"nextUri,omitempty"` + // The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. + PreviousURI string `json:"previousUri,omitempty"` + // The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`. + ResultSetSize string `json:"resultSetSize,omitempty"` + // The starting index position of the current result set. + StartPosition string `json:"startPosition,omitempty"` + // The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`. + TotalSetSize string `json:"totalSetSize,omitempty"` +} + // BillingCharge contains information about a billing charge. type BillingCharge struct { // Reserved: TBD @@ -3356,9 +4261,9 @@ type BillingPayment struct { PaymentID string `json:"paymentId,omitempty"` } -// BillingPaymentItem payments +// BillingPaymentItem defines a billing payment request object. type BillingPaymentItem struct { - // Reserved: TBD + // The total amount of the purchase. Amount string `json:"amount,omitempty"` // A sender-defined description of the line item. // @@ -3398,13 +4303,15 @@ type BillingPaymentsResponse struct { type BillingPlan struct { // Reserved for DocuSign. AppStoreProducts []AppStoreProduct `json:"appStoreProducts,omitempty"` - // Contains the currencyCode and currencySymbol for the alternate currency values for envelopeFee, fixedFee, and seatFee that are configured for this plan feature set. + // Contains the `currencyCode` and `currencySymbol` for the alternate currency values for `envelopeFee`, `fixedFee`, and `seatFee` that are configured for this plan feature set. CurrencyPlanPrices []CurrencyPlanPrice `json:"currencyPlanPrices,omitempty"` - // When set to **true**, then customer support is provided as part of the account plan. + // When set to **true**, customer support is provided as part of the account plan. EnableSupport DSBool `json:"enableSupport,omitempty"` - // The number of seats (users) included. + // The number of seats (users) included in the plan. IncludedSeats string `json:"includedSeats,omitempty"` + // Any other percentage discount for the plan. // + // Example: `"0.00"` OtherDiscountPercent string `json:"otherDiscountPercent,omitempty"` // The payment cycle associated with the plan. The possible values are: Monthly or Annually. PaymentCycle string `json:"paymentCycle,omitempty"` @@ -3420,7 +4327,7 @@ type BillingPlan struct { // - `DigitalExternal` // - `DirectDebit` PaymentMethod string `json:"paymentMethod,omitempty"` - // The per-seat price for the plan. + // The per seat price for the plan. PerSeatPrice string `json:"perSeatPrice,omitempty"` // Identifies the type of plan. Examples include: // @@ -3431,18 +4338,24 @@ type BillingPlan struct { PlanClassification string `json:"planClassification,omitempty"` // Reserved for DocuSign. PlanFeatureSets []FeatureSet `json:"planFeatureSets,omitempty"` - // The DocuSign plan id for the account. + // DocuSign's id for the account plan. PlanID string `json:"planId,omitempty"` - // The name of the billing plan. - PlanName string `json:"planName,omitempty"` // + // + PlanName string `json:"planName,omitempty"` + // A complex type that returns information about any seat discounts. It contains the information `BeginSeatCount`, `EndSeatCount` and `SeatDiscountPercent`. SeatDiscounts []SeatDiscount `json:"seatDiscounts,omitempty"` // The support incident fee charged for each support incident. + // + // Example: `"$0.00"` SupportIncidentFee string `json:"supportIncidentFee,omitempty"` // The support plan fee charged for this plan. + // + // Example: `"$0.00"` SupportPlanFee string `json:"supportPlanFee,omitempty"` } +// BillingPlanInformation this object contains details about a billing plan. type BillingPlanInformation struct { // AppStoreReceipt *AppStoreReceipt `json:"appStoreReceipt,omitempty"` @@ -3452,11 +4365,11 @@ type BillingPlanInformation struct { CreditCardInformation *CreditCardInformation `json:"creditCardInformation,omitempty"` // Information about the bank that processes direct debits for the payment plan. DirectDebitProcessorInformation *DirectDebitProcessorInformation `json:"directDebitProcessorInformation,omitempty"` - // + // (Optional) The user's reason for downgrading their billing plan. DowngradeReason string `json:"downgradeReason,omitempty"` - // When set to **true**, then customer support is provided as part of the account plan. + // When set to **true**, customer support is provided as part of the account plan. EnableSupport DSBool `json:"enableSupport,omitempty"` - // The number of seats (users) included. + // The number of seats (users) included in the plan. IncludedSeats string `json:"includedSeats,omitempty"` // Reserved for DocuSign. IncrementalSeats string `json:"incrementalSeats,omitempty"` @@ -3476,32 +4389,33 @@ type BillingPlanInformation struct { PaymentProcessorInformation *PaymentProcessorInformation `json:"paymentProcessorInformation,omitempty"` // An object used to identify the features and attributes of the account being created. PlanInformation *PlanInformation `json:"planInformation,omitempty"` - // A complex type that contains the following information for entering referral and discount information. The following items are included in the referral information (all string content): enableSupport, includedSeats, saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, saleDiscountSeatPriceOverride, planStartMonth, referralCode, referrerName, advertisementId, publisherId, shopperId, promoCode, groupMemberId, idType, and industry - // - // ###### Note: saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, and saleDiscountSeatPriceOverride are reserved for DoucSign use only. - // + // A complex type that contains properties for entering referral and discount information. ReferralInformation *ReferralInformation `json:"referralInformation,omitempty"` + // The renewal status of the account. Possible values are: // + // - `auto`: The account automatically renews. + // - `queued_for_close`: The account will be closed at the billingPeriodEndDate. + // - queued_for_downgrade`: The account will be downgraded at the `billingPeriodEndDate`. RenewalStatus string `json:"renewalStatus,omitempty"` - // Reserved for DocuSign use only. + // Reserved for DocuSign. SaleDiscountAmount string `json:"saleDiscountAmount,omitempty"` - // Reserved for DocuSign use only. + // Reserved for DocuSign. SaleDiscountFixedAmount string `json:"saleDiscountFixedAmount,omitempty"` - // Reserved for DocuSign use only. + // Reserved for DocuSign. SaleDiscountPercent string `json:"saleDiscountPercent,omitempty"` - // Reserved for DocuSign use only. + // Reserved for DocuSign. SaleDiscountPeriods string `json:"saleDiscountPeriods,omitempty"` - // Reserved for DocuSign use only. + // Reserved for DocuSign. SaleDiscountSeatPriceOverride string `json:"saleDiscountSeatPriceOverride,omitempty"` } -// BillingPlanPreview contains information about a preview billing plan. +// BillingPlanPreview information used to provide a preview of a billing plan. type BillingPlanPreview struct { // Specifies the ISO currency code for the account. CurrencyCode string `json:"currencyCode,omitempty"` // Invoice *BillingInvoice `json:"invoice,omitempty"` - // + // When set to **true**, the billing plan is prorated. IsProrated string `json:"isProrated,omitempty"` // SubtotalAmount string `json:"subtotalAmount,omitempty"` @@ -3515,21 +4429,27 @@ type BillingPlanPreview struct { type BillingPlanResponse struct { // An object that contains details about the billing plan. BillingPlan *BillingPlan `json:"billingPlan,omitempty"` - // + // A list of billing plans that the current billing plan can be rolled into. SuccessorPlans []BillingPlan `json:"successorPlans,omitempty"` } // BillingPlanUpdateResponse defines a billing plan update response object. type BillingPlanUpdateResponse struct { + // The type of payment method used for the account. Valid values are: // + // - `credit_card` + // - AccountPaymentMethod string `json:"accountPaymentMethod,omitempty"` // BillingPlanPreview *BillingPlanPreview `json:"billingPlanPreview,omitempty"` // Specifies the ISO currency code for the account. CurrencyCode string `json:"currencyCode,omitempty"` - // The number of seats (users) included. + // The number of seats (users) included in the plan. IncludedSeats string `json:"includedSeats,omitempty"` + // The payment cycle associated with the plan. The possible values are: // + // - `Monthly` + // - `Annually` PaymentCycle string `json:"paymentCycle,omitempty"` // The payment method used for the billing plan. Valid values are: // @@ -3543,9 +4463,14 @@ type BillingPlanUpdateResponse struct { // - `DigitalExternal` // - `DirectDebit` PaymentMethod string `json:"paymentMethod,omitempty"` - // The DocuSign plan id for the account. + // DocuSign's id for the account plan. PlanID string `json:"planId,omitempty"` // The name of the billing plan used for the account. + // + // Examples: + // + // - `Personal - Annual` + // - `Unlimited Envelope Subscription - Annual Billing` PlanName string `json:"planName,omitempty"` } @@ -3568,9 +4493,54 @@ type BillingPrice struct { type Brand struct { // The name of the company associated with the brand. BrandCompany string `json:"brandCompany,omitempty"` - // The id of the brand. + // The ID used to identify a specific brand in API calls. BrandID string `json:"brandId,omitempty"` - // An array of [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes that specifies the languages that the brand supports. + // An array of two-letter codes for the languages that you want to use with the brand. The supported languages are: + // + // - Arabic (`ar`) + // - Armenian (`hy`) + // - Bahasa Indonesia (`id`) + // - Bahasa Malay (`ms`) + // - Bulgarian (`bg`) + // - Chinese Simplified (`zh_CN`) + // - Chinese Traditional (`zh_TW`) + // - Croatian (`hr`) + // - Czech (`cs`) + // - Danish (`da`) + // - Dutch (`nl`) + // - English UK (`en_GB`) + // - English US (`en`) + // - Estonian (`et`) + // - Farsi (`fa`) + // - Finnish (`fi`) + // - French (`fr`) + // - French Canada (`fr_CA`) + // - German (`de`) + // - Greek (`el`) + // - Hebrew (`he`) + // - Hindi (`hi`) + // - Hungarian (`hu`) + // - Italian (`it`) + // - Japanese (`ja`) + // - Korean (`ko`) + // - Latvian (`lv`) + // - Lithuanian (`lt`) + // - Norwegian (`no`) + // - Polish (`pl`) + // - Portuguese (`pt`) + // - Portuguese Brasil (`pt_BR`) + // - Romanian (`ro`) + // - Russian (`ru`) + // - Serbian (`sr`) + // - Slovak (`sk`) + // - Slovenian (`sl`) + // - Spanish (`es`) + // - Spanish Latin America (`es_MX`) + // - Swedish (`sv`) + // - Thai (`th`) + // - Turkish (`tr`) + // - Ukranian (`uk`) + // - Vietnamese (`vi`) BrandLanguages []string `json:"brandLanguages,omitempty"` // The name of the brand. BrandName string `json:"brandName,omitempty"` @@ -3581,7 +4551,52 @@ type Brand struct { // - Header background // - Header text Colors []NameValue `json:"colors,omitempty"` - // The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of this brand's default language. + // The two-letter code for the language that you want to use as the brand default. The supported languages are: + // + // - Arabic (`ar`) + // - Armenian (`hy`) + // - Bahasa Indonesia (`id`) + // - Bahasa Malay (`ms`) + // - Bulgarian (`bg`) + // - Chinese Simplified (`zh_CN`) + // - Chinese Traditional (`zh_TW`) + // - Croatian (`hr`) + // - Czech (`cs`) + // - Danish (`da`) + // - Dutch (`nl`) + // - English UK (`en_GB`) + // - English US (`en`) + // - Estonian (`et`) + // - Farsi (`fa`) + // - Finnish (`fi`) + // - French (`fr`) + // - French Canada (`fr_CA`) + // - German (`de`) + // - Greek (`el`) + // - Hebrew (`he`) + // - Hindi (`hi`) + // - Hungarian (`hu`) + // - Italian (`it`) + // - Japanese (`ja`) + // - Korean (`ko`) + // - Latvian (`lv`) + // - Lithuanian (`lt`) + // - Norwegian (`no`) + // - Polish (`pl`) + // - Portuguese (`pt`) + // - Portuguese Brasil (`pt_BR`) + // - Romanian (`ro`) + // - Russian (`ru`) + // - Serbian (`sr`) + // - Slovak (`sk`) + // - Slovenian (`sl`) + // - Spanish (`es`) + // - Spanish Latin America (`es_MX`) + // - Swedish (`sv`) + // - Thai (`th`) + // - Turkish (`tr`) + // - Ukranian (`uk`) + // - Vietnamese (`vi`) DefaultBrandLanguage string `json:"defaultBrandLanguage,omitempty"` // Deprecated. EmailContent []BrandEmailContent `json:"emailContent,omitempty"` @@ -3651,8 +4666,9 @@ type BrandLogos struct { Secondary string `json:"secondary,omitempty"` } +// BrandRequest this request object contains information about a specific brand. type BrandRequest struct { - // The ID of the brand. + // The ID of the brand used in API calls BrandID string `json:"brandId,omitempty"` } @@ -3685,11 +4701,11 @@ type BrandResources struct { DataNotSavedNotInMaster []string `json:"dataNotSavedNotInMaster,omitempty"` // Information about the user who last modified the brand resource. ModifiedByUserInfo *UserInfo `json:"modifiedByUserInfo,omitempty"` - // Most recent date on which this user record was modified. + // The date on which this user record was last modified. ModifiedDate string `json:"modifiedDate,omitempty"` // This property is returned in the response to the [AccountBrands::listResources][listResources] request. It contains a list of any email templates that have been modified to differ from the master resource files. // - // [listResources]: ./categories/Accounts/AccountBrands/listResources.html + // [listResources]: https://developers.docusign.com/docs/esign-rest-api/reference/Accounts/AccountBrands/listResources ModifiedTemplates []string `json:"modifiedTemplates,omitempty"` // The type of brand resource file. A brand uses a different resource file to control each of the following experiences: // @@ -3709,15 +4725,16 @@ type BrandResourcesList struct { ResourcesContentTypes []BrandResources `json:"resourcesContentTypes,omitempty"` } +// BrandsRequest details about one or more brands. type BrandsRequest struct { // A list of brands. Brands []BrandRequest `json:"brands,omitempty"` } -// BrandsResponse brand management for groups +// BrandsResponse if your account includes multiple signing brands, you can use the groups functionality to assign different brands to different groups. This resource enables you to manage group brands. type BrandsResponse struct { // A list of brands. - Brands []Brand `json:"brands,omitempty"` + BrandOptions []Brand `json:"brandOptions,omitempty"` // The brand that envelope recipients see when a brand is not explicitly set. RecipientBrandIDDefault string `json:"recipientBrandIdDefault,omitempty"` // The brand that envelope senders see when a brand is not explicitly set. @@ -3737,7 +4754,7 @@ type BulkEnvelope struct { Email string `json:"email,omitempty"` // GUID of the bulk envelope. EnvelopeID string `json:"envelopeId,omitempty"` - // URI that you can use to retrieve the bulk envelopes. + // The URI for retrieving the envelope or envelopes. EnvelopeURI string `json:"envelopeUri,omitempty"` // This object describes errors that occur. It is only valid for responses and ignored in requests. ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` @@ -3750,50 +4767,33 @@ type BulkEnvelope struct { } type BulkEnvelopeStatus struct { - // Identifier used to query the status of an individual bulk recipient batch. + // Specifies an identifier which can be used to retrieve a more detailed status of individual bulk recipient batches. BatchID string `json:"batchId,omitempty"` - // The total number of items in the batch being queried. + // The number of items returned in this response. BatchSize string `json:"batchSize,omitempty"` // A list of bulk envelope objects. BulkEnvelopes []BulkEnvelope `json:"bulkEnvelopes,omitempty"` // URI at which you can retrieve the batch envelopes. BulkEnvelopesBatchURI string `json:"bulkEnvelopesBatchUri,omitempty"` - // The last position in the result set. + // The last index position in the result set. EndPosition string `json:"endPosition,omitempty"` - // The number of entries with a status of `failed`. + // The number of entries with a status of failed. Failed string `json:"failed,omitempty"` // The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. NextURI string `json:"nextUri,omitempty"` // The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. PreviousURI string `json:"previousUri,omitempty"` - // The number of entries with a status of `queued`. + // The number of entries with a status of queued. Queued string `json:"queued,omitempty"` - // The number of results returned in this response. Because you can filter which entries are included in the response, this value is always less than or equal to `totalSetSize`. + // The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`. ResultSetSize string `json:"resultSetSize,omitempty"` - // The number of entries with a status of `sent`. + // The number of entries with a status of sent. Sent string `json:"sent,omitempty"` - // The starting position of the current result set. + // The starting index position of the current result set. StartPosition string `json:"startPosition,omitempty"` // The date on which the bulk envelope was created. SubmittedDate string `json:"submittedDate,omitempty"` - // The total number of items in the search's result set. This value is always greater than or equal to the value of `resultSetSize`. - TotalSetSize string `json:"totalSetSize,omitempty"` -} - -type BulkEnvelopesResponse struct { - // Reserved: TBD - BulkEnvelopeStatuses []BulkEnvelopeStatus `json:"bulkEnvelopeStatuses,omitempty"` - // The last position in the result set. - EndPosition string `json:"endPosition,omitempty"` - // The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. - NextURI string `json:"nextUri,omitempty"` - // The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. - PreviousURI string `json:"previousUri,omitempty"` - // The number of results returned in this response. Because you can filter which entries are included in the response, this value is always less than or equal to `totalSetSize`. - ResultSetSize string `json:"resultSetSize,omitempty"` - // The starting position of the current result set. - StartPosition string `json:"startPosition,omitempty"` - // The total number of items in the search's result set. This value is always greater than or equal to the value of `resultSetSize`. + // The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`. TotalSetSize string `json:"totalSetSize,omitempty"` } @@ -3875,17 +4875,17 @@ type BulkRecipientsRequest struct { type BulkRecipientsResponse struct { // A complex type containing information about the bulk recipients in the response. BulkRecipients []BulkRecipient `json:"bulkRecipients,omitempty"` - // The last position in the result set. + // The last index position in the result set. EndPosition string `json:"endPosition,omitempty"` // The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. NextURI string `json:"nextUri,omitempty"` // The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. PreviousURI string `json:"previousUri,omitempty"` - // The number of results returned in this response. Because you can filter which entries are included in the response, this value is always less than or equal to `totalSetSize`. + // The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`. ResultSetSize string `json:"resultSetSize,omitempty"` - // The starting position of the current result set. + // The starting index position of the current result set. StartPosition string `json:"startPosition,omitempty"` - // The total number of items in the search's result set. This value is always greater than or equal to the value of `resultSetSize`. + // The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`. TotalSetSize string `json:"totalSetSize,omitempty"` } @@ -3894,7 +4894,7 @@ type BulkRecipientsSummaryResponse struct { BulkRecipients []BulkRecipient `json:"bulkRecipients,omitempty"` // The number of items returned in this response. BulkRecipientsCount string `json:"bulkRecipientsCount,omitempty"` - // Contains a URI for an endpoint that allows you to easily retrieve bulk recipient information. + // Reserved for DocuSign. BulkRecipientsURI string `json:"bulkRecipientsUri,omitempty"` // Array or errors. ErrorDetails []ErrorDetails `json:"errorDetails,omitempty"` @@ -3905,78 +4905,423 @@ type BulkRecipientsUpdateResponse struct { Signer *Signer `json:"signer,omitempty"` } -type CaptiveRecipient struct { - // Specifies whether the recipient is embedded or remote. - // - // If the `clientUserId` property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing. - // - // Note: if the `clientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true**, an error is generated on sending. +type BulkSendBatchRequest struct { // - // Maximum length: 100 characters. - ClientUserID string `json:"clientUserId,omitempty"` - // Specifies the email address associated with the captive recipient. - Email string `json:"email,omitempty"` - // This object describes errors that occur. It is only valid for responses and ignored in requests. - ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` - // Specifies the user name associated with the captive recipient. - UserName string `json:"userName,omitempty"` -} - -type CaptiveRecipientInformation struct { - // A complex type containing information about one or more captive recipients. - CaptiveRecipients []CaptiveRecipient `json:"captiveRecipients,omitempty"` + BatchName string `json:"batchName,omitempty"` } -// CarbonCopy is a carbon copy recipient. -type CarbonCopy struct { - // If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. +// BulkSendBatchStatus result of `getBulkSendBatchStatus` +type BulkSendBatchStatus struct { + // The batch ID. + BatchID string `json:"batchId,omitempty"` + // The batch name. + BatchName string `json:"batchName,omitempty"` + // The number of of bulk envelopes submitted in the current batch // - // Maximum Length: 50 characters and it must conform to the account's access code format setting. + BatchSize string `json:"batchSize,omitempty"` + // An array of error statuses. + BulkErrors []BulkSendErrorStatus `json:"bulkErrors,omitempty"` + // The ID of the draft envelope or template that was used to create the batch. // - // If blank, but the signer `accessCode` property is set in the envelope, then that value is used. + EnvelopeIDOrTemplateID string `json:"envelopeIdOrTemplateId,omitempty"` + // The URI to get all envelopes sent in the batch. // - // If blank and the signer `accessCode` property is not set, then the access code is not required. - AccessCode string `json:"accessCode,omitempty"` - // Metadata that indicates whether the `accessCode` property is editable. + EnvelopesURI string `json:"envelopesUri,omitempty"` + // The number of envelopes that failed to process or send. // - AccessCodeMetadata *PropertyMetadata `json:"accessCodeMetadata,omitempty"` - // This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient. - AddAccessCodeToEmail string `json:"addAccessCodeToEmail,omitempty"` - // Optional element. When set to true, the agents recipient associated with this recipient can change the recipient's pre-populated email address. This element is only active if enabled for the account. - AgentCanEditEmail DSBool `json:"agentCanEditEmail,omitempty"` - // Optional element. When set to **true**, the agents recipient associated with this recipient can change the recipient's pre-populated name. This element is only active if enabled for the account. - AgentCanEditName DSBool `json:"agentCanEditName,omitempty"` - // Not applicable for Carbon Copy recipients. - ClientUserID string `json:"clientUserId,omitempty"` - // Indicates the number of times that the recipient has been through a signing completion for the envelope. + Failed string `json:"failed,omitempty"` + // The id of the mailing list used to create the batch. + MailingListID string `json:"mailingListId,omitempty"` // - // If this number is greater than 0 for a signing group, only the user who previously completed may sign again. - CompletedCount string `json:"completedCount,omitempty"` - // An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters. - CustomFields []string `json:"customFields,omitempty"` - // The date and time the recipient declined the document. - DeclinedDateTime *time.Time `json:"declinedDateTime,omitempty"` - // The reason the recipient declined the document. - DeclinedReason string `json:"declinedReason,omitempty"` - // The date and time that the envelope was delivered to the recipient. - DeliveredDateTime *time.Time `json:"deliveredDateTime,omitempty"` - // Reserved for DocuSign. - DeliveryMethod string `json:"deliveryMethod,omitempty"` - // Reserved for DocuSign. - DeliveryMethodMetadata *PropertyMetadata `json:"deliveryMethodMetadata,omitempty"` - // A list of documentVisibility objects, which define a recipient's read/write access to a document. - DocumentVisibility []DocumentVisibility `json:"documentVisibility,omitempty"` - // Email id of the recipient. Notification of the document to sign is sent to this email id. + OwnerUserID string `json:"ownerUserId,omitempty"` + // The number of envelopes waiting in pending queue // - // Maximum length: 100 characters. + Queued string `json:"queued,omitempty"` + // The id of the sender. + SenderUserID string `json:"senderUserId,omitempty"` + // The number of envelopes sent successfully. + Sent string `json:"sent,omitempty"` + // The timestamp of when the batch was submitted in ISO-8601 format. + // + // + SubmittedDate string `json:"submittedDate,omitempty"` +} + +// BulkSendBatchSummaries is a list of bulk send batch summaries. +type BulkSendBatchSummaries struct { + // The maximum number of envelopes the account is permitted to submit in a given batch. + BatchSizeLimit string `json:"batchSizeLimit,omitempty"` + // An array of batch summaries. + BulkBatchSummaries []BulkSendBatchSummary `json:"bulkBatchSummaries,omitempty"` + // The last index position in the result set. + EndPosition string `json:"endPosition,omitempty"` + // The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. + NextURI string `json:"nextUri,omitempty"` + // The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. + PreviousURI string `json:"previousUri,omitempty"` + // Maximum number of envelopes an account is permitted to have in the queue at any one time. + QueueLimit string `json:"queueLimit,omitempty"` + // The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`. + ResultSetSize string `json:"resultSetSize,omitempty"` + // The starting index position of the current result set. + StartPosition string `json:"startPosition,omitempty"` + // The number of envelopes currently pending processing for the entire account. + TotalQueued string `json:"totalQueued,omitempty"` + // The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`. + TotalSetSize string `json:"totalSetSize,omitempty"` +} + +// BulkSendBatchSummary summary status of a single batch. +type BulkSendBatchSummary struct { + // The batch ID. + BatchID string `json:"batchId,omitempty"` + // The name of the batch. + BatchName string `json:"batchName,omitempty"` + // The number of envelopes in the batch. + BatchSize string `json:"batchSize,omitempty"` + // The batch details URI. + BatchURI string `json:"batchUri,omitempty"` + // Number of envelopes that failed to send. + Failed string `json:"failed,omitempty"` + // Number of envelopes peding processing. + // + Queued string `json:"queued,omitempty"` + // Number of envelopes that have been sent. + Sent string `json:"sent,omitempty"` + // The time stamp of when the batch was created in ISO-8601 format. + SubmittedDate string `json:"submittedDate,omitempty"` +} + +// BulkSendErrorStatus is a single bulk send error report. +type BulkSendErrorStatus struct { + // The timestamp of when the error occurred in ISO-8601 format. + Created string `json:"created,omitempty"` + // The error message generated during processing, if any. + // + ErrorMessage string `json:"errorMessage,omitempty"` + // An array of email addresses for the failed bulk envelope. + // + // Recipient email/info of the failed bulk envelope. + // + RecipientEmails []string `json:"recipientEmails,omitempty"` +} + +// BulkSendRequest this object contains information about the envelope or template that you want to send in bulk. +type BulkSendRequest struct { + // + BatchName string `json:"batchName,omitempty"` + // The GUID of the envelope or template that you want to send in bulk. + EnvelopeOrTemplateID string `json:"envelopeOrTemplateId,omitempty"` +} + +// BulkSendResponse is the object contains the response to a bulk send request. +type BulkSendResponse struct { + // A batch identifier that you can use to get the status of the batch. + BatchID string `json:"batchId,omitempty"` + // + BatchName string `json:"batchName,omitempty"` + // The total number of items in the batch being queried. + BatchSize string `json:"batchSize,omitempty"` + // The GUID of the envelope or template that was sent. + EnvelopeOrTemplateID string `json:"envelopeOrTemplateId,omitempty"` + // A human-readable object that describes errors that occur. It is only valid for responses and ignored in requests. + ErrorDetails []string `json:"errorDetails,omitempty"` + // A list of errors that occurred. This information is intended to be parsed by machine. + Errors []string `json:"errors,omitempty"` + // + QueueLimit string `json:"queueLimit,omitempty"` + // + TotalQueued string `json:"totalQueued,omitempty"` +} + +// BulkSendTestResponse this object contains the results of a bulk send test. +type BulkSendTestResponse struct { + // When **true**, the envelope or template is compatible with the bulk send list and can be sent by using the [BulkSend::createBulkSendRequest][BulkSendRequest] method. + // + // **Note**: This property is only returned in responses and ignored in requests. + // + // [BulkSendRequest]: https://developers.docusign.com/docs/esign-rest-api/reference/BulkEnvelopes/BulkSend/createBulkSendRequest + CanBeSent bool `json:"canBeSent,omitempty"` + // Human-readable details about any validation errors that occurred. + ValidationErrorDetails []string `json:"validationErrorDetails,omitempty"` + // A list of validation errors that were encountered during the bulk send test. + // + // **Note**: This information is intended to be parsed by machine. + ValidationErrors []string `json:"validationErrors,omitempty"` +} + +// BulkSendingCopy this object contains the details to use for a specific copy, or instance, of the envelope. When you send an envelope by using a bulk send list, you can customize these properties for each instance. +type BulkSendingCopy struct { + // The custom fields for this copy of the envelope. + // + // **Note**: These custom fields must also be included in the original envelope or template that you want to send. + CustomFields []BulkSendingCopyCustomField `json:"customFields,omitempty"` + // The email body for this copy of the envelope. + EmailBlurb string `json:"emailBlurb,omitempty"` + // The email subject line for this copy of the envelope. + // For information about adding merge field information to the email subject, + // see [Template Email Subject Merge Fields](https://developers.docusign.com/docs/esign-rest-api/reference/templates/templates/create/). + EmailSubject string `json:"emailSubject,omitempty"` + // Information about the recipients associated with this copy of the envelope. + Recipients []BulkSendingCopyRecipient `json:"recipients,omitempty"` +} + +// BulkSendingCopyCustomField this object contains details about a custom field for a bulk send copy. In a bulk send request, each custom field in the bulk send list must match a custom field in the envelope or template that you want to send. +type BulkSendingCopyCustomField struct { + // The name of the custom field. + Name string `json:"name,omitempty"` + // The value of the custom field. + Value string `json:"value,omitempty"` +} + +// BulkSendingCopyRecipient this object contains details about a bulk send recipient. +type BulkSendingCopyRecipient struct { + // If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. + // + // Maximum Length: 50 characters and it must conform to the account's access code format setting. + // + // If blank, but the signer `accessCode` property is set in the envelope, then that value is used. + // + // If blank and the signer `accessCode` property is not set, then the access code is not required. + AccessCode string `json:"accessCode,omitempty"` + // Specifies whether the recipient is embedded or remote. + // + // If the `clientUserId` property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing. + // + // Note: if the `clientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true**, an error is generated on sending. + // + // Maximum length: 100 characters. + ClientUserID string `json:"clientUserId,omitempty"` + // An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters. + CustomFields []string `json:"customFields,omitempty"` + // Reserved for DocuSign. + DeliveryMethod string `json:"deliveryMethod,omitempty"` + // The recipient's email address. + Email string `json:"email,omitempty"` + // An optional complex type that sets a specific email subject and body for this recipient's notification email. + // + // **Note**: You can set the `emailNotification` property separately for each recipient. If you set the value only for certain recipients, the other recipients will inherit the this value from the top-level `emailSubject` and `emailBlurb`. + EmailNotification *RecipientEmailNotification `json:"emailNotification,omitempty"` + // Specifies a sender-provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. + // + // If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation launched by a partner. + // + // It is important to understand that in a typical embedded workflow, the authentication of an embedded recipient is the responsibility of the sending application. DocuSign expects that senders will follow their own processes for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process is initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process, bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. + // + // If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: `envelopeId`, `recipientId`, `recipientName`, `recipientEmail`, and `customFields`. The `customFields` property must be set for the recipient or envelope. The merge fields are enclosed in double brackets. + // + // *Example*: + // + // `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` + EmbeddedRecipientStartURL string `json:"embeddedRecipientStartURL,omitempty"` + // Reserved for DocuSign. + FaxNumber string `json:"faxNumber,omitempty"` + // The email address of the signing host. + // This is the DocuSign user that is hosting the in-person signing session. + // + // Required when `inPersonSigningType` is `inPersonSigner`. + // For eNotary flow, use `email` instead. + // + // Maximum Length: 100 characters. + // + HostEmail string `json:"hostEmail,omitempty"` + // The name of the signing host. + // This is the DocuSign user that is hosting the in-person signing session. + // + // Required when `inPersonSigningType` is `inPersonSigner`. + // For eNotary flow, use `name` instead. + // + // Maximum Length: 100 characters. + // + HostName string `json:"hostName,omitempty"` + // The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are: + // + // - `Phone Auth $`: The recipient must authenticate by using two-factor authentication (2FA). You provide the phone number to use for 2FA in the `phoneAuthentication` object. + // - `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object. + // - `ID Check $`: The recipient must answer detailed security questions. + // + // **Example**: Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node. + IDCheckConfigurationName string `json:"idCheckConfigurationName,omitempty"` + // An object that contains input information related to a recipient ID check. + IDCheckInformationInput *IDCheckInformationInput `json:"idCheckInformationInput,omitempty"` + // + IdentificationMethod string `json:"identificationMethod,omitempty"` + // + Name string `json:"name,omitempty"` + // A note sent to the recipient in the signing email. + // This note is unique to this recipient. + // In the user interface, + // it appears near the upper left corner + // of the document + // on the signing screen. + // + // Maximum Length: 1000 characters. + // + Note string `json:"note,omitempty"` + // When `idCheckConfigurationName` is set to `Phone Auth $`, you use this complex type to provide the recipient authentication method details. It contains the following elements: + // + // * `recipMayProvideNumber`: Boolean. When set to **true**, the recipient can use whatever phone number they choose. + // * `senderProvidedNumbers`: ArrayOfStrings. A list of phone numbers the recipient can use. + // * `recordVoicePrint`: Reserved for DocuSign. + // * `validateRecipProvidedNumber`: Reserved for DocuSign. + // + // + PhoneAuthentication *RecipientPhoneAuthentication `json:"phoneAuthentication,omitempty"` + // Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. + RecipientID string `json:"recipientId,omitempty"` + // The default signature provider is the DocuSign Electronic signature system. This parameter is used to specify one or more Standards Based Signature (digital signature) providers for the signer to use. [More information.](https://developers.docusign.com/esign-rest-api/guides/standards-based-signatures) + RecipientSignatureProviders []RecipientSignatureProvider `json:"recipientSignatureProviders,omitempty"` + // The name of the role associated with the recipient. This property is optional and is only used in place of a `recipientId`. + RoleName string `json:"roleName,omitempty"` + // The in-person signer's full legal name. + // + // Required when `inPersonSigningType` is `inPersonSigner`. + // For eNotary flow, use `name` instead. + // + // Maximum Length: 100 characters. + // + SignerName string `json:"signerName,omitempty"` + // Optional. The ID of the [signing group](https://support.docusign.com/en/guides/ndse-user-guide-signing-groups). + // + // **Note**: When you send an envelope to a signing group, anyone in the group can open it and sign it with their own signature. For this reason, we recommend that you do not include non-signer recipients (such as carbon copy recipients) in the same signing group as signer recipients. However, you could create a second signing group for the non-signer recipients and change the default action of Needs to Sign to a different value, such as Receives a Copy. + SigningGroupID string `json:"signingGroupId,omitempty"` + // When `idCheckConfigurationName` is set to `SMS Auth $`, you use this complex type to provide the recipient authentication method details. It contains the element `senderProvidedNumbers`, which is an array of phone numbers that the recipient can use for SMS text authentication. + // + // + SmsAuthentication *RecipientSMSAuthentication `json:"smsAuthentication,omitempty"` + // Deprecated. + SocialAuthentications []SocialAuthentication `json:"socialAuthentications,omitempty"` + // A list of tabs associated with the recipient. In a bulk send request, each of these recipient tabs must match a recipient tab on the envelope or template that you want to send. To match up, the `tabLabel` for this tab and the `tabLabel` for the corresponding tab on the envelope or template must be the same. + // + // For example, if the envelope has a placeholder text tab with the `tabLabel` `childName`, you must assign the same `tabLabel` `childName` to the tab here that you are populating with that information. + // + // You can use the following types of tabs to match bulk send recipients to an envelope: + // + // - Text tabs + // - Radio group tabs (where the name of the `radioGroup` on the envelope is used as the `tabLabel` in the bulk send list) + // - List tabs + Tabs []BulkSendingCopyTab `json:"tabs,omitempty"` +} + +// BulkSendingCopyTab is a tab associated with the bulk send recipient. In a bulk send request, each recipient tab must match a recipient tab on the envelope or template that you want to send. To match up, the `tabLabel` for this tab and the `tabLabel` for the corresponding tab on the envelope or template must be the same. +// +// For example, if the envelope has a placeholder text tab with the `tabLabel` `childName`, you must assign the same `tabLabel` `childName` to the tab here that you are populating with that information. +type BulkSendingCopyTab struct { + // The initial value that you want to assign to the tab. + InitialValue string `json:"initialValue,omitempty"` + // The label associated with the recipient tab. In a bulk send request, the `tabLabel` for this tab and the `tabLabel` for the corresponding tab on the envelope or template must be the same. + // + // Maximum Length: 500 characters. + TabLabel string `json:"tabLabel,omitempty"` +} + +// BulkSendingList this object contains the details for the bulk send list. +type BulkSendingList struct { + // An array of `bulkCopy` objects. Each object represents an instance or copy of an envelope and contains details such as the recipient, custom fields, tabs, and other information. + BulkCopies []BulkSendingCopy `json:"bulkCopies,omitempty"` + // The GUID of the bulk send list. + ListID string `json:"listId,omitempty"` + // The name of the bulk send list. + Name string `json:"name,omitempty"` +} + +// BulkSendingListSummaries this complex type contains summaries that provide basic information about the bulk send lists that belong to the current user. +type BulkSendingListSummaries struct { + // An array of `bulkSendingListSummary` objects where each summary provides basic information about a bulk send list that belongs to the current user. + BulkListSummaries []BulkSendingListSummary `json:"bulkListSummaries,omitempty"` +} + +// BulkSendingListSummary this object contains basic information about a bulk send list. +type BulkSendingListSummary struct { + // The GUID of the bulk send list. This property is created after you post a new bulk send list. + BulkSendListID string `json:"bulkSendListId,omitempty"` + // The GUID of the user who created the bulk send list. + CreatedByUser string `json:"createdByUser,omitempty"` + // The UTC DateTime that the bulk send list was created. + CreatedDate string `json:"createdDate,omitempty"` + // The name of the bulk send list. + Name string `json:"name,omitempty"` +} + +// CaptiveRecipient this object contains details about a captive (embedded) recipient. +type CaptiveRecipient struct { + // Specifies whether the recipient is embedded or remote. + // + // If the `clientUserId` property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing. + // + // Note: if the `clientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true**, an error is generated on sending. + // + // Maximum length: 100 characters. + ClientUserID string `json:"clientUserId,omitempty"` + // The email address associated with the captive recipient. + Email string `json:"email,omitempty"` + // This object describes errors that occur. It is only valid for responses and ignored in requests. + ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` + // The username associated with the captive recipient. + UserName string `json:"userName,omitempty"` +} + +// CaptiveRecipientInformation contains information about captive (embedded) recipients. +type CaptiveRecipientInformation struct { + // A complex type containing information about one or more captive recipients. + CaptiveRecipients []CaptiveRecipient `json:"captiveRecipients,omitempty"` +} + +// CarbonCopy contains information about a carbon copy recipient. Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date or add information to any of the documents. +type CarbonCopy struct { + // If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. + // + // Maximum Length: 50 characters and it must conform to the account's access code format setting. + // + // If blank, but the signer `accessCode` property is set in the envelope, then that value is used. + // + // If blank and the signer `accessCode` property is not set, then the access code is not required. + AccessCode string `json:"accessCode,omitempty"` + // Metadata that indicates whether the `accessCode` property is editable. Read only. + AccessCodeMetadata *PropertyMetadata `json:"accessCodeMetadata,omitempty"` + // Optional. When set to **true**, the access code will be added to the email sent to the recipient. This nullifies the security measure of `accessCode` on the recipient. + AddAccessCodeToEmail string `json:"addAccessCodeToEmail,omitempty"` + // An array of additional notification objects. + AdditionalNotifications []RecipientAdditionalNotification `json:"additionalNotifications,omitempty"` + // Optional element. When set to **true**, the agents recipient associated with this recipient can change the recipient's pre-populated email address. This element is only active if enabled for the account. + AgentCanEditEmail DSBool `json:"agentCanEditEmail,omitempty"` + // Optional element. When set to **true**, the agents recipient associated with this recipient can change the recipient's pre-populated name. This element is only active if enabled for the account. + AgentCanEditName DSBool `json:"agentCanEditName,omitempty"` + // + AllowSystemOverrideForLockedRecipient string `json:"allowSystemOverrideForLockedRecipient,omitempty"` + // Not applicable for Carbon Copy recipients. + ClientUserID string `json:"clientUserId,omitempty"` + // Indicates the number of times that the recipient has been through a signing completion for the envelope. If this number is greater than 0 for a signing group, only the user who previously completed may sign again. Read only. + CompletedCount string `json:"completedCount,omitempty"` + // An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters. + CustomFields []string `json:"customFields,omitempty"` + // The date and time the recipient declined the document. Read only. + DeclinedDateTime *time.Time `json:"declinedDateTime,omitempty"` + // The reason the recipient declined the document. Read only. + DeclinedReason string `json:"declinedReason,omitempty"` + // The date and time that the envelope was delivered to the recipient. Read only. + DeliveredDateTime *time.Time `json:"deliveredDateTime,omitempty"` + // Reserved for DocuSign. + DeliveryMethod string `json:"deliveryMethod,omitempty"` + // Reserved for DocuSign. + DeliveryMethodMetadata *PropertyMetadata `json:"deliveryMethodMetadata,omitempty"` + // + DesignatorID string `json:"designatorId,omitempty"` + // + DesignatorIDGUID string `json:"designatorIdGuid,omitempty"` + // A list of `documentVisibility` objects. Each object in the list specifies whether a document in the envelope is visible to this recipient. For the envelope to use this functionality, Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true**. + DocumentVisibility []DocumentVisibility `json:"documentVisibility,omitempty"` + // The recipient's email address. Notification of the document to sign is sent to this email address. + // + // Maximum length: 100 characters. Email string `json:"email,omitempty"` - // Metadata that indicates if the sender can edit the email id of the recipient. + // Metadata that indicates whether the `email` property is editable. Read only. EmailMetadata *PropertyMetadata `json:"emailMetadata,omitempty"` // An optional complex type that sets a specific email subject and body for this recipient's notification email. // - // **Note**: If you use this field to set a specific email notification for one recipient, you must also set the email notification for the other recipients. Using this field for one or more recipients negates the Envelope `Subject` and `EmailBlurb` property settings. + // **Note**: You can set the `emailNotification` property separately for each recipient. If you set the value only for certain recipients, the other recipients will inherit the this value from the top-level `emailSubject` and `emailBlurb`. EmailNotification *RecipientEmailNotification `json:"emailNotification,omitempty"` - // Specifies a sender-provided valid URL string for redirecting an embedded recipient. When this option is used, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the recipient clicks the document link in the email, the recipient is redirected through DocuSign to the specified URL to complete the required actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. + // Specifies a sender-provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. // // If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation launched by a partner. // @@ -4000,33 +5345,41 @@ type CarbonCopy struct { FaxNumberMetadata *PropertyMetadata `json:"faxNumberMetadata,omitempty"` // The recipient's first name. Maximum Length: 50 characters. FirstName string `json:"firstName,omitempty"` - // Metadata that indicates if the sender can edit the recipient's first name. + // Metadata that indicates whether the `firstame` property is editable. Read only. FirstNameMetadata *PropertyMetadata `json:"firstNameMetadata,omitempty"` // Reserved for DocuSign. FullName string `json:"fullName,omitempty"` // Reserved for DocuSign. FullNameMetadata *PropertyMetadata `json:"fullNameMetadata,omitempty"` - // The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. + // The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are: + // + // - `Phone Auth $`: The recipient must authenticate by using two-factor authentication (2FA). You provide the phone number to use for 2FA in the `phoneAuthentication` object. + // - `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object. + // - `ID Check $`: The recipient must answer detailed security questions. // // **Example**: Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node. IDCheckConfigurationName string `json:"idCheckConfigurationName,omitempty"` - // Metadata that indicates if the sender can edit the `idCheckConfigurationName` property. + // Metadata that indicates whether the `idCheckConfigurationName` property is editable. Read only. IDCheckConfigurationNameMetadata *PropertyMetadata `json:"idCheckConfigurationNameMetadata,omitempty"` // An object that contains input information related to a recipient ID check. IDCheckInformationInput *IDCheckInformationInput `json:"idCheckInformationInput,omitempty"` + // Specifies the ID Verification workflow applied on an envelope by workflow ID.
See the [list](https://developers.docusign.com/docs/esign-rest-api/reference/Accounts/IdentityVerifications/list) method in the [IdentityVerifications](https://developers.docusign.com/docs/esign-rest-api/reference/Accounts/IdentityVerifications) resource for more information on how to retrieve workflow IDs available for an account.
This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods.
Note that ID Verification and ID Check are two distinct methods. ID Verification checks recipients' identity by verifying their ID while ID Check relies on data available on public records (such as current and former address). + IdentityVerification *RecipientIdentityVerification `json:"identityVerification,omitempty"` // When set to **true** and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account. InheritEmailNotificationConfiguration DSBool `json:"inheritEmailNotificationConfiguration,omitempty"` // The recipient's last name. LastName string `json:"lastName,omitempty"` - // Metadata that indicates if the sender can edit the recipient's last name. + // Metadata that indicates whether the `lastName` property is editable. Read only. LastNameMetadata *PropertyMetadata `json:"lastNameMetadata,omitempty"` // Reserved for DocuSign. LockedRecipientPhoneAuthEditable string `json:"lockedRecipientPhoneAuthEditable,omitempty"` // Reserved for DocuSign. LockedRecipientSmsEditable string `json:"lockedRecipientSmsEditable,omitempty"` // The full legal name of the recipient. Maximum Length: 100 characters. + // + // **Note**: You must always set a value for this property in requests, even if `firstName` and `lastName` are set. Name string `json:"name,omitempty"` - // Metadata that indicates if the sender can edit the full legal name of the recipient. + // Metadata that indicates whether the `name` property is editable. Read only. NameMetadata *PropertyMetadata `json:"nameMetadata,omitempty"` // A note sent to the recipient in the signing email. // This note is unique to this recipient. @@ -4038,87 +5391,103 @@ type CarbonCopy struct { // Maximum Length: 1000 characters. // Note string `json:"note,omitempty"` - // Metadata indicating if the sender can edit the note sent to the recipient in the signing email. + // Metadata that indicates whether the `note` property is editable. Read only. NoteMetadata *PropertyMetadata `json:"noteMetadata,omitempty"` - // A complex type that contains the following elements: + // When `idCheckConfigurationName` is set to `Phone Auth $`, you use this complex type to provide the recipient authentication method details. It contains the following elements: + // + // * `recipMayProvideNumber`: Boolean. When set to **true**, the recipient can use whatever phone number they choose. + // * `senderProvidedNumbers`: ArrayOfStrings. A list of phone numbers the recipient can use. + // * `recordVoicePrint`: Reserved for DocuSign. + // * `validateRecipProvidedNumber`: Reserved for DocuSign. + // // - // * `recipMayProvideNumber` - Boolean. When set to **true**, the recipient can use whatever phone number they choose. - // * `senderProvidedNumbers` - ArrayOfString. A list of phone numbers the recipient can use. - // * `recordVoicePrint` - Reserved. - // * `validateRecipProvidedNumber` - Reserved. PhoneAuthentication DSBool `json:"phoneAuthentication,omitempty"` + // The proof file of the recipient. + ProofFile *RecipientProofFile `json:"proofFile,omitempty"` // Reserved for DocuSign. RecipientAttachments []RecipientAttachment `json:"recipientAttachments,omitempty"` - // Information about the recipient's authentication status. + // Information about the recipient's authentication status. Read only. RecipientAuthenticationStatus *AuthenticationStatus `json:"recipientAuthenticationStatus,omitempty"` - // Metadata about the features that are supported for the recipient type. + // Metadata about the features that are supported for the recipient type. Read only. RecipientFeatureMetadata []FeatureAvailableMetadata `json:"recipientFeatureMetadata,omitempty"` - // A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`. + // Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. RecipientID string `json:"recipientId,omitempty"` - // The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. + // The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only. RecipientIDGUID string `json:"recipientIdGuid,omitempty"` // The recipient type, as specified by the following values: - // - `agents`: Agent recipients can add name and email information for recipients that appear after the agent in routing order. - // - `carbonCopies`: Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date, or add information to any of the documents. This type of recipient can be used in any routing order. - // - `certifiedDeliveries`: Certified delivery recipients must receive the completed documents for the envelope to be completed. They don't need to sign, initial, date, or add information to any of the documents. - // - `editors`: Editors have the same management and access rights for the envelope as the sender. Editors can add name and email information, add or change the routing order, set authentication options, and can edit signature/initial tabs and data fields for the remaining recipients. - // - `inPersonSigners`: In-person recipients are DocuSign users who act as signing hosts in the same physical location as the signer. + // - `agent`: Agent recipients can add name and email information for recipients that appear after the agent in routing order. + // - `carbonCopy`: Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date, or add information to any of the documents. This type of recipient can be used in any routing order. + // - `certifiedDelivery`: Certified delivery recipients must receive the completed documents for the envelope to be completed. They don't need to sign, initial, date, or add information to any of the documents. + // - `editor`: Editors have the same management and access rights for the envelope as the sender. Editors can add name and email information, add or change the routing order, set authentication options, and can edit signature/initial tabs and data fields for the remaining recipients. + // - `inPersonSigner`: In-person recipients are DocuSign users who act as signing hosts in the same physical location as the signer. // - `intermediaries`: Intermediary recipients can optionally add name and email information for recipients at the same or subsequent level in the routing order. - // - `seals`: Electronic seal recipients represent legal entities. - // - `signers`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope. - // - `witnesses`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope. + // - `seal`: Electronic seal recipients represent legal entities. + // - `signer`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope. + // - `witness`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope. RecipientType string `json:"recipientType,omitempty"` - // Metadata that indicates if the sender can edit the recipient type. + // Metadata that indicates whether the `recipientType` property is editable. Read only. RecipientTypeMetadata *PropertyMetadata `json:"recipientTypeMetadata,omitempty"` // When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. RequireIDLookup DSBool `json:"requireIdLookup,omitempty"` - // Metadata that indicates whether the `requireIdLookup` property is editable. - // + // Metadata that indicates whether the `requireIdLookup` property is editable. Read only. RequireIDLookupMetadata *PropertyMetadata `json:"requireIdLookupMetadata,omitempty"` - // Optional element. Specifies the role name associated with the recipient.

This is required when working with template recipients. + // Optional element. Specifies the role name associated with the recipient.

This property is required when you are working with template recipients. RoleName string `json:"roleName,omitempty"` // Specifies the routing order of the recipient in the envelope. RoutingOrder string `json:"routingOrder,omitempty"` - // Metadata that indicates if the sender can edit the routing order for the recipient. + // Metadata that indicates whether the `routingOrder` property is editable. Read only. RoutingOrderMetadata *PropertyMetadata `json:"routingOrderMetadata,omitempty"` - // The date and time the envelope was sent. + // The UTC DateTime when the envelope was sent. Read only. SentDateTime *time.Time `json:"sentDateTime,omitempty"` // Reserved for DocuSign. SignedDateTime *time.Time `json:"signedDateTime,omitempty"` - // The ID of the signing group of which the recipient is a member, if applicable. + // When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once). SigningGroupID string `json:"signingGroupId,omitempty"` - // Metadata that indicates if the sender can edit the signing group id. + // Metadata that indicates whether the `signingGroupId` property is editable. Read only. SigningGroupIDMetadata *PropertyMetadata `json:"signingGroupIdMetadata,omitempty"` - // The display name for the signing group. + // Optional. The name of the signing group. // // Maximum Length: 100 characters. SigningGroupName string `json:"signingGroupName,omitempty"` // A complex type that contains information about users in the signing group. SigningGroupUsers []UserInfo `json:"signingGroupUsers,omitempty"` - // Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication. + // When `idCheckConfigurationName` is set to `SMS Auth $`, you use this complex type to provide the recipient authentication method details. It contains the element `senderProvidedNumbers`, which is an array of phone numbers that the recipient can use for SMS text authentication. + // // SmsAuthentication *RecipientSMSAuthentication `json:"smsAuthentication,omitempty"` - // Lists the social ID type that can be used for recipient authentication. + // Deprecated. SocialAuthentications []SocialAuthentication `json:"socialAuthentications,omitempty"` - // Recipient status. - // - // + // The recipient's status. Read only. + // + // Possible values: + // + // - `autoresponded`: The recipient's email system auto-responded to the email from DocuSign. This status is used in the web console to inform senders about the bounced-back email. This recipient status is only used if **Send-on-behalf-of** is turned off for the account. + // - `completed`: The recipient has completed their actions (signing or other required actions if not a signer) for an envelope. + // - `created`: The recipient is in a draft state. This value is only associated with draft envelopes (envelopes that have a status of `created`). + // - `declined`: The recipient declined to sign the document(s) in the envelope. + // - `delivered`: The recipient has viewed the document(s) in an envelope through the DocuSign signing website. This is not an email delivery of the documents in an envelope. + // - `faxPending`: The recipient has finished signing and the system is waiting for a fax attachment from the recipient before completing their signing step. + // - `sent`: The recipient has been sent an email notification that it is their turn to sign an envelope. + // - `signed`: The recipient has completed (signed) all required tags in an envelope. This is a temporary state during processing, after which the recipient's status automatically switches to `completed`. Status string `json:"status,omitempty"` - // The code for recipient's status. + // The code associated with the recipient's status. Read only. StatusCode string `json:"statusCode,omitempty"` - // A list of `commentTabs` that contains the carbon copy recipient's comments. + // When set to **true**, email notifications are suppressed for the recipient, and they must access envelopes and documents from their DocuSign inbox. + SuppressEmails string `json:"suppressEmails,omitempty"` + // A list of `commentTabs` that contains the Carbon Copy recipient's comments. Tabs *Tabs `json:"tabs,omitempty"` // When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. TemplateLocked DSBool `json:"templateLocked,omitempty"` // When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. TemplateRequired DSBool `json:"templateRequired,omitempty"` - // The total number of tabs in the documents. + // The total number of tabs in the documents. Read only. TotalTabCount string `json:"totalTabCount,omitempty"` // The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing. // UserID string `json:"userId,omitempty"` } +// CertifiedDelivery contains information about a certified delivery recipient. Certified delivery recipients must receive the completed documents for the envelope to be completed. However, they don't need to sign, initial, date or add information to any of the documents. type CertifiedDelivery struct { // If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. // @@ -4128,15 +5497,18 @@ type CertifiedDelivery struct { // // If blank and the signer `accessCode` property is not set, then the access code is not required. AccessCode string `json:"accessCode,omitempty"` - // Metadata that indicates whether the `accessCode` property is editable. - // + // Metadata that indicates whether the `accessCode` property is editable. Read only. AccessCodeMetadata *PropertyMetadata `json:"accessCodeMetadata,omitempty"` - // This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient. + // Optional. When set to **true**, the access code will be added to the email sent to the recipient. This nullifies the security measure of `accessCode` on the recipient. AddAccessCodeToEmail string `json:"addAccessCodeToEmail,omitempty"` - // Optional element. When set to true, the agents recipient associated with this recipient can change the recipient's pre-populated email address. This element is only active if enabled for the account. + // An array of additional notification objects. + AdditionalNotifications []RecipientAdditionalNotification `json:"additionalNotifications,omitempty"` + // Optional element. When set to **true**, the agents recipient associated with this recipient can change the recipient's pre-populated email address. This element is only active if enabled for the account. AgentCanEditEmail DSBool `json:"agentCanEditEmail,omitempty"` // Optional element. When set to **true**, the agents recipient associated with this recipient can change the recipient's pre-populated name. This element is only active if enabled for the account. AgentCanEditName DSBool `json:"agentCanEditName,omitempty"` + // + AllowSystemOverrideForLockedRecipient string `json:"allowSystemOverrideForLockedRecipient,omitempty"` // Specifies whether the recipient is embedded or remote. // // If the `clientUserId` property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing. @@ -4145,33 +5517,35 @@ type CertifiedDelivery struct { // // Maximum length: 100 characters. ClientUserID string `json:"clientUserId,omitempty"` - // Indicates the number of times that the recipient has been through a signing completion for the envelope. - // - // If this number is greater than 0 for a signing group, only the user who previously completed may sign again. + // Indicates the number of times that the recipient has been through a signing completion for the envelope. If this number is greater than 0 for a signing group, only the user who previously completed may sign again. Read only. CompletedCount string `json:"completedCount,omitempty"` // An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters. CustomFields []string `json:"customFields,omitempty"` - // The date and time the recipient declined the document. + // The date and time the recipient declined the document. Read only. DeclinedDateTime *time.Time `json:"declinedDateTime,omitempty"` - // The reason the recipient declined the document. + // The reason the recipient declined the document. Read only. DeclinedReason string `json:"declinedReason,omitempty"` - // The date and time that the envelope was delivered to the recipient. + // The date and time that the envelope was delivered to the recipient. Read only. DeliveredDateTime *time.Time `json:"deliveredDateTime,omitempty"` // Reserved for DocuSign. DeliveryMethod string `json:"deliveryMethod,omitempty"` // Reserved for DocuSign. DeliveryMethodMetadata *PropertyMetadata `json:"deliveryMethodMetadata,omitempty"` - // A list of documentVisibility objects, which define a recipient's read/write access to a document. + // + DesignatorID string `json:"designatorId,omitempty"` + // + DesignatorIDGUID string `json:"designatorIdGuid,omitempty"` + // A list of `documentVisibility` objects. Each object in the list specifies whether a document in the envelope is visible to this recipient. For the envelope to use this functionality, Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true**. DocumentVisibility []DocumentVisibility `json:"documentVisibility,omitempty"` - // The email id of the recipient. + // The recipient's email address. Email string `json:"email,omitempty"` - // Metadata that indicates if the sender can edit the email address of the recipient. + // Metadata that indicates whether the `email` property is editable. Read only. EmailMetadata *PropertyMetadata `json:"emailMetadata,omitempty"` // An optional complex type that sets a specific email subject and body for this recipient's notification email. // - // **Note**: If you use this field to set a specific email notification for one recipient, you must also set the email notification for the other recipients. Using this field for one or more recipients negates the Envelope `Subject` and `EmailBlurb` property settings. + // **Note**: You can set the `emailNotification` property separately for each recipient. If you set the value only for certain recipients, the other recipients will inherit the this value from the top-level `emailSubject` and `emailBlurb`. EmailNotification *RecipientEmailNotification `json:"emailNotification,omitempty"` - // Specifies a sender-provided valid URL string for redirecting an embedded recipient. When this option is used, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the recipient clicks the document link in the email, the recipient is redirected through DocuSign to the specified URL to complete the required actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. + // Specifies a sender-provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. // // If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation launched by a partner. // @@ -4191,38 +5565,45 @@ type CertifiedDelivery struct { ExcludedDocuments DSBool `json:"excludedDocuments,omitempty"` // Reserved for DocuSign. FaxNumber string `json:"faxNumber,omitempty"` - // Metadata that indicates whether the `faxNumber` property is editable. - // + // Reserved for DocuSign. FaxNumberMetadata *PropertyMetadata `json:"faxNumberMetadata,omitempty"` // The recipient's first name. Maximum Length: 50 characters. FirstName string `json:"firstName,omitempty"` - // Metadata that indicates if the sender can edit the recipient's first name. + // Metadata that indicates whether the `firstame` property is editable. Read only. FirstNameMetadata *PropertyMetadata `json:"firstNameMetadata,omitempty"` // Reserved for DocuSign. FullName string `json:"fullName,omitempty"` // Reserved for DocuSign. FullNameMetadata *PropertyMetadata `json:"fullNameMetadata,omitempty"` - // The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. + // The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are: + // + // - `Phone Auth $`: The recipient must authenticate by using two-factor authentication (2FA). You provide the phone number to use for 2FA in the `phoneAuthentication` object. + // - `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object. + // - `ID Check $`: The recipient must answer detailed security questions. // // **Example**: Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node. IDCheckConfigurationName string `json:"idCheckConfigurationName,omitempty"` - // Metadata that indicates if the sender can edit the `idCheckConfigurationName` property. + // Metadata that indicates whether the `idCheckConfigurationName` property is editable. Read only. IDCheckConfigurationNameMetadata *PropertyMetadata `json:"idCheckConfigurationNameMetadata,omitempty"` // An object that contains input information related to a recipient ID check. IDCheckInformationInput *IDCheckInformationInput `json:"idCheckInformationInput,omitempty"` + // Specifies the ID Verification workflow applied on an envelope by workflow ID.
See the [list](https://developers.docusign.com/docs/esign-rest-api/reference/Accounts/IdentityVerifications/list) method in the [IdentityVerifications](https://developers.docusign.com/docs/esign-rest-api/reference/Accounts/IdentityVerifications) resource for more information on how to retrieve workflow IDs available for an account.
This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods.
Note that ID Verification and ID Check are two distinct methods. ID Verification checks recipients' identity by verifying their ID while ID Check relies on data available on public records (such as current and former address). + IdentityVerification *RecipientIdentityVerification `json:"identityVerification,omitempty"` // When set to **true** and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account. InheritEmailNotificationConfiguration DSBool `json:"inheritEmailNotificationConfiguration,omitempty"` - // The last name of the recipient. + // The recipient's last name. LastName string `json:"lastName,omitempty"` - // Metadata that indicates if the sender is able to edit the last name of the recipient. + // Metadata that indicates whether the `lastName` property is editable. Read only. LastNameMetadata *PropertyMetadata `json:"lastNameMetadata,omitempty"` // Reserved for DocuSign. LockedRecipientPhoneAuthEditable string `json:"lockedRecipientPhoneAuthEditable,omitempty"` // Reserved for DocuSign. LockedRecipientSmsEditable string `json:"lockedRecipientSmsEditable,omitempty"` - // The full legal name of the recipient. + // The full legal name of the recipient. Maximum Length: 100 characters. + // + // **Note**: You must always set a value for this property in requests, even if `firstName` and `lastName` are set. Name string `json:"name,omitempty"` - // Metadata that indicates if the user can edit the full legal name of the recipient. + // Metadata that indicates whether the `name` property is editable. Read only. NameMetadata *PropertyMetadata `json:"nameMetadata,omitempty"` // A note sent to the recipient in the signing email. // This note is unique to this recipient. @@ -4234,79 +5615,94 @@ type CertifiedDelivery struct { // Maximum Length: 1000 characters. // Note string `json:"note,omitempty"` - // Metadata that indicates if the sender can edit the note sent to the recipient in the signing email. + // Metadata that indicates whether the `note` property is editable. Read only. NoteMetadata *PropertyMetadata `json:"noteMetadata,omitempty"` - // A complex type that contains the following elements: + // When `idCheckConfigurationName` is set to `Phone Auth $`, you use this complex type to provide the recipient authentication method details. It contains the following elements: + // + // * `recipMayProvideNumber`: Boolean. When set to **true**, the recipient can use whatever phone number they choose. + // * `senderProvidedNumbers`: ArrayOfStrings. A list of phone numbers the recipient can use. + // * `recordVoicePrint`: Reserved for DocuSign. + // * `validateRecipProvidedNumber`: Reserved for DocuSign. + // // - // * `recipMayProvideNumber` - Boolean. When set to **true**, the recipient can use whatever phone number they choose. - // * `senderProvidedNumbers` - ArrayOfString. A list of phone numbers the recipient can use. - // * `recordVoicePrint` - Reserved. - // * `validateRecipProvidedNumber` - Reserved. PhoneAuthentication DSBool `json:"phoneAuthentication,omitempty"` + // The proof file of the recipient. + ProofFile *RecipientProofFile `json:"proofFile,omitempty"` // Reserved for DocuSign. RecipientAttachments []RecipientAttachment `json:"recipientAttachments,omitempty"` - // Information about the recipient's authentication status. + // Information about the recipient's authentication status. Read only. RecipientAuthenticationStatus *AuthenticationStatus `json:"recipientAuthenticationStatus,omitempty"` - // Metadata about the features that are supported for the recipient type. + // Metadata about the features that are supported for the recipient type. Read only. RecipientFeatureMetadata []FeatureAvailableMetadata `json:"recipientFeatureMetadata,omitempty"` - // Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. + // Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the document. RecipientID string `json:"recipientId,omitempty"` - // The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. + // The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only. RecipientIDGUID string `json:"recipientIdGuid,omitempty"` // The recipient type, as specified by the following values: - // - `agents`: Agent recipients can add name and email information for recipients that appear after the agent in routing order. - // - `carbonCopies`: Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date, or add information to any of the documents. This type of recipient can be used in any routing order. - // - `certifiedDeliveries`: Certified delivery recipients must receive the completed documents for the envelope to be completed. They don't need to sign, initial, date, or add information to any of the documents. - // - `editors`: Editors have the same management and access rights for the envelope as the sender. Editors can add name and email information, add or change the routing order, set authentication options, and can edit signature/initial tabs and data fields for the remaining recipients. - // - `inPersonSigners`: In-person recipients are DocuSign users who act as signing hosts in the same physical location as the signer. + // - `agent`: Agent recipients can add name and email information for recipients that appear after the agent in routing order. + // - `carbonCopy`: Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date, or add information to any of the documents. This type of recipient can be used in any routing order. + // - `certifiedDelivery`: Certified delivery recipients must receive the completed documents for the envelope to be completed. They don't need to sign, initial, date, or add information to any of the documents. + // - `editor`: Editors have the same management and access rights for the envelope as the sender. Editors can add name and email information, add or change the routing order, set authentication options, and can edit signature/initial tabs and data fields for the remaining recipients. + // - `inPersonSigner`: In-person recipients are DocuSign users who act as signing hosts in the same physical location as the signer. // - `intermediaries`: Intermediary recipients can optionally add name and email information for recipients at the same or subsequent level in the routing order. - // - `seals`: Electronic seal recipients represent legal entities. - // - `signers`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope. - // - `witnesses`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope. + // - `seal`: Electronic seal recipients represent legal entities. + // - `signer`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope. + // - `witness`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope. RecipientType string `json:"recipientType,omitempty"` - // Metadata that indicates if the sender can edit the recipient type. + // Metadata that indicates whether the `recipientType` property is editable. Read only. RecipientTypeMetadata *PropertyMetadata `json:"recipientTypeMetadata,omitempty"` // When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. RequireIDLookup DSBool `json:"requireIdLookup,omitempty"` - // Metadata that indicates whether the `requireIdLookup` property is editable. - // + // Metadata that indicates whether the `requireIdLookup` property is editable. Read only. RequireIDLookupMetadata *PropertyMetadata `json:"requireIdLookupMetadata,omitempty"` - // Optional element. Specifies the role name associated with the recipient.

This is required when working with template recipients. + // Optional element. Specifies the role name associated with the recipient.

This property is required when you are working with template recipients. RoleName string `json:"roleName,omitempty"` // Specifies the routing order of the recipient in the envelope. RoutingOrder string `json:"routingOrder,omitempty"` - // Metadata that indicates if the sender can edit the routing order for the recipient. + // Metadata that indicates whether the `routingOrder` property is editable. Read only. RoutingOrderMetadata *PropertyMetadata `json:"routingOrderMetadata,omitempty"` - // The date and time the envelope was sent. + // The UTC DateTime when the envelope was sent. Read only. SentDateTime *time.Time `json:"sentDateTime,omitempty"` // Reserved for DocuSign. SignedDateTime *time.Time `json:"signedDateTime,omitempty"` - // The id of the signing group of which the recipient is a member, if applicable. + // When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once). SigningGroupID string `json:"signingGroupId,omitempty"` - // Metadata that indicates if the sender can edit the signing group id. + // Metadata that indicates whether the `signingGroupId` property is editable. Read only. SigningGroupIDMetadata *PropertyMetadata `json:"signingGroupIdMetadata,omitempty"` - // The display name for the signing group. + // Optional. The name of the signing group. // // Maximum Length: 100 characters. SigningGroupName string `json:"signingGroupName,omitempty"` // A complex type that contains information about users in the signing group. SigningGroupUsers []UserInfo `json:"signingGroupUsers,omitempty"` - // Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication. + // When `idCheckConfigurationName` is set to `SMS Auth $`, you use this complex type to provide the recipient authentication method details. It contains the element `senderProvidedNumbers`, which is an array of phone numbers that the recipient can use for SMS text authentication. + // // SmsAuthentication *RecipientSMSAuthentication `json:"smsAuthentication,omitempty"` - // Lists the social ID type that can be used for recipient authentication. + // Deprecated. SocialAuthentications []SocialAuthentication `json:"socialAuthentications,omitempty"` - // Recipient status. - // - // + // The status of the recipient. Read only. + // + // Possible values: + // + // - `autoresponded`: The recipient's email system auto-responded to the email from DocuSign. This status is used in the web console to inform senders about the bounced-back email. This recipient status is only used if **Send-on-behalf-of** is turned off for the account. + // - `completed`: The recipient has completed their actions (signing or other required actions if not a signer) for an envelope. + // - `created`: The recipient is in a draft state. This value is only associated with draft envelopes (envelopes that have a status of `created`). + // - `declined`: The recipient declined to sign the document(s) in the envelope. + // - `delivered`: The recipient has viewed the document(s) in an envelope through the DocuSign signing website. This is not an email delivery of the documents in an envelope. + // - `faxPending`: The recipient has finished signing and the system is waiting for a fax attachment from the recipient before completing their signing step. + // - `sent`: The recipient has been sent an email notification that it is their turn to sign an envelope. + // - `signed`: The recipient has completed (signed) all required tags in an envelope. This is a temporary state during processing, after which the recipient's status automatically switches to `completed`. Status string `json:"status,omitempty"` - // Reserved for DocuSign. + // The code associated with the recipient's status. Read only. StatusCode string `json:"statusCode,omitempty"` + // When set to **true**, email notifications are suppressed for the recipient, and they must access envelopes and documents from their DocuSign inbox. + SuppressEmails string `json:"suppressEmails,omitempty"` // When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. TemplateLocked DSBool `json:"templateLocked,omitempty"` // When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. TemplateRequired DSBool `json:"templateRequired,omitempty"` - // The total number of tabs in the documents. + // The total number of tabs in the documents. Read only. TotalTabCount string `json:"totalTabCount,omitempty"` // The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing. // @@ -4320,6 +5716,10 @@ type Checkbox struct { TabGuidedForm TabPosition TabStyle + // + AnchorAllowWhiteSpaceInCharacters string `json:"anchorAllowWhiteSpaceInCharacters,omitempty"` + // + AnchorAllowWhiteSpaceInCharactersMetadata *PropertyMetadata `json:"anchorAllowWhiteSpaceInCharactersMetadata,omitempty"` // The height of the tab in pixels. Height string `json:"height,omitempty"` // Metadata that indicates whether the `height` property is editable. @@ -4328,6 +5728,8 @@ type Checkbox struct { Locked DSBool `json:"locked,omitempty"` // Metadata that indicates whether the `locked` property is editable. LockedMetadata *PropertyMetadata `json:"lockedMetadata,omitempty"` + // + MergeFieldXML string `json:"mergeFieldXml,omitempty"` // Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field. RequireInitialOnSharedChange DSBool `json:"requireInitialOnSharedChange,omitempty"` // Metadata that indicates whether the `requireInitialOnSharedChange` property is editable. @@ -4345,6 +5747,8 @@ type Checkbox struct { // Metadata that indicates whether the `shared` property is editable. // SharedMetadata *PropertyMetadata `json:"sharedMetadata,omitempty"` + // + SmartContractInformation *SmartContractInformation `json:"smartContractInformation,omitempty"` // Metadata that indicates whether the `toolTip` property is editable. ToolTipMetadata *PropertyMetadata `json:"toolTipMetadata,omitempty"` // The text of a tooltip that appears when a user hovers over a form field or tab. @@ -4377,7 +5781,7 @@ type ChunkedUploadRequest struct { Data []byte `json:"data,omitempty"` } -// ChunkedUploadResponse this response object is returned after you upload a chunked upload. +// ChunkedUploadResponse is the ChunkedUploads resource provides methods to complete integrity checks, and to add, commit, retrieve, initiate and delete chunked uploads. type ChunkedUploadResponse struct { // A 64-byte, Secure Hash Algorithm 256 (SHA256) checksum that the caller computes across the entirety of the original content that has been uploaded to the chunked upload. DocuSign compares this value to its own computation. If the two values are not equal, the original content and received content are not the same and the commit action is refused. Checksum string `json:"checksum,omitempty"` @@ -4390,8 +5794,11 @@ type ChunkedUploadResponse struct { // When **true**, the chunked upload has been committed. A committed chunked upload can no longer receive any additional parts and is ready for use within other API requests. Committed string `json:"committed,omitempty"` // The UTC time at which the chunked upload expires and is no longer addressable. + // + // **Note**: The length of time before expiration is configurable, and begins when you initiate the chunked upload. You must fully upload and use a chunked upload within this time. The default value for this duration is 20 minutes. ExpirationDateTime *time.Time `json:"expirationDateTime,omitempty"` // The maximum number of parts allowed for a chunked upload. This value is configurable per DocuSign environment, account, or integrator. The default value is 128. The maximum possible value is 256. + // MaxChunkedUploadParts string `json:"maxChunkedUploadParts,omitempty"` // The maximum total size allowed for a chunked upload. This value is configured per DocuSign environment, account, or integrator. The default value is 50 MB. MaxTotalSize string `json:"maxTotalSize,omitempty"` @@ -4401,6 +5808,7 @@ type ChunkedUploadResponse struct { TotalSize string `json:"totalSize,omitempty"` } +// CloudStorageProvider contains details about a specific cloud storage provider. type CloudStorageProvider struct { // The authentication URL used for the cloud storage provider. This information is only included in the response if the user has not passed authentication for the cloud storage provider. If the redirectUrl query string is provided, the returnUrl is appended to the authenticationUrl. AuthenticationURL string `json:"authenticationUrl,omitempty"` @@ -4412,64 +5820,61 @@ type CloudStorageProvider struct { RedirectURL string `json:"redirectUrl,omitempty"` // The service name for the cloud storage provider. Service string `json:"service,omitempty"` - // The DocuSign generated ID for the cloud storage provider + // The DocuSign-generated ID for the cloud storage provider. ServiceID string `json:"serviceId,omitempty"` } -// CloudStorageProviders cloud storage providers +// CloudStorageProviders is the CloudStorageProviders resource provides methods that allow you to manage the cloud storage providers associate with an account. type CloudStorageProviders struct { // An Array containing the storage providers associated with the user. StorageProviders []CloudStorageProvider `json:"storageProviders,omitempty"` } +// Comment details about envelope comments. type Comment struct { - // The Guid of the envelope the comment thread belongs to. + // The envelope ID of the envelope status that failed to post. EnvelopeID string `json:"envelopeId,omitempty"` // Reserved for DocuSign. Hmac string `json:"hmac,omitempty"` - // The unique identifier for the comment. + // A unique ID for the Salesforce object. ID string `json:"id,omitempty"` // An array of userIds that are mentioned directly in the body of a comment. Mentions []string `json:"mentions,omitempty"` - // When **true**, indicates that the comment was read. + // Indicates if the comment has been read by the target recipient of the comment. Read bool `json:"read,omitempty"` - // The email address of the user who created the comment. + // SentByEmail string `json:"sentByEmail,omitempty"` - // The full name of the user who created the comment. + // SentByFullName string `json:"sentByFullName,omitempty"` // Reserved for DocuSign. SentByImageID string `json:"sentByImageId,omitempty"` - // The initials of the user who created the comment. + // SentByInitials string `json:"sentByInitials,omitempty"` - // The recipient id of the user who created the comment. + // SentByRecipientID string `json:"sentByRecipientId,omitempty"` - // The user id of the user who created the comment. + // SentByUserID string `json:"sentByUserId,omitempty"` - // The id of the signing group that can view the comment or that created the comment. + // When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once). SigningGroupID string `json:"signingGroupId,omitempty"` - // The display name for the signing group. + // Optional. The name of the signing group. // // Maximum Length: 100 characters. SigningGroupName string `json:"signingGroupName,omitempty"` - // The subject of the envelope. + // Subject string `json:"subject,omitempty"` - // The unique identifier for the tab that represents the comment thread. + // The unique identifier for the tab. TabID string `json:"tabId,omitempty"` - // The content of the comment, as UTF-8 text. - // - // Maximum Length: 500 characters. - // - // **Note**: The maximum size allowed for the entire message body is 32 KB. + // Specifies the text that is shown in the dropdown list. Text string `json:"text,omitempty"` // The unique identifier for the comment thread. ThreadID string `json:"threadId,omitempty"` // The userId of the user who created the thread. ThreadOriginatorID string `json:"threadOriginatorId,omitempty"` - // The time the comment was created, formatted according to the format of the user who created the comment. + // TimeStampFormatted string `json:"timeStampFormatted,omitempty"` - // The time the comment was created. + // Timestamp string `json:"timestamp,omitempty"` - // The user ids of the users that the comment is visible to. + // VisibleTo []string `json:"visibleTo,omitempty"` } @@ -4503,6 +5908,10 @@ type CommentThread struct { TabBase TabGuidedForm TabPosition + // + AnchorAllowWhiteSpaceInCharacters string `json:"anchorAllowWhiteSpaceInCharacters,omitempty"` + // + AnchorAllowWhiteSpaceInCharactersMetadata *PropertyMetadata `json:"anchorAllowWhiteSpaceInCharactersMetadata,omitempty"` // When set to **true**, the information in the tab is bold. Bold string `json:"bold,omitempty"` // Metadata that indicates whether the `bold` property is editable. @@ -4579,6 +5988,10 @@ type CommentThread struct { ItalicMetadata *PropertyMetadata `json:"italicMetadata,omitempty"` // Reserved for DocuSign. LocalePolicy *LocalePolicyTab `json:"localePolicy,omitempty"` + // + MergeFieldXML string `json:"mergeFieldXml,omitempty"` + // + SmartContractInformation *SmartContractInformation `json:"smartContractInformation,omitempty"` // The unique identifier for the comment thread. ThreadID string `json:"threadId,omitempty"` // Metadata that indicates whether the `toolTip` property is editable. @@ -4600,825 +6013,517 @@ type CommentsPublish struct { CommentsToPublish []CommentPublish `json:"commentsToPublish,omitempty"` } -// Company is a tab that displays the recipient's company name. -// -type Company struct { - TabBase - TabGuidedForm - TabPosition - TabStyle - TabValue - // When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. +type CommissionCounty struct { // - // When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. + AnchorAllowWhiteSpaceInCharacters string `json:"anchorAllowWhiteSpaceInCharacters,omitempty"` // - // This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. - ConcealValueOnDocument DSBool `json:"concealValueOnDocument,omitempty"` - // Metadata that indicates whether the `concealValueOnDocument` property is editable. - ConcealValueOnDocumentMetadata *PropertyMetadata `json:"concealValueOnDocumentMetadata,omitempty"` - // When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. - DisableAutoSize DSBool `json:"disableAutoSize,omitempty"` - // Metadata that indicates whether the `disableAutoSize` property is editable. - DisableAutoSizeMetadata *PropertyMetadata `json:"disableAutoSizeMetadata,omitempty"` - // The height of the tab in pixels. - Height string `json:"height,omitempty"` - // Metadata that indicates whether the `height` property is editable. - HeightMetadata *PropertyMetadata `json:"heightMetadata,omitempty"` - // Reserved for DocuSign. - LocalePolicy *LocalePolicyTab `json:"localePolicy,omitempty"` - // When set to **true**, the signer cannot change the data of the custom tab. - Locked DSBool `json:"locked,omitempty"` - // Metadata that indicates whether the `locked` property is editable. - LockedMetadata *PropertyMetadata `json:"lockedMetadata,omitempty"` - // An optional value that describes the maximum length of the property when the property is a string. - MaxLength string `json:"maxLength,omitempty"` - // Metadata that indicates whether the `maxLength` property is editable. - MaxLengthMetadata *PropertyMetadata `json:"maxLengthMetadata,omitempty"` - // The initial value of the tab when it was sent to the recipient. - OriginalValue string `json:"originalValue,omitempty"` - // Metadata that indicates whether the `originalValue` property is editable. - OriginalValueMetadata *PropertyMetadata `json:"originalValueMetadata,omitempty"` - // When set to **true**, the signer is required to fill out this tab. - Required TabRequired `json:"required,omitempty"` - // Metadata that indicates whether the `required` property is editable. - RequiredMetadata *PropertyMetadata `json:"requiredMetadata,omitempty"` - // Metadata that indicates whether the `toolTip` property is editable. - ToolTipMetadata *PropertyMetadata `json:"toolTipMetadata,omitempty"` - // The text of a tooltip that appears when a user hovers over a form field or tab. - Tooltip string `json:"tooltip,omitempty"` - // The width of the tab in pixels. - Width string `json:"width,omitempty"` - // Metadata that indicates whether the `width` property is editable. - WidthMetadata *PropertyMetadata `json:"widthMetadata,omitempty"` -} - -type CompleteSignHashResponse struct { - // Complex element contains the details on the documents in the envelope. - Documents []SignHashDocument `json:"documents,omitempty"` + AnchorAllowWhiteSpaceInCharactersMetadata *PropertyMetadata `json:"anchorAllowWhiteSpaceInCharactersMetadata,omitempty"` + // This property controls how [anchor tabs][AnchorTabs] are placed. When **true**, the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false**. // - RedirectionURL string `json:"redirectionUrl,omitempty"` + // For example, when set to **true**, if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When set to **false**, `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. // - RemainingSignatureRequests string `json:"remainingSignatureRequests,omitempty"` -} - -type CompleteSignRequest struct { - // When set to **false**, the envelope signing certificate is removed from the download. - Certificate string `json:"certificate,omitempty"` + // This functionality uses the following rules: // - CorrelationID string `json:"correlationId,omitempty"` + // - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: // - DocumentUpdateInfos []DocumentUpdateInfo `json:"documentUpdateInfos,omitempty"` + // $~><|^+= // - MaxSignatureLength string `json:"maxSignatureLength,omitempty"` - // Specifies the physical location where the signing takes place. It can have two enumeration values; `inPerson` and `online`. The default value is `online`. - SigningLocation string `json:"signingLocation,omitempty"` - // Specifies the Transaction ID from the AppStore. - TransactionID string `json:"transactionId,omitempty"` -} - -type CompositeTemplate struct { - // The identify of this composite template. It is used as a reference when adding document object information. If used, the document's `content-disposition` must include the composite template ID to which the document should be added. If a composite template ID is not specified in the content-disposition, the document is applied based on the value of the `documentId` property only. If no document object is specified, the composite template inherits the first document. - CompositeTemplateID string `json:"compositeTemplateId,omitempty"` + // For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` // - Document *Document `json:"document,omitempty"` - // Zero or more inline templates and their position in the overlay. If supplied, they are overlaid into the envelope in the order of their Sequence value. - InlineTemplates []InlineTemplate `json:"inlineTemplates,omitempty"` + // - Strings embedded in other strings are ignored during the matching process. // - PdfMetaDataTemplateSequence string `json:"pdfMetaDataTemplateSequence,omitempty"` - // 0 or more server-side templates and their position in the overlay. If supplied, they are overlaid into the envelope in the order of their Sequence value - ServerTemplates []ServerTemplate `json:"serverTemplates,omitempty"` -} - -type ConnectConfigResults struct { - // Array of Connect Configurations - Configurations []ConnectCustomConfiguration `json:"configurations,omitempty"` - // The count of records in the log list. - TotalRecords string `json:"totalRecords,omitempty"` -} - -// ConnectCustomConfiguration connect configurations -type ConnectCustomConfiguration struct { - // When set to **true**, the tracked envelope and recipient events for all users, including users that are added a later time, are sent through Connect. - AllUsers DSBool `json:"allUsers,omitempty"` - // When set to **true**, data is sent to the urlToPublishTo web address. This option can be set to false to stop sending data while maintaining the Connect configuration information. - AllowEnvelopePublish DSBool `json:"allowEnvelopePublish,omitempty"` + // - In words that have dashes, the parts separated by dashes are treated as distinct words. // - AllowSalesforcePublish string `json:"allowSalesforcePublish,omitempty"` - // If merge fields are being used, specifies the type of the merge field. The only supported value is **salesforce**. - ConfigurationType string `json:"configurationType,omitempty"` - // Read only: the DocuSign generated ID for the Connect configuration. - ConnectID string `json:"connectId,omitempty"` - // This turns Connect logging on or off. When set to **true**, logging is turned on. - EnableLog DSBool `json:"enableLog,omitempty"` - // An array of strings that lists envelope-related events that are tracked through Connect. The possible event values are: + // Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**. // - // - `sent` - // - `delivered` - // - `completed` - // - `declined` - // - `voided` + // - Letters with accent marks are treated as distinct characters from their unaccented counterparts. // + // - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. // - // **Note**: In previous versions of the API, this value was a single comma-separated string. - EnvelopeEvents []string `json:"envelopeEvents,omitempty"` + // Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. // - ExternalFolderID string `json:"externalFolderId,omitempty"` + // - Unlike punctuation, numbers are not ignored when finding anchor words. // - ExternalFolderLabel string `json:"externalFolderLabel,omitempty"` + // Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). // - IncludeCertSoapHeader string `json:"includeCertSoapHeader,omitempty"` - // When set to **true**, the Connect Service includes the Certificate of Completion with completed envelopes. - IncludeCertificateOfCompletion DSBool `json:"includeCertificateOfCompletion,omitempty"` - // When set to **true**, the Document Fields associated with the envelope's documents are included in the notification messages. Document Fields are optional custom name-value pairs added to documents using the API. - IncludeDocumentFields DSBool `json:"includeDocumentFields,omitempty"` - // When set to **true**, Connect will send the PDF document along with the update XML. - IncludeDocuments DSBool `json:"includeDocuments,omitempty"` - // When set to **true**, Connect will include the voidedReason for voided envelopes. - IncludeEnvelopeVoidReason DSBool `json:"includeEnvelopeVoidReason,omitempty"` + // **Note**: You can only specify the value of this property in POST requests. // - IncludeHMAC string `json:"includeHMAC,omitempty"` - // When set to **true**, Connect will include the sender account as Custom Field in the data. - IncludeSenderAccountasCustomField DSBool `json:"includeSenderAccountasCustomField,omitempty"` - // When set to **true**, Connect will include the envelope time zone information. - IncludeTimeZoneInformation DSBool `json:"includeTimeZoneInformation,omitempty"` - // The name of the Connect configuration. The name helps identify the configuration in the list. - Name string `json:"name,omitempty"` - // The user's encrypted password hash. - Password string `json:"password,omitempty"` - // An array of strings that lists of recipient-related events that trigger a notification - // to your webhook Connect listener. The possible event values are: + // [AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place + AnchorCaseSensitive string `json:"anchorCaseSensitive,omitempty"` + // Metadata that indicates whether the `anchorCaseSensitive` property is editable. + AnchorCaseSensitiveMetadata *PropertyMetadata `json:"anchorCaseSensitiveMetadata,omitempty"` + // This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are : // - // - `sent` - // - `delivered` - // - `completed` - // - `declined` - // - `authenticationfailed` - // - `autoresponded` + // - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. + // - `right`: Aligns the tab’s left side with the last character of the matching anchor word. // - // **Note**: In previous versions of the API, this value was a single comma-separated string. - RecipientEvents []string `json:"recipientEvents,omitempty"` - // If **true** [Mutual TLS](https://developers.docusign.com/esign-rest-api/guides/mutual-tls-intro) authentication is enabled. - RequireMutualTLS string `json:"requireMutualTls,omitempty"` - // #### When set to **true**, and SIM mode is activated: + // **Note**: You can only specify the value of this property in POST requests. // - // If the HTTP Status response to a notification message is not in the range of 200-299, - // then the message delivery failed, and the configuration is marked as down. + // [AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place // - // The message will be queued and retried once per day. - // While a Connect configuration is marked down, subsequent notifications will not be tried, they'll be immediately queued with reason "Pending". - // Once a message succeeds, all queued messages for the configuration will be tried immediately, in order. + AnchorHorizontalAlignment string `json:"anchorHorizontalAlignment,omitempty"` + // Metadata that indicates whether the `anchorHorizontalAlignment` property is editable. + AnchorHorizontalAlignmentMetadata *PropertyMetadata `json:"anchorHorizontalAlignmentMetadata,omitempty"` + // When set to **true**, this tab is ignored if the `anchorString` is not found in the document. + AnchorIgnoreIfNotPresent string `json:"anchorIgnoreIfNotPresent,omitempty"` + // Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable. + AnchorIgnoreIfNotPresentMetadata *PropertyMetadata `json:"anchorIgnoreIfNotPresentMetadata,omitempty"` + // When set to **true**, the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false**. // - // There is a maximum of ten retries. Alternately, you can use Republish Connect Information to manually republish the notification. + // For example, when set to **true**, if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When set to **false**, if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. // - // #### When set to **true**, and SIM mode is not activated: + // This functionality uses the following rules: // - // If the HTTP Status response to a notification message is not in the range of 200-299, then the message delivery failed, and the message is queued. + // - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: // - // The message will be retried after at least a day the next time a subsequent message is successfully sent to this configuration (subscription). Subsequent notifications will be tried when they occur. - // There is a maximum of ten retries. Alternately, you can use Republish Connect Information to manually republish the notification. - RequiresAcknowledgement DSBool `json:"requiresAcknowledgement,omitempty"` - // The access token to use for Salesforce integration. - SalesforceAccessToken string `json:"salesforceAccessToken,omitempty"` - // The version of the Salesforce API that you are using. - SalesforceAPIVersion string `json:"salesforceApiVersion,omitempty"` + // $~><|^+= // - SalesforceDocumentsAsContentFiles string `json:"salesforceDocumentsAsContentFiles,omitempty"` + // For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` // - SalesforceRefreshToken string `json:"salesforceRefreshToken,omitempty"` + // - Strings embedded in other strings are ignored during the matching process. // - SenderOverride string `json:"senderOverride,omitempty"` + // - In words that have dashes, the parts separated by dashes are treated as distinct words. // - SenderSelectableItems []string `json:"senderSelectableItems,omitempty"` + // Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**. // - SfObjects []ConnectSalesforceObject `json:"sfObjects,omitempty"` - // When set to **true**, Mutual TLS will be enabled for notifications. Mutual TLS must be initiated by the listener (the customer's web server) during the TLS handshake protocol. - SignMessageWithX509Certificate DSBool `json:"signMessageWithX509Certificate,omitempty"` - // The namespace of the SOAP interface. + // - Letters with accent marks are treated as distinct characters from their unaccented counterparts. // - // The namespace value must be set if useSoapInterface is set to true. - SoapNamespace string `json:"soapNamespace,omitempty"` - // The endpoint to which webhook notification messages are sent via an HTTPS POST request. The url must start with https. The customer's web server must use an SSL/TLS certificate whose CA is in the Microsoft list of trusted CAs. Self-signed certificates are not ok. Free certificates from Let's Encrypt can be used. - URLToPublishTo string `json:"urlToPublishTo,omitempty"` - // When set to **true**, indicates that the `urlToPublishTo` property contains a SOAP endpoint. - UseSoapInterface DSBool `json:"useSoapInterface,omitempty"` - // A comma separated list of userIds. This sets the users associated with the tracked envelope and recipient events. When a tracked event occurs for a set user, the a notification message is sent to your Connect listener. + // - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. // - // ###### Note: If allUsers is set to `false` then you must provide a list of user ids. - UserIds []string `json:"userIds,omitempty"` - // The name of the user. - UserName string `json:"userName,omitempty"` -} - -type ConnectDebugLog struct { - // Name of the Connect configuration. - ConnectConfig string `json:"connectConfig,omitempty"` - // This object describes errors that occur. It is only valid for responses and ignored in requests. - ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` - // Date and time of the event. - EventDateTime *time.Time `json:"eventDateTime,omitempty"` - // Description of the event. - EventDescription string `json:"eventDescription,omitempty"` - // Log output. - Payload string `json:"payload,omitempty"` -} - -type ConnectFailureFilter struct { + // Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. // - EnvelopeIds []string `json:"envelopeIds,omitempty"` + // - Unlike punctuation, numbers are not ignored when finding anchor words. // - Synchronous string `json:"synchronous,omitempty"` -} - -type ConnectFailureResult struct { + // Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). + // + // + // **Note**: You can only specify the value of this property in POST requests. + // + // [AnchorTab]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place + // + AnchorMatchWholeWord string `json:"anchorMatchWholeWord,omitempty"` + // Metadata that indicates whether the `anchorMatchWholeWord` property is editable. + AnchorMatchWholeWordMetadata *PropertyMetadata `json:"anchorMatchWholeWordMetadata,omitempty"` + // Specifies the string to find in the document and use as the basis for tab placement. + AnchorString string `json:"anchorString,omitempty"` + // Metadata that indicates whether the `anchorString` property is editable. + AnchorStringMetadata *PropertyMetadata `json:"anchorStringMetadata,omitempty"` // Reserved for DocuSign. - ConfigID string `json:"configId,omitempty"` + AnchorTabProcessorVersion string `json:"anchorTabProcessorVersion,omitempty"` // Reserved for DocuSign. + AnchorTabProcessorVersionMetadata *PropertyMetadata `json:"anchorTabProcessorVersionMetadata,omitempty"` + // Specifies units of the + // `anchorXOffset` and + // `anchorYOffset`. + // Valid units are: // - ConfigURL string `json:"configUrl,omitempty"` - // The envelope ID of the envelope status that failed to post. - EnvelopeID string `json:"envelopeId,omitempty"` - // Connection status. - Status string `json:"status,omitempty"` - // Connection status message. - StatusMessage string `json:"statusMessage,omitempty"` -} - -type ConnectFailureResults struct { + // - `pixels` + // - `inches` + // - `mms` + // - `cms` // - RetryQueue []ConnectFailureResult `json:"retryQueue,omitempty"` -} - -type ConnectLog struct { - // The external account number (int) or account ID GUID. - AccountID string `json:"accountId,omitempty"` - // Web address of the listener or retrieving service endpoint for Connect. - ConfigURL string `json:"configUrl,omitempty"` - // A complex element containing information about the Connect configuration, error details, date/time, description and payload. - // This information is included in the response only when the `additional_info` query is set to **true**. - // This additional information is only available when retrieving general logs with [ConnectEvents:get](https://developers.docusign.com/esign-rest-api/reference/Connect/ConnectEvents/get); not when retrieving failure logs with [ConnectEvents:listFailures](https://developers.docusign.com/esign-rest-api/reference/Connect/ConnectEvents/listFailures). - ConnectDebugLog []ConnectDebugLog `json:"connectDebugLog,omitempty"` - // Identifier for the Connect configuration that failed. If an account has multiple Connect configurations, this value is used to look up the Connect configuration for the failed post. - ConnectID string `json:"connectId,omitempty"` - // Date and time the Connect post was created. - Created *time.Time `json:"created,omitempty"` - // Email address of the envelope sender. - Email string `json:"email,omitempty"` - // ID of the envelope that failed to post. - EnvelopeID string `json:"envelopeId,omitempty"` - // Server error for the Connect post failure. - Error string `json:"error,omitempty"` - // ID of the Connect post failure. - FailureID string `json:"failureId,omitempty"` - // URI for the Connect post failure. - FailureURI string `json:"failureUri,omitempty"` - // Date and time of the last attempt to post. - LastTry string `json:"lastTry,omitempty"` - // ID of the Connect log entry. - LogID string `json:"logId,omitempty"` - // URI for the Connect log entry. - LogURI string `json:"logUri,omitempty"` - // The number of times the Connect post has been retried. - RetryCount string `json:"retryCount,omitempty"` - // URI that can be used to retry to publish the Connect post. - RetryURI string `json:"retryUri,omitempty"` - // Envelope status for the Connect post: - // - `Any` - // - `Voided` - // - `Created` - // - `Deleted` - // - `Sent` - // - `Delivered` - // - `Signed` - // - `Completed` - // - `Declined` - // - `TimedOut` - // - `Template` - // - `Processing` - Status string `json:"status,omitempty"` - // The envelope subject. - Subject string `json:"subject,omitempty"` - // The name of the envelope sender. - UserName string `json:"userName,omitempty"` -} - -// ConnectLogs connect event logging information. This object contains sections for regular Connect logs and for Connect failures. -type ConnectLogs struct { - // A list of Connect failure logs. - Failures []ConnectLog `json:"failures,omitempty"` - // A list of Connect general logs. - Logs []ConnectLog `json:"logs,omitempty"` - // The count of records in the log list. - TotalRecords string `json:"totalRecords,omitempty"` - // Type of user: - // - `type_owner` - // - `type_participant` - Type string `json:"type,omitempty"` -} - -type ConnectSalesforceField struct { - // - DsAttribute string `json:"dsAttribute,omitempty"` - // - DsLink string `json:"dsLink,omitempty"` - // - DsNode string `json:"dsNode,omitempty"` - // A unique ID for the Salesforce object. - ID string `json:"id,omitempty"` - // - SfField string `json:"sfField,omitempty"` - // - SfFieldName string `json:"sfFieldName,omitempty"` - // - SfFolder string `json:"sfFolder,omitempty"` - // - SfLockedValue string `json:"sfLockedValue,omitempty"` -} - -type ConnectSalesforceObject struct { - // - Active string `json:"active,omitempty"` - // A sender-defined description of the line item. - // - Description string `json:"description,omitempty"` - // A unique ID for the Salesforce object. - ID string `json:"id,omitempty"` - // - Insert string `json:"insert,omitempty"` - // - OnCompleteOnly string `json:"onCompleteOnly,omitempty"` + AnchorUnits string `json:"anchorUnits,omitempty"` + // Metadata that indicates whether the `anchorUnits` property is editable. + AnchorUnitsMetadata *PropertyMetadata `json:"anchorUnitsMetadata,omitempty"` + // Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. // - SelectFields []ConnectSalesforceField `json:"selectFields,omitempty"` + AnchorXOffset string `json:"anchorXOffset,omitempty"` + // Metadata that indicates whether the `anchorXOffset` property is editable. + AnchorXOffsetMetadata *PropertyMetadata `json:"anchorXOffsetMetadata,omitempty"` + // Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. // - SfObject string `json:"sfObject,omitempty"` - // The name of the Salesforce object. - SfObjectName string `json:"sfObjectName,omitempty"` + AnchorYOffset string `json:"anchorYOffset,omitempty"` + // Metadata that indicates whether the `anchorYOffset` property is editable. + AnchorYOffsetMetadata *PropertyMetadata `json:"anchorYOffsetMetadata,omitempty"` + // When set to **true**, the information in the tab is bold. + Bold string `json:"bold,omitempty"` + // Metadata that indicates whether the `bold` property is editable. + BoldMetadata *PropertyMetadata `json:"boldMetadata,omitempty"` + // When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. // - UpdateFields []ConnectSalesforceField `json:"updateFields,omitempty"` -} - -type ConnectUserObject struct { - // The type of custom Connect configuration being accessed. - Configurationtype string `json:"configurationtype,omitempty"` - // The ID of the custom Connect configuration being accessed. - ConnectID string `json:"connectId,omitempty"` - // Boolean value that indicates whether the custom Connect configuration is enabled or not. - Enabled string `json:"enabled,omitempty"` + // When an envelope is completed the information is only available to the sender through the Form Data link in the DocuSign Console. The information on the downloaded document remains masked by asterisks. // - HasAccess string `json:"hasAccess,omitempty"` + // This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. + ConcealValueOnDocument string `json:"concealValueOnDocument,omitempty"` + // Metadata that indicates whether the `concealValueOnDocument` property is editable. + ConcealValueOnDocumentMetadata *PropertyMetadata `json:"concealValueOnDocumentMetadata,omitempty"` + // For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility. + ConditionalParentLabel string `json:"conditionalParentLabel,omitempty"` + // Metadata that indicates whether the `conditionalParentLabel` property is editable. + ConditionalParentLabelMetadata *PropertyMetadata `json:"conditionalParentLabelMetadata,omitempty"` + // For conditional fields, this is the value of the parent tab that controls the tab's visibility. // - SenderSearchableItems []string `json:"senderSearchableItems,omitempty"` -} - -type ConsoleViewRequest struct { - // The envelope ID of the envelope status that failed to post. - EnvelopeID string `json:"envelopeId,omitempty"` - // The URL to be redirected to after the console view session has ended. - ReturnURL string `json:"returnUrl,omitempty"` -} - -// ConsumerDisclosure account consumer disclosures -type ConsumerDisclosure struct { - // A GUID identifying the account associated with the consumer disclosure - AccountEsignID string `json:"accountEsignId,omitempty"` - // Indicates whether the customer can withdraw their acceptance of the consumer disclosure. - AllowCDWithdraw DSBool `json:"allowCDWithdraw,omitempty"` - // Metadata that indicates whether the `allowCDWithdraw` property is editable. + // If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. // - AllowCDWithdrawMetadata *SettingsMetadata `json:"allowCDWithdrawMetadata,omitempty"` + ConditionalParentValue string `json:"conditionalParentValue,omitempty"` + // Metadata that indicates whether the `conditionalParentValue` property is editable. + ConditionalParentValueMetadata *PropertyMetadata `json:"conditionalParentValueMetadata,omitempty"` + // The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. + CustomTabID string `json:"customTabId,omitempty"` + // Metadata that indicates whether the `customTabId` property is editable. + CustomTabIDMetadata *PropertyMetadata `json:"customTabIdMetadata,omitempty"` + // When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. + DisableAutoSize string `json:"disableAutoSize,omitempty"` + // Metadata that indicates whether the `disableAutoSize` property is editable. + DisableAutoSizeMetadata *PropertyMetadata `json:"disableAutoSizeMetadata,omitempty"` + // Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. + DocumentID string `json:"documentId,omitempty"` + // Metadata that indicates whether the `documentId` property is editable. + DocumentIDMetadata *PropertyMetadata `json:"documentIdMetadata,omitempty"` + // This object describes errors that occur. It is only valid for responses and ignored in requests. + ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` + // The font to be used for the tab value. Supported fonts include: // - ChangeEmail string `json:"changeEmail,omitempty"` + // - Default + // - Arial + // - ArialNarrow + // - Calibri + // - CourierNew + // - Garamond + // - Georgia + // - Helvetica + // - LucidaConsole + // - MSGothic + // - MSMincho + // - OCR-A + // - Tahoma + // - TimesNewRoman + // - Trebuchet + // - Verdana // - ChangeEmailOther string `json:"changeEmailOther,omitempty"` - // The name of the company associated with the consumer disclosure. - CompanyName string `json:"companyName,omitempty"` - // The phone number of the company associated with the consumer disclosure. - CompanyPhone string `json:"companyPhone,omitempty"` + Font string `json:"font,omitempty"` + // The font color to use for the information in the tab. Possible values are: // - CopyCostPerPage string `json:"copyCostPerPage,omitempty"` - // Specifies the fee collection method for cases in which the customer requires paper copies of the document. + // - Black + // - BrightBlue + // - BrightRed + // - DarkGreen + // - DarkRed + // - Gold + // - Green + // - NavyBlue + // - Purple + // - White // - // Maximum Length: 255 characters - CopyFeeCollectionMethod string `json:"copyFeeCollectionMethod,omitempty"` + FontColor string `json:"fontColor,omitempty"` + // Metadata that indicates whether the `fontColor` property is editable. + FontColorMetadata *PropertyMetadata `json:"fontColorMetadata,omitempty"` + // Metadata that indicates whether the `font` property is editable. + FontMetadata *PropertyMetadata `json:"fontMetadata,omitempty"` + // The font size used for the information in the tab. Possible values are: // - CopyRequestEmail string `json:"copyRequestEmail,omitempty"` + // - Size7 + // - Size8 + // - Size9 + // - Size10 + // - Size11 + // - Size12 + // - Size14 + // - Size16 + // - Size18 + // - Size20 + // - Size22 + // - Size24 + // - Size26 + // - Size28 + // - Size36 + // - Size48 + // - Size72 + FontSize string `json:"fontSize,omitempty"` + // Metadata that indicates whether the `fontSize` property is editable. + FontSizeMetadata *PropertyMetadata `json:"fontSizeMetadata,omitempty"` + // An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. + FormOrder string `json:"formOrder,omitempty"` + // Metadata that indicates whether the `formOrder` property is editable. + FormOrderMetadata *PropertyMetadata `json:"formOrderMetadata,omitempty"` + // A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. + FormPageLabel string `json:"formPageLabel,omitempty"` + // Metadata that indicates whether the `formPageLabel` property is editable. + FormPageLabelMetadata *PropertyMetadata `json:"formPageLabelMetadata,omitempty"` + // An integer specifying the order in which to present the guided form pages. + FormPageNumber string `json:"formPageNumber,omitempty"` + // Metadata that indicates whether the `fromPageNumber` property is editable. + FormPageNumberMetadata *PropertyMetadata `json:"formPageNumberMetadata,omitempty"` + // The height of the tab in pixels. + Height string `json:"height,omitempty"` + // Metadata that indicates whether the `height` property is editable. + HeightMetadata *PropertyMetadata `json:"heightMetadata,omitempty"` + // When set to **true**, the information in the tab is italic. + Italic string `json:"italic,omitempty"` + // Metadata that indicates whether the `italic` property is editable. + ItalicMetadata *PropertyMetadata `json:"italicMetadata,omitempty"` + // Reserved for DocuSign. + LocalePolicy *LocalePolicyTab `json:"localePolicy,omitempty"` + // When set to **true**, the signer cannot change the data of the custom tab. + Locked string `json:"locked,omitempty"` + // Metadata that indicates whether the `locked` property is editable. + LockedMetadata *PropertyMetadata `json:"lockedMetadata,omitempty"` + // An optional value that describes the maximum length of the property when the property is a string. + MaxLength string `json:"maxLength,omitempty"` + // Metadata that indicates whether the `maxLength` property is editable. + MaxLengthMetadata *PropertyMetadata `json:"maxLengthMetadata,omitempty"` + // Contains the information necessary to map the tab to a field in SalesForce. + MergeField *MergeField `json:"mergeField,omitempty"` // - Custom string `json:"custom,omitempty"` + MergeFieldXML string `json:"mergeFieldXml,omitempty"` // - EnableEsign string `json:"enableEsign,omitempty"` - // The Electronic Record and Signature Disclosure text. The disclosure text includes the html formatting. - EsignAgreement string `json:"esignAgreement,omitempty"` + Name string `json:"name,omitempty"` + // Metadata that indicates whether the `name` property is editable. Read only. + NameMetadata *PropertyMetadata `json:"nameMetadata,omitempty"` + // The initial value of the tab when it was sent to the recipient. + OriginalValue string `json:"originalValue,omitempty"` + // Metadata that indicates whether the `originalValue` property is editable. + OriginalValueMetadata *PropertyMetadata `json:"originalValueMetadata,omitempty"` + // Specifies the page number on which the tab is located. + PageNumber string `json:"pageNumber,omitempty"` + // Metadata that indicates whether the `pageNumber` property is editable. + PageNumberMetadata *PropertyMetadata `json:"pageNumberMetadata,omitempty"` + // Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. + RecipientID string `json:"recipientId,omitempty"` + // The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only. + RecipientIDGUID string `json:"recipientIdGuid,omitempty"` + // Metadata that indicates whether the `recipientIdGuid` property is editable. + RecipientIDGUIDMetadata *PropertyMetadata `json:"recipientIdGuidMetadata,omitempty"` + // Metadata that indicates whether the `recipientId` property is editable. + RecipientIDMetadata *PropertyMetadata `json:"recipientIdMetadata,omitempty"` + // When set to **true**, the signer is required to fill out this tab. + Required string `json:"required,omitempty"` + // Metadata that indicates whether the `required` property is editable. + RequiredMetadata *PropertyMetadata `json:"requiredMetadata,omitempty"` // - EsignText string `json:"esignText,omitempty"` + SmartContractInformation *SmartContractInformation `json:"smartContractInformation,omitempty"` + // Indicates the envelope status. Valid values are: // - LanguageCode string `json:"languageCode,omitempty"` + // * sent - The envelope is sent to the recipients. + // * created - The envelope is saved as a draft and can be modified and sent later. + Status string `json:"status,omitempty"` + // Metadata that indicates whether the `status` property is editable. + StatusMetadata *PropertyMetadata `json:"statusMetadata,omitempty"` + // An array of tab group labels that uniquely identify tab groups. To assign a tab to a `tabGroup`, you assign the `TabGroupLabel` to the `Tab.TabGroupLabels` array. + TabGroupLabels []string `json:"tabGroupLabels,omitempty"` + // Metadata that indicates whether the `tabGroupLabels` property is editable. + TabGroupLabelsMetadata *PropertyMetadata `json:"tabGroupLabelsMetadata,omitempty"` + // The unique identifier for the tab. + TabID string `json:"tabId,omitempty"` + // Metadata that indicates whether the `tabId` property is editable. + TabIDMetadata *PropertyMetadata `json:"tabIdMetadata,omitempty"` + // The label associated with the tab. This value may be an empty string. + // If no value is provided, the tab type is used as the value. // - MustAgreeToEsign string `json:"mustAgreeToEsign,omitempty"` - // **Deprecated** + // Maximum Length: 500 characters. // - // The `€œpdfId` property in the consumer_disclosure PUT request is deprecated. For security reasons going forward, any value provided in the request packet must be ignored. - PdfID string `json:"pdfId,omitempty"` + TabLabel string `json:"tabLabel,omitempty"` + // Metadata that indicates whether the `tabLabel` property is editable. + TabLabelMetadata *PropertyMetadata `json:"tabLabelMetadata,omitempty"` + // A positive integer that sets the order the tab is navigated to during signing. // - UseBrand string `json:"useBrand,omitempty"` - // Boolean that specifies whether recipients in the same account as the sender must agree to eSign an Electronic Record and Signature Disclosure Statement. - UseConsumerDisclosureWithinAccount DSBool `json:"useConsumerDisclosureWithinAccount,omitempty"` - // Metadata that indicates whether the `useConsumerDisclosureWithinAccount` property is editable. + // Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. + TabOrder string `json:"tabOrder,omitempty"` + // Metadata that indicates whether the `tabOrder` property is editable. + TabOrderMetadata *PropertyMetadata `json:"tabOrderMetadata,omitempty"` + // Indicates the type of tab (for example, `signHere` or `initialHere`). + TabType string `json:"tabType,omitempty"` + // Metadata that indicates whether the `tabType` property is editable. + TabTypeMetadata *PropertyMetadata `json:"tabTypeMetadata,omitempty"` + // When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. + TemplateLocked string `json:"templateLocked,omitempty"` + // Metadata that indicates whether the `templateLocked` property is editable. + TemplateLockedMetadata *PropertyMetadata `json:"templateLockedMetadata,omitempty"` + // When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. + TemplateRequired string `json:"templateRequired,omitempty"` + // Metadata that indicates whether the `templateRequired` property is editable. + TemplateRequiredMetadata *PropertyMetadata `json:"templateRequiredMetadata,omitempty"` + // Metadata that indicates whether the `toolTip` property is editable. + ToolTipMetadata *PropertyMetadata `json:"toolTipMetadata,omitempty"` + // The text of a tooltip that appears when a user hovers over a form field or tab. + Tooltip string `json:"tooltip,omitempty"` + // When set to **true**, the information in the tab is underlined. + Underline string `json:"underline,omitempty"` + // Metadata that indicates whether the `underline` property is editable. + UnderlineMetadata *PropertyMetadata `json:"underlineMetadata,omitempty"` + // Specifies the value of the tab. + Value string `json:"value,omitempty"` + // Metadata that indicates whether the `value` property is editable. + ValueMetadata *PropertyMetadata `json:"valueMetadata,omitempty"` + // The width of the tab in pixels. + Width string `json:"width,omitempty"` + // Metadata that indicates whether the `width` property is editable. + WidthMetadata *PropertyMetadata `json:"widthMetadata,omitempty"` + // This property indicates the horizontal offset of the object on the page. + // DocuSign uses 72 DPI when determining position. + // Required. May be zero. // - UseConsumerDisclosureWithinAccountMetadata *SettingsMetadata `json:"useConsumerDisclosureWithinAccountMetadata,omitempty"` - // Contains the first address line of the postal address to which a customer can send a consent withdrawal notification. + XPosition string `json:"xPosition,omitempty"` + // Metadata that indicates whether the `xPosition` property is editable. + XPositionMetadata *PropertyMetadata `json:"xPositionMetadata,omitempty"` + // This property indicates the vertical offset of the object on the page. + // DocuSign uses 72 DPI when determining position. + // Required. May be zero. // - // Maximum length: 100 characters. - WithdrawAddressLine1 string `json:"withdrawAddressLine1,omitempty"` - // Contains the second address line of the postal address to which a customer can send a consent withdrawal notification. + YPosition string `json:"yPosition,omitempty"` + // Metadata that indicates whether the `yPosition` property is editable. + YPositionMetadata *PropertyMetadata `json:"yPositionMetadata,omitempty"` +} + +type CommissionExpiration struct { // - // Maximum length: 100 characters. - WithdrawAddressLine2 string `json:"withdrawAddressLine2,omitempty"` - // Indicates whether the customer can withdraw consent by email. - WithdrawByEmail DSBool `json:"withdrawByEmail,omitempty"` - // Indicates whether the customer can withdraw consent by postal mail. - WithdrawByMail DSBool `json:"withdrawByMail,omitempty"` - // Indicates whether the customer can withdraw consent by phone. - WithdrawByPhone DSBool `json:"withdrawByPhone,omitempty"` - // Contains the city of the postal address to which a customer can send a consent withdrawal notification. + AnchorAllowWhiteSpaceInCharacters string `json:"anchorAllowWhiteSpaceInCharacters,omitempty"` // - // Maximum length: 50 characters. - WithdrawCity string `json:"withdrawCity,omitempty"` - // Indicates the consequences of withdrawing consent. - WithdrawConsequences string `json:"withdrawConsequences,omitempty"` - // Contains the email address to which a customer can send a consent withdrawal notification. + AnchorAllowWhiteSpaceInCharactersMetadata *PropertyMetadata `json:"anchorAllowWhiteSpaceInCharactersMetadata,omitempty"` + // This property controls how [anchor tabs][AnchorTabs] are placed. When **true**, the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false**. // - // Maximum length: 100 characters. - WithdrawEmail string `json:"withdrawEmail,omitempty"` - // Indicates other information need to withdraw consent. + // For example, when set to **true**, if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When set to **false**, `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. // - // Maximum length: 255 characters. - WithdrawOther string `json:"withdrawOther,omitempty"` - // Contains the phone number which a customer can call to register consent withdrawal notification. + // This functionality uses the following rules: // - // Maximum length: 20 characters. - WithdrawPhone string `json:"withdrawPhone,omitempty"` - // Contains the postal code of the postal address to which a customer can send a consent withdrawal notification. + // - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: // - // Maximum length: 20 characters. - WithdrawPostalCode string `json:"withdrawPostalCode,omitempty"` - // Contains the state of the postal address to which a customer can send a consent withdrawal notification. - WithdrawState string `json:"withdrawState,omitempty"` -} - -type Contact struct { + // $~><|^+= // - CloudProvider string `json:"cloudProvider,omitempty"` + // For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` // - CloudProviderContainerID string `json:"cloudProviderContainerId,omitempty"` - // The unique identifier of a person in the contacts address book. - ContactID string `json:"contactId,omitempty"` + // - Strings embedded in other strings are ignored during the matching process. // - ContactPhoneNumbers []ContactPhoneNumber `json:"contactPhoneNumbers,omitempty"` + // - In words that have dashes, the parts separated by dashes are treated as distinct words. // - ContactURI string `json:"contactUri,omitempty"` + // Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**. // - Emails []string `json:"emails,omitempty"` - // This object describes errors that occur. It is only valid for responses and ignored in requests. - ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` + // - Letters with accent marks are treated as distinct characters from their unaccented counterparts. // - IsOwner bool `json:"isOwner,omitempty"` + // - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. // - Name string `json:"name,omitempty"` + // Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. // - Organization string `json:"organization,omitempty"` - // When **true**, the tab is shared. - Shared DSBool `json:"shared,omitempty"` + // - Unlike punctuation, numbers are not ignored when finding anchor words. // - SigningGroup string `json:"signingGroup,omitempty"` - // The display name for the signing group. + // Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). // - // Maximum Length: 100 characters. - SigningGroupName string `json:"signingGroupName,omitempty"` -} - -type ContactGetResponse struct { + // **Note**: You can only specify the value of this property in POST requests. // - Contacts []Contact `json:"contacts,omitempty"` - // The last position in the result set. - EndPosition string `json:"endPosition,omitempty"` - // The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. - NextURI string `json:"nextUri,omitempty"` - // The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. - PreviousURI string `json:"previousUri,omitempty"` - // The number of results returned in this response. Because you can filter which entries are included in the response, this value is always less than or equal to `totalSetSize`. - ResultSetSize string `json:"resultSetSize,omitempty"` - // The starting position of the current result set. - StartPosition string `json:"startPosition,omitempty"` - // The total number of items in the search's result set. This value is always greater than or equal to the value of `resultSetSize`. - TotalSetSize string `json:"totalSetSize,omitempty"` -} - -type ContactModRequest struct { + // [AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place + AnchorCaseSensitive string `json:"anchorCaseSensitive,omitempty"` + // Metadata that indicates whether the `anchorCaseSensitive` property is editable. + AnchorCaseSensitiveMetadata *PropertyMetadata `json:"anchorCaseSensitiveMetadata,omitempty"` + // This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are : // - ContactList []Contact `json:"contactList,omitempty"` -} - -type ContactPhoneNumber struct { + // - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. + // - `right`: Aligns the tab’s left side with the last character of the matching anchor word. // - PhoneNumber string `json:"phoneNumber,omitempty"` + // **Note**: You can only specify the value of this property in POST requests. // - PhoneType string `json:"phoneType,omitempty"` -} - -type ContactUpdateResponse struct { + // [AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place // - Contacts []Contact `json:"contacts,omitempty"` -} - -type CorrectViewRequest struct { - // The url used after correct/send view session has ended. DocuSign redirects to the url and includes an event parameter that can be used by your app. The event parameters returned are: + AnchorHorizontalAlignment string `json:"anchorHorizontalAlignment,omitempty"` + // Metadata that indicates whether the `anchorHorizontalAlignment` property is editable. + AnchorHorizontalAlignmentMetadata *PropertyMetadata `json:"anchorHorizontalAlignmentMetadata,omitempty"` + // When set to **true**, this tab is ignored if the `anchorString` is not found in the document. + AnchorIgnoreIfNotPresent string `json:"anchorIgnoreIfNotPresent,omitempty"` + // Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable. + AnchorIgnoreIfNotPresentMetadata *PropertyMetadata `json:"anchorIgnoreIfNotPresentMetadata,omitempty"` + // When set to **true**, the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false**. // - // * send (user corrected and sent the envelope) - // * save (user saved the envelope) - // * cancel (user canceled the transaction.) - // * error (there was an error when performing the correct or send) - // * sessionEnd (the session ended before the user completed a different action) + // For example, when set to **true**, if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When set to **false**, if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. // - // ###### Note: Include https:// in the URL or the redirect might not succeed on some browsers. - ReturnURL string `json:"returnUrl,omitempty"` - // Specifies whether the window is displayed with or without dressing. - SuppressNavigation string `json:"suppressNavigation,omitempty"` -} - -type Country struct { + // This functionality uses the following rules: // - IsoCode string `json:"isoCode,omitempty"` + // - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: // - Name string `json:"name,omitempty"` + // $~><|^+= // - ProvinceValidated string `json:"provinceValidated,omitempty"` + // For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` // - Provinces []Province `json:"provinces,omitempty"` -} - -type Credential struct { - // If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. + // - Strings embedded in other strings are ignored during the matching process. // - // Maximum Length: 50 characters and it must conform to the account's access code format setting. + // - In words that have dashes, the parts separated by dashes are treated as distinct words. // - // If blank, but the signer `accessCode` property is set in the envelope, then that value is used. + // Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**. // - // If blank and the signer `accessCode` property is not set, then the access code is not required. - AccessCode string `json:"accessCode,omitempty"` - // Type of user: - // - `type_owner` - // - `type_participant` - Type string `json:"type,omitempty"` - // Specifies the value of the tab. - Value string `json:"value,omitempty"` -} - -// CreditCardInformation this object contains information about a credit card that is associated with an account. -type CreditCardInformation struct { - // A complex element containing the credit card billing address information. - Address *AddressInformation `json:"address,omitempty"` - // The credit card number. - CardNumber string `json:"cardNumber,omitempty"` - // The type of credit card. Valid values are: + // - Letters with accent marks are treated as distinct characters from their unaccented counterparts. // - // - `visa` - // - `mastercard` - // - `amex` - CardType string `json:"cardType,omitempty"` - // The 3 or 4-digit card verification value (CVV) number associated with the credit card. CVV numbers are also referred to as card security codes (CSCs). - CvNumber string `json:"cvNumber,omitempty"` - // The month that the credit card expires, expressed as a number from 1 to 12. - ExpirationMonth string `json:"expirationMonth,omitempty"` - // The year in which the credit card expires, in 4-digit format. - ExpirationYear string `json:"expirationYear,omitempty"` - // The exact name as it appears on the credit card. - NameOnCard string `json:"nameOnCard,omitempty"` -} - -type CreditCardTypes struct { - // An array containing supported credit card types. - CardTypes []string `json:"cardTypes,omitempty"` -} - -// CurrencyFeatureSetPrice information about the price and currency associated with the feature set. Reserved for internal DocuSign use only. -type CurrencyFeatureSetPrice struct { - // Reserved for DocuSign. - CurrencyCode string `json:"currencyCode,omitempty"` - // Reserved for DocuSign. - CurrencySymbol string `json:"currencySymbol,omitempty"` - // Reserved for DocuSign. - EnvelopeFee DSBool `json:"envelopeFee,omitempty"` - // Reserved for DocuSign. - FixedFee DSBool `json:"fixedFee,omitempty"` - // Reserved for DocuSign. - SeatFee DSBool `json:"seatFee,omitempty"` -} - -type CurrencyPlanPrice struct { - // Specifies the ISO currency code for the account. - CurrencyCode string `json:"currencyCode,omitempty"` - // Specifies the currency symbol for the account. - CurrencySymbol string `json:"currencySymbol,omitempty"` + // - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. // - PerSeatPrice string `json:"perSeatPrice,omitempty"` - // The support incident fee charged for each support incident. - SupportIncidentFee string `json:"supportIncidentFee,omitempty"` - // The support plan fee charged for this plan. - SupportPlanFee string `json:"supportPlanFee,omitempty"` - // A simple type enumeration of the language used. The supported languages, with the language value shown in parenthesis, are: Arabic (ar), Bahasa Indonesia (id), Bahasa Melayu (ms) Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro),Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). - SupportedCardTypes *CreditCardTypes `json:"supportedCardTypes,omitempty"` -} - -type CustomField struct { + // Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. // - CustomFieldType string `json:"customFieldType,omitempty"` - // This object describes errors that occur. It is only valid for responses and ignored in requests. - ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` - // An ID used to specify a custom field. - FieldID string `json:"fieldId,omitempty"` - // An array of strings that represent the items in a list. - ListItems []string `json:"listItems,omitempty"` + // - Unlike punctuation, numbers are not ignored when finding anchor words. // - Name string `json:"name,omitempty"` - // When set to **true**, the signer is required to fill out this tab. - Required TabRequired `json:"required,omitempty"` - // A boolean indicating if the value should be displayed. If this value is set to **true**, the custom field is displayed at the top of the certificate of completion. If this value is left blank/ or set to **false**, then it does not appear in the certificate of completion. - Show DSBool `json:"show,omitempty"` - // Specifies the value of the tab. - Value string `json:"value,omitempty"` -} - -// CustomFields envelope custom fields -type CustomFields struct { - // An array of list custom fields. - ListCustomFields []ListCustomField `json:"listCustomFields,omitempty"` - // An array of text custom fields. - TextCustomFields []TextCustomField `json:"textCustomFields,omitempty"` -} - -type CustomFieldsEnvelope struct { - // An array of list custom fields. - ListCustomFields []ListCustomField `json:"listCustomFields,omitempty"` - // An array of text custom fields. - TextCustomFields []TextCustomField `json:"textCustomFields,omitempty"` -} - -// CustomSettingsInformation users' custom settings -type CustomSettingsInformation struct { - // The name/value pair information for the user custom setting. - CustomSettings []NameValue `json:"customSettings,omitempty"` -} - -// Date is a tab that allows the recipient to enter a date. Date tabs -// are one-line fields that allow date information to be -// entered in any format. The tooltip for this tab recommends -// entering the date as MM/DD/YYYY, but this is not enforced. -// The format entered by the signer is retained. If you need a -// particular date format enforced, DocuSign recommends using a -// Text tab with a validation pattern and a validation message -// to enforce the format. -// -type Date struct { - TabBase - TabGuidedForm - TabPosition - TabStyle - TabValue - // When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. + // Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). // - // When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. // - // This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. - ConcealValueOnDocument DSBool `json:"concealValueOnDocument,omitempty"` - // Metadata that indicates whether the `concealValueOnDocument` property is editable. - ConcealValueOnDocumentMetadata *PropertyMetadata `json:"concealValueOnDocumentMetadata,omitempty"` - // When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. - DisableAutoSize DSBool `json:"disableAutoSize,omitempty"` - // Metadata that indicates whether the `disableAutoSize` property is editable. - DisableAutoSizeMetadata *PropertyMetadata `json:"disableAutoSizeMetadata,omitempty"` - // The height of the tab in pixels. - Height string `json:"height,omitempty"` - // Metadata that indicates whether the `height` property is editable. - HeightMetadata *PropertyMetadata `json:"heightMetadata,omitempty"` - // Reserved for DocuSign. - LocalePolicy *LocalePolicyTab `json:"localePolicy,omitempty"` - // When set to **true**, the signer cannot change the data of the custom tab. - Locked DSBool `json:"locked,omitempty"` - // Metadata that indicates whether the `locked` property is editable. - LockedMetadata *PropertyMetadata `json:"lockedMetadata,omitempty"` - // An optional value that describes the maximum length of the property when the property is a string. - MaxLength string `json:"maxLength,omitempty"` - // Metadata that indicates whether the `maxLength` property is editable. - MaxLengthMetadata *PropertyMetadata `json:"maxLengthMetadata,omitempty"` - // The initial value of the tab when it was sent to the recipient. - OriginalValue string `json:"originalValue,omitempty"` - // Metadata that indicates whether the `originalValue` property is editable. - OriginalValueMetadata *PropertyMetadata `json:"originalValueMetadata,omitempty"` - // When set to **true** and shared is true, information must be entered in this field to complete the envelope. - RequireAll DSBool `json:"requireAll,omitempty"` - // Metadata that indicates whether the `requireAll` property is editable. - RequireAllMetadata *PropertyMetadata `json:"requireAllMetadata,omitempty"` - // Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field. - RequireInitialOnSharedChange DSBool `json:"requireInitialOnSharedChange,omitempty"` - // Metadata that indicates whether the `requireInitialOnSharedChange` property is editable. - RequireInitialOnSharedChangeMetadata *PropertyMetadata `json:"requireInitialOnSharedChangeMetadata,omitempty"` - // When set to **true**, the signer is required to fill out this tab. - Required TabRequired `json:"required,omitempty"` - // Metadata that indicates whether the `required` property is editable. - RequiredMetadata *PropertyMetadata `json:"requiredMetadata,omitempty"` - // When set to **true**, the sender must populate the tab before an envelope can be sent using the template. + // **Note**: You can only specify the value of this property in POST requests. // - // This value tab can only be changed by modifying (PUT) the template. + // [AnchorTab]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place // - // Tabs with a `senderRequired` value of true cannot be deleted from an envelope. - SenderRequired DSBool `json:"senderRequired,omitempty"` - // Metadata that indicates whether the `senderRequired` property is editable. - SenderRequiredMetadata *PropertyMetadata `json:"senderRequiredMetadata,omitempty"` - // When set to **true**, this custom tab is shared. - Shared DSBool `json:"shared,omitempty"` - // Metadata that indicates whether the `shared` property is editable. - SharedMetadata *PropertyMetadata `json:"sharedMetadata,omitempty"` - // Metadata that indicates whether the `toolTip` property is editable. - ToolTipMetadata *PropertyMetadata `json:"toolTipMetadata,omitempty"` - // The text of a tooltip that appears when a user hovers over a form field or tab. - Tooltip string `json:"tooltip,omitempty"` - // The message displayed if the custom tab fails input validation (either custom of embedded). - ValidationMessage string `json:"validationMessage,omitempty"` - // Metadata that indicates whether the `validationMessage` property is editable. - ValidationMessageMetadata *PropertyMetadata `json:"validationMessageMetadata,omitempty"` - // A regular expression used to validate input for the tab. - ValidationPattern string `json:"validationPattern,omitempty"` - // Metadata that indicates whether the `validationPattern` property is editable. - ValidationPatternMetadata *PropertyMetadata `json:"validationPatternMetadata,omitempty"` - // The width of the tab in pixels. - Width string `json:"width,omitempty"` - // Metadata that indicates whether the `width` property is editable. - WidthMetadata *PropertyMetadata `json:"widthMetadata,omitempty"` -} - -// DateSigned is a tab that displays the date that the recipient signed the -// document. -// -type DateSigned struct { - TabBase - TabGuidedForm - TabPosition - TabStyle - TabValue - // The height of the tab in pixels. - Height string `json:"height,omitempty"` - // Metadata that indicates whether the `height` property is editable. - HeightMetadata *PropertyMetadata `json:"heightMetadata,omitempty"` + AnchorMatchWholeWord string `json:"anchorMatchWholeWord,omitempty"` + // Metadata that indicates whether the `anchorMatchWholeWord` property is editable. + AnchorMatchWholeWordMetadata *PropertyMetadata `json:"anchorMatchWholeWordMetadata,omitempty"` + // Specifies the string to find in the document and use as the basis for tab placement. + AnchorString string `json:"anchorString,omitempty"` + // Metadata that indicates whether the `anchorString` property is editable. + AnchorStringMetadata *PropertyMetadata `json:"anchorStringMetadata,omitempty"` // Reserved for DocuSign. - LocalePolicy *LocalePolicyTab `json:"localePolicy,omitempty"` - // Metadata that indicates whether the `toolTip` property is editable. - ToolTipMetadata *PropertyMetadata `json:"toolTipMetadata,omitempty"` - // The text of a tooltip that appears when a user hovers over a form field or tab. - Tooltip string `json:"tooltip,omitempty"` - // The width of the tab in pixels. - Width string `json:"width,omitempty"` - // Metadata that indicates whether the `width` property is editable. - WidthMetadata *PropertyMetadata `json:"widthMetadata,omitempty"` -} - -// DateStampProperties specifies the area in which a date stamp is placed. This parameter uses pixel positioning to draw a rectangle at the center of the stamp area. The stamp is superimposed on top of this central area. -// -// This property contains the following information about the central rectangle: -// -// - `DateAreaX`: The X axis position of the top-left corner. -// - `DateAreaY`: The Y axis position of the top-left corner. -// - `DateAreaWidth`: The width of the rectangle. -// - `DateAreaHeight`: The height of the rectangle. -type DateStampProperties struct { - // The height of the rectangle. - DateAreaHeight string `json:"dateAreaHeight,omitempty"` - // The width of the rectangle. - DateAreaWidth string `json:"dateAreaWidth,omitempty"` - // The X axis position of the top-left corner. - DateAreaX string `json:"dateAreaX,omitempty"` - // The Y axis position of the top-left corner. - DateAreaY string `json:"dateAreaY,omitempty"` -} - -// Decline is a tab that allows the recipient the option of declining an -// envelope. If the recipient clicks the tab during the signing -// process, the envelope is voided. -// -type Decline struct { - TabBase - TabGuidedForm - TabPosition + AnchorTabProcessorVersion string `json:"anchorTabProcessorVersion,omitempty"` + // Reserved for DocuSign. + AnchorTabProcessorVersionMetadata *PropertyMetadata `json:"anchorTabProcessorVersionMetadata,omitempty"` + // Specifies units of the + // `anchorXOffset` and + // `anchorYOffset`. + // Valid units are: + // + // - `pixels` + // - `inches` + // - `mms` + // - `cms` + // + AnchorUnits string `json:"anchorUnits,omitempty"` + // Metadata that indicates whether the `anchorUnits` property is editable. + AnchorUnitsMetadata *PropertyMetadata `json:"anchorUnitsMetadata,omitempty"` + // Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. + // + AnchorXOffset string `json:"anchorXOffset,omitempty"` + // Metadata that indicates whether the `anchorXOffset` property is editable. + AnchorXOffsetMetadata *PropertyMetadata `json:"anchorXOffsetMetadata,omitempty"` + // Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. + // + AnchorYOffset string `json:"anchorYOffset,omitempty"` + // Metadata that indicates whether the `anchorYOffset` property is editable. + AnchorYOffsetMetadata *PropertyMetadata `json:"anchorYOffsetMetadata,omitempty"` // When set to **true**, the information in the tab is bold. Bold string `json:"bold,omitempty"` // Metadata that indicates whether the `bold` property is editable. BoldMetadata *PropertyMetadata `json:"boldMetadata,omitempty"` - // Specifies the decline text displayed in the tab. - ButtonText string `json:"buttonText,omitempty"` - // Metadata that indicates whether the `buttonText` property is editable. - ButtonTextMetadata *PropertyMetadata `json:"buttonTextMetadata,omitempty"` - // The reason the recipient declined the document. - DeclineReason string `json:"declineReason,omitempty"` - // Metadata that indicates whether the `declineReason` property is editable. - DeclineReasonMetadata *PropertyMetadata `json:"declineReasonMetadata,omitempty"` + // When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. + // + // When an envelope is completed the information is only available to the sender through the Form Data link in the DocuSign Console. The information on the downloaded document remains masked by asterisks. + // + // This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. + ConcealValueOnDocument string `json:"concealValueOnDocument,omitempty"` + // Metadata that indicates whether the `concealValueOnDocument` property is editable. + ConcealValueOnDocumentMetadata *PropertyMetadata `json:"concealValueOnDocumentMetadata,omitempty"` + // For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility. + ConditionalParentLabel string `json:"conditionalParentLabel,omitempty"` + // Metadata that indicates whether the `conditionalParentLabel` property is editable. + ConditionalParentLabelMetadata *PropertyMetadata `json:"conditionalParentLabelMetadata,omitempty"` + // For conditional fields, this is the value of the parent tab that controls the tab's visibility. + // + // If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. + // + ConditionalParentValue string `json:"conditionalParentValue,omitempty"` + // Metadata that indicates whether the `conditionalParentValue` property is editable. + ConditionalParentValueMetadata *PropertyMetadata `json:"conditionalParentValueMetadata,omitempty"` + // The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. + CustomTabID string `json:"customTabId,omitempty"` + // Metadata that indicates whether the `customTabId` property is editable. + CustomTabIDMetadata *PropertyMetadata `json:"customTabIdMetadata,omitempty"` + // When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. + DisableAutoSize string `json:"disableAutoSize,omitempty"` + // Metadata that indicates whether the `disableAutoSize` property is editable. + DisableAutoSizeMetadata *PropertyMetadata `json:"disableAutoSizeMetadata,omitempty"` + // Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. + DocumentID string `json:"documentId,omitempty"` + // Metadata that indicates whether the `documentId` property is editable. + DocumentIDMetadata *PropertyMetadata `json:"documentIdMetadata,omitempty"` + // This object describes errors that occur. It is only valid for responses and ignored in requests. + ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` // The font to be used for the tab value. Supported fonts include: // // - Default @@ -5479,6 +6584,18 @@ type Decline struct { FontSize string `json:"fontSize,omitempty"` // Metadata that indicates whether the `fontSize` property is editable. FontSizeMetadata *PropertyMetadata `json:"fontSizeMetadata,omitempty"` + // An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. + FormOrder string `json:"formOrder,omitempty"` + // Metadata that indicates whether the `formOrder` property is editable. + FormOrderMetadata *PropertyMetadata `json:"formOrderMetadata,omitempty"` + // A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. + FormPageLabel string `json:"formPageLabel,omitempty"` + // Metadata that indicates whether the `formPageLabel` property is editable. + FormPageLabelMetadata *PropertyMetadata `json:"formPageLabelMetadata,omitempty"` + // An integer specifying the order in which to present the guided form pages. + FormPageNumber string `json:"formPageNumber,omitempty"` + // Metadata that indicates whether the `fromPageNumber` property is editable. + FormPageNumberMetadata *PropertyMetadata `json:"formPageNumberMetadata,omitempty"` // The height of the tab in pixels. Height string `json:"height,omitempty"` // Metadata that indicates whether the `height` property is editable. @@ -5489,688 +6606,871 @@ type Decline struct { ItalicMetadata *PropertyMetadata `json:"italicMetadata,omitempty"` // Reserved for DocuSign. LocalePolicy *LocalePolicyTab `json:"localePolicy,omitempty"` - // Metadata that indicates whether the `toolTip` property is editable. - ToolTipMetadata *PropertyMetadata `json:"toolTipMetadata,omitempty"` - // The text of a tooltip that appears when a user hovers over a form field or tab. - Tooltip string `json:"tooltip,omitempty"` - // When set to **true**, the information in the tab is underlined. - Underline string `json:"underline,omitempty"` - // Metadata that indicates whether the `underline` property is editable. - UnderlineMetadata *PropertyMetadata `json:"underlineMetadata,omitempty"` - // The width of the tab in pixels. - Width string `json:"width,omitempty"` - // Metadata that indicates whether the `width` property is editable. - WidthMetadata *PropertyMetadata `json:"widthMetadata,omitempty"` -} - -type DiagnosticsSettingsInformation struct { - // Specifies the maximum number of API requests to log. - APIRequestLogMaxEntries string `json:"apiRequestLogMaxEntries,omitempty"` - // Indicates the remaining number of API requests that can be logged. - APIRequestLogRemainingEntries string `json:"apiRequestLogRemainingEntries,omitempty"` - // When set to **true**, enables API request logging for the user. - APIRequestLogging DSBool `json:"apiRequestLogging,omitempty"` -} - -type DirectDebitProcessorInformation struct { - // - BankBranchCode string `json:"bankBranchCode,omitempty"` - // - BankCheckDigit string `json:"bankCheckDigit,omitempty"` - // - BankCode string `json:"bankCode,omitempty"` + // When set to **true**, the signer cannot change the data of the custom tab. + Locked string `json:"locked,omitempty"` + // Metadata that indicates whether the `locked` property is editable. + LockedMetadata *PropertyMetadata `json:"lockedMetadata,omitempty"` + // An optional value that describes the maximum length of the property when the property is a string. + MaxLength string `json:"maxLength,omitempty"` + // Metadata that indicates whether the `maxLength` property is editable. + MaxLengthMetadata *PropertyMetadata `json:"maxLengthMetadata,omitempty"` + // Contains the information necessary to map the tab to a field in SalesForce. + MergeField *MergeField `json:"mergeField,omitempty"` // - BankName string `json:"bankName,omitempty"` + MergeFieldXML string `json:"mergeFieldXml,omitempty"` // - BankTransferAccountName string `json:"bankTransferAccountName,omitempty"` + Name string `json:"name,omitempty"` + // Metadata that indicates whether the `name` property is editable. Read only. + NameMetadata *PropertyMetadata `json:"nameMetadata,omitempty"` + // The initial value of the tab when it was sent to the recipient. + OriginalValue string `json:"originalValue,omitempty"` + // Metadata that indicates whether the `originalValue` property is editable. + OriginalValueMetadata *PropertyMetadata `json:"originalValueMetadata,omitempty"` + // Specifies the page number on which the tab is located. + PageNumber string `json:"pageNumber,omitempty"` + // Metadata that indicates whether the `pageNumber` property is editable. + PageNumberMetadata *PropertyMetadata `json:"pageNumberMetadata,omitempty"` + // Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. + RecipientID string `json:"recipientId,omitempty"` + // The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only. + RecipientIDGUID string `json:"recipientIdGuid,omitempty"` + // Metadata that indicates whether the `recipientIdGuid` property is editable. + RecipientIDGUIDMetadata *PropertyMetadata `json:"recipientIdGuidMetadata,omitempty"` + // Metadata that indicates whether the `recipientId` property is editable. + RecipientIDMetadata *PropertyMetadata `json:"recipientIdMetadata,omitempty"` + // When set to **true**, the signer is required to fill out this tab. + Required string `json:"required,omitempty"` + // Metadata that indicates whether the `required` property is editable. + RequiredMetadata *PropertyMetadata `json:"requiredMetadata,omitempty"` // - BankTransferAccountNumber string `json:"bankTransferAccountNumber,omitempty"` + SmartContractInformation *SmartContractInformation `json:"smartContractInformation,omitempty"` + // Indicates the envelope status. Valid values are: // - BankTransferType string `json:"bankTransferType,omitempty"` - // Specifies the country associated with the address. - Country string `json:"country,omitempty"` - // Filters returned user records by the specified email address. - Email string `json:"email,omitempty"` - // The user's first name. - // Maximum Length: 50 characters. - FirstName string `json:"firstName,omitempty"` + // * sent - The envelope is sent to the recipients. + // * created - The envelope is saved as a draft and can be modified and sent later. + Status string `json:"status,omitempty"` + // Metadata that indicates whether the `status` property is editable. + StatusMetadata *PropertyMetadata `json:"statusMetadata,omitempty"` + // An array of tab group labels that uniquely identify tab groups. To assign a tab to a `tabGroup`, you assign the `TabGroupLabel` to the `Tab.TabGroupLabels` array. + TabGroupLabels []string `json:"tabGroupLabels,omitempty"` + // Metadata that indicates whether the `tabGroupLabels` property is editable. + TabGroupLabelsMetadata *PropertyMetadata `json:"tabGroupLabelsMetadata,omitempty"` + // The unique identifier for the tab. + TabID string `json:"tabId,omitempty"` + // Metadata that indicates whether the `tabId` property is editable. + TabIDMetadata *PropertyMetadata `json:"tabIdMetadata,omitempty"` + // The label associated with the tab. This value may be an empty string. + // If no value is provided, the tab type is used as the value. // - IBAN string `json:"iBAN,omitempty"` + // Maximum Length: 500 characters. // - LastName string `json:"lastName,omitempty"` -} - -type DobInformationInput struct { - // Specifies the recipient's date, month, and year of birth. - DateOfBirth string `json:"dateOfBirth,omitempty"` - // Specifies the display level for the recipient. Valid values are: - // * `ReadOnly` - // * `Editable` - // * `DoNotDisplay` - DisplayLevelCode string `json:"displayLevelCode,omitempty"` - // A Boolean value that specifies whether the information must be returned in the response. - ReceiveInResponse DSBool `json:"receiveInResponse,omitempty"` + TabLabel string `json:"tabLabel,omitempty"` + // Metadata that indicates whether the `tabLabel` property is editable. + TabLabelMetadata *PropertyMetadata `json:"tabLabelMetadata,omitempty"` + // A positive integer that sets the order the tab is navigated to during signing. + // + // Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. + TabOrder string `json:"tabOrder,omitempty"` + // Metadata that indicates whether the `tabOrder` property is editable. + TabOrderMetadata *PropertyMetadata `json:"tabOrderMetadata,omitempty"` + // Indicates the type of tab (for example, `signHere` or `initialHere`). + TabType string `json:"tabType,omitempty"` + // Metadata that indicates whether the `tabType` property is editable. + TabTypeMetadata *PropertyMetadata `json:"tabTypeMetadata,omitempty"` + // When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. + TemplateLocked string `json:"templateLocked,omitempty"` + // Metadata that indicates whether the `templateLocked` property is editable. + TemplateLockedMetadata *PropertyMetadata `json:"templateLockedMetadata,omitempty"` + // When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. + TemplateRequired string `json:"templateRequired,omitempty"` + // Metadata that indicates whether the `templateRequired` property is editable. + TemplateRequiredMetadata *PropertyMetadata `json:"templateRequiredMetadata,omitempty"` + // Metadata that indicates whether the `toolTip` property is editable. + ToolTipMetadata *PropertyMetadata `json:"toolTipMetadata,omitempty"` + // The text of a tooltip that appears when a user hovers over a form field or tab. + Tooltip string `json:"tooltip,omitempty"` + // When set to **true**, the information in the tab is underlined. + Underline string `json:"underline,omitempty"` + // Metadata that indicates whether the `underline` property is editable. + UnderlineMetadata *PropertyMetadata `json:"underlineMetadata,omitempty"` + // Specifies the value of the tab. + Value string `json:"value,omitempty"` + // Metadata that indicates whether the `value` property is editable. + ValueMetadata *PropertyMetadata `json:"valueMetadata,omitempty"` + // The width of the tab in pixels. + Width string `json:"width,omitempty"` + // Metadata that indicates whether the `width` property is editable. + WidthMetadata *PropertyMetadata `json:"widthMetadata,omitempty"` + // This property indicates the horizontal offset of the object on the page. + // DocuSign uses 72 DPI when determining position. + // Required. May be zero. + // + XPosition string `json:"xPosition,omitempty"` + // Metadata that indicates whether the `xPosition` property is editable. + XPositionMetadata *PropertyMetadata `json:"xPositionMetadata,omitempty"` + // This property indicates the vertical offset of the object on the page. + // DocuSign uses 72 DPI when determining position. + // Required. May be zero. + // + YPosition string `json:"yPosition,omitempty"` + // Metadata that indicates whether the `yPosition` property is editable. + YPositionMetadata *PropertyMetadata `json:"yPositionMetadata,omitempty"` } -// Document is a document object. -type Document struct { - // Reserved for DocuSign - ApplyAnchorTabs string `json:"applyAnchorTabs,omitempty"` - // This string sets the display and behavior properties of - // the document during signing. The possible values are: - // - // * `modal`
- // The document is shown as a supplement action strip - // and can be viewed, downloaded, or printed in a modal window. - // This is the recommended value for supplemental documents. +type CommissionNumber struct { // - // * `download`
- // The document is shown as a supplement action strip - // and can be viewed, downloaded, or printed in a new browser window. + AnchorAllowWhiteSpaceInCharacters string `json:"anchorAllowWhiteSpaceInCharacters,omitempty"` // - // * `inline`
- // The document is shown in the normal signing window. - // This value is not used with supplemental documents, - // but is the default value for all other documents. + AnchorAllowWhiteSpaceInCharactersMetadata *PropertyMetadata `json:"anchorAllowWhiteSpaceInCharactersMetadata,omitempty"` + // This property controls how [anchor tabs][AnchorTabs] are placed. When **true**, the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false**. // - Display string `json:"display,omitempty"` - // The document's bytes. This field can be used to include a base64 version of the document bytes within an envelope definition instead of sending the document using a multi-part HTTP request. The maximum document size is smaller if this field is used due to the overhead of the base64 encoding. - DocumentBase64 []byte `json:"documentBase64,omitempty"` + // For example, when set to **true**, if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When set to **false**, `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. // - DocumentFields []NameValue `json:"documentFields,omitempty"` - // The type of group the document belongs to (`certificate` or `content`). - DocumentGroup string `json:"documentGroup,omitempty"` - // Specifies the document ID of this document. This value is used by tabs to determine which document they appear in. - DocumentID string `json:"documentId,omitempty"` - // When set to **true**, the document is been already encrypted by the sender for use with the DocuSign Key Manager Security Appliance. + // This functionality uses the following rules: // - EncryptedWithKeyManager DSBool `json:"encryptedWithKeyManager,omitempty"` - // The file extension type of the document. Non-PDF documents are converted to PDF. + // - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: // - // If the document is not a PDF, `fileExtension` is required. + // $~><|^+= // - // If you try to upload a non-PDF document without a `fileExtension`, you will receive an "unable to load document" error message. + // For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` // - FileExtension string `json:"fileExtension,omitempty"` + // - Strings embedded in other strings are ignored during the matching process. // - FileFormatHint string `json:"fileFormatHint,omitempty"` + // - In words that have dashes, the parts separated by dashes are treated as distinct words. // - HTMLDefinition *DocumentHTMLDefinition `json:"htmlDefinition,omitempty"` - // When set to **true**, - // the document is included in the combined document download. - // The default value is **true**. + // Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**. // - IncludeInDownload DSBool `json:"includeInDownload,omitempty"` - // Matchboxes define areas in a document for document matching when you are creating envelopes. They are only used when you upload and edit a template. + // - Letters with accent marks are treated as distinct characters from their unaccented counterparts. // - // A matchbox consists of 5 elements: + // - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. // - // * pageNumber - The document page number on which the matchbox will appear. - // * xPosition - The x position of the matchbox on a page. - // * yPosition - The y position of the matchbox on a page. - // * width - The width of the matchbox. - // * height - The height of the matchbox. + // Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. // - MatchBoxes []MatchBox `json:"matchBoxes,omitempty"` - // The name of the document. - Name string `json:"name,omitempty"` - // (Optional) The order in which to sort the results. + // - Unlike punctuation, numbers are not ignored when finding anchor words. // - // Valid values are: + // Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). // + // **Note**: You can only specify the value of this property in POST requests. // - // * `asc`: Ascending order. - // * `desc`: Descending order. - Order string `json:"order,omitempty"` - // An integer value specifying the number of document pages in the template. - PageCount string `json:"pageCount,omitempty"` + // [AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place + AnchorCaseSensitive string `json:"anchorCaseSensitive,omitempty"` + // Metadata that indicates whether the `anchorCaseSensitive` property is editable. + AnchorCaseSensitiveMetadata *PropertyMetadata `json:"anchorCaseSensitiveMetadata,omitempty"` + // This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are : // - PageSizes []PageSize `json:"pageSizes,omitempty"` - // An array of page objects. - Pages string `json:"pages,omitempty"` - // The user's encrypted password hash. - Password string `json:"password,omitempty"` + // - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. + // - `right`: Aligns the tab’s left side with the last character of the matching anchor word. // - PdfFormFieldOption string `json:"pdfFormFieldOption,omitempty"` - // The file id from the cloud storage service where the document is located. This information is returned using [CloudStorage::listFolders](https://developers.docusign.com/esign-rest-api/reference/CloudStorage/CloudStorage/listFolders) or [CloudStorage::list](https://developers.docusign.com/esign-rest-api/reference/CloudStorage/CloudStorage/list). + // **Note**: You can only specify the value of this property in POST requests. // - RemoteURL string `json:"remoteUrl,omitempty"` - // Sets how the signer interacts with the supplemental document. - // The possible values are: + // [AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place // - // * `no_interaction`
- // No recipient action is required. + AnchorHorizontalAlignment string `json:"anchorHorizontalAlignment,omitempty"` + // Metadata that indicates whether the `anchorHorizontalAlignment` property is editable. + AnchorHorizontalAlignmentMetadata *PropertyMetadata `json:"anchorHorizontalAlignmentMetadata,omitempty"` + // When set to **true**, this tab is ignored if the `anchorString` is not found in the document. + AnchorIgnoreIfNotPresent string `json:"anchorIgnoreIfNotPresent,omitempty"` + // Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable. + AnchorIgnoreIfNotPresentMetadata *PropertyMetadata `json:"anchorIgnoreIfNotPresentMetadata,omitempty"` + // When set to **true**, the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false**. // - // * `view`
- // The recipient is required to view the document. + // For example, when set to **true**, if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When set to **false**, if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. // - // * `accept`
- // The recipient is required to accept the document by selecting accept during signing, but is not required to view the document. + // This functionality uses the following rules: // - // * `view_accept`
- // The recipient is required to view and accept the document. + // - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: // + // $~><|^+= // - SignerMustAcknowledge string `json:"signerMustAcknowledge,omitempty"` - // A list of `signHere` tabs, which can be used to add a visual representation for an electronic seal in a document. - Tabs *Tabs `json:"tabs,omitempty"` - // When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. - TemplateLocked DSBool `json:"templateLocked,omitempty"` - // When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. - TemplateRequired DSBool `json:"templateRequired,omitempty"` - // When set to **true**, PDF form field data is transformed into document tab values when the PDF form field name matches the DocuSign custom tab tabLabel. The resulting PDF form data is also returned in the PDF meta data when requesting the document PDF. + // For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` // - TransformPdfFields DSBool `json:"transformPdfFields,omitempty"` - // URI containing the user ID. - URI string `json:"uri,omitempty"` -} - -type DocumentFieldsInformation struct { + // - Strings embedded in other strings are ignored during the matching process. // - DocumentFields []NameValue `json:"documentFields,omitempty"` -} - -type DocumentHTMLCollapsibleDisplaySettings struct { + // - In words that have dashes, the parts separated by dashes are treated as distinct words. // - ArrowClosed string `json:"arrowClosed,omitempty"` + // Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**. // - ArrowColor string `json:"arrowColor,omitempty"` + // - Letters with accent marks are treated as distinct characters from their unaccented counterparts. // - ArrowLocation string `json:"arrowLocation,omitempty"` + // - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. // - ArrowOpen string `json:"arrowOpen,omitempty"` + // Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. // - ArrowSize string `json:"arrowSize,omitempty"` + // - Unlike punctuation, numbers are not ignored when finding anchor words. // - ArrowStyle string `json:"arrowStyle,omitempty"` + // Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). // - ContainerStyle string `json:"containerStyle,omitempty"` // - LabelStyle string `json:"labelStyle,omitempty"` + // **Note**: You can only specify the value of this property in POST requests. // - OnlyArrowIsClickable bool `json:"onlyArrowIsClickable,omitempty"` + // [AnchorTab]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place // - OuterLabelAndArrowStyle string `json:"outerLabelAndArrowStyle,omitempty"` -} - -type DocumentHTMLDefinition struct { + AnchorMatchWholeWord string `json:"anchorMatchWholeWord,omitempty"` + // Metadata that indicates whether the `anchorMatchWholeWord` property is editable. + AnchorMatchWholeWordMetadata *PropertyMetadata `json:"anchorMatchWholeWordMetadata,omitempty"` + // Specifies the string to find in the document and use as the basis for tab placement. + AnchorString string `json:"anchorString,omitempty"` + // Metadata that indicates whether the `anchorString` property is editable. + AnchorStringMetadata *PropertyMetadata `json:"anchorStringMetadata,omitempty"` + // Reserved for DocuSign. + AnchorTabProcessorVersion string `json:"anchorTabProcessorVersion,omitempty"` + // Reserved for DocuSign. + AnchorTabProcessorVersionMetadata *PropertyMetadata `json:"anchorTabProcessorVersionMetadata,omitempty"` + // Specifies units of the + // `anchorXOffset` and + // `anchorYOffset`. + // Valid units are: // - DisplayAnchorPrefix string `json:"displayAnchorPrefix,omitempty"` + // - `pixels` + // - `inches` + // - `mms` + // - `cms` // - DisplayAnchors []DocumentHTMLDisplayAnchor `json:"displayAnchors,omitempty"` - // The position on the page where the display section appears. - DisplayOrder int32 `json:"displayOrder,omitempty"` - // The number of the page on which the display section appears. - DisplayPageNumber int32 `json:"displayPageNumber,omitempty"` + AnchorUnits string `json:"anchorUnits,omitempty"` + // Metadata that indicates whether the `anchorUnits` property is editable. + AnchorUnitsMetadata *PropertyMetadata `json:"anchorUnitsMetadata,omitempty"` + // Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. // - DocumentGUID string `json:"documentGuid,omitempty"` - // Integer that identifies the document in the envelope. - DocumentID string `json:"documentId,omitempty"` + AnchorXOffset string `json:"anchorXOffset,omitempty"` + // Metadata that indicates whether the `anchorXOffset` property is editable. + AnchorXOffsetMetadata *PropertyMetadata `json:"anchorXOffsetMetadata,omitempty"` + // Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. // - HeaderLabel string `json:"headerLabel,omitempty"` + AnchorYOffset string `json:"anchorYOffset,omitempty"` + // Metadata that indicates whether the `anchorYOffset` property is editable. + AnchorYOffsetMetadata *PropertyMetadata `json:"anchorYOffsetMetadata,omitempty"` + // When set to **true**, the information in the tab is bold. + Bold string `json:"bold,omitempty"` + // Metadata that indicates whether the `bold` property is editable. + BoldMetadata *PropertyMetadata `json:"boldMetadata,omitempty"` + // When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. // - MaxScreenWidth string `json:"maxScreenWidth,omitempty"` + // When an envelope is completed the information is only available to the sender through the Form Data link in the DocuSign Console. The information on the downloaded document remains masked by asterisks. // - RemoveEmptyTags DSBool `json:"removeEmptyTags,omitempty"` + // This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. + ConcealValueOnDocument string `json:"concealValueOnDocument,omitempty"` + // Metadata that indicates whether the `concealValueOnDocument` property is editable. + ConcealValueOnDocumentMetadata *PropertyMetadata `json:"concealValueOnDocumentMetadata,omitempty"` + // For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility. + ConditionalParentLabel string `json:"conditionalParentLabel,omitempty"` + // Metadata that indicates whether the `conditionalParentLabel` property is editable. + ConditionalParentLabelMetadata *PropertyMetadata `json:"conditionalParentLabelMetadata,omitempty"` + // For conditional fields, this is the value of the parent tab that controls the tab's visibility. // - ShowMobileOptimizedToggle DSBool `json:"showMobileOptimizedToggle,omitempty"` + // If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. // - Source string `json:"source,omitempty"` -} - -type DocumentHTMLDefinitionOriginal struct { - // Integer that identifies the document in the envelope. + ConditionalParentValue string `json:"conditionalParentValue,omitempty"` + // Metadata that indicates whether the `conditionalParentValue` property is editable. + ConditionalParentValueMetadata *PropertyMetadata `json:"conditionalParentValueMetadata,omitempty"` + // The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. + CustomTabID string `json:"customTabId,omitempty"` + // Metadata that indicates whether the `customTabId` property is editable. + CustomTabIDMetadata *PropertyMetadata `json:"customTabIdMetadata,omitempty"` + // When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. + DisableAutoSize string `json:"disableAutoSize,omitempty"` + // Metadata that indicates whether the `disableAutoSize` property is editable. + DisableAutoSizeMetadata *PropertyMetadata `json:"disableAutoSizeMetadata,omitempty"` + // Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. DocumentID string `json:"documentId,omitempty"` - // The Guid of the document. - DocumentIDGUID string `json:"documentIdGuid,omitempty"` + // Metadata that indicates whether the `documentId` property is editable. + DocumentIDMetadata *PropertyMetadata `json:"documentIdMetadata,omitempty"` + // This object describes errors that occur. It is only valid for responses and ignored in requests. + ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` + // The font to be used for the tab value. Supported fonts include: // - HTMLDefinition *DocumentHTMLDefinition `json:"htmlDefinition,omitempty"` -} - -type DocumentHTMLDefinitionOriginals struct { + // - Default + // - Arial + // - ArialNarrow + // - Calibri + // - CourierNew + // - Garamond + // - Georgia + // - Helvetica + // - LucidaConsole + // - MSGothic + // - MSMincho + // - OCR-A + // - Tahoma + // - TimesNewRoman + // - Trebuchet + // - Verdana // - HTMLDefinitions []DocumentHTMLDefinitionOriginal `json:"htmlDefinitions,omitempty"` -} - -type DocumentHTMLDefinitions struct { + Font string `json:"font,omitempty"` + // The font color to use for the information in the tab. Possible values are: // - HTMLDefinitions []string `json:"htmlDefinitions,omitempty"` -} - -type DocumentHTMLDisplayAnchor struct { + // - Black + // - BrightBlue + // - BrightRed + // - DarkGreen + // - DarkRed + // - Gold + // - Green + // - NavyBlue + // - Purple + // - White // - CaseSensitive bool `json:"caseSensitive,omitempty"` - // This object defines how the HTML section inside the `startAnchor` and `endAnchor` displays. - DisplaySettings *DocumentHTMLDisplaySettings `json:"displaySettings,omitempty"` - // Specifies the end of the area in the HTML where the display settings will be applied. If you do not specify an end anchor, the end of the document will be used by default. + FontColor string `json:"fontColor,omitempty"` + // Metadata that indicates whether the `fontColor` property is editable. + FontColorMetadata *PropertyMetadata `json:"fontColorMetadata,omitempty"` + // Metadata that indicates whether the `font` property is editable. + FontMetadata *PropertyMetadata `json:"fontMetadata,omitempty"` + // The font size used for the information in the tab. Possible values are: // - // **Note**: A start anchor, an end anchor, or both are required. - EndAnchor string `json:"endAnchor,omitempty"` - // When **true**, removes the end anchor string for the Smart Section from the HTML, preventing it from displaying. - RemoveEndAnchor bool `json:"removeEndAnchor,omitempty"` - // When **true**, removes the start anchor string for the Smart Section from the HTML, preventing it from displaying. - RemoveStartAnchor bool `json:"removeStartAnchor,omitempty"` - // Specifies the beginning of the area in the HTML where the display settings will be applied. If you do not specify a start anchor, the beginning of the document will be used by default. + // - Size7 + // - Size8 + // - Size9 + // - Size10 + // - Size11 + // - Size12 + // - Size14 + // - Size16 + // - Size18 + // - Size20 + // - Size22 + // - Size24 + // - Size26 + // - Size28 + // - Size36 + // - Size48 + // - Size72 + FontSize string `json:"fontSize,omitempty"` + // Metadata that indicates whether the `fontSize` property is editable. + FontSizeMetadata *PropertyMetadata `json:"fontSizeMetadata,omitempty"` + // An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. + FormOrder string `json:"formOrder,omitempty"` + // Metadata that indicates whether the `formOrder` property is editable. + FormOrderMetadata *PropertyMetadata `json:"formOrderMetadata,omitempty"` + // A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. + FormPageLabel string `json:"formPageLabel,omitempty"` + // Metadata that indicates whether the `formPageLabel` property is editable. + FormPageLabelMetadata *PropertyMetadata `json:"formPageLabelMetadata,omitempty"` + // An integer specifying the order in which to present the guided form pages. + FormPageNumber string `json:"formPageNumber,omitempty"` + // Metadata that indicates whether the `fromPageNumber` property is editable. + FormPageNumberMetadata *PropertyMetadata `json:"formPageNumberMetadata,omitempty"` + // The height of the tab in pixels. + Height string `json:"height,omitempty"` + // Metadata that indicates whether the `height` property is editable. + HeightMetadata *PropertyMetadata `json:"heightMetadata,omitempty"` + // When set to **true**, the information in the tab is italic. + Italic string `json:"italic,omitempty"` + // Metadata that indicates whether the `italic` property is editable. + ItalicMetadata *PropertyMetadata `json:"italicMetadata,omitempty"` + // Reserved for DocuSign. + LocalePolicy *LocalePolicyTab `json:"localePolicy,omitempty"` + // When set to **true**, the signer cannot change the data of the custom tab. + Locked string `json:"locked,omitempty"` + // Metadata that indicates whether the `locked` property is editable. + LockedMetadata *PropertyMetadata `json:"lockedMetadata,omitempty"` + // An optional value that describes the maximum length of the property when the property is a string. + MaxLength string `json:"maxLength,omitempty"` + // Metadata that indicates whether the `maxLength` property is editable. + MaxLengthMetadata *PropertyMetadata `json:"maxLengthMetadata,omitempty"` + // Contains the information necessary to map the tab to a field in SalesForce. + MergeField *MergeField `json:"mergeField,omitempty"` // - // **Note**: A start anchor, an end anchor, or both are required. - StartAnchor string `json:"startAnchor,omitempty"` -} - -type DocumentHTMLDisplaySettings struct { - // Specifies the valid CSS-formatted styles to use on responsive table cells. Only valid in display sections of `responsive_table` or `responsive_table_single_column` types. - CellStyle string `json:"cellStyle,omitempty"` - // This object defines the appearance and function of a collapsible section or item. - CollapsibleSettings *DocumentHTMLCollapsibleDisplaySettings `json:"collapsibleSettings,omitempty"` - // This string sets the display and behavior properties of - // the document during signing. The possible values are: + MergeFieldXML string `json:"mergeFieldXml,omitempty"` // - // * `modal`
- // The document is shown as a supplement action strip - // and can be viewed, downloaded, or printed in a modal window. - // This is the recommended value for supplemental documents. + Name string `json:"name,omitempty"` + // Metadata that indicates whether the `name` property is editable. Read only. + NameMetadata *PropertyMetadata `json:"nameMetadata,omitempty"` + // The initial value of the tab when it was sent to the recipient. + OriginalValue string `json:"originalValue,omitempty"` + // Metadata that indicates whether the `originalValue` property is editable. + OriginalValueMetadata *PropertyMetadata `json:"originalValueMetadata,omitempty"` + // Specifies the page number on which the tab is located. + PageNumber string `json:"pageNumber,omitempty"` + // Metadata that indicates whether the `pageNumber` property is editable. + PageNumberMetadata *PropertyMetadata `json:"pageNumberMetadata,omitempty"` + // Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. + RecipientID string `json:"recipientId,omitempty"` + // The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only. + RecipientIDGUID string `json:"recipientIdGuid,omitempty"` + // Metadata that indicates whether the `recipientIdGuid` property is editable. + RecipientIDGUIDMetadata *PropertyMetadata `json:"recipientIdGuidMetadata,omitempty"` + // Metadata that indicates whether the `recipientId` property is editable. + RecipientIDMetadata *PropertyMetadata `json:"recipientIdMetadata,omitempty"` + // When set to **true**, the signer is required to fill out this tab. + Required string `json:"required,omitempty"` + // Metadata that indicates whether the `required` property is editable. + RequiredMetadata *PropertyMetadata `json:"requiredMetadata,omitempty"` // - // * `download`
- // The document is shown as a supplement action strip - // and can be viewed, downloaded, or printed in a new browser window. + SmartContractInformation *SmartContractInformation `json:"smartContractInformation,omitempty"` + // Indicates the envelope status. Valid values are: // - // * `inline`
- // The document is shown in the normal signing window. - // This value is not used with supplemental documents, - // but is the default value for all other documents. + // * sent - The envelope is sent to the recipients. + // * created - The envelope is saved as a draft and can be modified and sent later. + Status string `json:"status,omitempty"` + // Metadata that indicates whether the `status` property is editable. + StatusMetadata *PropertyMetadata `json:"statusMetadata,omitempty"` + // An array of tab group labels that uniquely identify tab groups. To assign a tab to a `tabGroup`, you assign the `TabGroupLabel` to the `Tab.TabGroupLabels` array. + TabGroupLabels []string `json:"tabGroupLabels,omitempty"` + // Metadata that indicates whether the `tabGroupLabels` property is editable. + TabGroupLabelsMetadata *PropertyMetadata `json:"tabGroupLabelsMetadata,omitempty"` + // The unique identifier for the tab. + TabID string `json:"tabId,omitempty"` + // Metadata that indicates whether the `tabId` property is editable. + TabIDMetadata *PropertyMetadata `json:"tabIdMetadata,omitempty"` + // The label associated with the tab. This value may be an empty string. + // If no value is provided, the tab type is used as the value. // - Display string `json:"display,omitempty"` - // The label for the display section. - DisplayLabel string `json:"displayLabel,omitempty"` - // The position on the page where the display section appears. - DisplayOrder int32 `json:"displayOrder,omitempty"` - // The number of the page on which the display section appears. - DisplayPageNumber int32 `json:"displayPageNumber,omitempty"` - // When **true**, the `displayLabel` is hidden when the display section is expanded and the display section is no longer collapsible. This property is valid only when the value of the `display` property is `collapsed`. - HideLabelWhenOpened bool `json:"hideLabelWhenOpened,omitempty"` - // Specifies the valid CSS-formatted styles to use on inline display sections. This property is valid only when the value of the `display` property is `inline`. - InlineOuterStyle string `json:"inlineOuterStyle,omitempty"` - // The label for the display section when it is expanded from a collapsed state. This label displays only on the first opening and is only valid with the value of the `display` property is `collapsed`. - LabelWhenOpened string `json:"labelWhenOpened,omitempty"` - // When **true** and the section is expanded, the position of the section close is scrolled to the top of the screen. This property is only valid when the value of the `display` property is `collapsed`. - ScrollToTopWhenOpened bool `json:"scrollToTopWhenOpened,omitempty"` - // Specifies the valid CSS-formatted styles to use on responsive tables. This property is valid only when the value of the `display` property is `responsive_table` or `responsive_table_single_column`. - TableStyle string `json:"tableStyle,omitempty"` -} - -type DocumentSecurityStore struct { + // Maximum Length: 500 characters. + // + TabLabel string `json:"tabLabel,omitempty"` + // Metadata that indicates whether the `tabLabel` property is editable. + TabLabelMetadata *PropertyMetadata `json:"tabLabelMetadata,omitempty"` + // A positive integer that sets the order the tab is navigated to during signing. // - Certificates []string `json:"certificates,omitempty"` + // Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. + TabOrder string `json:"tabOrder,omitempty"` + // Metadata that indicates whether the `tabOrder` property is editable. + TabOrderMetadata *PropertyMetadata `json:"tabOrderMetadata,omitempty"` + // Indicates the type of tab (for example, `signHere` or `initialHere`). + TabType string `json:"tabType,omitempty"` + // Metadata that indicates whether the `tabType` property is editable. + TabTypeMetadata *PropertyMetadata `json:"tabTypeMetadata,omitempty"` + // When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. + TemplateLocked string `json:"templateLocked,omitempty"` + // Metadata that indicates whether the `templateLocked` property is editable. + TemplateLockedMetadata *PropertyMetadata `json:"templateLockedMetadata,omitempty"` + // When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. + TemplateRequired string `json:"templateRequired,omitempty"` + // Metadata that indicates whether the `templateRequired` property is editable. + TemplateRequiredMetadata *PropertyMetadata `json:"templateRequiredMetadata,omitempty"` + // Metadata that indicates whether the `toolTip` property is editable. + ToolTipMetadata *PropertyMetadata `json:"toolTipMetadata,omitempty"` + // The text of a tooltip that appears when a user hovers over a form field or tab. + Tooltip string `json:"tooltip,omitempty"` + // When set to **true**, the information in the tab is underlined. + Underline string `json:"underline,omitempty"` + // Metadata that indicates whether the `underline` property is editable. + UnderlineMetadata *PropertyMetadata `json:"underlineMetadata,omitempty"` + // Specifies the value of the tab. + Value string `json:"value,omitempty"` + // Metadata that indicates whether the `value` property is editable. + ValueMetadata *PropertyMetadata `json:"valueMetadata,omitempty"` + // The width of the tab in pixels. + Width string `json:"width,omitempty"` + // Metadata that indicates whether the `width` property is editable. + WidthMetadata *PropertyMetadata `json:"widthMetadata,omitempty"` + // This property indicates the horizontal offset of the object on the page. + // DocuSign uses 72 DPI when determining position. + // Required. May be zero. // - Crls []string `json:"crls,omitempty"` + XPosition string `json:"xPosition,omitempty"` + // Metadata that indicates whether the `xPosition` property is editable. + XPositionMetadata *PropertyMetadata `json:"xPositionMetadata,omitempty"` + // This property indicates the vertical offset of the object on the page. + // DocuSign uses 72 DPI when determining position. + // Required. May be zero. // - Ocsps []string `json:"ocsps,omitempty"` + YPosition string `json:"yPosition,omitempty"` + // Metadata that indicates whether the `yPosition` property is editable. + YPositionMetadata *PropertyMetadata `json:"yPositionMetadata,omitempty"` } -type DocumentTemplate struct { +type CommissionState struct { // - DocumentEndPage string `json:"documentEndPage,omitempty"` - // Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - DocumentID string `json:"documentId,omitempty"` + AnchorAllowWhiteSpaceInCharacters string `json:"anchorAllowWhiteSpaceInCharacters,omitempty"` // - DocumentStartPage string `json:"documentStartPage,omitempty"` - // This object describes errors that occur. It is only valid for responses and ignored in requests. - ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` - // The unique identifier of the template. If this is not provided, DocuSign generates an error and the call fails. - TemplateID string `json:"templateId,omitempty"` -} - -type DocumentTemplateList struct { + AnchorAllowWhiteSpaceInCharactersMetadata *PropertyMetadata `json:"anchorAllowWhiteSpaceInCharactersMetadata,omitempty"` + // This property controls how [anchor tabs][AnchorTabs] are placed. When **true**, the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false**. // - DocumentTemplates []DocumentTemplate `json:"documentTemplates,omitempty"` -} - -type DocumentUpdateInfo struct { - // A Base64-encoded representation of the attachment that is used to upload and download the file. File attachments may be up to 50 MB in size. - Data string `json:"data,omitempty"` - // Integer that identifies the document in the envelope. - DocumentID string `json:"documentId,omitempty"` + // For example, when set to **true**, if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When set to **false**, `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. // - DocumentSecurityStore *DocumentSecurityStore `json:"documentSecurityStore,omitempty"` + // This functionality uses the following rules: // - Name string `json:"name,omitempty"` + // - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: // - ReturnFormat string `json:"returnFormat,omitempty"` + // $~><|^+= // - SignatureDataInfos []SignatureDataInfo `json:"signatureDataInfos,omitempty"` + // For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` // - TimeStampField *TimeStampField `json:"timeStampField,omitempty"` -} - -// DocumentVisibility this object configures a recipient's read/write access to a document. -type DocumentVisibility struct { - // Integer that identifies the document in the envelope. - DocumentID string `json:"documentId,omitempty"` - // This object describes errors that occur. It is only valid for responses and ignored in requests. - ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` - // A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`. - RecipientID string `json:"recipientId,omitempty"` - // Indicates whether the document is editable: + // - Strings embedded in other strings are ignored during the matching process. // - // - `editable` - // - `read_only` - Rights string `json:"rights,omitempty"` - // When **true**, the document is visible to the recipient. - Visible string `json:"visible,omitempty"` -} - -// DocumentVisibilityList is a list of `documentVisibility` objects that specify whether documents are visible to recipients. -type DocumentVisibilityList struct { - // An array of `documentVisibility` objects that specifies which documents are visible to which recipients. - DocumentVisibility []DocumentVisibility `json:"documentVisibility,omitempty"` -} - -type ENoteConfiguration struct { + // - In words that have dashes, the parts separated by dashes are treated as distinct words. // - ConnectConfigured string `json:"connectConfigured,omitempty"` + // Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**. // - ENoteConfigured string `json:"eNoteConfigured,omitempty"` + // - Letters with accent marks are treated as distinct characters from their unaccented counterparts. // - Organization string `json:"organization,omitempty"` - // The user's encrypted password hash. - Password string `json:"password,omitempty"` - // The name of the user. - UserName string `json:"userName,omitempty"` -} - -// Editor is a complex type defining the management and access rights of a recipient assigned as an editor on the document. -type Editor struct { - // If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. + // - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. // - // Maximum Length: 50 characters and it must conform to the account's access code format setting. + // Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. // - // If blank, but the signer `accessCode` property is set in the envelope, then that value is used. + // - Unlike punctuation, numbers are not ignored when finding anchor words. // - // If blank and the signer `accessCode` property is not set, then the access code is not required. - AccessCode string `json:"accessCode,omitempty"` - // Metadata that indicates if the sender can edit the `accessCode` property. - AccessCodeMetadata *PropertyMetadata `json:"accessCodeMetadata,omitempty"` - // This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient. - AddAccessCodeToEmail string `json:"addAccessCodeToEmail,omitempty"` - // Specifies whether the recipient is embedded or remote. + // Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). // - // If the `clientUserId` property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing. + // **Note**: You can only specify the value of this property in POST requests. // - // Note: if the `clientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true**, an error is generated on sending. + // [AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place + AnchorCaseSensitive string `json:"anchorCaseSensitive,omitempty"` + // Metadata that indicates whether the `anchorCaseSensitive` property is editable. + AnchorCaseSensitiveMetadata *PropertyMetadata `json:"anchorCaseSensitiveMetadata,omitempty"` + // This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are : // - // Maximum length: 100 characters. - ClientUserID string `json:"clientUserId,omitempty"` - // Indicates the number of times that the recipient has been through a signing completion for the envelope. + // - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. + // - `right`: Aligns the tab’s left side with the last character of the matching anchor word. // - // If this number is greater than 0 for a signing group, only the user who previously completed may sign again. - CompletedCount string `json:"completedCount,omitempty"` - // An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters. - CustomFields []string `json:"customFields,omitempty"` - // The date and time the recipient declined the document. - DeclinedDateTime *time.Time `json:"declinedDateTime,omitempty"` - // The reason the recipient declined the document. - DeclinedReason string `json:"declinedReason,omitempty"` - // The date and time that the envelope was delivered to the recipient. - DeliveredDateTime *time.Time `json:"deliveredDateTime,omitempty"` - // Reserved for DocuSign. - DeliveryMethod string `json:"deliveryMethod,omitempty"` - // Metadata that indicates whether the `deliveryMethod` property is editable. + // **Note**: You can only specify the value of this property in POST requests. // - DeliveryMethodMetadata *PropertyMetadata `json:"deliveryMethodMetadata,omitempty"` - // A list of documentVisibility objects, which define a recipient's read/write access to a document. - DocumentVisibility []DocumentVisibility `json:"documentVisibility,omitempty"` - // Email id of the recipient. Notification of the document to sign is sent to this email id. + // [AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place // - // Maximum length: 100 characters. - Email string `json:"email,omitempty"` - // Metadata that indicates if the sender can edit the email id of the recipient. - EmailMetadata *PropertyMetadata `json:"emailMetadata,omitempty"` - // An optional complex type that sets a specific email subject and body for this recipient's notification email. + AnchorHorizontalAlignment string `json:"anchorHorizontalAlignment,omitempty"` + // Metadata that indicates whether the `anchorHorizontalAlignment` property is editable. + AnchorHorizontalAlignmentMetadata *PropertyMetadata `json:"anchorHorizontalAlignmentMetadata,omitempty"` + // When set to **true**, this tab is ignored if the `anchorString` is not found in the document. + AnchorIgnoreIfNotPresent string `json:"anchorIgnoreIfNotPresent,omitempty"` + // Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable. + AnchorIgnoreIfNotPresentMetadata *PropertyMetadata `json:"anchorIgnoreIfNotPresentMetadata,omitempty"` + // When set to **true**, the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false**. // - // **Note**: If you use this field to set a specific email notification for one recipient, you must also set the email notification for the other recipients. Using this field for one or more recipients negates the Envelope `Subject` and `EmailBlurb` property settings. - EmailNotification *RecipientEmailNotification `json:"emailNotification,omitempty"` - // Specifies a sender-provided valid URL string for redirecting an embedded recipient. When this option is used, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the recipient clicks the document link in the email, the recipient is redirected through DocuSign to the specified URL to complete the required actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. + // For example, when set to **true**, if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When set to **false**, if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. // - // If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation launched by a partner. + // This functionality uses the following rules: // - // It is important to understand that in a typical embedded workflow, the authentication of an embedded recipient is the responsibility of the sending application. DocuSign expects that senders will follow their own processes for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process is initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process, bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. + // - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: // - // If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: `envelopeId`, `recipientId`, `recipientName`, `recipientEmail`, and `customFields`. The `customFields` property must be set for the recipient or envelope. The merge fields are enclosed in double brackets. + // $~><|^+= // - // *Example*: + // For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` // - // `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` - EmbeddedRecipientStartURL string `json:"embeddedRecipientStartURL,omitempty"` - // This object describes errors that occur. It is only valid for responses and ignored in requests. - ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` - // Reserved for DocuSign. - FaxNumber string `json:"faxNumber,omitempty"` - // Metadata that indicates whether the `faxNumber` property is editable. + // - Strings embedded in other strings are ignored during the matching process. // - FaxNumberMetadata *PropertyMetadata `json:"faxNumberMetadata,omitempty"` - // The recipient's first name. + // - In words that have dashes, the parts separated by dashes are treated as distinct words. // - // Maximum Length: 50 characters. - FirstName string `json:"firstName,omitempty"` - // Metadata that indicates if the sender can edit the recipient's first name. - FirstNameMetadata *PropertyMetadata `json:"firstNameMetadata,omitempty"` - // Reserved for DocuSign. - FullName string `json:"fullName,omitempty"` - // Reserved for DocuSign. - FullNameMetadata *PropertyMetadata `json:"fullNameMetadata,omitempty"` - // The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. + // Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**. // - // **Example**: Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node. - IDCheckConfigurationName string `json:"idCheckConfigurationName,omitempty"` - // Metadata that indicates if the sender can edit the `idCheckConfigurationName` property. - IDCheckConfigurationNameMetadata *PropertyMetadata `json:"idCheckConfigurationNameMetadata,omitempty"` - // An object that contains input information related to a recipient ID check. - IDCheckInformationInput *IDCheckInformationInput `json:"idCheckInformationInput,omitempty"` - // When set to **true** and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account. - InheritEmailNotificationConfiguration DSBool `json:"inheritEmailNotificationConfiguration,omitempty"` - // The recipient's last name. - LastName string `json:"lastName,omitempty"` - // Metadata that indicates if the sender can edit the recipient's last name. - LastNameMetadata *PropertyMetadata `json:"lastNameMetadata,omitempty"` - // Reserved for DocuSign. - LockedRecipientPhoneAuthEditable string `json:"lockedRecipientPhoneAuthEditable,omitempty"` - // Reserved for DocuSign. - LockedRecipientSmsEditable string `json:"lockedRecipientSmsEditable,omitempty"` - // The full legal name of the recipient. Maximum Length: 100 characters. - Name string `json:"name,omitempty"` - // Metadata that indicates if the sender can edit the full legal name of the recipient. - NameMetadata *PropertyMetadata `json:"nameMetadata,omitempty"` - // A note sent to the recipient in the signing email. - // This note is unique to this recipient. - // In the user interface, - // it appears near the upper left corner - // of the document - // on the signing screen. + // - Letters with accent marks are treated as distinct characters from their unaccented counterparts. // - // Maximum Length: 1000 characters. + // - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. // - Note string `json:"note,omitempty"` - // Metadata that indicates if the sender can edit the note sent to the recipient in the signing email. - NoteMetadata *PropertyMetadata `json:"noteMetadata,omitempty"` - // A complex type that contains the following elements: + // Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. // - // * `recipMayProvideNumber` - Boolean. When set to **true**, the recipient can use whatever phone number they choose. - // * `senderProvidedNumbers` - ArrayOfString. A list of phone numbers the recipient can use. - // * `recordVoicePrint` - Reserved. - // * `validateRecipProvidedNumber` - Reserved. - PhoneAuthentication DSBool `json:"phoneAuthentication,omitempty"` - // Reserved for DocuSign. - RecipientAttachments []RecipientAttachment `json:"recipientAttachments,omitempty"` - // Information about the recipient's authentication status. - RecipientAuthenticationStatus *AuthenticationStatus `json:"recipientAuthenticationStatus,omitempty"` - // Metadata about the features that are supported for the recipient type. - RecipientFeatureMetadata []FeatureAvailableMetadata `json:"recipientFeatureMetadata,omitempty"` - // Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. - RecipientID string `json:"recipientId,omitempty"` - // The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. - RecipientIDGUID string `json:"recipientIdGuid,omitempty"` - // The recipient type, as specified by the following values: - // - `agents`: Agent recipients can add name and email information for recipients that appear after the agent in routing order. - // - `carbonCopies`: Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date, or add information to any of the documents. This type of recipient can be used in any routing order. - // - `certifiedDeliveries`: Certified delivery recipients must receive the completed documents for the envelope to be completed. They don't need to sign, initial, date, or add information to any of the documents. - // - `editors`: Editors have the same management and access rights for the envelope as the sender. Editors can add name and email information, add or change the routing order, set authentication options, and can edit signature/initial tabs and data fields for the remaining recipients. - // - `inPersonSigners`: In-person recipients are DocuSign users who act as signing hosts in the same physical location as the signer. - // - `intermediaries`: Intermediary recipients can optionally add name and email information for recipients at the same or subsequent level in the routing order. - // - `seals`: Electronic seal recipients represent legal entities. - // - `signers`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope. - // - `witnesses`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope. - RecipientType string `json:"recipientType,omitempty"` - // Metadata that indicates if the sender can edit the recipient type. - RecipientTypeMetadata *PropertyMetadata `json:"recipientTypeMetadata,omitempty"` - // When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. - RequireIDLookup DSBool `json:"requireIdLookup,omitempty"` - // Metadata that indicates whether the `requireIdLookup` property is editable. + // - Unlike punctuation, numbers are not ignored when finding anchor words. // - RequireIDLookupMetadata *PropertyMetadata `json:"requireIdLookupMetadata,omitempty"` - // Optional element. Specifies the role name associated with the recipient.

This is required when working with template recipients. - RoleName string `json:"roleName,omitempty"` - // Specifies the routing order of the recipient in the envelope. - RoutingOrder string `json:"routingOrder,omitempty"` - // Metadata that indicates if the sender can edit the routing order for the recipient. - RoutingOrderMetadata *PropertyMetadata `json:"routingOrderMetadata,omitempty"` - // The date and time the envelope was sent. - SentDateTime *time.Time `json:"sentDateTime,omitempty"` - // Reserved for DocuSign. - SignedDateTime *time.Time `json:"signedDateTime,omitempty"` - // The id of the signing group of which the recipient is a member, if applicable. - SigningGroupID string `json:"signingGroupId,omitempty"` - // Metadata that indicates if the sender can edit the signing group id. - SigningGroupIDMetadata *PropertyMetadata `json:"signingGroupIdMetadata,omitempty"` - // The display name for the signing group. + // Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). // - // Maximum Length: 100 characters. - SigningGroupName string `json:"signingGroupName,omitempty"` - // A complex type that contains information about users in the signing group. - SigningGroupUsers []UserInfo `json:"signingGroupUsers,omitempty"` - // Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication. // - SmsAuthentication *RecipientSMSAuthentication `json:"smsAuthentication,omitempty"` - // Lists the social ID type that can be used for recipient authentication. - SocialAuthentications []SocialAuthentication `json:"socialAuthentications,omitempty"` - // Recipient status. - // + // **Note**: You can only specify the value of this property in POST requests. // - Status string `json:"status,omitempty"` + // [AnchorTab]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place + // + AnchorMatchWholeWord string `json:"anchorMatchWholeWord,omitempty"` + // Metadata that indicates whether the `anchorMatchWholeWord` property is editable. + AnchorMatchWholeWordMetadata *PropertyMetadata `json:"anchorMatchWholeWordMetadata,omitempty"` + // Specifies the string to find in the document and use as the basis for tab placement. + AnchorString string `json:"anchorString,omitempty"` + // Metadata that indicates whether the `anchorString` property is editable. + AnchorStringMetadata *PropertyMetadata `json:"anchorStringMetadata,omitempty"` // Reserved for DocuSign. - StatusCode string `json:"statusCode,omitempty"` - // When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. - TemplateLocked DSBool `json:"templateLocked,omitempty"` - // When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. - TemplateRequired DSBool `json:"templateRequired,omitempty"` - // The total number of tabs in the documents. - TotalTabCount string `json:"totalTabCount,omitempty"` - // The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing. + AnchorTabProcessorVersion string `json:"anchorTabProcessorVersion,omitempty"` + // Reserved for DocuSign. + AnchorTabProcessorVersionMetadata *PropertyMetadata `json:"anchorTabProcessorVersionMetadata,omitempty"` + // Specifies units of the + // `anchorXOffset` and + // `anchorYOffset`. + // Valid units are: // - UserID string `json:"userId,omitempty"` -} - -// Email is a tab that allows the recipient to enter an email address. -// This is a one-line field that checks that a valid email -// address is entered. It uses the same parameters as a Text -// tab, with the validation message and pattern set for email -// information. -// -// When getting information that includes -// this tab type, the original value of the tab when the -// associated envelope was sent is included in the response. -// -type Email struct { - TabBase - TabGuidedForm - TabPosition - TabStyle - TabValue + // - `pixels` + // - `inches` + // - `mms` + // - `cms` + // + AnchorUnits string `json:"anchorUnits,omitempty"` + // Metadata that indicates whether the `anchorUnits` property is editable. + AnchorUnitsMetadata *PropertyMetadata `json:"anchorUnitsMetadata,omitempty"` + // Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. + // + AnchorXOffset string `json:"anchorXOffset,omitempty"` + // Metadata that indicates whether the `anchorXOffset` property is editable. + AnchorXOffsetMetadata *PropertyMetadata `json:"anchorXOffsetMetadata,omitempty"` + // Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. + // + AnchorYOffset string `json:"anchorYOffset,omitempty"` + // Metadata that indicates whether the `anchorYOffset` property is editable. + AnchorYOffsetMetadata *PropertyMetadata `json:"anchorYOffsetMetadata,omitempty"` + // When set to **true**, the information in the tab is bold. + Bold string `json:"bold,omitempty"` + // Metadata that indicates whether the `bold` property is editable. + BoldMetadata *PropertyMetadata `json:"boldMetadata,omitempty"` // When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. // - // When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. + // When an envelope is completed the information is only available to the sender through the Form Data link in the DocuSign Console. The information on the downloaded document remains masked by asterisks. // // This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. - ConcealValueOnDocument DSBool `json:"concealValueOnDocument,omitempty"` + ConcealValueOnDocument string `json:"concealValueOnDocument,omitempty"` // Metadata that indicates whether the `concealValueOnDocument` property is editable. ConcealValueOnDocumentMetadata *PropertyMetadata `json:"concealValueOnDocumentMetadata,omitempty"` + // For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility. + ConditionalParentLabel string `json:"conditionalParentLabel,omitempty"` + // Metadata that indicates whether the `conditionalParentLabel` property is editable. + ConditionalParentLabelMetadata *PropertyMetadata `json:"conditionalParentLabelMetadata,omitempty"` + // For conditional fields, this is the value of the parent tab that controls the tab's visibility. + // + // If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. + // + ConditionalParentValue string `json:"conditionalParentValue,omitempty"` + // Metadata that indicates whether the `conditionalParentValue` property is editable. + ConditionalParentValueMetadata *PropertyMetadata `json:"conditionalParentValueMetadata,omitempty"` + // The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. + CustomTabID string `json:"customTabId,omitempty"` + // Metadata that indicates whether the `customTabId` property is editable. + CustomTabIDMetadata *PropertyMetadata `json:"customTabIdMetadata,omitempty"` // When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. - DisableAutoSize DSBool `json:"disableAutoSize,omitempty"` + DisableAutoSize string `json:"disableAutoSize,omitempty"` // Metadata that indicates whether the `disableAutoSize` property is editable. DisableAutoSizeMetadata *PropertyMetadata `json:"disableAutoSizeMetadata,omitempty"` - // The height of the tab in pixels. - Height string `json:"height,omitempty"` - // Metadata that indicates whether the `height` property is editable. - HeightMetadata *PropertyMetadata `json:"heightMetadata,omitempty"` - // Reserved for DocuSign. - LocalePolicy *LocalePolicyTab `json:"localePolicy,omitempty"` - // When set to **true**, the signer cannot change the data of the custom tab. - Locked DSBool `json:"locked,omitempty"` - // Metadata that indicates whether the `locked` property is editable. - LockedMetadata *PropertyMetadata `json:"lockedMetadata,omitempty"` - // An optional value that describes the maximum length of the property when the property is a string. - MaxLength string `json:"maxLength,omitempty"` - // Metadata that indicates whether the `maxLength` property is editable. - MaxLengthMetadata *PropertyMetadata `json:"maxLengthMetadata,omitempty"` - // The initial value of the tab when it was sent to the recipient. - OriginalValue string `json:"originalValue,omitempty"` - // Metadata that indicates whether the `originalValue` property is editable. - OriginalValueMetadata *PropertyMetadata `json:"originalValueMetadata,omitempty"` - // When set to **true** and shared is true, information must be entered in this field to complete the envelope. - RequireAll DSBool `json:"requireAll,omitempty"` - // Metadata that indicates whether the `requireAll` property is editable. - RequireAllMetadata *PropertyMetadata `json:"requireAllMetadata,omitempty"` - // Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field. - RequireInitialOnSharedChange DSBool `json:"requireInitialOnSharedChange,omitempty"` - // Metadata that indicates whether the `requireInitialOnSharedChange` property is editable. - RequireInitialOnSharedChangeMetadata *PropertyMetadata `json:"requireInitialOnSharedChangeMetadata,omitempty"` - // When set to **true**, the signer is required to fill out this tab. - Required TabRequired `json:"required,omitempty"` - // Metadata that indicates whether the `required` property is editable. - RequiredMetadata *PropertyMetadata `json:"requiredMetadata,omitempty"` - // When set to **true**, the sender must populate the tab before an envelope can be sent using the template. - // - // This value tab can only be changed by modifying (PUT) the template. + // Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. + DocumentID string `json:"documentId,omitempty"` + // Metadata that indicates whether the `documentId` property is editable. + DocumentIDMetadata *PropertyMetadata `json:"documentIdMetadata,omitempty"` + // This object describes errors that occur. It is only valid for responses and ignored in requests. + ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` + // The font to be used for the tab value. Supported fonts include: // - // Tabs with a `senderRequired` value of true cannot be deleted from an envelope. - SenderRequired DSBool `json:"senderRequired,omitempty"` - // Metadata that indicates whether the `senderRequired` property is editable. - SenderRequiredMetadata *PropertyMetadata `json:"senderRequiredMetadata,omitempty"` - // When set to **true**, this tab is shared. - Shared DSBool `json:"shared,omitempty"` - // Metadata that indicates whether the `shared` property is editable. - SharedMetadata *PropertyMetadata `json:"sharedMetadata,omitempty"` + // - Default + // - Arial + // - ArialNarrow + // - Calibri + // - CourierNew + // - Garamond + // - Georgia + // - Helvetica + // - LucidaConsole + // - MSGothic + // - MSMincho + // - OCR-A + // - Tahoma + // - TimesNewRoman + // - Trebuchet + // - Verdana + // + Font string `json:"font,omitempty"` + // The font color to use for the information in the tab. Possible values are: + // + // - Black + // - BrightBlue + // - BrightRed + // - DarkGreen + // - DarkRed + // - Gold + // - Green + // - NavyBlue + // - Purple + // - White + // + FontColor string `json:"fontColor,omitempty"` + // Metadata that indicates whether the `fontColor` property is editable. + FontColorMetadata *PropertyMetadata `json:"fontColorMetadata,omitempty"` + // Metadata that indicates whether the `font` property is editable. + FontMetadata *PropertyMetadata `json:"fontMetadata,omitempty"` + // The font size used for the information in the tab. Possible values are: + // + // - Size7 + // - Size8 + // - Size9 + // - Size10 + // - Size11 + // - Size12 + // - Size14 + // - Size16 + // - Size18 + // - Size20 + // - Size22 + // - Size24 + // - Size26 + // - Size28 + // - Size36 + // - Size48 + // - Size72 + FontSize string `json:"fontSize,omitempty"` + // Metadata that indicates whether the `fontSize` property is editable. + FontSizeMetadata *PropertyMetadata `json:"fontSizeMetadata,omitempty"` + // An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. + FormOrder string `json:"formOrder,omitempty"` + // Metadata that indicates whether the `formOrder` property is editable. + FormOrderMetadata *PropertyMetadata `json:"formOrderMetadata,omitempty"` + // A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. + FormPageLabel string `json:"formPageLabel,omitempty"` + // Metadata that indicates whether the `formPageLabel` property is editable. + FormPageLabelMetadata *PropertyMetadata `json:"formPageLabelMetadata,omitempty"` + // An integer specifying the order in which to present the guided form pages. + FormPageNumber string `json:"formPageNumber,omitempty"` + // Metadata that indicates whether the `fromPageNumber` property is editable. + FormPageNumberMetadata *PropertyMetadata `json:"formPageNumberMetadata,omitempty"` + // The height of the tab in pixels. + Height string `json:"height,omitempty"` + // Metadata that indicates whether the `height` property is editable. + HeightMetadata *PropertyMetadata `json:"heightMetadata,omitempty"` + // When set to **true**, the information in the tab is italic. + Italic string `json:"italic,omitempty"` + // Metadata that indicates whether the `italic` property is editable. + ItalicMetadata *PropertyMetadata `json:"italicMetadata,omitempty"` + // Reserved for DocuSign. + LocalePolicy *LocalePolicyTab `json:"localePolicy,omitempty"` + // When set to **true**, the signer cannot change the data of the custom tab. + Locked string `json:"locked,omitempty"` + // Metadata that indicates whether the `locked` property is editable. + LockedMetadata *PropertyMetadata `json:"lockedMetadata,omitempty"` + // An optional value that describes the maximum length of the property when the property is a string. + MaxLength string `json:"maxLength,omitempty"` + // Metadata that indicates whether the `maxLength` property is editable. + MaxLengthMetadata *PropertyMetadata `json:"maxLengthMetadata,omitempty"` + // Contains the information necessary to map the tab to a field in SalesForce. + MergeField *MergeField `json:"mergeField,omitempty"` + // + MergeFieldXML string `json:"mergeFieldXml,omitempty"` + // + Name string `json:"name,omitempty"` + // Metadata that indicates whether the `name` property is editable. Read only. + NameMetadata *PropertyMetadata `json:"nameMetadata,omitempty"` + // The initial value of the tab when it was sent to the recipient. + OriginalValue string `json:"originalValue,omitempty"` + // Metadata that indicates whether the `originalValue` property is editable. + OriginalValueMetadata *PropertyMetadata `json:"originalValueMetadata,omitempty"` + // Specifies the page number on which the tab is located. + PageNumber string `json:"pageNumber,omitempty"` + // Metadata that indicates whether the `pageNumber` property is editable. + PageNumberMetadata *PropertyMetadata `json:"pageNumberMetadata,omitempty"` + // Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. + RecipientID string `json:"recipientId,omitempty"` + // The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only. + RecipientIDGUID string `json:"recipientIdGuid,omitempty"` + // Metadata that indicates whether the `recipientIdGuid` property is editable. + RecipientIDGUIDMetadata *PropertyMetadata `json:"recipientIdGuidMetadata,omitempty"` + // Metadata that indicates whether the `recipientId` property is editable. + RecipientIDMetadata *PropertyMetadata `json:"recipientIdMetadata,omitempty"` + // When set to **true**, the signer is required to fill out this tab. + Required string `json:"required,omitempty"` + // Metadata that indicates whether the `required` property is editable. + RequiredMetadata *PropertyMetadata `json:"requiredMetadata,omitempty"` + // + SmartContractInformation *SmartContractInformation `json:"smartContractInformation,omitempty"` + // Indicates the envelope status. Valid values are: + // + // * sent - The envelope is sent to the recipients. + // * created - The envelope is saved as a draft and can be modified and sent later. + Status string `json:"status,omitempty"` + // Metadata that indicates whether the `status` property is editable. + StatusMetadata *PropertyMetadata `json:"statusMetadata,omitempty"` + // An array of tab group labels that uniquely identify tab groups. To assign a tab to a `tabGroup`, you assign the `TabGroupLabel` to the `Tab.TabGroupLabels` array. + TabGroupLabels []string `json:"tabGroupLabels,omitempty"` + // Metadata that indicates whether the `tabGroupLabels` property is editable. + TabGroupLabelsMetadata *PropertyMetadata `json:"tabGroupLabelsMetadata,omitempty"` + // The unique identifier for the tab. + TabID string `json:"tabId,omitempty"` + // Metadata that indicates whether the `tabId` property is editable. + TabIDMetadata *PropertyMetadata `json:"tabIdMetadata,omitempty"` + // The label associated with the tab. This value may be an empty string. + // If no value is provided, the tab type is used as the value. + // + // Maximum Length: 500 characters. + // + TabLabel string `json:"tabLabel,omitempty"` + // Metadata that indicates whether the `tabLabel` property is editable. + TabLabelMetadata *PropertyMetadata `json:"tabLabelMetadata,omitempty"` + // A positive integer that sets the order the tab is navigated to during signing. + // + // Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. + TabOrder string `json:"tabOrder,omitempty"` + // Metadata that indicates whether the `tabOrder` property is editable. + TabOrderMetadata *PropertyMetadata `json:"tabOrderMetadata,omitempty"` + // Indicates the type of tab (for example, `signHere` or `initialHere`). + TabType string `json:"tabType,omitempty"` + // Metadata that indicates whether the `tabType` property is editable. + TabTypeMetadata *PropertyMetadata `json:"tabTypeMetadata,omitempty"` + // When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. + TemplateLocked string `json:"templateLocked,omitempty"` + // Metadata that indicates whether the `templateLocked` property is editable. + TemplateLockedMetadata *PropertyMetadata `json:"templateLockedMetadata,omitempty"` + // When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. + TemplateRequired string `json:"templateRequired,omitempty"` + // Metadata that indicates whether the `templateRequired` property is editable. + TemplateRequiredMetadata *PropertyMetadata `json:"templateRequiredMetadata,omitempty"` // Metadata that indicates whether the `toolTip` property is editable. ToolTipMetadata *PropertyMetadata `json:"toolTipMetadata,omitempty"` // The text of a tooltip that appears when a user hovers over a form field or tab. Tooltip string `json:"tooltip,omitempty"` - // The message displayed if the custom tab fails input validation (either custom of embedded). - ValidationMessage string `json:"validationMessage,omitempty"` - // Metadata that indicates whether the `validationMessage` property is editable. - ValidationMessageMetadata *PropertyMetadata `json:"validationMessageMetadata,omitempty"` - // A regular expression used to validate input for the tab. - ValidationPattern string `json:"validationPattern,omitempty"` - // Metadata that indicates whether the `validationPattern` property is editable. - ValidationPatternMetadata *PropertyMetadata `json:"validationPatternMetadata,omitempty"` + // When set to **true**, the information in the tab is underlined. + Underline string `json:"underline,omitempty"` + // Metadata that indicates whether the `underline` property is editable. + UnderlineMetadata *PropertyMetadata `json:"underlineMetadata,omitempty"` + // Specifies the value of the tab. + Value string `json:"value,omitempty"` + // Metadata that indicates whether the `value` property is editable. + ValueMetadata *PropertyMetadata `json:"valueMetadata,omitempty"` // The width of the tab in pixels. Width string `json:"width,omitempty"` // Metadata that indicates whether the `width` property is editable. WidthMetadata *PropertyMetadata `json:"widthMetadata,omitempty"` + // This property indicates the horizontal offset of the object on the page. + // DocuSign uses 72 DPI when determining position. + // Required. May be zero. + // + XPosition string `json:"xPosition,omitempty"` + // Metadata that indicates whether the `xPosition` property is editable. + XPositionMetadata *PropertyMetadata `json:"xPositionMetadata,omitempty"` + // This property indicates the vertical offset of the object on the page. + // DocuSign uses 72 DPI when determining position. + // Required. May be zero. + // + YPosition string `json:"yPosition,omitempty"` + // Metadata that indicates whether the `yPosition` property is editable. + YPositionMetadata *PropertyMetadata `json:"yPositionMetadata,omitempty"` } -// EmailAddress is a tab that displays the recipient's email as entered in the -// recipient information. +// Company is a tab that displays the recipient's company name. // -type EmailAddress struct { +type Company struct { TabBase TabGuidedForm TabPosition TabStyle TabValue + // + AnchorAllowWhiteSpaceInCharacters string `json:"anchorAllowWhiteSpaceInCharacters,omitempty"` + // + AnchorAllowWhiteSpaceInCharactersMetadata *PropertyMetadata `json:"anchorAllowWhiteSpaceInCharactersMetadata,omitempty"` + // When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. + // + // When an envelope is completed the information is only available to the sender through the Form Data link in the DocuSign Console. The information on the downloaded document remains masked by asterisks. + // + // This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. + ConcealValueOnDocument DSBool `json:"concealValueOnDocument,omitempty"` + // Metadata that indicates whether the `concealValueOnDocument` property is editable. + ConcealValueOnDocumentMetadata *PropertyMetadata `json:"concealValueOnDocumentMetadata,omitempty"` + // When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. + DisableAutoSize DSBool `json:"disableAutoSize,omitempty"` + // Metadata that indicates whether the `disableAutoSize` property is editable. + DisableAutoSizeMetadata *PropertyMetadata `json:"disableAutoSizeMetadata,omitempty"` // The height of the tab in pixels. Height string `json:"height,omitempty"` // Metadata that indicates whether the `height` property is editable. HeightMetadata *PropertyMetadata `json:"heightMetadata,omitempty"` // Reserved for DocuSign. LocalePolicy *LocalePolicyTab `json:"localePolicy,omitempty"` + // When set to **true**, the signer cannot change the data of the custom tab. + Locked DSBool `json:"locked,omitempty"` + // Metadata that indicates whether the `locked` property is editable. + LockedMetadata *PropertyMetadata `json:"lockedMetadata,omitempty"` + // An optional value that describes the maximum length of the property when the property is a string. + MaxLength string `json:"maxLength,omitempty"` + // Metadata that indicates whether the `maxLength` property is editable. + MaxLengthMetadata *PropertyMetadata `json:"maxLengthMetadata,omitempty"` + // + MergeFieldXML string `json:"mergeFieldXml,omitempty"` + // The initial value of the tab when it was sent to the recipient. + OriginalValue string `json:"originalValue,omitempty"` + // Metadata that indicates whether the `originalValue` property is editable. + OriginalValueMetadata *PropertyMetadata `json:"originalValueMetadata,omitempty"` + // When set to **true**, the signer is required to fill out this tab. + Required TabRequired `json:"required,omitempty"` + // Metadata that indicates whether the `required` property is editable. + RequiredMetadata *PropertyMetadata `json:"requiredMetadata,omitempty"` + // + SmartContractInformation *SmartContractInformation `json:"smartContractInformation,omitempty"` // Metadata that indicates whether the `toolTip` property is editable. ToolTipMetadata *PropertyMetadata `json:"toolTipMetadata,omitempty"` // The text of a tooltip that appears when a user hovers over a form field or tab. @@ -6181,1754 +7481,6098 @@ type EmailAddress struct { WidthMetadata *PropertyMetadata `json:"widthMetadata,omitempty"` } -// EmailSettings envelope email settings -type EmailSettings struct { - // An array of up to five email addresses that receive a copy of all email communications for an envelope. Maximum Length: 100 characters. +type CompleteSignHashResponse struct { + // A complex element that contains details about the documents associated with the envelope. + Documents []SignHashDocument `json:"documents,omitempty"` // - // **Note**: Only users with the `canManageAccount` setting set to **true** can use this option. + RedirectionURL string `json:"redirectionUrl,omitempty"` + // For documents that require multiple signatures, this is the number of signature requests remaining. + RemainingSignatureRequests string `json:"remainingSignatureRequests,omitempty"` +} + +// CompositeTemplate this object contains information about a [composite template][composite], which you can use to to apply multiple templates to a single envelope, combine templates with PDF forms, and combine templates with documents from cloud sources. +// +// [composite]: https://developers.docusign.com/esign-rest-api/guides/features/templates#composite-templates +type CompositeTemplate struct { + // The id of this composite template. This id is used as a reference when adding document object information. If used, the document's `content-disposition` must include the composite template ID to which the document should be added. If a composite template ID is not specified in the content-disposition, the document is applied based on the value of the `documentId` property only. If no document object is specified, the composite template inherits the first document. + CompositeTemplateID string `json:"compositeTemplateId,omitempty"` + // An optional document object that will act as the primary document in the composite template object. If the document node is present, it will take precedence over any server template or inline template documents. It always comes first. Only use this when you want to supply the document dynamically. + Document *Document `json:"document,omitempty"` + // Zero or more inline templates and their position in the overlay. If supplied, they are overlaid into the envelope in the order of their Sequence value. + InlineTemplates []InlineTemplate `json:"inlineTemplates,omitempty"` + // A number representing the sequence in which to apply the template that contains the PDF metadata. // - // DocuSign verifies that the email format is correct, but does not verify that the email address is active. You can use this for archiving purposes. However, using this property overrides the BCC for Email Archive information setting for this envelope. + // Example: `4` + PdfMetaDataTemplateSequence string `json:"pdfMetaDataTemplateSequence,omitempty"` + // Zero or more server-side templates and their position in the overlay. If supplied, they are overlaid into the envelope in the order of their Sequence value + ServerTemplates []ServerTemplate `json:"serverTemplates,omitempty"` +} + +type ConditionalRecipientRule struct { + // An array of conditions that satisfy the rule. + Conditions []ConditionalRecipientRuleCondition `json:"conditions,omitempty"` + // An integer that specifies the order in which rules are processed. + // Lower values are processed before higher values. + Order string `json:"order,omitempty"` // - // **Example**: if your account has BCC for Email Archive set up for the email address archive@mycompany.com and you send an envelope using the BCC Email Override to send a BCC email to salesarchive@mycompany.com, then a copy of the envelope is only sent to the salesarchive@mycompany.com email address. - BccEmailAddresses []BccEmailAddress `json:"bccEmailAddresses,omitempty"` - // The Reply To email address to use for email replies, instead of the one that is configured at the account level. DocuSign verifies that the email address is in a correct format, but does not verify that it is active. Maximum Length: 100 characters. - ReplyEmailAddressOverride string `json:"replyEmailAddressOverride,omitempty"` - // The name to associate with the Reply To email address, instead of the name that is configured at the account level. Maximum Length: 100 characters. - ReplyEmailNameOverride string `json:"replyEmailNameOverride,omitempty"` + RecipientGroup *RecipientGroup `json:"recipientGroup,omitempty"` + // Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. + RecipientID string `json:"recipientId,omitempty"` } -// Envelope envelope creation, management -type Envelope struct { - // Reserved for DocuSign. - AccessControlListBase64 string `json:"accessControlListBase64,omitempty"` - // When set to **true**, users can add comments to the documents in the envelope. For example, if a signer has a question about the text in the document, they can add a comment to the document. - AllowComments string `json:"allowComments,omitempty"` - // When **true**, Document Markup is enabled for envelope. The account must have Document Markup enabled to use this. - AllowMarkup DSBool `json:"allowMarkup,omitempty"` - // When **true**, the recipient can redirect an envelope to a more appropriate recipient. - AllowReassign DSBool `json:"allowReassign,omitempty"` - // When set to **true**, recipients can view the history of the envelope. - AllowViewHistory DSBool `json:"allowViewHistory,omitempty"` - // Deprecated. This feature has been replaced by signing groups. - AnySigner string `json:"anySigner,omitempty"` - // When **true**, the envelope is queued for processing and the value of the `status` property is set to 'Processing'. Additionally, get status calls return 'Processing' until completed. +type ConditionalRecipientRuleCondition struct { // + Filters []ConditionalRecipientRuleFilter `json:"filters,omitempty"` + // An integer that specifies the order in which rules are processed. + // Lower values are processed before higher values. + Order string `json:"order,omitempty"` // - // **Note**: A `transactionId` is required for this call to work correctly. When the envelope is created, the status is 'Processing' and an `envelopeId` is not returned in the response. To get the `envelopeId`, use a GET envelope query using the [transactionId](https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/create/#envelopeDefinition) or by checking the Connect notification. - Asynchronous DSBool `json:"asynchronous,omitempty"` - // Contains a URL for retrieving the attachments that are associated with the envelope. - AttachmentsURI string `json:"attachmentsUri,omitempty"` - // Specifies whether all documents in this envelope are authoritative copies. - // A document can set its own `authoritativeCopy` property to override this value. For example you can set the `authoritativeCopy` on an envelope level to true but can turn it off for a specific document. - AuthoritativeCopy DSBool `json:"authoritativeCopy,omitempty"` - // The default `authoritativeCopy` setting for documents in this envelope that do not have `authoritativeCopy` set. - // If this property is not set, each document defaults to the envelope's `authoritativeCopy`. - AuthoritativeCopyDefault string `json:"authoritativeCopyDefault,omitempty"` - // When **true**, auto navigation is set for the recipient. + RecipientLabel string `json:"recipientLabel,omitempty"` +} + +type ConditionalRecipientRuleFilter struct { // - AutoNavigation string `json:"autoNavigation,omitempty"` - // The id of the brand. - BrandID string `json:"brandId,omitempty"` - // Indicates if the brandId for the envelope is locked. - BrandLock string `json:"brandLock,omitempty"` - // Contains a URI that you can use to retrieve certificate information. - CertificateURI string `json:"certificateUri,omitempty"` - // Specifies the date and time this item was completed. - CompletedDateTime *time.Time `json:"completedDateTime,omitempty"` - // The date and time the item was created. - CreatedDateTime *time.Time `json:"createdDateTime,omitempty"` - // An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters. - CustomFields *CustomFields `json:"customFields,omitempty"` - // Contains a URI for an endpoint to retrieve the custom fields. - CustomFieldsURI string `json:"customFieldsUri,omitempty"` - // The date and time the recipient declined the document. - DeclinedDateTime *time.Time `json:"declinedDateTime,omitempty"` - // Specifies the data and time the item was deleted. - DeletedDateTime *time.Time `json:"deletedDateTime,omitempty"` - // The date and time that the envelope was delivered to the recipient. - DeliveredDateTime *time.Time `json:"deliveredDateTime,omitempty"` - // When set to **true**, responsive documents are disabled for the envelope. - DisableResponsiveDocument string `json:"disableResponsiveDocument,omitempty"` - // Contains a URL that you can use to retrieve all of the documents associated with the envelope combined into a single PDF file. - DocumentsCombinedURI string `json:"documentsCombinedUri,omitempty"` - // Contains a URI for an endpoint that you can use to retrieve the documents. - DocumentsURI string `json:"documentsUri,omitempty"` - // This is the same as the email body. If specified it is included in the email body for all envelope recipients. - EmailBlurb string `json:"emailBlurb,omitempty"` - // A complex element that allows the sender to override some envelope email setting information. This can be used to override the Reply To email address and name associated with the envelope and to override the BCC email addresses to which an envelope is sent. + Operator string `json:"operator,omitempty"` + // Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. + RecipientID string `json:"recipientId,omitempty"` + // Must be set to "api". + Scope string `json:"scope,omitempty"` + // The unique identifier for the tab. + TabID string `json:"tabId,omitempty"` + // The label associated with the tab. This value may be an empty string. + // If no value is provided, the tab type is used as the value. // - // When the emailSettings information is used for an envelope, it only applies to that envelope. + // Maximum Length: 500 characters. // - // **IMPORTANT**: The `emailSettings` information is not returned in the GET method for envelope status. Use GET /email_settings to return information about the email settings. - EmailSettings *EmailSettings `json:"emailSettings,omitempty"` - // The subject line of the email message that is sent to all recipients. + TabLabel string `json:"tabLabel,omitempty"` + // Specifies the value of the tab. + Value string `json:"value,omitempty"` +} + +// ConnectConfigResults this object contains the results of a ConnectConfigurations::GET method. +type ConnectConfigResults struct { + // An array of DocuSign Connect configurations. + Configurations []ConnectCustomConfiguration `json:"configurations,omitempty"` + // The number of results. + TotalRecords string `json:"totalRecords,omitempty"` +} + +type ConnectCustomConfiguration struct { + // When set to **true**, the tracked envelope and recipient events for all users, including users that are added a later time, are sent through Connect. + AllUsers DSBool `json:"allUsers,omitempty"` + // When set to **true**, data is sent to the urlToPublishTo web address. This option can be set to false to stop sending data while maintaining the Connect configuration information. + AllowEnvelopePublish DSBool `json:"allowEnvelopePublish,omitempty"` + // When set to **true** (default), DocuSign sends data to the designated Salesforce account through Connect. + AllowSalesforcePublish string `json:"allowSalesforcePublish,omitempty"` + // If you are using merge fields, this property specifies the type of the merge field. The only supported value is `salesforce`. + ConfigurationType string `json:"configurationType,omitempty"` + // Specifies the DocuSign generated ID for the Connect configuration. + ConnectID string `json:"connectId,omitempty"` + // When set to **true**, Connect logging is turned on. We recommend that you enable this functionality, which helps you troubleshoot any issues. // - // For information about adding merge field information to the email subject, see [Template Email Subject Merge Fields](https://developers.docusign.com/esign-rest-api/reference/Templates/Templates/create#template-email-subject-merge-fields). + // You can have a maximum of 100 active logs in your account. You can view the entries in active logs in the **Logs** tab in the console. + EnableLog DSBool `json:"enableLog,omitempty"` + // A list of envelope-level event statuses that will trigger Connect to send updates to the endpoint specified in the `url` property. // - EmailSubject string `json:"emailSubject,omitempty"` - // When set to **true**, the signer is allowed to print the document and sign it on paper. - EnableWetSign DSBool `json:"enableWetSign,omitempty"` - // When set to **true**, signers can only view the documents on which they have tabs. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all of the documents in an envelope, unless they are specifically excluded by using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded by using this setting when an envelope is sent. + // To receive notifications, you must include either an `envelopeEvents` node or a `recipientEvents` node. You do not need to specify both. + EnvelopeEvents []string `json:"envelopeEvents,omitempty"` + // Allows you to specify the format of the information the Connect webhooks returns. For more information, see [Connect webhooks with JSON notifications](https://www.docusign.com/blog/developers/connect-webhooks-json-notifications) + EventData *ConnectEventData `json:"eventData,omitempty"` + // The id of an external folder. + ExternalFolderID string `json:"externalFolderId,omitempty"` + // The label for an external folder. + ExternalFolderLabel string `json:"externalFolderLabel,omitempty"` // - // **Note**: To use this functionality, [Document Visibility][docviz] must be enabled for the account by making the account setting `allowDocumentVisibility` **true**. + IncludeCertSoapHeader string `json:"includeCertSoapHeader,omitempty"` + // When set to **true**, the Connect Service includes the Certificate of Completion with completed envelopes. + IncludeCertificateOfCompletion DSBool `json:"includeCertificateOfCompletion,omitempty"` + // When set to **true**, the Document Fields associated with the envelope's documents are included in the notification messages. Document Fields are optional custom name-value pairs added to documents using the API. + IncludeDocumentFields DSBool `json:"includeDocumentFields,omitempty"` + // reserved + IncludeDocuments DSBool `json:"includeDocuments,omitempty"` + // When set to **true**, if the envelope is voided, the Connect Service notification will include the void reason, as entered by the person that voided the envelope. + IncludeEnvelopeVoidReason DSBool `json:"includeEnvelopeVoidReason,omitempty"` // - // [docviz]: /esign/restapi/Envelopes/EnvelopeDocumentVisibility - EnforceSignerVisibility DSBool `json:"enforceSignerVisibility,omitempty"` - // An array of attachment objects that provide information about the attachments that are associated with the envelope. - EnvelopeAttachments []Attachment `json:"envelopeAttachments,omitempty"` - // An array containing information about the documents that are included in the envelope. - EnvelopeDocuments []EnvelopeDocument `json:"envelopeDocuments,omitempty"` - // The envelope's GUID. + IncludeHMAC string `json:"includeHMAC,omitempty"` + // When set to **true**, Connect will include the sender account as Custom Field in the data. + IncludeSenderAccountasCustomField DSBool `json:"includeSenderAccountasCustomField,omitempty"` + // When set to **true**, Connect will include the envelope time zone information. + IncludeTimeZoneInformation DSBool `json:"includeTimeZoneInformation,omitempty"` + // The name of the Connect configuration. The name helps identify the configuration in the list. + Name string `json:"name,omitempty"` + // The user's encrypted password hash. + Password string `json:"password,omitempty"` + // An array of recipient event statuses that will trigger Connect to send notifications to your webhook listener at the url endpoint specified in the `url` property. // - // Example: `93be49ab-afa0-4adf-933c-f752070d71ec` - EnvelopeID string `json:"envelopeId,omitempty"` - // When set to **true**, [Envelope ID Stamping](https://support.docusign.com/en/guides/ndse-user-guide-set-advanced-document-options) is enabled. - // Once a document or attachment is stamped with an Envelope ID, - // the ID is seen by all recipients - // and becomes a permanent part of the document - // and cannot be removed. - EnvelopeIDStamping DSBool `json:"envelopeIdStamping,omitempty"` - // Reserved for DocuSign. - EnvelopeLocation string `json:"envelopeLocation,omitempty"` - // Metadata that indicates whether the `envelope` property is editable. + // To receive notifications, you must include either an `envelopeEvents` node or a `recipientEvents` node. You do not need to specify both. + RecipientEvents []string `json:"recipientEvents,omitempty"` + // When set to **true**, [Mutual TLS](https://developers.docusign.com/esign-rest-api/guides/mutual-tls-intro) authentication is enabled. + RequireMutualTLS string `json:"requireMutualTls,omitempty"` + // When set to **true**, event delivery acknowledgements are enabled for your Connect configuration. // - EnvelopeMetadata *EnvelopeMetadata `json:"envelopeMetadata,omitempty"` - // URI that you can use to retrieve the bulk envelopes. - EnvelopeURI string `json:"envelopeUri,omitempty"` - // An integer specifying the number of days that a sent envelope remains active before it expires. A negative number in a response indicates that the envelope has already expired. - ExpireAfter string `json:"expireAfter,omitempty"` - // The date and time the envelope is set to expire. - ExpireDateTime string `json:"expireDateTime,omitempty"` - // When set to **true**, the envelope expires (is no longer available for signing) after the specified number of days after it is sent (`sentDateTime`). Set `expireAfter` to set the number of days until an envelope expires. When **false**, the account default setting is used. If the account does not have an expiration setting, the DocuSign default value of 120 days is used. - ExpireEnabled string `json:"expireEnabled,omitempty"` - // May contain an external identifier for the envelope. - ExternalEnvelopeID string `json:"externalEnvelopeId,omitempty"` - // A collection of folder objects returned in a response. - Folders []Folder `json:"folders,omitempty"` - // When set to **true**, indicates that users have added comments to the envelope. - HasComments string `json:"hasComments,omitempty"` - // Specifies if the `EnvelopeFormData` associated with any forms in the envelope has changed. - HasFormDataChanged string `json:"hasFormDataChanged,omitempty"` - // When set to **true**, indicates that a .wav file used for voice authentication is included in the envelope. - HasWavFile string `json:"hasWavFile,omitempty"` - // Reserved for DocuSign. - Holder string `json:"holder,omitempty"` - // The date and time the envelope was initially sent. - InitialSentDateTime *time.Time `json:"initialSentDateTime,omitempty"` - // When **true**, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES). - Is21CFRPart11 DSBool `json:"is21CFRPart11,omitempty"` - // When set to **true**, indicates that the envelope is a dynamic envelope. - IsDynamicEnvelope string `json:"isDynamicEnvelope,omitempty"` - // When set to **true**, indicates that the envelope is a signature-provided envelope. - IsSignatureProviderEnvelope DSBool `json:"isSignatureProviderEnvelope,omitempty"` - // The date and time the item was last modified. - LastModifiedDateTime *time.Time `json:"lastModifiedDateTime,omitempty"` - // Reserved for DocuSign. - Location string `json:"location,omitempty"` - // Provides lock information about an envelope that a user has locked. - LockInformation *LockInformation `json:"lockInformation,omitempty"` - // When set to **true**, prevents senders from changing the contents of `emailBlurb` and `emailSubject` properties for the envelope. + // DocuSign Connect awaits a valid 200 response from your application acknowledging that it received a message. If you do not acknowledge receiving an event notification message within 100 seconds, DocuSign treats the message as a failure and places it into a failure queue. It is imperative that you acknowledge successful receipt of Connect events as they occur by sending a 200 event back. // - // Additionally, this prevents users from making changes to the contents of `emailBlurb` and `emailSubject` properties when correcting envelopes. + // #### When set to **true** and Send Individual Messages (SIM) mode is activated // - // However, if the `messageLock` node is set to **true** and the `emailSubject` property is empty, senders and correctors are able to add a subject to the envelope. - MessageLock DSBool `json:"messageLock,omitempty"` - // A complex element that specifies the notification options for the envelope. It consists of: + // If the HTTP status response to a notification message is not in the range of 200-299, + // then the message delivery failed, and the configuration is marked as down. // - // * useAccountDefaults - When set to **true**, the account default notification settings are used for the envelope. - // * reminders - A complex element that specifies reminder settings for the envelope. It consists of: + // The message will be queued and retried once per day. + // While a Connect configuration is marked down, subsequent notifications will not be tried. Instead they will be immediately queued with the reason `Pending`. + // When a message succeeds, all queued messages for the configuration will be tried immediately, in order. // - // * reminderEnabled - When set to **true**, a reminder message is sent to the recipient. - // * reminderDelay - An interger that sets the number of days after the recipient receives the envelope that reminder emails are sent to the recipient. - // * reminderFrequency - An interger that sets the interval, in days, between reminder emails. + // There is a maximum of ten retries. Alternately, you can use **Republish Connect Information** to manually republish the notification. // - // * expirations - A complex element that specifies the expiration settings for the envelope. It consists of: + // #### When set to **true** and SIM mode is not activated // - // * expireEnabled - When set to **true**, the envelope expires (is no longer available for signing) in the set number of days. If false, the account default setting is used. If the account does not have an expiration setting, the DocuSign default value of 120 days is used. - // * expireAfter - An integer that sets the number of days the envelope is active. - // * expireWarn - An integer that sets the number of days before envelope expiration that an expiration warning email is sent to the recipient. If set to 0 (zero), no warning email is sent. + // If the HTTP Status response to a notification message is not in the range of 200-299, then the message delivery failed, and the message is queued. // - Notification DSBool `json:"notification,omitempty"` - // Contains a URI for an endpoint that you can use to retrieve the notifications. - NotificationURI string `json:"notificationUri,omitempty"` - // Contains information about any PowerForms that are included in the envelope. - PowerForm *PowerForm `json:"powerForm,omitempty"` - // The date that a purge was completed. - PurgeCompletedDate string `json:"purgeCompletedDate,omitempty"` - // The date that a purge was requested. - PurgeRequestDate string `json:"purgeRequestDate,omitempty"` - // Shows the current purge state for the envelope. The possible values are: + // The message will be retried after at least a day the next time a subsequent message is successfully sent to this configuration (subscription). Subsequent notifications will be tried when they occur. + // There is a maximum of ten retries. Alternately, you can use **Republish Connect Information** to manually republish the notification. // - // * `unpurged`: There has been no successful request to purge documents. - // * `documents_queued`: The envelope documents have been added to the purge queue, but have not been purged. - // * `documents_dequeued`: The envelope documents have been taken out of the purge queue. - // * `documents_and_metadata_queued`: The envelope documents and metadata have been added to the purge queue, but have not yet been purged. - // * `documents_purged`: The envelope documents have been successfully purged. - // * `documents_and_metadata_purged`: The envelope documents and metadata have been successfully purged. + // #### When set to **false** // + // When `requiresAcknowledgement` is set to **false** and you do not acknowledge receiving an event notification message within 100 seconds, DocuSign treats the message as a failure and determines that the server is unavailable. It does not retry to send the notification message, and you must handle the failure manually. // - PurgeState string `json:"purgeState,omitempty"` - // An array of recipient objects that provides details about the recipients of the envelope. - Recipients *Recipients `json:"recipients,omitempty"` - // When set to **true**, prevents senders from changing, correcting, or deleting the recipient information for the envelope. - RecipientsLock DSBool `json:"recipientsLock,omitempty"` - // Contains a URI for an endpoint that you can use to retrieve the recipients. - RecipientsURI string `json:"recipientsUri,omitempty"` - // Information about the sender of the envelope. - Sender *UserInfo `json:"sender,omitempty"` - // The date and time the envelope was sent. - SentDateTime *time.Time `json:"sentDateTime,omitempty"` - // When set to **true**, the recipient can sign on a mobile device. - SignerCanSignOnMobile DSBool `json:"signerCanSignOnMobile,omitempty"` - // Specifies the physical location where the signing takes place. It can have two enumeration values; `inPerson` and `online`. The default value is `online`. - SigningLocation string `json:"signingLocation,omitempty"` - // Indicates the envelope status. Valid values are: // - // * `completed`: The envelope has been completed and all tags have been signed. - // * `created`: The envelope is created as a draft. It can be modified and sent later. - // * `declined`: The envelope has been declined by the recipients. - // * `delivered`: The envelope has been delivered to the recipients. - // * `sent`: The envelope is sent to the recipients. - // * `signed`: The envelope has been signed by the recipients. - // * `voided`: The envelope is no longer valid and recipients cannot access or sign the envelope. + RequiresAcknowledgement DSBool `json:"requiresAcknowledgement,omitempty"` + // The version of the Salesforce API that you are using. + SalesforceAPIVersion string `json:"salesforceApiVersion,omitempty"` // - Status string `json:"status,omitempty"` - // The data and time the status changed. - StatusChangedDateTime *time.Time `json:"statusChangedDateTime,omitempty"` - // The DateTime that the envelope changed status (i.e. was created or sent.) - StatusDateTime string `json:"statusDateTime,omitempty"` - // Contains a URI for an endpoint that you can use to retrieve the templates. - TemplatesURI string `json:"templatesUri,omitempty"` - // Used to identify an envelope. The id is a sender-generated value and is valid in the DocuSign system for 7 days. It is recommended that a transaction ID is used for offline signing to ensure that an envelope is not sent multiple times. The `transactionId` property can be used determine an envelope's status (i.e. was it created or not) in cases where the internet connection was lost before the envelope status was returned. - TransactionID string `json:"transactionId,omitempty"` - // When set to **true**, the disclosure is shown to recipients in accordance with the account's Electronic Record and Signature Disclosure frequency setting. When set to **false**, the Electronic Record and Signature Disclosure is not shown to any envelope recipients. + SalesforceAuthcode string `json:"salesforceAuthcode,omitempty"` // - // If the `useDisclosure` property is not set, then the account's normal disclosure setting is used and the value of the `useDisclosure` property is not returned in responses when getting envelope information. - UseDisclosure DSBool `json:"useDisclosure,omitempty"` - // The date and time the envelope or template was voided. - VoidedDateTime *time.Time `json:"voidedDateTime,omitempty"` - // The reason the envelope or template was voided. - VoidedReason string `json:"voidedReason,omitempty"` -} - -type EnvelopeAttachment struct { - // Valid values are `sender` and `senderAndAllRecipients`. - AccessControl string `json:"accessControl,omitempty"` - // The unique identifier for the attachment. - AttachmentID string `json:"attachmentId,omitempty"` - // Specifies the type of the attachment for the recipient. Possible values are: + SalesforceCallBackURL string `json:"salesforceCallBackUrl,omitempty"` + // When set to **true**, DocuSign can use documents in your Salesforce account for sending and signing. + SalesforceDocumentsAsContentFiles string `json:"salesforceDocumentsAsContentFiles,omitempty"` // - // - `.htm` - // - `.xml` - AttachmentType string `json:"attachmentType,omitempty"` - // This object describes errors that occur. It is only valid for responses and ignored in requests. - ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` + SenderOverride string `json:"senderOverride,omitempty"` + // This property sets the items that are available for selection when adding or editing Connect objects. + SenderSelectableItems []string `json:"senderSelectableItems,omitempty"` + // An array of Salesforce objects. + SfObjects []ConnectSalesforceObject `json:"sfObjects,omitempty"` + // When set to **true**, Mutual TLS will be enabled for notifications. Mutual TLS must be initiated by the listener (the customer's web server) during the TLS handshake protocol. + SignMessageWithX509Certificate DSBool `json:"signMessageWithX509Certificate,omitempty"` + // The namespace of the SOAP interface. // - Label string `json:"label,omitempty"` + // **Note**: If `useSoapInterface` is set to **true**, you must set this value. + SoapNamespace string `json:"soapNamespace,omitempty"` + // This is the web address and name of your listener or Retrieving Service endpoint. You need to include HTTPS:// in the web address. + URLToPublishTo string `json:"urlToPublishTo,omitempty"` + // When set to **true**, the notifications are sent to your endpoint as SOAP requests. + UseSoapInterface DSBool `json:"useSoapInterface,omitempty"` + // A comma-separated list of userIds. This sets the users associated with the tracked envelope and recipient events. When a tracked event occurs for a set user, the a notification message is sent to your Connect listener. // - Name string `json:"name,omitempty"` + // **Note**: If allUsers is set to `false` then you must provide a list of user ids. + UserIds []string `json:"userIds,omitempty"` + // The name of the user. + UserName string `json:"userName,omitempty"` } -type EnvelopeAttachmentsRequest struct { - // An object that contains information about the attachment. - Attachments []Attachment `json:"attachments,omitempty"` +type ConnectDebugLog struct { + // The name of the Connect configuration. + ConnectConfig string `json:"connectConfig,omitempty"` + // This object describes errors that occur. It is only valid for responses and ignored in requests. + ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` + // The UTC date and time of the event. + EventDateTime *time.Time `json:"eventDateTime,omitempty"` + // A description of the event. + EventDescription string `json:"eventDescription,omitempty"` + // Log output. + Payload string `json:"payload,omitempty"` } -type EnvelopeAttachmentsResult struct { - // An array of attachment objects that contain information about the attachments. - Attachments []EnvelopeAttachment `json:"attachments,omitempty"` +// ConnectEventData this object lets you choose the data format of your Connect response. +// For more information about using this object, see [Connect webhooks with JSON notifications](https://www.docusign.com/blog/developers/connect-webhooks-json-notifications). +type ConnectEventData struct { + // The format of the response. One of: + // + // If the value of `version` is `restv2.1`, the value of this property is one of: + // + // - `json` (Default when `version` is `rest2.1`. + // - `xml` + // + // If the value of `version` is `legacy` or empty, the only valid value is `xml`. + // + // + // For more information about formats, see the *Data format* section in [Choose the architecture of your webhook](https://developers.docusign.com/platform/webhooks/connect/architecture/). + // + // + Format string `json:"format,omitempty"` + // A string array of the data to be included. + // The default is the empty array `[]`. + // + // - `attachments`: Include attachments associated with the envelope. + // - `custom_fields`: Include the custom fields associated with the envelope. + // - `documents`: Include the documents associated with the envelope. + // - `extensions`: Include information about the email settings associated with the envelope. + // - `folders`: Include the folder where the envelope exists. + // - `payment_tabs`: Include the payment tabs associated with the envelope. + // - `powerform`: Include the PowerForms associated with the envelope. + // - `recipients`: Include the recipients associated with the envelope. + // - `tabs`: Include the tabs associated with the envelope. + // + IncludeData []string `json:"includeData,omitempty"` + // Specifies how the connection data is returned. + // + // - `legacy`: (Default) The response follows the original Connect Message format. + // - `restv2.1`: The response follows the new Connect Message format. + Version string `json:"version,omitempty"` } -type EnvelopeAuditEvent struct { +// ConnectFailureFilter is a list of failed envelope IDs to retry. +type ConnectFailureFilter struct { + // An array of envelope GUIDs. // - EventFields []NameValue `json:"eventFields,omitempty"` + // Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec` + // + EnvelopeIds []string `json:"envelopeIds,omitempty"` + // Must be **false**. Setting this property to any other value will result in errors. + Synchronous string `json:"synchronous,omitempty"` } -type EnvelopeAuditEventResponse struct { - // Reserved: TBD - AuditEvents []EnvelopeAuditEvent `json:"auditEvents,omitempty"` +// ConnectFailureResult this object contains details about a Connect failure result. +type ConnectFailureResult struct { + // Reserved for DocuSign. + ConfigID string `json:"configId,omitempty"` + // Reserved for DocuSign. + // + ConfigURL string `json:"configUrl,omitempty"` + // The envelope ID of the envelope status that failed to post. + EnvelopeID string `json:"envelopeId,omitempty"` + // The connection status. + Status string `json:"status,omitempty"` + // A human-readable message describing the connection status. + StatusMessage string `json:"statusMessage,omitempty"` } -// EnvelopeDefinition envelope object definition. -type EnvelopeDefinition struct { - // Reserved for DocuSign. - AccessControlListBase64 string `json:"accessControlListBase64,omitempty"` - // Sets the document reading zones for screen reader applications. This element can only be used if Document Accessibility is enabled for the account. +type ConnectFailureResults struct { + // Details about a Connect failure result. + RetryQueue []ConnectFailureResult `json:"retryQueue,omitempty"` +} + +// ConnectLog contains information about a Connect log entry. +type ConnectLog struct { + // The account ID associated with the envelope. + AccountID string `json:"accountId,omitempty"` + // The web address of the listener or retrieving service endpoint for Connect. + ConfigURL string `json:"configUrl,omitempty"` + // A complex element containing information about the Connect configuration, error details, date/time, description and payload. + // This information is included in the response only when the `additional_info` query is set to **true**. + // This additional information is only available when retrieving general logs with [ConnectEvents:get](https://developers.docusign.com/docs/esign-rest-api/reference/Connect/ConnectEvents/get), but not when retrieving failure logs with [ConnectEvents:listFailures](https://developers.docusign.com/docs/esign-rest-api/reference/Connect/ConnectEvents/listFailures). + ConnectDebugLog []ConnectDebugLog `json:"connectDebugLog,omitempty"` + // The id of the Connect configuration that failed. If an account has multiple Connect configurations, this value is used to look up the Connect configuration for the failed post. + ConnectID string `json:"connectId,omitempty"` + // The UTC DateTime when the Connect post was created. + Created *time.Time `json:"created,omitempty"` + // The email address of the envelope sender. + Email string `json:"email,omitempty"` + // The id of the envelope that failed to post. + EnvelopeID string `json:"envelopeId,omitempty"` + // The error that caused the Connect post to fail. + Error string `json:"error,omitempty"` + // The failure log ID for the failure. + FailureID string `json:"failureId,omitempty"` + // The URI for the Connect post failure. + FailureURI string `json:"failureUri,omitempty"` + // The UTC DateTime of the last attempt to post. + LastTry string `json:"lastTry,omitempty"` + // The Connect log ID for the entry. + LogID string `json:"logId,omitempty"` + // The URI for the Connect log entry. + LogURI string `json:"logUri,omitempty"` + // The number of times the Connect post has been retried. + RetryCount string `json:"retryCount,omitempty"` + // A URI that you can use to retry to publish the Connect post. + RetryURI string `json:"retryUri,omitempty"` + // The envelope status for the Connect post. Possible values are: + // - `Any` + // - `Voided` + // - `Created` + // - `Deleted` + // - `Sent` + // - `Delivered` + // - `Signed` + // - `Completed` + // - `Declined` + // - `TimedOut` + // - `Template` + // - `Processing` // - // ###### Note: This information is currently generated from the DocuSign web console by setting the reading zones when creating a template, exporting the reading zone string information, and adding it here. - Accessibility string `json:"accessibility,omitempty"` - // When **true**, indicates that comments are allowed on the envelope. - AllowComments string `json:"allowComments,omitempty"` - // When **true**, Document Markup is enabled for envelope. The account must have Document Markup enabled to use this. - AllowMarkup DSBool `json:"allowMarkup,omitempty"` - // When **true**, the recipient can redirect an envelope to a more appropriate recipient. - AllowReassign DSBool `json:"allowReassign,omitempty"` - // When set to **true**, this enables the Recursive Recipients feature and allows a recipient to appear more than once in the routing order. - AllowRecipientRecursion DSBool `json:"allowRecipientRecursion,omitempty"` - // Specifies if users can view the history of the envelope. - AllowViewHistory DSBool `json:"allowViewHistory,omitempty"` - // Deprecated. This feature has been replaced by signing groups. - AnySigner string `json:"anySigner,omitempty"` - // When **true**, the envelope is queued for processing and the value of the `status` property is set to 'Processing'. Additionally, get status calls return 'Processing' until completed. + // For details about these statuses, see [Envelope Status Code Descriptions](https://developers.docusign.com/esign-rest-api/guides/status-and-error-codes#envelope-status-code-descriptions). + Status string `json:"status,omitempty"` + // The subject of the envelope. + Subject string `json:"subject,omitempty"` + // The name of the sender of the envelope. + UserName string `json:"userName,omitempty"` +} + +type ConnectLogs struct { + // A list of Connect failure logs. + Failures []ConnectLog `json:"failures,omitempty"` + // A list of Connect general logs. + Logs []ConnectLog `json:"logs,omitempty"` + // The count of records in the log list. + TotalRecords string `json:"totalRecords,omitempty"` // + Type string `json:"type,omitempty"` +} + +// ConnectSalesforceField this object is used to match a DocuSign field to a Salesforce field so that Docusign can send information to your Salesforce account. +type ConnectSalesforceField struct { // - // **Note**: A `transactionId` is required for this call to work correctly. When the envelope is created, the status is 'Processing' and an `envelopeId` is not returned in the response. To get the `envelopeId`, use a GET envelope query using the [transactionId](https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/create/#envelopeDefinition) or by checking the Connect notification. - Asynchronous DSBool `json:"asynchronous,omitempty"` + DsAttribute string `json:"dsAttribute,omitempty"` + // A URL that links to the information in the DocuSign field. + DsLink string `json:"dsLink,omitempty"` // - Attachments []Attachment `json:"attachments,omitempty"` - // The URI for retrieving information about the attachments associated with the envelope. - AttachmentsURI string `json:"attachmentsUri,omitempty"` - // Specifies whether all documents in this envelope are authoritative copies. - // A document can set its own `authoritativeCopy` property to override this value. For example you can set the `authoritativeCopy` on an envelope level to true but can turn it off for a specific document. - AuthoritativeCopy DSBool `json:"authoritativeCopy,omitempty"` - // The default `authoritativeCopy` setting for documents in this envelope that do not have `authoritativeCopy` set. - // If this property is not set, each document defaults to the envelope's `authoritativeCopy`. - AuthoritativeCopyDefault string `json:"authoritativeCopyDefault,omitempty"` - // When **true**, auto navigation is set for the recipient. + DsNode string `json:"dsNode,omitempty"` + // A unique ID for the Salesforce object. + ID string `json:"id,omitempty"` // - AutoNavigation string `json:"autoNavigation,omitempty"` - // This sets the brand profile format used for the envelope. The value in the string is the brandId associated with the profile. Account branding must be enabled for the account to use this option. - BrandID string `json:"brandId,omitempty"` - // Indicates if the brandId for the envelope is locked. - BrandLock string `json:"brandLock,omitempty"` - // Contains a URI that you can use to retrieve certificate information. - CertificateURI string `json:"certificateUri,omitempty"` - // Specifies the date and time this item was completed. - CompletedDateTime *time.Time `json:"completedDateTime,omitempty"` - // A complex type that can be added to create envelopes from a combination of DocuSign templates and PDF forms. The basic envelope remains the same, while the Composite Template adds new document and template overlays into the envelope. There can be any number of Composite Template structures in the envelope. - CompositeTemplates []CompositeTemplate `json:"compositeTemplates,omitempty"` - // The date and time the item was created. - CreatedDateTime *time.Time `json:"createdDateTime,omitempty"` - // An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters. - CustomFields *CustomFields `json:"customFields,omitempty"` - // Contains a URI for an endpoint to retrieve the custom fields. - CustomFieldsURI string `json:"customFieldsUri,omitempty"` - // The date and time the recipient declined the document. - DeclinedDateTime *time.Time `json:"declinedDateTime,omitempty"` - // Specifies the data and time the item was deleted. - DeletedDateTime *time.Time `json:"deletedDateTime,omitempty"` - // The date and time that the envelope was delivered to the recipient. - DeliveredDateTime *time.Time `json:"deliveredDateTime,omitempty"` - // When **true**, indicates that the responsive document feature has been turned off for the envelope. - DisableResponsiveDocument string `json:"disableResponsiveDocument,omitempty"` - // Complex element contains the details on the documents in the envelope. - Documents []Document `json:"documents,omitempty"` - // Contains a URL that you can use to retrieve all of the documents associated with the envelope combined into a single PDF file. - DocumentsCombinedURI string `json:"documentsCombinedUri,omitempty"` - // Contains a URI for an endpoint that you can use to retrieve the documents. - DocumentsURI string `json:"documentsUri,omitempty"` - // Optional element. This is the same as the email body. If specified it is included in email body for all envelope recipients. This can be a maximum of 10000 characters - EmailBlurb string `json:"emailBlurb,omitempty"` - // This optional complex element allows sender to override some envelope email setting information. This can be used to override the Reply To email address and name associated with the envelope and to override the BCC email addresses to which an envelope is sent. When the emailSettings information is used for an envelope, it only applies to that envelope. - // ###### Important Note: The emailSettings information is not returned in the GET for envelope status. Use GET /email_settings to return information about the emailSettings. - EmailSettings *EmailSettings `json:"emailSettings,omitempty"` - // The subject line of the email message that is sent to all recipients. + SfField string `json:"sfField,omitempty"` + // The name of the Salesforce field. + SfFieldName string `json:"sfFieldName,omitempty"` + // The name of the Salesforce folder. + SfFolder string `json:"sfFolder,omitempty"` // - // For information about adding merge field information to the email subject, see [Template Email Subject Merge Fields](https://developers.docusign.com/esign-rest-api/reference/Templates/Templates/create#template-email-subject-merge-fields). + SfLockedValue string `json:"sfLockedValue,omitempty"` +} + +// ConnectSalesforceObject is a `connectSalesforceObject` is an object that updates envelope and document status or recipient status in your Salesforce account. +// +// When you install DocuSign Connect for Salesforce, the service automatically sets up two Connect objects: one that updates envelope status and documents and one that updates recipient status. You can also customize DocuSign Connect for Salesforce by associating DocuSign objects with Salesforce objects so that DocuSign Connect for Salesforce updates or inserts the information into the Salesforce object. For more information, see +// [DocuSign for Salesforce - Adding Completed Documents to the Notes and Attachments](https://support.docusign.com/articles/DocuSign-for-Salesforce-Adding-Completed-Documents-to-the-Notes-and-Attachments-New). +type ConnectSalesforceObject struct { + // When set to **true**, the `connectSalesforceObject` is active. + Active string `json:"active,omitempty"` + // A description of the `connectSalesforceObject`. + Description string `json:"description,omitempty"` + // The id of the `connectSalesforceObject`. + ID string `json:"id,omitempty"` // - EmailSubject string `json:"emailSubject,omitempty"` - // When set to **true**, the signer is allowed to print the document and sign it on paper. - EnableWetSign DSBool `json:"enableWetSign,omitempty"` - // When set to **true**, signers can only view the documents on which they have tabs. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all of the documents in an envelope, unless they are specifically excluded by using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded by using this setting when an envelope is sent. + Insert string `json:"insert,omitempty"` + // When **true**, Salesforce is updated only when the envelope is complete. + OnCompleteOnly string `json:"onCompleteOnly,omitempty"` + // The DocuSign and Salesforce fields that you want to use to match a Salesforce object with DocuSign information. This information tells Connect when to send updates to Salesforce. + SelectFields []ConnectSalesforceField `json:"selectFields,omitempty"` + // The Salesforce.com object type, such as `case`, `contact`, or `opportunity`. + SfObject string `json:"sfObject,omitempty"` + // A name for the Salesforce object. // - // **Note**: To use this functionality, [Document Visibility][docviz] must be enabled for the account by making the account setting `allowDocumentVisibility` **true**. + // **Note**: You can enter any name for the object. It does not have to match the `sfObject` property. + SfObjectName string `json:"sfObjectName,omitempty"` + // The DocuSign and Salesforce fields that you want to update. // - // [docviz]: /esign/restapi/Envelopes/EnvelopeDocumentVisibility - EnforceSignerVisibility DSBool `json:"enforceSignerVisibility,omitempty"` - // An array of attachment objects that provide information about the attachments that are associated with the envelope. - EnvelopeAttachments []Attachment `json:"envelopeAttachments,omitempty"` - // An array containing information about the documents that are included in the envelope. - EnvelopeDocuments []EnvelopeDocument `json:"envelopeDocuments,omitempty"` - // The envelope ID of the envelope status that failed to post. + // **Note**: You can choose to update SalesForce (with information from DocuSign) only, update DocuSign only, or both. + UpdateFields []ConnectSalesforceField `json:"updateFields,omitempty"` +} + +type ConnectUserObject struct { + // The type of custom Connect configuration being accessed. + Configurationtype string `json:"configurationtype,omitempty"` + // The ID of the custom Connect configuration being accessed. + ConnectID string `json:"connectId,omitempty"` + // Boolean value that indicates whether the custom Connect configuration is enabled or not. + Enabled string `json:"enabled,omitempty"` + // + HasAccess string `json:"hasAccess,omitempty"` + // + SenderSearchableItems []string `json:"senderSearchableItems,omitempty"` +} + +// ConsoleViewRequest is the request object for the EnvelopeViews::createConsole method. +type ConsoleViewRequest struct { + // The id of the envelope. EnvelopeID string `json:"envelopeId,omitempty"` - // When set to **true**, [Envelope ID Stamping](https://support.docusign.com/en/guides/ndse-user-guide-set-advanced-document-options) is enabled. - // Once a document or attachment is stamped with an Envelope ID, - // the ID is seen by all recipients - // and becomes a permanent part of the document - // and cannot be removed. - EnvelopeIDStamping DSBool `json:"envelopeIdStamping,omitempty"` - // Reserved for DocuSign. - EnvelopeLocation string `json:"envelopeLocation,omitempty"` - // Metadata about the features that are enabled for the envelope. - EnvelopeMetadata *EnvelopeMetadata `json:"envelopeMetadata,omitempty"` - // URI that you can use to retrieve the bulk envelopes. - EnvelopeURI string `json:"envelopeUri,omitempty"` - // This optional object is used to register a webhook that will receive status changes for this envelope. - EventNotification *EventNotification `json:"eventNotification,omitempty"` - // An array of event notification objects. - EventNotifications []EventNotification `json:"eventNotifications,omitempty"` - // An integer specifying the number of days that a sent envelope remains active before it expires. A negative number in a response indicates that the envelope has already expired. - ExpireAfter string `json:"expireAfter,omitempty"` - // The date and time the envelope is set to expire. - ExpireDateTime string `json:"expireDateTime,omitempty"` - // When set to **true**, the envelope expires (is no longer available for signing) after the specified number of days after it is sent (`sentDateTime`). Set `expireAfter` to set the number of days until an envelope expires. When **false**, the account default setting is used. If the account does not have an expiration setting, the DocuSign default value of 120 days is used. - ExpireEnabled string `json:"expireEnabled,omitempty"` - // May contain an external identifier for the envelope. - ExternalEnvelopeID string `json:"externalEnvelopeId,omitempty"` - // An array of the folders in which the envelope is included. - Folders []Folder `json:"folders,omitempty"` - // When set to **true**, indicates that users have added comments to the envelope. - HasComments string `json:"hasComments,omitempty"` - // When set to **true**, indicates that the form data associated with the envelope has changed since it was sent. If **false**, this property does not appear in the response. - HasFormDataChanged string `json:"hasFormDataChanged,omitempty"` - // When **true**, indicates that a wave file (voice recording) is part of the envelope. - HasWavFile string `json:"hasWavFile,omitempty"` - // Reserved for DocuSign. - Holder string `json:"holder,omitempty"` - // The date and time that the envelope was initially sent. - InitialSentDateTime *time.Time `json:"initialSentDateTime,omitempty"` - // When **true**, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES). - Is21CFRPart11 DSBool `json:"is21CFRPart11,omitempty"` - // When set to **true**, indicates that the envelope is a dynamic envelope. - IsDynamicEnvelope string `json:"isDynamicEnvelope,omitempty"` - // When set to **true**, indicates that the envelope is a signature-provided envelope. - IsSignatureProviderEnvelope DSBool `json:"isSignatureProviderEnvelope,omitempty"` - // The date and time the item was last modified. - LastModifiedDateTime *time.Time `json:"lastModifiedDateTime,omitempty"` - // Reserved for DocuSign. - Location string `json:"location,omitempty"` - // Provides lock information about an envelope that a user has locked. - LockInformation *LockInformation `json:"lockInformation,omitempty"` - // When set to **true**, prevents senders from changing the contents of `emailBlurb` and `emailSubject` properties for the envelope. + // (Optional) The URL to which the user should be redirected after the console view session has ended. // - // Additionally, this prevents users from making changes to the contents of `emailBlurb` and `emailSubject` properties when correcting envelopes. + // Maximum Length: 500 characters. If the `returnUrl` exceeds this limit, the user is redirected to a truncated URL. + ReturnURL string `json:"returnUrl,omitempty"` +} + +// ConsumerDisclosure details about envelope consumer disclosures. +type ConsumerDisclosure struct { + // The GUID of the account associated with the consumer disclosure. + AccountEsignID string `json:"accountEsignId,omitempty"` + // When set to **true**, indicates that the customer can withdraw their consent to the consumer disclosure when they decline to sign documents. If these recipients sign documents sent to them from your account in the future, they will be required to agree to the terms in the disclosure. The default value is **false**. + // **Note**: Only Admin users can change this setting. + AllowCDWithdraw DSBool `json:"allowCDWithdraw,omitempty"` + // Metadata that indicates whether the `allowCDWithdraw` property is editable. // - // However, if the `messageLock` node is set to **true** and the `emailSubject` property is empty, senders and correctors are able to add a subject to the envelope. - MessageLock DSBool `json:"messageLock,omitempty"` - // An optional complex element that specifies the notification options for the envelope. - Notification *Notification `json:"notification,omitempty"` - // Contains a URI for an endpoint that you can use to retrieve the notifications. - NotificationURI string `json:"notificationUri,omitempty"` - // The user's encrypted password hash. - Password string `json:"password,omitempty"` - // Contains information about any PowerForms that are included in the envelope. - PowerForm *PowerForm `json:"powerForm,omitempty"` - // The date that a purge was completed. - PurgeCompletedDate string `json:"purgeCompletedDate,omitempty"` - // The date that a purge was requested. - PurgeRequestDate string `json:"purgeRequestDate,omitempty"` - // Initiates a purge request. Valid values are: - // * documents_queued - Places envelope documents in the purge queue. - // * documents_and_metadata_queued - Places envelope documents and metadata in the purge queue. + AllowCDWithdrawMetadata *SettingsMetadata `json:"allowCDWithdrawMetadata,omitempty"` + // If the customer needs to change their email address, this is the email address to which they should the change request. + ChangeEmail string `json:"changeEmail,omitempty"` + // Other information about the requirements for the user to change their email address. // - PurgeState string `json:"purgeState,omitempty"` - // Specifies the envelope recipients. - Recipients *Recipients `json:"recipients,omitempty"` - // When set to **true**, prevents senders from changing, correcting, or deleting the recipient information for the envelope. - RecipientsLock DSBool `json:"recipientsLock,omitempty"` - // Contains a URI for an endpoint that you can use to retrieve the recipients. - RecipientsURI string `json:"recipientsUri,omitempty"` - // Information about the sender of the envelope. - Sender *UserInfo `json:"sender,omitempty"` - // The date and time the envelope was sent. - SentDateTime *time.Time `json:"sentDateTime,omitempty"` - // When set to **true**, the recipient can sign on a mobile device. - SignerCanSignOnMobile DSBool `json:"signerCanSignOnMobile,omitempty"` - // Specifies the physical location where the signing takes place. It can have two enumeration values; `inPerson` and `online`. The default value is `online`. - SigningLocation string `json:"signingLocation,omitempty"` - // Indicates the envelope status. Valid values are: + // Example: // - // * sent - The envelope is sent to the recipients. - // * created - The envelope is saved as a draft and can be modified and sent later. - Status string `json:"status,omitempty"` - // The data and time the status changed. - StatusChangedDateTime *time.Time `json:"statusChangedDateTime,omitempty"` - // The DateTime that the envelope changed status (i.e. was created or sent.) - StatusDateTime string `json:"statusDateTime,omitempty"` - // The unique identifier of the template. If this is not provided, DocuSign will generate a value. - TemplateID string `json:"templateId,omitempty"` - // Specifies the template recipients. Each roleName in the template must have a recipient assigned to it. This is made up by the following elements: - // - // * email - The recipient's email address. - // * name - The recipient's name. - // * roleName - The template roleName associated with the recipient. - // * clientUserId - Optional, this sets if the signer is This specifies if the recipient is embedded or remote. If the clientUserId is not null then the recipient is embedded. Note that if a ClientUserId is used and the account settings SignerMustHaveAccount or SignerMustLoginToSign are true, an error is generated on sending. - // * defaultRecipient - Optional, When set to **true**, this recipient is the default recipient and any tabs generated by the transformPdfFields option are mapped to this recipient. - // * routingOrder - This specifies the routing order of the recipient in the envelope. - // * accessCode - This optional element specifies the access code a recipient has to enter to validate the identity. This can be a maximum of 50 characters. - // * inPersonSignerName - Optional, if the template role is an in person signer, this is the full legal name of the signer. This can be a maximum of 100 characters. - // * emailNotification - This is an optional complex element that has a role-specific emailSubject, emailBody, and language. It follows the same format as the emailNotification node for Recipients. - // * tabs - This allows the tab values to be specified for matching to tabs in the template. + // `We do not require any other information from you to change your email address.` + ChangeEmailOther string `json:"changeEmailOther,omitempty"` + // Specifies the company name used in the disclosure. The default value is the account name. // - TemplateRoles []TemplateRole `json:"templateRoles,omitempty"` - // Contains a URI for an endpoint that you can use to retrieve the templates. - TemplatesURI string `json:"templatesUri,omitempty"` - // Used to identify an envelope. The id is a sender-generated value and is valid in the DocuSign system for 7 days. It is recommended that a transaction ID is used for offline signing to ensure that an envelope is not sent multiple times. The `transactionId` property can be used determine an envelope's status (i.e. was it created or not) in cases where the internet connection was lost before the envelope status was returned. - TransactionID string `json:"transactionId,omitempty"` - // When set to **true**, the disclosure is shown to recipients in accordance with the account's Electronic Record and Signature Disclosure frequency setting. When set to **false**, the Electronic Record and Signature Disclosure is not shown to any envelope recipients. + // However, if your account uses signing brands that specify a company name, you can substitute the brand's company name by setting the `useBrand` property to **true**. Whenever an envelope is sent from the account that uses a signing brand with a specified `companyName`, that value is used in email notifications and in the signing experience. // - // If the `useDisclosure` property is not set, then the account's normal disclosure setting is used and the value of the `useDisclosure` property is not returned in responses when getting envelope information. - UseDisclosure DSBool `json:"useDisclosure,omitempty"` - // The date and time the envelope or template was voided. - VoidedDateTime *time.Time `json:"voidedDateTime,omitempty"` - // The reason the envelope or template was voided. - VoidedReason string `json:"voidedReason,omitempty"` -} - -type EnvelopeDocument struct { - // If recipients were added by converting form fields into tabs, their ids will appear here. Read only. - AddedRecipientIds []string `json:"addedRecipientIds,omitempty"` - // If this document is an attachment to another document in the envelope, this is the id of the attachment tab it is associated with on the other document. - AttachmentTabID string `json:"attachmentTabId,omitempty"` - // Specifies whether all documents in this envelope are authoritative copies. - // A document can set its own `authoritativeCopy` property to override this value. For example you can set the `authoritativeCopy` on an envelope level to true but can turn it off for a specific document. - AuthoritativeCopy DSBool `json:"authoritativeCopy,omitempty"` - // Metadata that indicates if the sender can edit the `authoritativeCopy` property. Not applicable for template documents. - AuthoritativeCopyMetadata *PropertyMetadata `json:"authoritativeCopyMetadata,omitempty"` + // **Note**: This substitution only works if you use the default legal disclosure or if you apply the `companyName` to the merge fields in a custom ERSD. You must also set the value of the `useBrand` property to **true**. // - AvailableDocumentTypes []SignatureType `json:"availableDocumentTypes,omitempty"` - // When **true**, the document has editable form fields that are made available through a PDF format. - ContainsPdfFormFields string `json:"containsPdfFormFields,omitempty"` - // This string sets the display and behavior properties of - // the document during signing. The possible values are: + CompanyName string `json:"companyName,omitempty"` + // The phone number of the company associated with the consumer disclosure, as a free-formatted string. + CompanyPhone string `json:"companyPhone,omitempty"` + // The cost per page if the customer requests paper copies. // - // * `modal`
- // The document is shown as a supplement action strip - // and can be viewed, downloaded, or printed in a modal window. - // This is the recommended value for supplemental documents. + // Example: // - // * `download`
- // The document is shown as a supplement action strip - // and can be viewed, downloaded, or printed in a new browser window. + // `0.0000` + CopyCostPerPage string `json:"copyCostPerPage,omitempty"` + // Specifies the fee collection method for cases in which the customer requires paper copies of the document. // - // * `inline`
- // The document is shown in the normal signing window. - // This value is not used with supplemental documents, - // but is the default value for all other documents. + // Maximum length: 255 characters. // - Display string `json:"display,omitempty"` - // Metadata that indicates if the sender can edit the `display` property. Not applicable for template documents. - DisplayMetadata *PropertyMetadata `json:"displayMetadata,omitempty"` - // The custom fields on the document. - DocumentFields []NameValue `json:"documentFields,omitempty"` - // The type of group the document belongs to (`certificate` or `content`). - DocumentGroup string `json:"documentGroup,omitempty"` - // Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - DocumentID string `json:"documentId,omitempty"` - // The Guid of the document. - DocumentIDGUID string `json:"documentIdGuid,omitempty"` - // If an error occurs, this property describes the error. - ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` - // When set to **true**, - // the document is included in the combined document download. - // The default value is **true**. + // Example: // - IncludeInDownload DSBool `json:"includeInDownload,omitempty"` - // Metadata that indicates if the sender can edit the `includeInDowload` property. Not applicable for template documents. - IncludeInDownloadMetadata *PropertyMetadata `json:"includeInDownloadMetadata,omitempty"` - // The name of the document. - Name string `json:"name,omitempty"` - // Metadata that indicates if the sender can edit the `name` property. Not applicable for template documents. - NameMetadata *PropertyMetadata `json:"nameMetadata,omitempty"` - // (Optional) The order in which to sort the results. + // `We will bill you for any fees at that time, if any.` + CopyFeeCollectionMethod string `json:"copyFeeCollectionMethod,omitempty"` + // The email address to which the customer should send a request for copies of a document. // - // Valid values are: + // Maximum length: 100 characters. + CopyRequestEmail string `json:"copyRequestEmail,omitempty"` + // When set to **true**, indicates that the consumer disclosure is a custom disclosure. The default is **false**. + Custom string `json:"custom,omitempty"` + // When set to **true** (default), indicates that eSign is enabled. + EnableEsign string `json:"enableEsign,omitempty"` + // The final, assembled text of the Electronic Record and Signature Disclosure that includes the appropriate `companyName` and other specifics. It also includes the HTML tags used for formatting. + EsignAgreement string `json:"esignAgreement,omitempty"` + // The template for the Electronic Record and Signature Disclosure, which contains placeholders for information such as the `companyName`. It also includes the HTML tags used for formatting. // + // **Note**: If you are switching to or updating a custom disclosure, you can edit both the text and the HTML formatting. + EsignText string `json:"esignText,omitempty"` + // The simple type enumeration for the language to use when displaying the disclosure. The following languages are supported: + // + // - Arabic (`ar`) + // - Bulgarian (`bg`) + // - Czech (`cs`) + // - Chinese Simplified (`zh_CN`) + // - Chinese Traditional (`zh_TW`) + // - Croatian (`hr`) + // - Danish (`da`) + // - Dutch (`nl`) + // - English US (`en`) + // - English UK (`en_GB`) + // - Estonian (`et`) + // - Farsi (`fa`) + // - Finnish (`fi`) + // - French (`fr`) + // - French Canadian (`fr_CA`) + // - German (`de`) + // - Greek (`el`) + // - Hebrew (`he`) + // - Hindi (`hi`) + // - Hungarian (`hu`) + // - Bahasa Indonesian (`id`) + // - Italian (`it`) + // - Japanese (`ja`) + // - Korean (`ko`) + // - Latvian (`lv`) + // - Lithuanian (`lt`) + // - Bahasa Melayu (`ms`) + // - Norwegian (`no`) + // - Polish (`pl`) + // - Portuguese (`pt`) + // - Portuguese Brazil (`pt_BR`) + // - Romanian (`ro`) + // - Russian (`ru`) + // - Serbian (`sr`) + // - Slovak (`sk`) + // - Slovenian (`sl`) + // - Spanish (`es`) + // - Spanish Latin America (`es_MX`) + // - Swedish (`sv`) + // - Thai (`th`) + // - Turkish (`tr`) + // - Ukrainian (`uk`) + // - Vietnamese (`vi`) + // + // Additionally, you can automatically detect the browser language being used by the viewer and display the disclosure in that language by setting the value to `browser`. + LanguageCode string `json:"languageCode,omitempty"` + // When set to **true**, the recipient must agree to the consumer disclosure. The value of this property is read only. It is calculated based on the account setting `consumerDisclosureFrequency` and the user's actions. + MustAgreeToEsign string `json:"mustAgreeToEsign,omitempty"` + // **Deprecated**. // - // * `asc`: Ascending order. - // * `desc`: Descending order. - Order string `json:"order,omitempty"` - // An array of page objects that contain information about the pages in a document. - Pages []Page `json:"pages,omitempty"` - // Sets how the signer interacts with the supplemental document. - // The possible values are: + // The `pdfId` property in the consumer_disclosure PUT request is deprecated. For security reasons going forward, any value provided in the request packet must be ignored. + PdfID string `json:"pdfId,omitempty"` + // When set to **true**, specifies that the company name in the signing brand is used for the disclosure. Whenever an envelope is sent from the account that uses a signing brand with a specified company name, that value is used in email notifications and in the signing experience. // - // * `no_interaction`
- // No recipient action is required. + // When set to **false** (default), or if the signing brand does not specify a company name, the account name is used instead. // - // * `view`
- // The recipient is required to view the document. + // **Note**: This substitution only works if you use the default legal disclosure or if you apply the `companyName` to the merge fields in a custom ERSD. + UseBrand string `json:"useBrand,omitempty"` + // When set to **true**, specifies that recipients in the same account as the sender must agree to eSign an Electronic Record and Signature Disclosure Statement. + UseConsumerDisclosureWithinAccount DSBool `json:"useConsumerDisclosureWithinAccount,omitempty"` + // Metadata that indicates whether the `useConsumerDisclosureWithinAccount` property is editable. // - // * `accept`
- // The recipient is required to accept the document by selecting accept during signing, but is not required to view the document. + UseConsumerDisclosureWithinAccountMetadata *SettingsMetadata `json:"useConsumerDisclosureWithinAccountMetadata,omitempty"` + // Contains the first address line of the postal address to which a customer can send a consent withdrawal notification. // - // * `view_accept`
- // The recipient is required to view and accept the document. + // Maximum length: 100 characters. + WithdrawAddressLine1 string `json:"withdrawAddressLine1,omitempty"` + // Contains the second address line of the postal address to which a customer can send a consent withdrawal notification. // + // Maximum length: 100 characters. + WithdrawAddressLine2 string `json:"withdrawAddressLine2,omitempty"` + // When set to **true** (default), indicates that the customer can withdraw consent by email. + WithdrawByEmail DSBool `json:"withdrawByEmail,omitempty"` + // When set to **true**, indicates that the customer can withdraw consent by postal mail. The default is **false**. + WithdrawByMail DSBool `json:"withdrawByMail,omitempty"` + // When set to **true**, indicates that the customer can withdraw consent by phone. The default is **false**. + WithdrawByPhone DSBool `json:"withdrawByPhone,omitempty"` + // Contains the city of the postal address to which a customer can send a consent withdrawal notification. // - SignerMustAcknowledge string `json:"signerMustAcknowledge,omitempty"` - // Metadata that indicates if the sender can edit the `signerMustAcknowledge` property. Not applicable for template documents. - SignerMustAcknowledgeMetadata *PropertyMetadata `json:"signerMustAcknowledgeMetadata,omitempty"` - // When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. - TemplateLocked string `json:"templateLocked,omitempty"` - // When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. - TemplateRequired string `json:"templateRequired,omitempty"` - // Type of user: - // - `type_owner` - // - `type_participant` - Type string `json:"type,omitempty"` - // URI containing the user ID. - URI string `json:"uri,omitempty"` -} - -// EnvelopeDocumentsResult envelope documents -type EnvelopeDocumentsResult struct { - // An array of document objects. - EnvelopeDocuments []EnvelopeDocument `json:"envelopeDocuments,omitempty"` - // The envelope ID of the envelope status that failed to post. - EnvelopeID string `json:"envelopeId,omitempty"` -} - -// EnvelopeEvent for which envelope events should your webhook be called? -type EnvelopeEvent struct { - // An envelope status for which your webhook should be called. Values: Draft, Sent, Delivered, Completed, Declined, or Voided. - EnvelopeEventStatusCode string `json:"envelopeEventStatusCode,omitempty"` - // reserved - IncludeDocuments string `json:"includeDocuments,omitempty"` + // Maximum length: 50 characters. + WithdrawCity string `json:"withdrawCity,omitempty"` + // Text indicating the consequences of withdrawing consent. + // + // Maximum length: 255 characters. + WithdrawConsequences string `json:"withdrawConsequences,omitempty"` + // Contains the email address to which a customer can send a consent withdrawal notification. + // + // Maximum length: 100 characters. + WithdrawEmail string `json:"withdrawEmail,omitempty"` + // Contains any other information needed to withdraw consent. + // + // Maximum length: 255 characters. + // + // Example: + // + // `We do not need any other information from you to withdraw consent.` + WithdrawOther string `json:"withdrawOther,omitempty"` + // Contains the phone number that a customer can call to register consent withdrawal notification as a free-formatted string. + // + // Maximum length: 20 characters. + WithdrawPhone string `json:"withdrawPhone,omitempty"` + // Contains the postal code of the postal address to which a customer can send a consent withdrawal notification. + // + // Maximum length: 20 characters. + WithdrawPostalCode string `json:"withdrawPostalCode,omitempty"` + // Contains the state of the postal address to which a customer can send a consent withdrawal notification. + // + // Example: `PA` + WithdrawState string `json:"withdrawState,omitempty"` } -// EnvelopeFormData this object contains the data that recipients have entered into the form fields associated with an envelope. -type EnvelopeFormData struct { - // The subject line of the email message that is sent to all recipients. +// Contact is the `Contacts` resource enables you to manage the contact in an account's address book. +type Contact struct { + // The cloud service that provided the contact. Valid values are: // - // For information about adding merge field information to the email subject, see [Template Email Subject Merge Fields](https://developers.docusign.com/esign-rest-api/reference/Templates/Templates/create#template-email-subject-merge-fields). + // - `rooms` + // - `docusignCore` (default) // - EmailSubject string `json:"emailSubject,omitempty"` - // The id of the envelope. - EnvelopeID string `json:"envelopeId,omitempty"` - // An array of form data objects. - FormData []FormDataItem `json:"formData,omitempty"` - // An array of form data objects that are associated with specific recipients. - RecipientFormData []RecipientFormData `json:"recipientFormData,omitempty"` - // The date and time the envelope was sent. - SentDateTime *time.Time `json:"sentDateTime,omitempty"` - // The status of the envelope. Valid values are: + // + CloudProvider string `json:"cloudProvider,omitempty"` + // The id of the container at the cloud provider. For example, this might be the room id for a DocuSign Transaction Room. + CloudProviderContainerID string `json:"cloudProviderContainerId,omitempty"` + // The id of a contact person in the account's address book. + ContactID string `json:"contactId,omitempty"` + // A list of the contact's phone numbers. + // + // **Note**: The phone numbers associated with shared contacts do not display to users other than the user who added the contact. Additionally, in the following scenarios, the phone number of a shared contact does not populate automatically for anyone other than the user who added the contact: + // + // - Sending an envelope by using SMS + // - Using phone authentication + // + // You must ask the user who added the contact for the phone number and then manually enter it into the authentication box. + ContactPhoneNumbers []ContactPhoneNumber `json:"contactPhoneNumbers,omitempty"` + // The URI for retrieving information about the contact. + ContactURI string `json:"contactUri,omitempty"` + // The email address or addresses associated with the contact. + Emails []string `json:"emails,omitempty"` + // This object describes errors that occur. It is only valid for responses and ignored in requests. + ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` + // When **true**, the current user is the owner of the contact. + IsOwner bool `json:"isOwner,omitempty"` + // The name of the contact. + Name string `json:"name,omitempty"` + // The name of the contact's organization. + Organization string `json:"organization,omitempty"` + // When set to **true**, the contact is shared. For more information, see [Shared Contacts](https://support.docusign.com/guides/ndse-user-guide-manage-contacts). + // + // **Note**: The phone numbers associated with shared contacts do not display to users other than the user who added the contact. Additionally, in the following scenarios, the phone number of a shared contact does not populate automatically for anyone other than the user who added the contact: + // + // - Sending an envelope by using SMS + // - Using phone authentication + // + // You must ask the user who added the contact for the phone number and then manually enter it into the authentication box. + Shared DSBool `json:"shared,omitempty"` + // If the contact belongs to a signing group, this property contains the `signingGroupId`. + SigningGroup string `json:"signingGroup,omitempty"` + // The name of the signing group that the contact belongs to. + SigningGroupName string `json:"signingGroupName,omitempty"` } -// EnvelopeID is a tab that displays the envelope ID. Recipients cannot enter -// or change the information in this tab. -// -type EnvelopeID struct { - TabBase - TabGuidedForm - TabPosition - TabStyle - // The height of the tab in pixels. - Height string `json:"height,omitempty"` - // Metadata that indicates whether the `height` property is editable. - HeightMetadata *PropertyMetadata `json:"heightMetadata,omitempty"` - // Reserved for DocuSign. - LocalePolicy *LocalePolicyTab `json:"localePolicy,omitempty"` - // Metadata that indicates whether the `toolTip` property is editable. - ToolTipMetadata *PropertyMetadata `json:"toolTipMetadata,omitempty"` - // The text of a tooltip that appears when a user hovers over a form field or tab. - Tooltip string `json:"tooltip,omitempty"` - // The width of the tab in pixels. - Width string `json:"width,omitempty"` - // Metadata that indicates whether the `width` property is editable. - WidthMetadata *PropertyMetadata `json:"widthMetadata,omitempty"` +// ContactGetResponse this response object contains information about the contacts associated with an account. +type ContactGetResponse struct { + // A list of contacts. + Contacts []Contact `json:"contacts,omitempty"` + // The last index position in the result set. + EndPosition string `json:"endPosition,omitempty"` + // The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. + NextURI string `json:"nextUri,omitempty"` + // The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. + PreviousURI string `json:"previousUri,omitempty"` + // The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`. + ResultSetSize string `json:"resultSetSize,omitempty"` + // The starting index position of the current result set. + StartPosition string `json:"startPosition,omitempty"` + // The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`. + TotalSetSize string `json:"totalSetSize,omitempty"` } -// EnvelopeIdsRequest lists of envelope and transaction IDs to use in the results. -type EnvelopeIdsRequest struct { - // A comma-separated list of envelope IDs to include in the results. - EnvelopeIds []string `json:"envelopeIds,omitempty"` - // A comma-separated list of transaction IDs to include in the results. Note that transaction IDs are valid for seven days. - TransactionIds []string `json:"transactionIds,omitempty"` +// ContactModRequest is the request object containing the new information for the contacts. +type ContactModRequest struct { + // A list of contacts. + ContactList []Contact `json:"contactList,omitempty"` } -type EnvelopeMetadata struct { - // Specifies if the Advanced Correct feature is enabled for the envelope. This feature enables you to correct the details of in process envelopes that you sent or are shared with you. It offers more functionality than the Correct feature. - AllowAdvancedCorrect string `json:"allowAdvancedCorrect,omitempty"` - // Specifies if the Correct feature is enabled for the envelope. This feature enables you to correct the details of in process envelopes that you sent or are shared with you, including the recipient, envelope, and document information. - AllowCorrect string `json:"allowCorrect,omitempty"` - // Specifies if DocuSign eNotary service is enabled for the envelope. - EnableSignWithNotary string `json:"enableSignWithNotary,omitempty"` +// ContactPhoneNumber details about the phone numbers associated with a specific contact. +type ContactPhoneNumber struct { + // The contact's phone number. + // + // Example: `+12223334444` + PhoneNumber string `json:"phoneNumber,omitempty"` + // The type of phone number. Valid values are: + // + // - `home` + // - `mobile` + // - `work` + // - `other` + // - `fax` + PhoneType string `json:"phoneType,omitempty"` } -// EnvelopeNotificationRequest is a complex element that specifies the notification settings for the envelope. -type EnvelopeNotificationRequest struct { - // A complex element that specifies the expiration settings for the envelope. - Expirations *Expirations `json:"expirations,omitempty"` - // A complex element that specifies reminder settings for the envelope - Reminders *Reminders `json:"reminders,omitempty"` - // When set to **true**, the account default notification settings are used for the envelope, overriding the reminders and expirations settings. When set to **false**, the reminders and expirations settings specified in this request are used. - UseAccountDefaults DSBool `json:"useAccountDefaults,omitempty"` +// ContactUpdateResponse this response objects shows the updated details for the contacts. +type ContactUpdateResponse struct { + // A list of contacts. + Contacts []Contact `json:"contacts,omitempty"` } -type EnvelopePurgeConfiguration struct { +// CorrectViewRequest is the request body for the EnvelopeViews::createCorrect method. +type CorrectViewRequest struct { + // (Optional) The URL to which the user should be redirected after the correct/send view session has ended. DocuSign redirects to this URL and includes an event parameter that your app can use. // - PurgeEnvelopes string `json:"purgeEnvelopes,omitempty"` + // Maximum Length: 500 characters. If the `returnUrl` exceeds this limit, the user is redirected to a truncated URL. // - RedactPII string `json:"redactPII,omitempty"` + // The event parameters returned are: // - RemoveTabsAndEnvelopeAttachments string `json:"removeTabsAndEnvelopeAttachments,omitempty"` + // * `send` (user corrected and sent the envelope) + // * `save` (user saved the envelope) + // * `cancel` (user canceled the transaction.) + // * `error` (there was an error when performing the correct or send) + // * `sessionEnd` (the session ended before the user completed a different action) // - RetentionDays string `json:"retentionDays,omitempty"` + // **Note**: Include `https://` in the URL or the redirect might not succeed on some browsers. + ReturnURL string `json:"returnUrl,omitempty"` + // Specifies whether the window is displayed with or without dressing. + SuppressNavigation string `json:"suppressNavigation,omitempty"` + // + ViewURL string `json:"viewUrl,omitempty"` } -type EnvelopeSummary struct { +type Country struct { // - BulkEnvelopeStatus *BulkEnvelopeStatus `json:"bulkEnvelopeStatus,omitempty"` - // The envelope ID of the envelope status that failed to post. - EnvelopeID string `json:"envelopeId,omitempty"` - // This object describes errors that occur. It is only valid for responses and ignored in requests. - ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` - // Indicates the envelope status. Valid values are: + IsoCode string `json:"isoCode,omitempty"` // - // * completed - The envelope has been completed and all tags have been signed. - // * created - The envelope is created as a draft. It can be modified and sent later. - // * declined - The envelope has been declined by the recipients. - // * delivered - The envelope has been delivered to the recipients. - // * sent - The envelope is sent to the recipients. - // * signed - The envelope has been signed by the recipients. - // * voided - The envelope is no longer valid and recipients cannot access or sign the envelope. + Name string `json:"name,omitempty"` // - Status string `json:"status,omitempty"` - // The DateTime that the envelope changed status (i.e. was created or sent.) - StatusDateTime *time.Time `json:"statusDateTime,omitempty"` - // URI containing the user ID. - URI string `json:"uri,omitempty"` + ProvinceValidated string `json:"provinceValidated,omitempty"` + // + Provinces []Province `json:"provinces,omitempty"` } -// EnvelopeTemplate template management -type EnvelopeTemplate struct { - // Reserved for DocuSign. - AccessControlListBase64 string `json:"accessControlListBase64,omitempty"` - // When set to **true**, indicates that comments are allowed on the envelope. - AllowComments string `json:"allowComments,omitempty"` - // When **true**, Document Markup is enabled for envelope. The account must have Document Markup enabled to use this. - AllowMarkup DSBool `json:"allowMarkup,omitempty"` - // When **true**, the recipient can redirect an envelope to a more appropriate recipient. - AllowReassign DSBool `json:"allowReassign,omitempty"` - // When set to **true**, recipients can view the history of the envelope. - AllowViewHistory DSBool `json:"allowViewHistory,omitempty"` - // Deprecated. This feature has been replaced by signing groups. - AnySigner string `json:"anySigner,omitempty"` - // When **true**, the envelope is queued for processing and the value of the `status` property is set to 'Processing'. Additionally, get status calls return 'Processing' until completed. +// CreditCardInformation this object contains information about a credit card that is associated with an account. +type CreditCardInformation struct { + // A complex element containing the credit card billing address information. + Address *AddressInformation `json:"address,omitempty"` + // The credit card number. + CardNumber string `json:"cardNumber,omitempty"` + // The type of credit card. Valid values are: // + // - `visa` + // - `mastercard` + // - `amex` + CardType string `json:"cardType,omitempty"` + // The 3 or 4-digit card verification value (CVV) number associated with the credit card. CVV numbers are also referred to as card security codes (CSCs). + CvNumber string `json:"cvNumber,omitempty"` + // The month that the credit card expires, expressed as a number from 1 to 12. + ExpirationMonth string `json:"expirationMonth,omitempty"` + // The year in which the credit card expires, in 4-digit format. + ExpirationYear string `json:"expirationYear,omitempty"` + // The exact name as it appears on the credit card. + NameOnCard string `json:"nameOnCard,omitempty"` +} + +type CreditCardTypes struct { + // An array containing supported credit card types. + CardTypes []string `json:"cardTypes,omitempty"` +} + +type Currency struct { // - // **Note**: A `transactionId` is required for this call to work correctly. When the envelope is created, the status is 'Processing' and an `envelopeId` is not returned in the response. To get the `envelopeId`, use a GET envelope query using the [transactionId](https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/create/#envelopeDefinition) or by checking the Connect notification. - Asynchronous DSBool `json:"asynchronous,omitempty"` - // Contains a URL for retrieving the attachments that are associated with the envelope. - AttachmentsURI string `json:"attachmentsUri,omitempty"` - // Specifies whether all documents in this envelope are authoritative copies. - // A document can set its own `authoritativeCopy` property to override this value. For example you can set the `authoritativeCopy` on an envelope level to true but can turn it off for a specific document. - AuthoritativeCopy DSBool `json:"authoritativeCopy,omitempty"` - // The default `authoritativeCopy` setting for documents in this envelope that do not have `authoritativeCopy` set. - // If this property is not set, each document defaults to the envelope's `authoritativeCopy`. - AuthoritativeCopyDefault string `json:"authoritativeCopyDefault,omitempty"` - // By default, templates that have been used within - // the last 60 days are included in auto-matching. + AnchorAllowWhiteSpaceInCharacters string `json:"anchorAllowWhiteSpaceInCharacters,omitempty"` // - // By explicitly setting `autoMatch`, - // you can permanently include or exclude the template - // in auto matching. + AnchorAllowWhiteSpaceInCharactersMetadata *PropertyMetadata `json:"anchorAllowWhiteSpaceInCharactersMetadata,omitempty"` + // This property controls how [anchor tabs][AnchorTabs] are placed. When **true**, the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false**. // - // When **true** the template is included in auto-matching - // regardless of when it was last used. + // For example, when set to **true**, if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When set to **false**, `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. // - // When **false** the template is never included in auto-matching. - AutoMatch string `json:"autoMatch,omitempty"` - // If **true**, the template has been explicitly included in or excluded from auto-matching. The default is false. - // This is a read-only property. - AutoMatchSpecifiedByUser string `json:"autoMatchSpecifiedByUser,omitempty"` - // When **true**, auto navigation is set for the recipient. + // This functionality uses the following rules: // - AutoNavigation string `json:"autoNavigation,omitempty"` - // The id of the brand. - BrandID string `json:"brandId,omitempty"` - // Indicates if the brandId for the envelope is locked. - BrandLock string `json:"brandLock,omitempty"` - // Contains a URI that you can use to retrieve certificate information. - CertificateURI string `json:"certificateUri,omitempty"` - // Specifies the date and time this item was completed. - CompletedDateTime *time.Time `json:"completedDateTime,omitempty"` - // The UTC DateTime when the workspace user authorization was created. - Created string `json:"created,omitempty"` - // The date and time the item was created. - CreatedDateTime *time.Time `json:"createdDateTime,omitempty"` - // An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters. - CustomFields *CustomFields `json:"customFields,omitempty"` - // Contains a URI for an endpoint to retrieve the custom fields. - CustomFieldsURI string `json:"customFieldsUri,omitempty"` - // The date and time the recipient declined the document. - DeclinedDateTime *time.Time `json:"declinedDateTime,omitempty"` - // Specifies the data and time the item was deleted. - DeletedDateTime *time.Time `json:"deletedDateTime,omitempty"` - // The date and time that the envelope was delivered to the recipient. - DeliveredDateTime *time.Time `json:"deliveredDateTime,omitempty"` - // A sender-defined description of the line item. + // - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: // - Description string `json:"description,omitempty"` - // When set to **true**, responsive documents are disabled for the envelope. - DisableResponsiveDocument string `json:"disableResponsiveDocument,omitempty"` - // Complex element contains the details on the documents in the envelope. - Documents []Document `json:"documents,omitempty"` - // Contains a URL that you can use to retrieve all of the documents associated with the envelope combined into a single PDF file. - DocumentsCombinedURI string `json:"documentsCombinedUri,omitempty"` - // Contains a URI for an endpoint that you can use to retrieve the documents. - DocumentsURI string `json:"documentsUri,omitempty"` - // This is the same as the email body. If the sender enters an email blurb, it is included in the email body for all envelope recipients. - EmailBlurb string `json:"emailBlurb,omitempty"` - // A complex type that contains email settings. - EmailSettings *EmailSettings `json:"emailSettings,omitempty"` - // The subject line of the email message that is sent to all recipients. + // $~><|^+= // - // For information about adding merge field information to the email subject, see [Template Email Subject Merge Fields](https://developers.docusign.com/esign-rest-api/reference/Templates/Templates/create#template-email-subject-merge-fields). + // For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` // - EmailSubject string `json:"emailSubject,omitempty"` - // When set to **true**, the signer is allowed to print the document and sign it on paper. - EnableWetSign DSBool `json:"enableWetSign,omitempty"` - // When set to **true**, signers can only view the documents on which they have tabs. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all of the documents in an envelope, unless they are specifically excluded by using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded by using this setting when an envelope is sent. + // - Strings embedded in other strings are ignored during the matching process. // - // **Note**: To use this functionality, [Document Visibility][docviz] must be enabled for the account by making the account setting `allowDocumentVisibility` **true**. + // - In words that have dashes, the parts separated by dashes are treated as distinct words. // - // [docviz]: /esign/restapi/Envelopes/EnvelopeDocumentVisibility - EnforceSignerVisibility DSBool `json:"enforceSignerVisibility,omitempty"` - // An array of attachment objects that provide information about the attachments that are associated with the envelope. - EnvelopeAttachments []Attachment `json:"envelopeAttachments,omitempty"` - // An array containing information about the documents that are included in the envelope. - EnvelopeDocuments []EnvelopeDocument `json:"envelopeDocuments,omitempty"` - // The envelope ID of the envelope status that failed to post. - EnvelopeID string `json:"envelopeId,omitempty"` - // When set to **true**, [Envelope ID Stamping](https://support.docusign.com/en/guides/ndse-user-guide-set-advanced-document-options) is enabled. - // Once a document or attachment is stamped with an Envelope ID, - // the ID is seen by all recipients - // and becomes a permanent part of the document - // and cannot be removed. - EnvelopeIDStamping DSBool `json:"envelopeIdStamping,omitempty"` - // Reserved for DocuSign. - EnvelopeLocation string `json:"envelopeLocation,omitempty"` - // Provides information about the features and services that are enabled for the envelope, including the Correct feature, the Advanced Correct feature, and DocuSign eNotary service. - EnvelopeMetadata *EnvelopeMetadata `json:"envelopeMetadata,omitempty"` - // URI that you can use to retrieve the bulk envelopes. - EnvelopeURI string `json:"envelopeUri,omitempty"` - // An integer specifying the number of days that a sent envelope remains active before it expires. A negative number in a response indicates that the envelope has already expired. - ExpireAfter string `json:"expireAfter,omitempty"` - // The date and time the envelope is set to expire. - ExpireDateTime string `json:"expireDateTime,omitempty"` - // When set to **true**, the envelope expires (is no longer available for signing) after the specified number of days after it is sent (`sentDateTime`). Set `expireAfter` to set the number of days until an envelope expires. When **false**, the account default setting is used. If the account does not have an expiration setting, the DocuSign default value of 120 days is used. - ExpireEnabled string `json:"expireEnabled,omitempty"` - // May contain an external identifier for the envelope. - ExternalEnvelopeID string `json:"externalEnvelopeId,omitempty"` - // The unique identifier for the folder that the template belongs to. - FolderID string `json:"folderId,omitempty"` - // An array of folder IDs that the template is in. - FolderIds []string `json:"folderIds,omitempty"` - // The name of the folder the template belongs to. - FolderName string `json:"folderName,omitempty"` - // A collection of folder objects returned in a response. - Folders []Folder `json:"folders,omitempty"` - // When set to **true**, indicates that users have added comments to the envelope. - HasComments string `json:"hasComments,omitempty"` - // Specifies if the `EnvelopeFormData` associated with any forms in the template has changed. - HasFormDataChanged string `json:"hasFormDataChanged,omitempty"` - // When set to **true**, indicates that the template includes a .wav file. - HasWavFile string `json:"hasWavFile,omitempty"` - // Reserved for DocuSign. - Holder string `json:"holder,omitempty"` - // The date and time the envelope that used the template was initially sent. - InitialSentDateTime *time.Time `json:"initialSentDateTime,omitempty"` - // When **true**, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES). - Is21CFRPart11 DSBool `json:"is21CFRPart11,omitempty"` - // When set to **true**, indicates that the envelope is a dynamic envelope. - IsDynamicEnvelope string `json:"isDynamicEnvelope,omitempty"` - // When set to **true**, indicates that the envelope is a signature-provided envelope. - IsSignatureProviderEnvelope DSBool `json:"isSignatureProviderEnvelope,omitempty"` - // Utc date and time the comment was last updated (can only be done by creator.) - LastModified string `json:"lastModified,omitempty"` - // The userId of the user who last modified the template. - LastModifiedBy *UserInfo `json:"lastModifiedBy,omitempty"` - // The date and time the template was last modified. - LastModifiedDateTime *time.Time `json:"lastModifiedDateTime,omitempty"` - // The date and time the template was last used. - LastUsed string `json:"lastUsed,omitempty"` - // Reserved for DocuSign. - Location string `json:"location,omitempty"` - // Provides lock information about an envelope that a user has locked. - LockInformation *LockInformation `json:"lockInformation,omitempty"` - // When set to **true**, prevents senders from changing the contents of `emailBlurb` and `emailSubject` properties for the envelope. + // Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**. // - // Additionally, this prevents users from making changes to the contents of `emailBlurb` and `emailSubject` properties when correcting envelopes. + // - Letters with accent marks are treated as distinct characters from their unaccented counterparts. // - // However, if the `messageLock` node is set to **true** and the `emailSubject` property is empty, senders and correctors are able to add a subject to the envelope. - MessageLock DSBool `json:"messageLock,omitempty"` - // The name of the template. - Name string `json:"name,omitempty"` - // The user's new password. - NewPassword string `json:"newPassword,omitempty"` - // A complex element that specifies the notification options for envelopes that use the template. - Notification *Notification `json:"notification,omitempty"` - // Contains a URI for an endpoint that you can use to retrieve the notifications. - NotificationURI string `json:"notificationUri,omitempty"` - // The owner of the template. - Owner *UserInfo `json:"owner,omitempty"` - // An integer value specifying the number of document pages in the template. - PageCount string `json:"pageCount,omitempty"` - // The password for editing the template. - Password string `json:"password,omitempty"` - // If **true**, a password is required to edit the template. - PasswordProtected string `json:"passwordProtected,omitempty"` - // A PowerForm objects that contain information about any PowerForms that are included in the template. - PowerForm *PowerForm `json:"powerForm,omitempty"` - // An array of PowerForm objects that contain information about any PowerForms that are included in the template. - PowerForms []PowerForm `json:"powerForms,omitempty"` - // The date that a purge was completed. - PurgeCompletedDate string `json:"purgeCompletedDate,omitempty"` - // The date that a purge was requested. - PurgeRequestDate string `json:"purgeRequestDate,omitempty"` - // Shows the current purge state for the envelope. The possible values are: + // - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. // - // * `unpurged`: There has been no successful request to purge documents. - // * `documents_queued`: The envelope documents have been added to the purge queue, but have not been purged. - // * `documents_dequeued`: The envelope documents have been taken out of the purge queue. - // * `documents_and_metadata_queued`: The envelope documents and metadata have been added to the purge queue, but have not yet been purged. - // * `documents_purged`: The envelope documents have been successfully purged. - // * `documents_and_metadata_purged`: The envelope documents and metadata have been successfully purged. + // Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. // + // - Unlike punctuation, numbers are not ignored when finding anchor words. // - PurgeState string `json:"purgeState,omitempty"` - // An array of recipient objects. - Recipients *Recipients `json:"recipients,omitempty"` - // When set to **true**, prevents senders from changing, correcting, or deleting the recipient information for the envelope. - RecipientsLock DSBool `json:"recipientsLock,omitempty"` - // Contains a URI for an endpoint that you can use to retrieve the recipients. - RecipientsURI string `json:"recipientsUri,omitempty"` - // Information about the sender. - Sender *UserInfo `json:"sender,omitempty"` - // The date and time the envelope was sent. - SentDateTime *time.Time `json:"sentDateTime,omitempty"` - // When **true**, indicates the template is shared with the **Everyone** group, - // and is shared with all users on the account. + // Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). // - // If **false**, the template is only shared with the **Administrator** group. + // **Note**: You can only specify the value of this property in POST requests. // - Shared string `json:"shared,omitempty"` - // When **true**, indicates that another user has shared the template with you. - SharedWithMe string `json:"sharedWithMe,omitempty"` - // When set to **true**, the recipient can sign on a mobile device. - SignerCanSignOnMobile DSBool `json:"signerCanSignOnMobile,omitempty"` - // Specifies the physical location where the signing takes place. It can have two enumeration values; `inPerson` and `online`. The default value is `online`. - SigningLocation string `json:"signingLocation,omitempty"` - // Indicates the envelope status. Valid values are: + // [AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place + AnchorCaseSensitive string `json:"anchorCaseSensitive,omitempty"` + // Metadata that indicates whether the `anchorCaseSensitive` property is editable. + AnchorCaseSensitiveMetadata *PropertyMetadata `json:"anchorCaseSensitiveMetadata,omitempty"` + // This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are : // - // * `sent` - The envelope is sent to the recipients. - // * `created` - The envelope is saved as a draft and can be modified and sent later. - Status string `json:"status,omitempty"` - // The data and time the status changed. - StatusChangedDateTime *time.Time `json:"statusChangedDateTime,omitempty"` - // The DateTime that the envelope changed status (i.e. was created or sent.) - StatusDateTime string `json:"statusDateTime,omitempty"` - // The ID of the template. - TemplateID string `json:"templateId,omitempty"` - // Contains a URI for an endpoint that you can use to retrieve the templates. - TemplatesURI string `json:"templatesUri,omitempty"` - // Used to identify an envelope. The id is a sender-generated value and is valid in the DocuSign system for 7 days. It is recommended that a transaction ID is used for offline signing to ensure that an envelope is not sent multiple times. The `transactionId` property can be used determine an envelope's status (i.e. was it created or not) in cases where the internet connection was lost before the envelope status was returned. - TransactionID string `json:"transactionId,omitempty"` - // Contains a URI that you can use to retreve the template. - URI string `json:"uri,omitempty"` - // When set to **true**, the disclosure is shown to recipients in accordance with the account's Electronic Record and Signature Disclosure frequency setting. When set to **false**, the Electronic Record and Signature Disclosure is not shown to any envelope recipients. + // - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. + // - `right`: Aligns the tab’s left side with the last character of the matching anchor word. // - // If the `useDisclosure` property is not set, then the account's normal disclosure setting is used and the value of the `useDisclosure` property is not returned in responses when getting envelope information. - UseDisclosure DSBool `json:"useDisclosure,omitempty"` - // The date and time the envelope or template was voided. - VoidedDateTime *time.Time `json:"voidedDateTime,omitempty"` - // The reason the envelope or template was voided. - VoidedReason string `json:"voidedReason,omitempty"` -} - -// EnvelopeTemplateResults information about templates. -type EnvelopeTemplateResults struct { - // The last position in the result set. - EndPosition string `json:"endPosition,omitempty"` - // The list of requested templates. - EnvelopeTemplates []EnvelopeTemplate `json:"envelopeTemplates,omitempty"` - // A collection of folder objects returned in a response. - Folders []Folder `json:"folders,omitempty"` - // The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. - NextURI string `json:"nextUri,omitempty"` - // The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. - PreviousURI string `json:"previousUri,omitempty"` - // The number of results returned in this response. Because you can filter which entries are included in the response, this value is always less than or equal to `totalSetSize`. - ResultSetSize string `json:"resultSetSize,omitempty"` - // The starting position of the current result set. - StartPosition string `json:"startPosition,omitempty"` - // The total number of items in the search's result set. This value is always greater than or equal to the value of `resultSetSize`. - TotalSetSize string `json:"totalSetSize,omitempty"` -} - -type EnvelopeTransactionStatus struct { - // The envelope ID of the envelope status that failed to post. - EnvelopeID string `json:"envelopeId,omitempty"` - // This object describes errors that occur. It is only valid for responses and ignored in requests. - ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` - // Indicates the envelope status. Valid values are: + // **Note**: You can only specify the value of this property in POST requests. + // + // [AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place + // + AnchorHorizontalAlignment string `json:"anchorHorizontalAlignment,omitempty"` + // Metadata that indicates whether the `anchorHorizontalAlignment` property is editable. + AnchorHorizontalAlignmentMetadata *PropertyMetadata `json:"anchorHorizontalAlignmentMetadata,omitempty"` + // When set to **true**, this tab is ignored if the `anchorString` is not found in the document. + AnchorIgnoreIfNotPresent string `json:"anchorIgnoreIfNotPresent,omitempty"` + // Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable. + AnchorIgnoreIfNotPresentMetadata *PropertyMetadata `json:"anchorIgnoreIfNotPresentMetadata,omitempty"` + // When set to **true**, the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false**. + // + // For example, when set to **true**, if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When set to **false**, if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. + // + // This functionality uses the following rules: + // + // - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: + // + // $~><|^+= + // + // For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` + // + // - Strings embedded in other strings are ignored during the matching process. + // + // - In words that have dashes, the parts separated by dashes are treated as distinct words. + // + // Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**. + // + // - Letters with accent marks are treated as distinct characters from their unaccented counterparts. + // + // - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. + // + // Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. + // + // - Unlike punctuation, numbers are not ignored when finding anchor words. + // + // Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). + // + // + // **Note**: You can only specify the value of this property in POST requests. + // + // [AnchorTab]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place + // + AnchorMatchWholeWord string `json:"anchorMatchWholeWord,omitempty"` + // Metadata that indicates whether the `anchorMatchWholeWord` property is editable. + AnchorMatchWholeWordMetadata *PropertyMetadata `json:"anchorMatchWholeWordMetadata,omitempty"` + // Specifies the string to find in the document and use as the basis for tab placement. + AnchorString string `json:"anchorString,omitempty"` + // Metadata that indicates whether the `anchorString` property is editable. + AnchorStringMetadata *PropertyMetadata `json:"anchorStringMetadata,omitempty"` + // Reserved for DocuSign. + AnchorTabProcessorVersion string `json:"anchorTabProcessorVersion,omitempty"` + // Reserved for DocuSign. + AnchorTabProcessorVersionMetadata *PropertyMetadata `json:"anchorTabProcessorVersionMetadata,omitempty"` + // Specifies units of the + // `anchorXOffset` and + // `anchorYOffset`. + // Valid units are: + // + // - `pixels` + // - `inches` + // - `mms` + // - `cms` + // + AnchorUnits string `json:"anchorUnits,omitempty"` + // Metadata that indicates whether the `anchorUnits` property is editable. + AnchorUnitsMetadata *PropertyMetadata `json:"anchorUnitsMetadata,omitempty"` + // Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. + // + AnchorXOffset string `json:"anchorXOffset,omitempty"` + // Metadata that indicates whether the `anchorXOffset` property is editable. + AnchorXOffsetMetadata *PropertyMetadata `json:"anchorXOffsetMetadata,omitempty"` + // Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. + // + AnchorYOffset string `json:"anchorYOffset,omitempty"` + // Metadata that indicates whether the `anchorYOffset` property is editable. + AnchorYOffsetMetadata *PropertyMetadata `json:"anchorYOffsetMetadata,omitempty"` + // When set to **true**, the information in the tab is bold. + Bold string `json:"bold,omitempty"` + // Metadata that indicates whether the `bold` property is editable. + BoldMetadata *PropertyMetadata `json:"boldMetadata,omitempty"` + // When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. + // + // When an envelope is completed the information is only available to the sender through the Form Data link in the DocuSign Console. The information on the downloaded document remains masked by asterisks. + // + // This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. + ConcealValueOnDocument string `json:"concealValueOnDocument,omitempty"` + // Metadata that indicates whether the `concealValueOnDocument` property is editable. + ConcealValueOnDocumentMetadata *PropertyMetadata `json:"concealValueOnDocumentMetadata,omitempty"` + // For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility. + ConditionalParentLabel string `json:"conditionalParentLabel,omitempty"` + // Metadata that indicates whether the `conditionalParentLabel` property is editable. + ConditionalParentLabelMetadata *PropertyMetadata `json:"conditionalParentLabelMetadata,omitempty"` + // For conditional fields, this is the value of the parent tab that controls the tab's visibility. + // + // If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. + // + ConditionalParentValue string `json:"conditionalParentValue,omitempty"` + // Metadata that indicates whether the `conditionalParentValue` property is editable. + ConditionalParentValueMetadata *PropertyMetadata `json:"conditionalParentValueMetadata,omitempty"` + // The DocuSign-generated custom tab id for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. + CustomTabID string `json:"customTabId,omitempty"` + // Metadata that indicates whether the `customTabId` property is editable. + CustomTabIDMetadata *PropertyMetadata `json:"customTabIdMetadata,omitempty"` + // When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. + DisableAutoSize string `json:"disableAutoSize,omitempty"` + // Metadata that indicates whether the `disableAutoSize` property is editable. + DisableAutoSizeMetadata *PropertyMetadata `json:"disableAutoSizeMetadata,omitempty"` + // The `documentId` is set by the API client. It is an integer that falls between `1` and 2,147,483,647. The value is encoded as a string without commas. The values `1`, `2`, `3`, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a `documentId` property that specifies the document on which to place the tab. + DocumentID string `json:"documentId,omitempty"` + // Metadata that indicates whether the `documentId` property is editable. + DocumentIDMetadata *PropertyMetadata `json:"documentIdMetadata,omitempty"` + // This object describes errors that occur. It is only valid for responses and ignored in requests. + ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` + // The font to be used for the tab value. Supported fonts include: + // + // - Default + // - Arial + // - ArialNarrow + // - Calibri + // - CourierNew + // - Garamond + // - Georgia + // - Helvetica + // - LucidaConsole + // - MSGothic + // - MSMincho + // - OCR-A + // - Tahoma + // - TimesNewRoman + // - Trebuchet + // - Verdana + // + Font string `json:"font,omitempty"` + // The font color to use for the information in the tab. Possible values are: + // + // - Black + // - BrightBlue + // - BrightRed + // - DarkGreen + // - DarkRed + // - Gold + // - Green + // - NavyBlue + // - Purple + // - White + // + FontColor string `json:"fontColor,omitempty"` + // Metadata that indicates whether the `fontColor` property is editable. + FontColorMetadata *PropertyMetadata `json:"fontColorMetadata,omitempty"` + // Metadata that indicates whether the `font` property is editable. + FontMetadata *PropertyMetadata `json:"fontMetadata,omitempty"` + // The font size used for the information in the tab. Possible values are: + // + // - Size7 + // - Size8 + // - Size9 + // - Size10 + // - Size11 + // - Size12 + // - Size14 + // - Size16 + // - Size18 + // - Size20 + // - Size22 + // - Size24 + // - Size26 + // - Size28 + // - Size36 + // - Size48 + // - Size72 + FontSize string `json:"fontSize,omitempty"` + // Metadata that indicates whether the `fontSize` property is editable. + FontSizeMetadata *PropertyMetadata `json:"fontSizeMetadata,omitempty"` + // An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. + FormOrder string `json:"formOrder,omitempty"` + // Metadata that indicates whether the `formOrder` property is editable. + FormOrderMetadata *PropertyMetadata `json:"formOrderMetadata,omitempty"` + // A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. + FormPageLabel string `json:"formPageLabel,omitempty"` + // Metadata that indicates whether the `formPageLabel` property is editable. + FormPageLabelMetadata *PropertyMetadata `json:"formPageLabelMetadata,omitempty"` + // An integer specifying the order in which to present the guided form pages. + FormPageNumber string `json:"formPageNumber,omitempty"` + // Metadata that indicates whether the `fromPageNumber` property is editable. + FormPageNumberMetadata *PropertyMetadata `json:"formPageNumberMetadata,omitempty"` + // The height of the tab in pixels. + Height string `json:"height,omitempty"` + // Metadata that indicates whether the `height` property is editable. + HeightMetadata *PropertyMetadata `json:"heightMetadata,omitempty"` + // When set to **true**, the information in the tab is italic. + Italic string `json:"italic,omitempty"` + // Metadata that indicates whether the `italic` property is editable. + ItalicMetadata *PropertyMetadata `json:"italicMetadata,omitempty"` + // Reserved for DocuSign. + LocalePolicy *LocalePolicyTab `json:"localePolicy,omitempty"` + // When set to **true**, the signer cannot change the data of the custom tab. + Locked string `json:"locked,omitempty"` + // Metadata that indicates whether the `locked` property is editable. + LockedMetadata *PropertyMetadata `json:"lockedMetadata,omitempty"` + // An optional value that describes the maximum length of the property when the property is a string. + MaxLength string `json:"maxLength,omitempty"` + // Metadata that indicates whether the `maxLength` property is editable. + MaxLengthMetadata *PropertyMetadata `json:"maxLengthMetadata,omitempty"` + // Contains the information necessary to map the tab to a field in SalesForce. + MergeField *MergeField `json:"mergeField,omitempty"` + // + MergeFieldXML string `json:"mergeFieldXml,omitempty"` + // + Name string `json:"name,omitempty"` + // Metadata that indicates whether the `name` property is editable. Read only. + NameMetadata *PropertyMetadata `json:"nameMetadata,omitempty"` + // + NumericalValue string `json:"numericalValue,omitempty"` + // The initial value of the tab when it was sent to the recipient. + OriginalValue string `json:"originalValue,omitempty"` + // Metadata that indicates whether the `originalValue` property is editable. + OriginalValueMetadata *PropertyMetadata `json:"originalValueMetadata,omitempty"` + // The page number being accessed. + PageNumber string `json:"pageNumber,omitempty"` + // Metadata that indicates whether the `pageNumber` property is editable. + PageNumberMetadata *PropertyMetadata `json:"pageNumberMetadata,omitempty"` + // A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`. + RecipientID string `json:"recipientId,omitempty"` + // The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only. + RecipientIDGUID string `json:"recipientIdGuid,omitempty"` + // Metadata that indicates whether the `recipientIdGuid` property is editable. + RecipientIDGUIDMetadata *PropertyMetadata `json:"recipientIdGuidMetadata,omitempty"` + // Metadata that indicates whether the `recipientId` property is editable. + RecipientIDMetadata *PropertyMetadata `json:"recipientIdMetadata,omitempty"` + // When set to **true** and shared is true, information must be entered in this field to complete the envelope. + RequireAll string `json:"requireAll,omitempty"` + // Metadata that indicates whether the `requireAll` property is editable. + RequireAllMetadata *PropertyMetadata `json:"requireAllMetadata,omitempty"` + // Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field. + RequireInitialOnSharedChange string `json:"requireInitialOnSharedChange,omitempty"` + // Metadata that indicates whether the `requireInitialOnSharedChange` property is editable. + RequireInitialOnSharedChangeMetadata *PropertyMetadata `json:"requireInitialOnSharedChangeMetadata,omitempty"` + // When set to **true**, the signer is required to fill out this tab. + Required string `json:"required,omitempty"` + // Metadata that indicates whether the `required` property is editable. + RequiredMetadata *PropertyMetadata `json:"requiredMetadata,omitempty"` + // When set to **true**, the sender must populate the tab before an envelope can be sent using the template. + // + // This value tab can only be changed by modifying (PUT) the template. + // + // Tabs with a `senderRequired` value of true cannot be deleted from an envelope. + SenderRequired string `json:"senderRequired,omitempty"` + // Metadata that indicates whether the `senderRequired` property is editable. + SenderRequiredMetadata *PropertyMetadata `json:"senderRequiredMetadata,omitempty"` + // When **true**, the tab is shared. + Shared string `json:"shared,omitempty"` + // Metadata that indicates whether the `shared` property is editable. + SharedMetadata *PropertyMetadata `json:"sharedMetadata,omitempty"` + // + SmartContractInformation *SmartContractInformation `json:"smartContractInformation,omitempty"` + // The status of the item. + Status string `json:"status,omitempty"` + // Metadata that indicates whether the `status` property is editable. + StatusMetadata *PropertyMetadata `json:"statusMetadata,omitempty"` + // An array of tab group labels that uniquely identify tab groups. To assign a tab to a `tabGroup`, you assign the `TabGroupLabel` to the `Tab.TabGroupLabels` array. + TabGroupLabels []string `json:"tabGroupLabels,omitempty"` + // Metadata that indicates whether the `tabGroupLabels` property is editable. + TabGroupLabelsMetadata *PropertyMetadata `json:"tabGroupLabelsMetadata,omitempty"` + // The unique identifier for the tab. + TabID string `json:"tabId,omitempty"` + // Metadata that indicates whether the `tabId` property is editable. + TabIDMetadata *PropertyMetadata `json:"tabIdMetadata,omitempty"` + // The label associated with the tab. This value may be an empty string. + // If no value is provided, the tab type is used as the value. + // + // Maximum Length: 500 characters. + // + TabLabel string `json:"tabLabel,omitempty"` + // Metadata that indicates whether the `tabLabel` property is editable. + TabLabelMetadata *PropertyMetadata `json:"tabLabelMetadata,omitempty"` + // A positive integer that sets the order the tab is navigated to during signing. + // + // Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. + TabOrder string `json:"tabOrder,omitempty"` + // Metadata that indicates whether the `tabOrder` property is editable. + TabOrderMetadata *PropertyMetadata `json:"tabOrderMetadata,omitempty"` + // Indicates the type of tab (for example, `signHere` or `initialHere`). + TabType string `json:"tabType,omitempty"` + // Metadata that indicates whether the `tabType` property is editable. + TabTypeMetadata *PropertyMetadata `json:"tabTypeMetadata,omitempty"` + // When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. + TemplateLocked string `json:"templateLocked,omitempty"` + // Metadata that indicates whether the `templateLocked` property is editable. + TemplateLockedMetadata *PropertyMetadata `json:"templateLockedMetadata,omitempty"` + // When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. + TemplateRequired string `json:"templateRequired,omitempty"` + // Metadata that indicates whether the `templateRequired` property is editable. + TemplateRequiredMetadata *PropertyMetadata `json:"templateRequiredMetadata,omitempty"` + // Metadata that indicates whether the `toolTip` property is editable. + ToolTipMetadata *PropertyMetadata `json:"toolTipMetadata,omitempty"` + // The text of a tooltip that appears when a user hovers over a form field or tab. + Tooltip string `json:"tooltip,omitempty"` + // When set to **true**, the information in the tab is underlined. + Underline string `json:"underline,omitempty"` + // Metadata that indicates whether the `underline` property is editable. + UnderlineMetadata *PropertyMetadata `json:"underlineMetadata,omitempty"` + // Specifies the value of the tab. + Value string `json:"value,omitempty"` + // Metadata that indicates whether the `value` property is editable. + ValueMetadata *PropertyMetadata `json:"valueMetadata,omitempty"` + // The width of the tab in pixels. + Width string `json:"width,omitempty"` + // Metadata that indicates whether the `width` property is editable. + WidthMetadata *PropertyMetadata `json:"widthMetadata,omitempty"` + // This property indicates the horizontal offset of the object on the page. + // DocuSign uses 72 DPI when determining position. + // Required. May be zero. + // + XPosition string `json:"xPosition,omitempty"` + // Metadata that indicates whether the `xPosition` property is editable. + XPositionMetadata *PropertyMetadata `json:"xPositionMetadata,omitempty"` + // This property indicates the vertical offset of the object on the page. + // DocuSign uses 72 DPI when determining position. + // Required. May be zero. + // + YPosition string `json:"yPosition,omitempty"` + // Metadata that indicates whether the `yPosition` property is editable. + YPositionMetadata *PropertyMetadata `json:"yPositionMetadata,omitempty"` +} + +// CurrencyFeatureSetPrice information about the price and currency associated with the feature set. Reserved for internal DocuSign use only. +type CurrencyFeatureSetPrice struct { + // Reserved for DocuSign. + CurrencyCode string `json:"currencyCode,omitempty"` + // Reserved for DocuSign. + CurrencySymbol string `json:"currencySymbol,omitempty"` + // Reserved for DocuSign. + EnvelopeFee DSBool `json:"envelopeFee,omitempty"` + // Reserved for DocuSign. + FixedFee DSBool `json:"fixedFee,omitempty"` + // Reserved for DocuSign. + SeatFee DSBool `json:"seatFee,omitempty"` +} + +type CurrencyPlanPrice struct { + // Specifies the ISO currency code for the account. + CurrencyCode string `json:"currencyCode,omitempty"` + // Specifies the currency symbol for the account. + CurrencySymbol string `json:"currencySymbol,omitempty"` + // The per-seat price associated with the plan. + // + // Example: `"456.0000"` + PerSeatPrice string `json:"perSeatPrice,omitempty"` + // The support incident fee charged for each support incident. + // + // Example: `"$0.00"` + SupportIncidentFee string `json:"supportIncidentFee,omitempty"` + // The support plan fee charged for this plan. + // + // Example: `"$0.00"` + SupportPlanFee string `json:"supportPlanFee,omitempty"` + // A simple type enumeration of the language used. The supported languages, with the language value shown in parenthesis, are: Arabic (ar), Bahasa Indonesia (id), Bahasa Melayu (ms) Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro),Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). + SupportedCardTypes *CreditCardTypes `json:"supportedCardTypes,omitempty"` +} + +// CustomField this object provides details about a custom field. +type CustomField struct { + // The type of custom field. Valid values are: + // + // - `text` (default) + // - `list` + CustomFieldType string `json:"customFieldType,omitempty"` + // This object describes errors that occur. It is only valid for responses and ignored in requests. + ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` + // The id of the custom field. + FieldID string `json:"fieldId,omitempty"` + // For a list custom field, this is an array of strings that represent the items in a list. + // + // Maximum Length: 2,000 characters. + ListItems []string `json:"listItems,omitempty"` + // The name of the custom field. + Name string `json:"name,omitempty"` + // When set to **true**, the signer must complete the custom field. + Required TabRequired `json:"required,omitempty"` + // When set to **true**, the custom field displays at the top of the Certificate of Completion. + Show DSBool `json:"show,omitempty"` + // Specifies the value of the custom field. + // + // Maximum Length: 2,000 characters. + Value string `json:"value,omitempty"` +} + +// CustomFields is an envelope custom field enables you to collect custom data about envelopes on a per-envelope basis. You can then use the custom data for sorting, organizing, searching, and other downstream processes. For example, you can use custom fields to copy envelopes or data to multiple areas in Salesforce. eOriginal customers can eVault their documents from the web app on a per-envelope basis by setting an envelope custom field with a name like "eVault with eOriginal?" to "Yes" or "No". +// +// When a user creates an envelope, the envelope custom fields display in the **Envelope Settings** section of the DocuSign console. Envelope recipients do not see the envelope custom fields. For more information, see [Envelope Custom Fields](https://support.docusign.com/en/guides/ndse-admin-guide-document-labels). +type CustomFields struct { + // An array of list custom fields. + ListCustomFields []ListCustomField `json:"listCustomFields,omitempty"` + // An array of text custom fields. + TextCustomFields []TextCustomField `json:"textCustomFields,omitempty"` +} + +type CustomFieldsEnvelope struct { + // An array of list custom fields. + ListCustomFields []ListCustomField `json:"listCustomFields,omitempty"` + // An array of text custom fields. + TextCustomFields []TextCustomField `json:"textCustomFields,omitempty"` +} + +type CustomSettingsInformation struct { + // The name/value pair information for the user custom setting. + CustomSettings []NameValue `json:"customSettings,omitempty"` +} + +// Date is a tab that allows the recipient to enter a date. Date tabs +// are one-line fields that allow date information to be +// entered in any format. The tooltip for this tab recommends +// entering the date as MM/DD/YYYY, but this is not enforced. +// The format entered by the signer is retained. If you need a +// particular date format enforced, DocuSign recommends using a +// Text tab with a validation pattern and a validation message +// to enforce the format. +// +type Date struct { + TabBase + TabGuidedForm + TabPosition + TabStyle + TabValue + // + AnchorAllowWhiteSpaceInCharacters string `json:"anchorAllowWhiteSpaceInCharacters,omitempty"` + // + AnchorAllowWhiteSpaceInCharactersMetadata *PropertyMetadata `json:"anchorAllowWhiteSpaceInCharactersMetadata,omitempty"` + // When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. + // + // When an envelope is completed the information is only available to the sender through the Form Data link in the DocuSign Console. The information on the downloaded document remains masked by asterisks. + // + // This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. + ConcealValueOnDocument DSBool `json:"concealValueOnDocument,omitempty"` + // Metadata that indicates whether the `concealValueOnDocument` property is editable. + ConcealValueOnDocumentMetadata *PropertyMetadata `json:"concealValueOnDocumentMetadata,omitempty"` + // When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. + DisableAutoSize DSBool `json:"disableAutoSize,omitempty"` + // Metadata that indicates whether the `disableAutoSize` property is editable. + DisableAutoSizeMetadata *PropertyMetadata `json:"disableAutoSizeMetadata,omitempty"` + // The height of the tab in pixels. + Height string `json:"height,omitempty"` + // Metadata that indicates whether the `height` property is editable. + HeightMetadata *PropertyMetadata `json:"heightMetadata,omitempty"` + // Reserved for DocuSign. + LocalePolicy *LocalePolicyTab `json:"localePolicy,omitempty"` + // When set to **true**, the signer cannot change the data of the custom tab. + Locked DSBool `json:"locked,omitempty"` + // Metadata that indicates whether the `locked` property is editable. + LockedMetadata *PropertyMetadata `json:"lockedMetadata,omitempty"` + // An optional value that describes the maximum length of the property when the property is a string. + MaxLength string `json:"maxLength,omitempty"` + // Metadata that indicates whether the `maxLength` property is editable. + MaxLengthMetadata *PropertyMetadata `json:"maxLengthMetadata,omitempty"` + // + MergeFieldXML string `json:"mergeFieldXml,omitempty"` + // The initial value of the tab when it was sent to the recipient. + OriginalValue string `json:"originalValue,omitempty"` + // Metadata that indicates whether the `originalValue` property is editable. + OriginalValueMetadata *PropertyMetadata `json:"originalValueMetadata,omitempty"` + // When set to **true** and shared is true, information must be entered in this field to complete the envelope. + RequireAll DSBool `json:"requireAll,omitempty"` + // Metadata that indicates whether the `requireAll` property is editable. + RequireAllMetadata *PropertyMetadata `json:"requireAllMetadata,omitempty"` + // Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field. + RequireInitialOnSharedChange DSBool `json:"requireInitialOnSharedChange,omitempty"` + // Metadata that indicates whether the `requireInitialOnSharedChange` property is editable. + RequireInitialOnSharedChangeMetadata *PropertyMetadata `json:"requireInitialOnSharedChangeMetadata,omitempty"` + // When set to **true**, the signer is required to fill out this tab. + Required TabRequired `json:"required,omitempty"` + // Metadata that indicates whether the `required` property is editable. + RequiredMetadata *PropertyMetadata `json:"requiredMetadata,omitempty"` + // When set to **true**, the sender must populate the tab before an envelope can be sent using the template. + // + // This value tab can only be changed by modifying (PUT) the template. + // + // Tabs with a `senderRequired` value of true cannot be deleted from an envelope. + SenderRequired DSBool `json:"senderRequired,omitempty"` + // Metadata that indicates whether the `senderRequired` property is editable. + SenderRequiredMetadata *PropertyMetadata `json:"senderRequiredMetadata,omitempty"` + // When set to **true**, this custom tab is shared. + Shared DSBool `json:"shared,omitempty"` + // Metadata that indicates whether the `shared` property is editable. + SharedMetadata *PropertyMetadata `json:"sharedMetadata,omitempty"` + // + SmartContractInformation *SmartContractInformation `json:"smartContractInformation,omitempty"` + // Metadata that indicates whether the `toolTip` property is editable. + ToolTipMetadata *PropertyMetadata `json:"toolTipMetadata,omitempty"` + // The text of a tooltip that appears when a user hovers over a form field or tab. + Tooltip string `json:"tooltip,omitempty"` + // The message displayed if the custom tab fails input validation (either custom of embedded). + ValidationMessage string `json:"validationMessage,omitempty"` + // Metadata that indicates whether the `validationMessage` property is editable. + ValidationMessageMetadata *PropertyMetadata `json:"validationMessageMetadata,omitempty"` + // A regular expression used to validate input for the tab. + ValidationPattern string `json:"validationPattern,omitempty"` + // Metadata that indicates whether the `validationPattern` property is editable. + ValidationPatternMetadata *PropertyMetadata `json:"validationPatternMetadata,omitempty"` + // The width of the tab in pixels. + Width string `json:"width,omitempty"` + // Metadata that indicates whether the `width` property is editable. + WidthMetadata *PropertyMetadata `json:"widthMetadata,omitempty"` +} + +// DateSigned is a tab that displays the date that the recipient signed the +// document. +// +type DateSigned struct { + TabBase + TabGuidedForm + TabPosition + TabStyle + TabValue + // + AnchorAllowWhiteSpaceInCharacters string `json:"anchorAllowWhiteSpaceInCharacters,omitempty"` + // + AnchorAllowWhiteSpaceInCharactersMetadata *PropertyMetadata `json:"anchorAllowWhiteSpaceInCharactersMetadata,omitempty"` + // The height of the tab in pixels. + Height string `json:"height,omitempty"` + // Metadata that indicates whether the `height` property is editable. + HeightMetadata *PropertyMetadata `json:"heightMetadata,omitempty"` + // Reserved for DocuSign. + LocalePolicy *LocalePolicyTab `json:"localePolicy,omitempty"` + // + MergeFieldXML string `json:"mergeFieldXml,omitempty"` + // + SmartContractInformation *SmartContractInformation `json:"smartContractInformation,omitempty"` + // Metadata that indicates whether the `toolTip` property is editable. + ToolTipMetadata *PropertyMetadata `json:"toolTipMetadata,omitempty"` + // The text of a tooltip that appears when a user hovers over a form field or tab. + Tooltip string `json:"tooltip,omitempty"` + // The width of the tab in pixels. + Width string `json:"width,omitempty"` + // Metadata that indicates whether the `width` property is editable. + WidthMetadata *PropertyMetadata `json:"widthMetadata,omitempty"` +} + +// DateStampProperties specifies the area in which a date stamp is placed. This parameter uses pixel positioning to draw a rectangle at the center of the stamp area. The stamp is superimposed on top of this central area. +// +// This property contains the following information about the central rectangle: +// +// - `DateAreaX`: The X axis position of the top-left corner. +// - `DateAreaY`: The Y axis position of the top-left corner. +// - `DateAreaWidth`: The width of the rectangle. +// - `DateAreaHeight`: The height of the rectangle. +type DateStampProperties struct { + // The height of the rectangle. + DateAreaHeight string `json:"dateAreaHeight,omitempty"` + // The width of the rectangle. + DateAreaWidth string `json:"dateAreaWidth,omitempty"` + // The X axis position of the top-left corner. + DateAreaX string `json:"dateAreaX,omitempty"` + // The Y axis position of the top-left corner. + DateAreaY string `json:"dateAreaY,omitempty"` +} + +// Decline is a tab that allows the recipient the option of declining an +// envelope. If the recipient clicks the tab during the signing +// process, the envelope is voided. +// +type Decline struct { + TabBase + TabGuidedForm + TabPosition + // + AnchorAllowWhiteSpaceInCharacters string `json:"anchorAllowWhiteSpaceInCharacters,omitempty"` + // + AnchorAllowWhiteSpaceInCharactersMetadata *PropertyMetadata `json:"anchorAllowWhiteSpaceInCharactersMetadata,omitempty"` + // When set to **true**, the information in the tab is bold. + Bold string `json:"bold,omitempty"` + // Metadata that indicates whether the `bold` property is editable. + BoldMetadata *PropertyMetadata `json:"boldMetadata,omitempty"` + // Specifies the decline text displayed in the tab. + ButtonText string `json:"buttonText,omitempty"` + // Metadata that indicates whether the `buttonText` property is editable. + ButtonTextMetadata *PropertyMetadata `json:"buttonTextMetadata,omitempty"` + // The reason the recipient declined the document. + DeclineReason string `json:"declineReason,omitempty"` + // Metadata that indicates whether the `declineReason` property is editable. + DeclineReasonMetadata *PropertyMetadata `json:"declineReasonMetadata,omitempty"` + // The font to be used for the tab value. Supported fonts include: + // + // - Default + // - Arial + // - ArialNarrow + // - Calibri + // - CourierNew + // - Garamond + // - Georgia + // - Helvetica + // - LucidaConsole + // - MSGothic + // - MSMincho + // - OCR-A + // - Tahoma + // - TimesNewRoman + // - Trebuchet + // - Verdana + // + Font string `json:"font,omitempty"` + // The font color to use for the information in the tab. Possible values are: + // + // - Black + // - BrightBlue + // - BrightRed + // - DarkGreen + // - DarkRed + // - Gold + // - Green + // - NavyBlue + // - Purple + // - White + // + FontColor string `json:"fontColor,omitempty"` + // Metadata that indicates whether the `fontColor` property is editable. + FontColorMetadata *PropertyMetadata `json:"fontColorMetadata,omitempty"` + // Metadata that indicates whether the `font` property is editable. + FontMetadata *PropertyMetadata `json:"fontMetadata,omitempty"` + // The font size used for the information in the tab. Possible values are: + // + // - Size7 + // - Size8 + // - Size9 + // - Size10 + // - Size11 + // - Size12 + // - Size14 + // - Size16 + // - Size18 + // - Size20 + // - Size22 + // - Size24 + // - Size26 + // - Size28 + // - Size36 + // - Size48 + // - Size72 + FontSize string `json:"fontSize,omitempty"` + // Metadata that indicates whether the `fontSize` property is editable. + FontSizeMetadata *PropertyMetadata `json:"fontSizeMetadata,omitempty"` + // The height of the tab in pixels. + Height string `json:"height,omitempty"` + // Metadata that indicates whether the `height` property is editable. + HeightMetadata *PropertyMetadata `json:"heightMetadata,omitempty"` + // When set to **true**, the information in the tab is italic. + Italic string `json:"italic,omitempty"` + // Metadata that indicates whether the `italic` property is editable. + ItalicMetadata *PropertyMetadata `json:"italicMetadata,omitempty"` + // Reserved for DocuSign. + LocalePolicy *LocalePolicyTab `json:"localePolicy,omitempty"` + // + MergeFieldXML string `json:"mergeFieldXml,omitempty"` + // + SmartContractInformation *SmartContractInformation `json:"smartContractInformation,omitempty"` + // Metadata that indicates whether the `toolTip` property is editable. + ToolTipMetadata *PropertyMetadata `json:"toolTipMetadata,omitempty"` + // The text of a tooltip that appears when a user hovers over a form field or tab. + Tooltip string `json:"tooltip,omitempty"` + // When set to **true**, the information in the tab is underlined. + Underline string `json:"underline,omitempty"` + // Metadata that indicates whether the `underline` property is editable. + UnderlineMetadata *PropertyMetadata `json:"underlineMetadata,omitempty"` + // The width of the tab in pixels. + Width string `json:"width,omitempty"` + // Metadata that indicates whether the `width` property is editable. + WidthMetadata *PropertyMetadata `json:"widthMetadata,omitempty"` +} + +type DiagnosticsSettingsInformation struct { + // Specifies the maximum number of API requests to log. + APIRequestLogMaxEntries string `json:"apiRequestLogMaxEntries,omitempty"` + // Indicates the remaining number of API requests that can be logged. + APIRequestLogRemainingEntries string `json:"apiRequestLogRemainingEntries,omitempty"` + // When set to **true**, enables API request logging for the user. + APIRequestLogging DSBool `json:"apiRequestLogging,omitempty"` +} + +// DirectDebitProcessorInformation contains information about a bank that processes a customer's direct debit payments. +type DirectDebitProcessorInformation struct { + // The branch code of the bank used for direct debit. + // + // Maximum Length: 10 characters. + BankBranchCode string `json:"bankBranchCode,omitempty"` + // The check digit or digits in the international bank account number. These digits are used to confirm the validity of the account. + // + // Maximum Length: 4 characters. + BankCheckDigit string `json:"bankCheckDigit,omitempty"` + // The code or number that identifies the bank. This is also known as the sort code. + // + // Example: `200000` + // + // Maximum Length: 18 characters. + BankCode string `json:"bankCode,omitempty"` + // The name of the direct debit bank. + // + // Maximum Length: 80 characters. + BankName string `json:"bankName,omitempty"` + // The name on the direct debit bank account. This field is required for POST and PUT requests. + // + // Maximum Length: 60 characters. + BankTransferAccountName string `json:"bankTransferAccountName,omitempty"` + // The customer's bank account number. This value will be obfuscated. This field is required for POST and PUT requests. + // + // Maximum Length: 30 characters. + BankTransferAccountNumber string `json:"bankTransferAccountNumber,omitempty"` + // Specifies the type of direct debit transfer. The value of this field is dependent on the user's country. This field is required for POST and PUT requests. Possible values are: + // + // - `DirectDebitUK` + // - `DirectEntryAU` + // - `SEPA` + BankTransferType string `json:"bankTransferType,omitempty"` + // The user's country. The system populates this value automatically. + // + // + Country string `json:"country,omitempty"` + // The email address of the user who is associated with the payment method. This field is required for POST and PUT requests. + // + // Maximum Length: 80 characters. + Email string `json:"email,omitempty"` + // The user's first name. This field is required for POST and PUT requests. + // + // Maximum Length: 30 characters. + FirstName string `json:"firstName,omitempty"` + // The International Bank Account Number (IBAN). + // + // Example: `DE89370400440532013000` + // + // For more information, see [PeopleSoft's guide to Setting Up Banks](https://docs.oracle.com/cd/E16365_01/fscm91pbr0/eng/psbooks/fsbk/chapter.htm?File=fsbk/htm/fsbk03.htm). + // + // **Note**: This number will be obfuscated. + IBAN string `json:"iBAN,omitempty"` + // The user's last name. This field is required for POST and PUT requests. + // + // Maximum Length: 70 characters. + LastName string `json:"lastName,omitempty"` +} + +type DisplayApplianceAccount struct { + // The account ID associated with the envelope. + AccountID string `json:"accountId,omitempty"` + // Boolean that allows envelope senders to opt out of the recipient signing auto-navigation feature and opt out of updating tab font color. + OptOutAutoNavTextAndTabColorUpdates bool `json:"optOutAutoNavTextAndTabColorUpdates,omitempty"` + // Boolean that specifies whether conditional field options are initially displayed (before a user makes entries). + ShowInitialConditionalFields bool `json:"showInitialConditionalFields,omitempty"` + // + SigningVersion string `json:"signingVersion,omitempty"` + // + TagHasSigBlock bool `json:"tagHasSigBlock,omitempty"` +} + +type DisplayApplianceInfo struct { +} + +type DisplayAppliancePdf struct { +} + +type DisplayApplianceSignerAttachment struct { +} + +// DobInformationInput complex type containing: +// +// * dateOfBirth +// * displayLevelCode +// * receiveInResponse +type DobInformationInput struct { + // Specifies the recipient's date, month, and year of birth. + DateOfBirth string `json:"dateOfBirth,omitempty"` + // Specifies the display level for the recipient. Valid values are: + // * `ReadOnly` + // * `Editable` + // * `DoNotDisplay` + DisplayLevelCode string `json:"displayLevelCode,omitempty"` + // A Boolean value that specifies whether the information must be returned in the response. + ReceiveInResponse DSBool `json:"receiveInResponse,omitempty"` +} + +// Document is a document object. +type Document struct { + // Reserved for DocuSign. + ApplyAnchorTabs string `json:"applyAnchorTabs,omitempty"` + // + AssignTabsToRecipientID string `json:"assignTabsToRecipientId,omitempty"` + // This string sets the display and behavior properties of + // the document during signing. The possible values are: + // + // * `modal`
+ // The document is shown as a supplement action strip + // and can be viewed, downloaded, or printed in a modal window. + // This is the recommended value for supplemental documents. + // + // * `download`
+ // The document is shown as a supplement action strip + // and can be viewed, downloaded, or printed in a new browser window. + // + // * `inline`
+ // The document is shown in the normal signing window. + // This value is not used with supplemental documents, + // but is the default value for all other documents. + // + Display string `json:"display,omitempty"` + // The document's bytes. This field can be used to include a base64 version of the document bytes within an envelope definition instead of sending the document using a multi-part HTTP request. The maximum document size is smaller if this field is used due to the overhead of the base64 encoding. + DocumentBase64 []byte `json:"documentBase64,omitempty"` + // The array of name/value custom data strings to be added to a document. Custom document field information is returned in the status, but otherwise is not used by DocuSign. The array contains the elements: + // + // * name – A string that can be a maximum of 50 characters. + // * value – A string that can be a maximum of 200 characters. + // + // *IMPORTANT*: If you are using xml, the name/value pair is contained in a nameValue element. + // + DocumentFields []NameValue `json:"documentFields,omitempty"` + // Specifies the document ID of this document. This value is used by tabs to determine which document they appear in. + DocumentID string `json:"documentId,omitempty"` + // When set to **true**, the document is been already encrypted by the sender for use with the DocuSign Key Manager Security Appliance. + // + EncryptedWithKeyManager DSBool `json:"encryptedWithKeyManager,omitempty"` + // The file extension type of the document. Non-PDF documents are converted to PDF. + // + // If the document is not a PDF, `fileExtension` is required. + // + // If you try to upload a non-PDF document without a `fileExtension`, you will receive an "unable to load document" error message. + // + FileExtension string `json:"fileExtension,omitempty"` + // + FileFormatHint string `json:"fileFormatHint,omitempty"` + // + HTMLDefinition *DocumentHTMLDefinition `json:"htmlDefinition,omitempty"` + // When set to **true**, + // the document is included in the combined document download (`documentsCombinedUri`). + // The default value is **true**. + // + IncludeInDownload DSBool `json:"includeInDownload,omitempty"` + // Matchboxes define areas in a document for document matching when you are creating envelopes. They are only used when you upload and edit a template. + // + // A matchbox consists of 5 elements: + // + // * pageNumber - The document page number on which the matchbox will appear. + // * xPosition - The x position of the matchbox on a page. + // * yPosition - The y position of the matchbox on a page. + // * width - The width of the matchbox. + // * height - The height of the matchbox. + // + MatchBoxes []MatchBox `json:"matchBoxes,omitempty"` + // The name of the document. + Name string `json:"name,omitempty"` + // (Optional) The order in which to sort the results. + // + // Valid values are: + // + // + // * `asc`: Ascending order. + // * `desc`: Descending order. + Order string `json:"order,omitempty"` + // An array of page objects. + Pages string `json:"pages,omitempty"` + // The user's encrypted password hash. + Password string `json:"password,omitempty"` + // + PdfFormFieldOption string `json:"pdfFormFieldOption,omitempty"` + // The file id from the cloud storage service where + // the document is located. This information is + // returned using + // [CloudStorage::listFolders](https://developers.docusign.com/docs/esign-rest-api/reference/CloudStorage/CloudStorage/listFolders/) or + // [CloudStorage::list](https://developers.docusign.com/docs/esign-rest-api/reference/CloudStorage/CloudStorage/list/). + // + RemoteURL string `json:"remoteUrl,omitempty"` + // Sets how the signer interacts with the supplemental document. + // The possible values are: + // + // * `no_interaction`
+ // No recipient action is required. + // + // * `view`
+ // The recipient is required to view the document. + // + // * `accept`
+ // The recipient is required to accept the document by selecting accept during signing, but is not required to view the document. + // + // * `view_accept`
+ // The recipient is required to view and accept the document. + // + // + SignerMustAcknowledge string `json:"signerMustAcknowledge,omitempty"` + // + SignerMustAcknowledgeUseAccountDefault bool `json:"signerMustAcknowledgeUseAccountDefault,omitempty"` + // A list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients. + Tabs *Tabs `json:"tabs,omitempty"` + // When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. + TemplateLocked DSBool `json:"templateLocked,omitempty"` + // When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. + TemplateRequired DSBool `json:"templateRequired,omitempty"` + // When set to **true**, PDF form field data is transformed into document tab values when the PDF form field name matches the DocuSign custom tab tabLabel. The resulting PDF form data is also returned in the PDF meta data when requesting the document PDF. + // + TransformPdfFields DSBool `json:"transformPdfFields,omitempty"` + // A URI containing the user ID. + URI string `json:"uri,omitempty"` +} + +// DocumentFieldsInformation template document fields +type DocumentFieldsInformation struct { + // The array of name/value custom data strings to add to a document. Custom document field information is returned in the status, but otherwise is not used by DocuSign. The array contains the following elements: + // + // * `name` - A string that can be a maximum of 50 characters. + // * `value` - A string that can be a maximum of 200 characters. + // + // **Important**: If you are using XML, the name/value pair is contained in a `nameValue` element. + // + DocumentFields []NameValue `json:"documentFields,omitempty"` +} + +type DocumentHTMLCollapsibleDisplaySettings struct { + // + ArrowClosed string `json:"arrowClosed,omitempty"` + // + ArrowColor string `json:"arrowColor,omitempty"` + // + ArrowLocation string `json:"arrowLocation,omitempty"` + // + ArrowOpen string `json:"arrowOpen,omitempty"` + // + ArrowSize string `json:"arrowSize,omitempty"` + // + ArrowStyle string `json:"arrowStyle,omitempty"` + // + ContainerStyle string `json:"containerStyle,omitempty"` + // + LabelStyle string `json:"labelStyle,omitempty"` + // + OnlyArrowIsClickable bool `json:"onlyArrowIsClickable,omitempty"` + // + OuterLabelAndArrowStyle string `json:"outerLabelAndArrowStyle,omitempty"` +} + +// DocumentHTMLDefinition holds the properties that define how to generate the responsive-formatted HTML for the document. +type DocumentHTMLDefinition struct { + // Contains text that all display anchors must start with. Using at least 4 characters will improve anchor processing performance. + DisplayAnchorPrefix string `json:"displayAnchorPrefix,omitempty"` + // An object that defines how to handle a section of the HTML in signing. This property enables an incoming request to make a section of the HTML collapsible and expandable or hidden from view. A start anchor, end anchor, or both are required. If the anchors are not found, the display anchor will be ignored. For a list of the available types, see the `display` enum. + DisplayAnchors []DocumentHTMLDisplayAnchor `json:"displayAnchors,omitempty"` + // The position on the page where the display section appears. + DisplayOrder int32 `json:"displayOrder,omitempty"` + // The number of the page on which the display section appears. + DisplayPageNumber int32 `json:"displayPageNumber,omitempty"` + // The GUID of the document. + DocumentGUID string `json:"documentGuid,omitempty"` + // Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. + DocumentID string `json:"documentId,omitempty"` + // Header text or an HTML tag to place above the responsive HTML block. + HeaderLabel string `json:"headerLabel,omitempty"` + // If set, the responsive HTML version of the signing document will only display on screens with the specified pixel width or less. If the screen is larger than the value that you specify, the default PDF version of the content displays instead. + MaxScreenWidth string `json:"maxScreenWidth,omitempty"` + // Holds a comma-separated list of HTML tags to remove if they have no text within their node (including child nodes). + RemoveEmptyTags DSBool `json:"removeEmptyTags,omitempty"` + // When set to **true**, the **Mobile-Friendly** toggle displays at the top of the screen on the user's mobile device. This toggle enables the user to switch between the mobile-friendly and PDF versions of a document. For example, the recipient can use this toggle to review the document using the PDF view before they finish signing. + ShowMobileOptimizedToggle DSBool `json:"showMobileOptimizedToggle,omitempty"` + // Specifies the type of responsive signing that will be used with the document. Valid strings are: + // + // - `document`: The HTML signing page will be generated from the provided document. For details, see [Converting a PDF to a signable HTML document](https://developers.docusign.com/esign-rest-api/guides/responsive-signing/converting-pdf). + // - `html`: The HTML signing page will be passed directly. For details, see [Converting a PDF to a signable HTML document](https://developers.docusign.com/esign-rest-api/guides/responsive-signing/converting-pdf). + Source string `json:"source,omitempty"` +} + +type DocumentHTMLDefinitionOriginal struct { + // Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. + DocumentID string `json:"documentId,omitempty"` + // The GUID of the document. + DocumentIDGUID string `json:"documentIdGuid,omitempty"` + // + HTMLDefinition *DocumentHTMLDefinition `json:"htmlDefinition,omitempty"` +} + +type DocumentHTMLDefinitionOriginals struct { + // Holds the properties that define how to generate the responsive-formatted HTML for the document. + HTMLDefinitions []DocumentHTMLDefinitionOriginal `json:"htmlDefinitions,omitempty"` +} + +type DocumentHTMLDefinitions struct { + // Holds the properties that define how to generate the responsive-formatted HTML for the document. + HTMLDefinitions []string `json:"htmlDefinitions,omitempty"` +} + +type DocumentHTMLDisplayAnchor struct { + // When set to **true**, the start or end anchor strings must match the strings specified by the start and end anchor settings in case as well as in content. + CaseSensitive bool `json:"caseSensitive,omitempty"` + // This object defines how the HTML section inside the `startAnchor` and `endAnchor` displays. + DisplaySettings *DocumentHTMLDisplaySettings `json:"displaySettings,omitempty"` + // Specifies the end of the area in the HTML where the display settings will be applied. If you do not specify an end anchor, the end of the document will be used by default. + // + // **Note**: A start anchor, an end anchor, or both are required. + EndAnchor string `json:"endAnchor,omitempty"` + // When **true**, removes the end anchor string for the Smart Section from the HTML, preventing it from displaying. + RemoveEndAnchor bool `json:"removeEndAnchor,omitempty"` + // When **true**, removes the start anchor string for the Smart Section from the HTML, preventing it from displaying. + RemoveStartAnchor bool `json:"removeStartAnchor,omitempty"` + // Specifies the beginning of the area in the HTML where the display settings will be applied. If you do not specify a start anchor, the beginning of the document will be used by default. + // + // **Note**: A start anchor, an end anchor, or both are required. + StartAnchor string `json:"startAnchor,omitempty"` +} + +type DocumentHTMLDisplaySettings struct { + // Specifies the valid CSS-formatted styles to use on responsive table cells. Only valid in display sections of `responsive_table` or `responsive_table_single_column` types. + CellStyle string `json:"cellStyle,omitempty"` + // This object defines the appearance and function of a collapsible section or item. + CollapsibleSettings *DocumentHTMLCollapsibleDisplaySettings `json:"collapsibleSettings,omitempty"` + // This string sets the display and behavior properties of + // the document during signing. The possible values are: + // + // * `modal`
+ // The document is shown as a supplement action strip + // and can be viewed, downloaded, or printed in a modal window. + // This is the recommended value for supplemental documents. + // + // * `download`
+ // The document is shown as a supplement action strip + // and can be viewed, downloaded, or printed in a new browser window. + // + // * `inline`
+ // The document is shown in the normal signing window. + // This value is not used with supplemental documents, + // but is the default value for all other documents. + // + Display string `json:"display,omitempty"` + // The label for the display section. + DisplayLabel string `json:"displayLabel,omitempty"` + // The position on the page where the display section appears. + DisplayOrder int32 `json:"displayOrder,omitempty"` + // The number of the page on which the display section appears. + DisplayPageNumber int32 `json:"displayPageNumber,omitempty"` + // When **true**, the `displayLabel` is hidden when the display section is expanded and the display section is no longer collapsible. This property is valid only when the value of the `display` property is `collapsed`. + HideLabelWhenOpened bool `json:"hideLabelWhenOpened,omitempty"` + // Specifies the valid CSS-formatted styles to use on inline display sections. This property is valid only when the value of the `display` property is `inline`. + InlineOuterStyle string `json:"inlineOuterStyle,omitempty"` + // The label for the display section when it is expanded from a collapsed state. This label displays only on the first opening and is only valid with the value of the `display` property is `collapsed`. + LabelWhenOpened string `json:"labelWhenOpened,omitempty"` + // Enables you to add descriptive text that appears before a collapsed section or continue button. + PreLabel string `json:"preLabel,omitempty"` + // When **true** and the section is expanded, the position of the section close is scrolled to the top of the screen. This property is only valid when the value of the `display` property is `collapsed`. + ScrollToTopWhenOpened bool `json:"scrollToTopWhenOpened,omitempty"` + // Specifies the valid CSS-formatted styles to use on responsive tables. This property is valid only when the value of the `display` property is `responsive_table` or `responsive_table_single_column`. + TableStyle string `json:"tableStyle,omitempty"` +} + +type DocumentTemplate struct { + // + DocumentEndPage string `json:"documentEndPage,omitempty"` + // Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. + DocumentID string `json:"documentId,omitempty"` + // + DocumentStartPage string `json:"documentStartPage,omitempty"` + // This object describes errors that occur. It is only valid for responses and ignored in requests. + ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` + // The unique identifier of the template. If this is not provided, DocuSign generates an error and the call fails. + TemplateID string `json:"templateId,omitempty"` +} + +type DocumentTemplateList struct { + // + DocumentTemplates []DocumentTemplate `json:"documentTemplates,omitempty"` +} + +// DocumentVisibility this object configures a recipient's read/write access to a document. +type DocumentVisibility struct { + // Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. + DocumentID string `json:"documentId,omitempty"` + // This object describes errors that occur. It is only valid for responses and ignored in requests. + ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` + // Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. + RecipientID string `json:"recipientId,omitempty"` + // Indicates whether the document is editable: + // + // - `editable` + // - `read_only` + Rights string `json:"rights,omitempty"` + // When **true**, the document is visible to the recipient. + Visible string `json:"visible,omitempty"` +} + +// DocumentVisibilityList document Visibility enables senders to control the visibility of the documents in an envelope at the recipient level. For example, if the parties associated with a legal proceeding should have access to different documents, the Document Visibility feature enables you to keep all of the documents in the same envelope and set view permissions for the documents by recipient. This functionality is enabled for envelopes and templates. It is not available for PowerForms. +// +// **Note**: Before you use Document Visibility, you should be aware of the following information: +// +// - Document Visibility must be enabled for your account by your DocuSign administrator. +// - A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. +// - When the Document Visibility setting hides a document from a recipient, the document also does not appear in the recipient's list of envelopes, documents, or page images. +// - Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all of the documents associated with the envelope or template. +// +// The Document Visibility feature has multiple settings that specify the options that senders have when sending documents. For more information, see [Use Document Visibility to Control Recipient Access](https://support.docusign.com/en/guides/ndse-user-guide-document-visibility). +type DocumentVisibilityList struct { + // An array of `documentVisibility` objects that specifies which documents are visible to which recipients. + DocumentVisibility []DocumentVisibility `json:"documentVisibility,omitempty"` +} + +type DowngradRequestBillingInfoResponse struct { + // + DowngradePlanInformation *DowngradePlanUpdateResponse `json:"downgradePlanInformation,omitempty"` + // The payment method used for the billing plan. Valid values are: + // + // - `NotSupported` + // - `CreditCard` + // - `PurchaseOrder` + // - `Premium` + // - `Freemium` + // - `FreeTrial` + // - `AppStore` + // - `DigitalExternal` + // - `DirectDebit` + PaymentMethod string `json:"paymentMethod,omitempty"` +} + +type DowngradeBillingPlanInformation struct { + // + DowngradeEventType string `json:"downgradeEventType,omitempty"` + // An object used to identify the features and attributes of the account being created. + PlanInformation *PlanInformation `json:"planInformation,omitempty"` +} + +type DowngradePlanUpdateResponse struct { + // The type of payment method used for the account. Valid values are: + // + // - `credit_card` + // - + AccountPaymentMethod string `json:"accountPaymentMethod,omitempty"` + // + DowngradeEffectiveDate string `json:"downgradeEffectiveDate,omitempty"` + // + DowngradePaymentCycle string `json:"downgradePaymentCycle,omitempty"` + // + DowngradePlanID string `json:"downgradePlanId,omitempty"` + // + DowngradePlanName string `json:"downgradePlanName,omitempty"` + // + DowngradeRequestStatus string `json:"downgradeRequestStatus,omitempty"` + // + Message string `json:"message,omitempty"` +} + +type Draw struct { + // + AllowSignerUpload string `json:"allowSignerUpload,omitempty"` + // + AnchorAllowWhiteSpaceInCharacters string `json:"anchorAllowWhiteSpaceInCharacters,omitempty"` + // + AnchorAllowWhiteSpaceInCharactersMetadata *PropertyMetadata `json:"anchorAllowWhiteSpaceInCharactersMetadata,omitempty"` + // This property controls how [anchor tabs][AnchorTabs] are placed. When **true**, the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false**. + // + // For example, when set to **true**, if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When set to **false**, `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. + // + // This functionality uses the following rules: + // + // - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: + // + // $~><|^+= + // + // For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` + // + // - Strings embedded in other strings are ignored during the matching process. + // + // - In words that have dashes, the parts separated by dashes are treated as distinct words. + // + // Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**. + // + // - Letters with accent marks are treated as distinct characters from their unaccented counterparts. + // + // - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. + // + // Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. + // + // - Unlike punctuation, numbers are not ignored when finding anchor words. + // + // Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). + // + // **Note**: You can only specify the value of this property in POST requests. + // + // [AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place + AnchorCaseSensitive string `json:"anchorCaseSensitive,omitempty"` + // Metadata that indicates whether the `anchorCaseSensitive` property is editable. + AnchorCaseSensitiveMetadata *PropertyMetadata `json:"anchorCaseSensitiveMetadata,omitempty"` + // This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are : + // + // - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. + // - `right`: Aligns the tab’s left side with the last character of the matching anchor word. + // + // **Note**: You can only specify the value of this property in POST requests. + // + // [AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place + // + AnchorHorizontalAlignment string `json:"anchorHorizontalAlignment,omitempty"` + // Metadata that indicates whether the `anchorHorizontalAlignment` property is editable. + AnchorHorizontalAlignmentMetadata *PropertyMetadata `json:"anchorHorizontalAlignmentMetadata,omitempty"` + // When set to **true**, this tab is ignored if the `anchorString` is not found in the document. + AnchorIgnoreIfNotPresent string `json:"anchorIgnoreIfNotPresent,omitempty"` + // Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable. + AnchorIgnoreIfNotPresentMetadata *PropertyMetadata `json:"anchorIgnoreIfNotPresentMetadata,omitempty"` + // When set to **true**, the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false**. + // + // For example, when set to **true**, if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When set to **false**, if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. + // + // This functionality uses the following rules: + // + // - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: + // + // $~><|^+= + // + // For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` + // + // - Strings embedded in other strings are ignored during the matching process. + // + // - In words that have dashes, the parts separated by dashes are treated as distinct words. + // + // Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**. + // + // - Letters with accent marks are treated as distinct characters from their unaccented counterparts. + // + // - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. + // + // Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. + // + // - Unlike punctuation, numbers are not ignored when finding anchor words. + // + // Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). + // + // + // **Note**: You can only specify the value of this property in POST requests. + // + // [AnchorTab]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place + // + AnchorMatchWholeWord string `json:"anchorMatchWholeWord,omitempty"` + // Metadata that indicates whether the `anchorMatchWholeWord` property is editable. + AnchorMatchWholeWordMetadata *PropertyMetadata `json:"anchorMatchWholeWordMetadata,omitempty"` + // Specifies the string to find in the document and use as the basis for tab placement. + AnchorString string `json:"anchorString,omitempty"` + // Metadata that indicates whether the `anchorString` property is editable. + AnchorStringMetadata *PropertyMetadata `json:"anchorStringMetadata,omitempty"` + // Reserved for DocuSign. + AnchorTabProcessorVersion string `json:"anchorTabProcessorVersion,omitempty"` + // Reserved for DocuSign. + AnchorTabProcessorVersionMetadata *PropertyMetadata `json:"anchorTabProcessorVersionMetadata,omitempty"` + // Specifies units of the + // `anchorXOffset` and + // `anchorYOffset`. + // Valid units are: + // + // - `pixels` + // - `inches` + // - `mms` + // - `cms` + // + AnchorUnits string `json:"anchorUnits,omitempty"` + // Metadata that indicates whether the `anchorUnits` property is editable. + AnchorUnitsMetadata *PropertyMetadata `json:"anchorUnitsMetadata,omitempty"` + // Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. + // + AnchorXOffset string `json:"anchorXOffset,omitempty"` + // Metadata that indicates whether the `anchorXOffset` property is editable. + AnchorXOffsetMetadata *PropertyMetadata `json:"anchorXOffsetMetadata,omitempty"` + // Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. + // + AnchorYOffset string `json:"anchorYOffset,omitempty"` + // Metadata that indicates whether the `anchorYOffset` property is editable. + AnchorYOffsetMetadata *PropertyMetadata `json:"anchorYOffsetMetadata,omitempty"` + // For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility. + ConditionalParentLabel string `json:"conditionalParentLabel,omitempty"` + // Metadata that indicates whether the `conditionalParentLabel` property is editable. + ConditionalParentLabelMetadata *PropertyMetadata `json:"conditionalParentLabelMetadata,omitempty"` + // For conditional fields, this is the value of the parent tab that controls the tab's visibility. + // + // If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. + // + ConditionalParentValue string `json:"conditionalParentValue,omitempty"` + // Metadata that indicates whether the `conditionalParentValue` property is editable. + ConditionalParentValueMetadata *PropertyMetadata `json:"conditionalParentValueMetadata,omitempty"` + // The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. + CustomTabID string `json:"customTabId,omitempty"` + // Metadata that indicates whether the `customTabId` property is editable. + CustomTabIDMetadata *PropertyMetadata `json:"customTabIdMetadata,omitempty"` + // Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. + DocumentID string `json:"documentId,omitempty"` + // Metadata that indicates whether the `documentId` property is editable. + DocumentIDMetadata *PropertyMetadata `json:"documentIdMetadata,omitempty"` + // This object describes errors that occur. It is only valid for responses and ignored in requests. + ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` + // An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. + FormOrder string `json:"formOrder,omitempty"` + // Metadata that indicates whether the `formOrder` property is editable. + FormOrderMetadata *PropertyMetadata `json:"formOrderMetadata,omitempty"` + // A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. + FormPageLabel string `json:"formPageLabel,omitempty"` + // Metadata that indicates whether the `formPageLabel` property is editable. + FormPageLabelMetadata *PropertyMetadata `json:"formPageLabelMetadata,omitempty"` + // An integer specifying the order in which to present the guided form pages. + FormPageNumber string `json:"formPageNumber,omitempty"` + // Metadata that indicates whether the `fromPageNumber` property is editable. + FormPageNumberMetadata *PropertyMetadata `json:"formPageNumberMetadata,omitempty"` + // The height of the tab in pixels. + Height string `json:"height,omitempty"` + // Metadata that indicates whether the `height` property is editable. + HeightMetadata *PropertyMetadata `json:"heightMetadata,omitempty"` + // When set to **true**, the signer cannot change the data of the custom tab. + Locked string `json:"locked,omitempty"` + // Metadata that indicates whether the `locked` property is editable. + LockedMetadata *PropertyMetadata `json:"lockedMetadata,omitempty"` + // Contains the information necessary to map the tab to a field in SalesForce. + MergeField *MergeField `json:"mergeField,omitempty"` + // + MergeFieldXML string `json:"mergeFieldXml,omitempty"` + // Specifies the page number on which the tab is located. + PageNumber string `json:"pageNumber,omitempty"` + // Metadata that indicates whether the `pageNumber` property is editable. + PageNumberMetadata *PropertyMetadata `json:"pageNumberMetadata,omitempty"` + // Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. + RecipientID string `json:"recipientId,omitempty"` + // The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only. + RecipientIDGUID string `json:"recipientIdGuid,omitempty"` + // Metadata that indicates whether the `recipientIdGuid` property is editable. + RecipientIDGUIDMetadata *PropertyMetadata `json:"recipientIdGuidMetadata,omitempty"` + // Metadata that indicates whether the `recipientId` property is editable. + RecipientIDMetadata *PropertyMetadata `json:"recipientIdMetadata,omitempty"` + // When set to **true**, the signer is required to fill out this tab. + Required string `json:"required,omitempty"` + // Metadata that indicates whether the `required` property is editable. + RequiredMetadata *PropertyMetadata `json:"requiredMetadata,omitempty"` + // When set to **true**, this custom tab is shared. + Shared string `json:"shared,omitempty"` + // Metadata that indicates whether the `shared` property is editable. + SharedMetadata *PropertyMetadata `json:"sharedMetadata,omitempty"` + // + SmartContractInformation *SmartContractInformation `json:"smartContractInformation,omitempty"` + // Indicates the envelope status. Valid values are: + // + // * sent - The envelope is sent to the recipients. + // * created - The envelope is saved as a draft and can be modified and sent later. + Status string `json:"status,omitempty"` + // Metadata that indicates whether the `status` property is editable. + StatusMetadata *PropertyMetadata `json:"statusMetadata,omitempty"` + // An array of tab group labels that uniquely identify tab groups. To assign a tab to a `tabGroup`, you assign the `TabGroupLabel` to the `Tab.TabGroupLabels` array. + TabGroupLabels []string `json:"tabGroupLabels,omitempty"` + // Metadata that indicates whether the `tabGroupLabels` property is editable. + TabGroupLabelsMetadata *PropertyMetadata `json:"tabGroupLabelsMetadata,omitempty"` + // The unique identifier for the tab. + TabID string `json:"tabId,omitempty"` + // Metadata that indicates whether the `tabId` property is editable. + TabIDMetadata *PropertyMetadata `json:"tabIdMetadata,omitempty"` + // Metadata that indicates whether the `tabLabel` property is editable. + TabLabelMetadata *PropertyMetadata `json:"tabLabelMetadata,omitempty"` + // A positive integer that sets the order the tab is navigated to during signing. + // + // Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. + TabOrder string `json:"tabOrder,omitempty"` + // Metadata that indicates whether the `tabOrder` property is editable. + TabOrderMetadata *PropertyMetadata `json:"tabOrderMetadata,omitempty"` + // Indicates the type of tab (for example, `signHere` or `initialHere`). + TabType string `json:"tabType,omitempty"` + // Metadata that indicates whether the `tabType` property is editable. + TabTypeMetadata *PropertyMetadata `json:"tabTypeMetadata,omitempty"` + // When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. + TemplateLocked string `json:"templateLocked,omitempty"` + // Metadata that indicates whether the `templateLocked` property is editable. + TemplateLockedMetadata *PropertyMetadata `json:"templateLockedMetadata,omitempty"` + // When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. + TemplateRequired string `json:"templateRequired,omitempty"` + // Metadata that indicates whether the `templateRequired` property is editable. + TemplateRequiredMetadata *PropertyMetadata `json:"templateRequiredMetadata,omitempty"` + // Metadata that indicates whether the `toolTip` property is editable. + ToolTipMetadata *PropertyMetadata `json:"toolTipMetadata,omitempty"` + // The text of a tooltip that appears when a user hovers over a form field or tab. + Tooltip string `json:"tooltip,omitempty"` + // + UseBackgroundAsCanvas string `json:"useBackgroundAsCanvas,omitempty"` + // The width of the tab in pixels. + Width string `json:"width,omitempty"` + // Metadata that indicates whether the `width` property is editable. + WidthMetadata *PropertyMetadata `json:"widthMetadata,omitempty"` + // This property indicates the horizontal offset of the object on the page. + // DocuSign uses 72 DPI when determining position. + // Required. May be zero. + // + XPosition string `json:"xPosition,omitempty"` + // Metadata that indicates whether the `xPosition` property is editable. + XPositionMetadata *PropertyMetadata `json:"xPositionMetadata,omitempty"` + // This property indicates the vertical offset of the object on the page. + // DocuSign uses 72 DPI when determining position. + // Required. May be zero. + // + YPosition string `json:"yPosition,omitempty"` + // Metadata that indicates whether the `yPosition` property is editable. + YPositionMetadata *PropertyMetadata `json:"yPositionMetadata,omitempty"` +} + +type ENoteConfiguration struct { + // + APIKey string `json:"apiKey,omitempty"` + // + ConnectConfigured string `json:"connectConfigured,omitempty"` + // + ENoteConfigured string `json:"eNoteConfigured,omitempty"` + // + Organization string `json:"organization,omitempty"` + // The user's encrypted password hash. + Password string `json:"password,omitempty"` + // The name of the user. + UserName string `json:"userName,omitempty"` +} + +// Editor is a complex type defining the management and access rights of a recipient assigned as an editor on the envelope. Editors have the same management and access rights for the envelope as the sender. They can make changes to the envelope as if they were using the Correct feature. This recipient can add name and email information, add or change the routing order and set authentication options for the remaining recipients. Additionally, this recipient can edit signature/initial tabs and text tabs for the remaining recipients. +type Editor struct { + // If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. + // + // Maximum Length: 50 characters and it must conform to the account's access code format setting. + // + // If blank, but the signer `accessCode` property is set in the envelope, then that value is used. + // + // If blank and the signer `accessCode` property is not set, then the access code is not required. + AccessCode string `json:"accessCode,omitempty"` + // Metadata that indicates whether the `accessCode` property is editable. Read only. + AccessCodeMetadata *PropertyMetadata `json:"accessCodeMetadata,omitempty"` + // Optional. When set to **true**, the access code will be added to the email sent to the recipient. This nullifies the security measure of `accessCode` on the recipient. + AddAccessCodeToEmail string `json:"addAccessCodeToEmail,omitempty"` + // An array of additional notification objects. + AdditionalNotifications []RecipientAdditionalNotification `json:"additionalNotifications,omitempty"` + // + AllowSystemOverrideForLockedRecipient string `json:"allowSystemOverrideForLockedRecipient,omitempty"` + // Specifies whether the recipient is embedded or remote. + // + // If the `clientUserId` property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing. + // + // Note: if the `clientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true**, an error is generated on sending. + // + // Maximum length: 100 characters. + ClientUserID string `json:"clientUserId,omitempty"` + // Indicates the number of times that the recipient has been through a signing completion for the envelope. If this number is greater than 0 for a signing group, only the user who previously completed may sign again. Read only. + CompletedCount string `json:"completedCount,omitempty"` + // An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters. + CustomFields []string `json:"customFields,omitempty"` + // The date and time the recipient declined the document. Read only. + DeclinedDateTime *time.Time `json:"declinedDateTime,omitempty"` + // The reason the recipient declined the document. Read only. + DeclinedReason string `json:"declinedReason,omitempty"` + // The date and time that the envelope was delivered to the recipient. Read only. + DeliveredDateTime *time.Time `json:"deliveredDateTime,omitempty"` + // Reserved for DocuSign. + DeliveryMethod string `json:"deliveryMethod,omitempty"` + // Reserved for DocuSign. + DeliveryMethodMetadata *PropertyMetadata `json:"deliveryMethodMetadata,omitempty"` + // + DesignatorID string `json:"designatorId,omitempty"` + // + DesignatorIDGUID string `json:"designatorIdGuid,omitempty"` + // A list of `documentVisibility` objects. Each object in the list specifies whether a document in the envelope is visible to this recipient. For the envelope to use this functionality, Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true**. + DocumentVisibility []DocumentVisibility `json:"documentVisibility,omitempty"` + // The recipient's email address. Notification of the document to sign is sent to this email address. + // + // Maximum length: 100 characters. + Email string `json:"email,omitempty"` + // Metadata that indicates whether the `email` property is editable. Read only. + EmailMetadata *PropertyMetadata `json:"emailMetadata,omitempty"` + // An optional complex type that sets a specific email subject and body for this recipient's notification email. + // + // **Note**: You can set the `emailNotification` property separately for each recipient. If you set the value only for certain recipients, the other recipients will inherit the this value from the top-level `emailSubject` and `emailBlurb`. + EmailNotification *RecipientEmailNotification `json:"emailNotification,omitempty"` + // Specifies a sender-provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. + // + // If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation launched by a partner. + // + // It is important to understand that in a typical embedded workflow, the authentication of an embedded recipient is the responsibility of the sending application. DocuSign expects that senders will follow their own processes for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process is initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process, bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. + // + // If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: `envelopeId`, `recipientId`, `recipientName`, `recipientEmail`, and `customFields`. The `customFields` property must be set for the recipient or envelope. The merge fields are enclosed in double brackets. + // + // *Example*: + // + // `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` + EmbeddedRecipientStartURL string `json:"embeddedRecipientStartURL,omitempty"` + // This object describes errors that occur. It is only valid for responses and ignored in requests. + ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` + // Reserved for DocuSign. + FaxNumber string `json:"faxNumber,omitempty"` + // Reserved for DocuSign. + FaxNumberMetadata *PropertyMetadata `json:"faxNumberMetadata,omitempty"` + // The recipient's first name. + // + // Maximum Length: 50 characters. + FirstName string `json:"firstName,omitempty"` + // Metadata that indicates whether the `firstame` property is editable. Read only. + FirstNameMetadata *PropertyMetadata `json:"firstNameMetadata,omitempty"` + // Reserved for DocuSign. + FullName string `json:"fullName,omitempty"` + // Reserved for DocuSign. + FullNameMetadata *PropertyMetadata `json:"fullNameMetadata,omitempty"` + // The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are: + // + // - `Phone Auth $`: The recipient must authenticate by using two-factor authentication (2FA). You provide the phone number to use for 2FA in the `phoneAuthentication` object. + // - `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object. + // - `ID Check $`: The recipient must answer detailed security questions. + // + // **Example**: Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node. + IDCheckConfigurationName string `json:"idCheckConfigurationName,omitempty"` + // Metadata that indicates whether the `idCheckConfigurationName` property is editable. Read only. + IDCheckConfigurationNameMetadata *PropertyMetadata `json:"idCheckConfigurationNameMetadata,omitempty"` + // An object that contains input information related to a recipient ID check. + IDCheckInformationInput *IDCheckInformationInput `json:"idCheckInformationInput,omitempty"` + // Specifies the ID Verification workflow applied on an envelope by workflow ID.
See the [list](https://developers.docusign.com/docs/esign-rest-api/reference/Accounts/IdentityVerifications/list) method in the [IdentityVerifications](https://developers.docusign.com/docs/esign-rest-api/reference/Accounts/IdentityVerifications) resource for more information on how to retrieve workflow IDs available for an account.
This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods.
Note that ID Verification and ID Check are two distinct methods. ID Verification checks recipients' identity by verifying their ID while ID Check relies on data available on public records (such as current and former address). + IdentityVerification *RecipientIdentityVerification `json:"identityVerification,omitempty"` + // When set to **true** and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account. + InheritEmailNotificationConfiguration DSBool `json:"inheritEmailNotificationConfiguration,omitempty"` + // The recipient's last name. + LastName string `json:"lastName,omitempty"` + // Metadata that indicates whether the `lastName` property is editable. Read only. + LastNameMetadata *PropertyMetadata `json:"lastNameMetadata,omitempty"` + // Reserved for DocuSign. + LockedRecipientPhoneAuthEditable string `json:"lockedRecipientPhoneAuthEditable,omitempty"` + // Reserved for DocuSign. + LockedRecipientSmsEditable string `json:"lockedRecipientSmsEditable,omitempty"` + // The full legal name of the recipient. Maximum Length: 100 characters. + // + // **Note**: You must always set a value for this property in requests, even if `firstName` and `lastName` are set. + Name string `json:"name,omitempty"` + // Metadata that indicates whether the `name` property is editable. Read only. + NameMetadata *PropertyMetadata `json:"nameMetadata,omitempty"` + // A note sent to the recipient in the signing email. + // This note is unique to this recipient. + // In the user interface, + // it appears near the upper left corner + // of the document + // on the signing screen. + // + // Maximum Length: 1000 characters. + // + Note string `json:"note,omitempty"` + // Metadata that indicates whether the `note` property is editable. Read only. + NoteMetadata *PropertyMetadata `json:"noteMetadata,omitempty"` + // When `idCheckConfigurationName` is set to `Phone Auth $`, you use this complex type to provide the recipient authentication method details. It contains the following elements: + // + // * `recipMayProvideNumber`: Boolean. When set to **true**, the recipient can use whatever phone number they choose. + // * `senderProvidedNumbers`: ArrayOfStrings. A list of phone numbers the recipient can use. + // * `recordVoicePrint`: Reserved for DocuSign. + // * `validateRecipProvidedNumber`: Reserved for DocuSign. + // + // + PhoneAuthentication DSBool `json:"phoneAuthentication,omitempty"` + // Reserved for DocuSign. + RecipientAttachments []RecipientAttachment `json:"recipientAttachments,omitempty"` + // Information about the recipient's authentication status. Read only. + RecipientAuthenticationStatus *AuthenticationStatus `json:"recipientAuthenticationStatus,omitempty"` + // Metadata about the features that are supported for the recipient type. Read only. + RecipientFeatureMetadata []FeatureAvailableMetadata `json:"recipientFeatureMetadata,omitempty"` + // Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the document. + RecipientID string `json:"recipientId,omitempty"` + // The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only. + RecipientIDGUID string `json:"recipientIdGuid,omitempty"` + // The recipient type, as specified by the following values: + // - `agent`: Agent recipients can add name and email information for recipients that appear after the agent in routing order. + // - `carbonCopy`: Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date, or add information to any of the documents. This type of recipient can be used in any routing order. + // - `certifiedDelivery`: Certified delivery recipients must receive the completed documents for the envelope to be completed. They don't need to sign, initial, date, or add information to any of the documents. + // - `editor`: Editors have the same management and access rights for the envelope as the sender. Editors can add name and email information, add or change the routing order, set authentication options, and can edit signature/initial tabs and data fields for the remaining recipients. + // - `inPersonSigner`: In-person recipients are DocuSign users who act as signing hosts in the same physical location as the signer. + // - `intermediaries`: Intermediary recipients can optionally add name and email information for recipients at the same or subsequent level in the routing order. + // - `seal`: Electronic seal recipients represent legal entities. + // - `signer`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope. + // - `witness`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope. + RecipientType string `json:"recipientType,omitempty"` + // Metadata that indicates whether the `recipientType` property is editable. Read only. + RecipientTypeMetadata *PropertyMetadata `json:"recipientTypeMetadata,omitempty"` + // When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. + RequireIDLookup DSBool `json:"requireIdLookup,omitempty"` + // Metadata that indicates whether the `requireIdLookup` property is editable. Read only. + RequireIDLookupMetadata *PropertyMetadata `json:"requireIdLookupMetadata,omitempty"` + // Optional element. Specifies the role name associated with the recipient.

This property is required when you are working with template recipients. + RoleName string `json:"roleName,omitempty"` + // Specifies the routing order of the recipient in the envelope. + RoutingOrder string `json:"routingOrder,omitempty"` + // Metadata that indicates whether the `routingOrder` property is editable. Read only. + RoutingOrderMetadata *PropertyMetadata `json:"routingOrderMetadata,omitempty"` + // The UTC DateTime when the envelope was sent. Read only. + SentDateTime *time.Time `json:"sentDateTime,omitempty"` + // Reserved for DocuSign. + SignedDateTime *time.Time `json:"signedDateTime,omitempty"` + // When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once). + SigningGroupID string `json:"signingGroupId,omitempty"` + // Metadata that indicates whether the `signingGroupId` property is editable. Read only. + SigningGroupIDMetadata *PropertyMetadata `json:"signingGroupIdMetadata,omitempty"` + // Optional. The name of the signing group. + // + // Maximum Length: 100 characters. + SigningGroupName string `json:"signingGroupName,omitempty"` + // A complex type that contains information about users in the signing group. + SigningGroupUsers []UserInfo `json:"signingGroupUsers,omitempty"` + // When `idCheckConfigurationName` is set to `SMS Auth $`, you use this complex type to provide the recipient authentication method details. It contains the element `senderProvidedNumbers`, which is an array of phone numbers that the recipient can use for SMS text authentication. + // + // + SmsAuthentication *RecipientSMSAuthentication `json:"smsAuthentication,omitempty"` + // Deprecated. + SocialAuthentications []SocialAuthentication `json:"socialAuthentications,omitempty"` + // The recipient's status. Read only. + // + // Possible values: + // + // - `autoresponded`: The recipient's email system auto-responded to the email from DocuSign. This status is used in the web console to inform senders about the bounced-back email. This recipient status is only used if **Send-on-behalf-of** is turned off for the account. + // - `completed`: The recipient has completed their actions (signing or other required actions if not a signer) for an envelope. + // - `created`: The recipient is in a draft state. This value is only associated with draft envelopes (envelopes that have a status of `created`). + // - `declined`: The recipient declined to sign the document(s) in the envelope. + // - `delivered`: The recipient has viewed the document(s) in an envelope through the DocuSign signing website. This is not an email delivery of the documents in an envelope. + // - `faxPending`: The recipient has finished signing and the system is waiting for a fax attachment from the recipient before completing their signing step. + // - `sent`: The recipient has been sent an email notification that it is their turn to sign an envelope. + // - `signed`: The recipient has completed (signed) all required tags in an envelope. This is a temporary state during processing, after which the recipient's status automatically switches to `completed`. + // + Status string `json:"status,omitempty"` + // The code associated with the recipient's status. Read only. + StatusCode string `json:"statusCode,omitempty"` + // When set to **true**, email notifications are suppressed for the recipient, and they must access envelopes and documents from their DocuSign inbox. + SuppressEmails string `json:"suppressEmails,omitempty"` + // When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. + TemplateLocked DSBool `json:"templateLocked,omitempty"` + // When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. + TemplateRequired DSBool `json:"templateRequired,omitempty"` + // The total number of tabs in the documents. Read only. + TotalTabCount string `json:"totalTabCount,omitempty"` + // The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing. + // + UserID string `json:"userId,omitempty"` +} + +// Email is a tab that allows the recipient to enter an email address. +// This is a one-line field that checks that a valid email +// address is entered. It uses the same parameters as a Text +// tab, with the validation message and pattern set for email +// information. +// +// When getting information that includes +// this tab type, the original value of the tab when the +// associated envelope was sent is included in the response. +// +type Email struct { + TabBase + TabGuidedForm + TabPosition + TabStyle + TabValue + // + AnchorAllowWhiteSpaceInCharacters string `json:"anchorAllowWhiteSpaceInCharacters,omitempty"` + // + AnchorAllowWhiteSpaceInCharactersMetadata *PropertyMetadata `json:"anchorAllowWhiteSpaceInCharactersMetadata,omitempty"` + // When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. + // + // When an envelope is completed the information is only available to the sender through the Form Data link in the DocuSign Console. The information on the downloaded document remains masked by asterisks. + // + // This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. + ConcealValueOnDocument DSBool `json:"concealValueOnDocument,omitempty"` + // Metadata that indicates whether the `concealValueOnDocument` property is editable. + ConcealValueOnDocumentMetadata *PropertyMetadata `json:"concealValueOnDocumentMetadata,omitempty"` + // When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. + DisableAutoSize DSBool `json:"disableAutoSize,omitempty"` + // Metadata that indicates whether the `disableAutoSize` property is editable. + DisableAutoSizeMetadata *PropertyMetadata `json:"disableAutoSizeMetadata,omitempty"` + // The height of the tab in pixels. + Height string `json:"height,omitempty"` + // Metadata that indicates whether the `height` property is editable. + HeightMetadata *PropertyMetadata `json:"heightMetadata,omitempty"` + // Reserved for DocuSign. + LocalePolicy *LocalePolicyTab `json:"localePolicy,omitempty"` + // When set to **true**, the signer cannot change the data of the custom tab. + Locked DSBool `json:"locked,omitempty"` + // Metadata that indicates whether the `locked` property is editable. + LockedMetadata *PropertyMetadata `json:"lockedMetadata,omitempty"` + // An optional value that describes the maximum length of the property when the property is a string. + MaxLength string `json:"maxLength,omitempty"` + // Metadata that indicates whether the `maxLength` property is editable. + MaxLengthMetadata *PropertyMetadata `json:"maxLengthMetadata,omitempty"` + // + MergeFieldXML string `json:"mergeFieldXml,omitempty"` + // The initial value of the tab when it was sent to the recipient. + OriginalValue string `json:"originalValue,omitempty"` + // Metadata that indicates whether the `originalValue` property is editable. + OriginalValueMetadata *PropertyMetadata `json:"originalValueMetadata,omitempty"` + // When set to **true** and shared is true, information must be entered in this field to complete the envelope. + RequireAll DSBool `json:"requireAll,omitempty"` + // Metadata that indicates whether the `requireAll` property is editable. + RequireAllMetadata *PropertyMetadata `json:"requireAllMetadata,omitempty"` + // Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field. + RequireInitialOnSharedChange DSBool `json:"requireInitialOnSharedChange,omitempty"` + // Metadata that indicates whether the `requireInitialOnSharedChange` property is editable. + RequireInitialOnSharedChangeMetadata *PropertyMetadata `json:"requireInitialOnSharedChangeMetadata,omitempty"` + // When set to **true**, the signer is required to fill out this tab. + Required TabRequired `json:"required,omitempty"` + // Metadata that indicates whether the `required` property is editable. + RequiredMetadata *PropertyMetadata `json:"requiredMetadata,omitempty"` + // When set to **true**, the sender must populate the tab before an envelope can be sent using the template. + // + // This value tab can only be changed by modifying (PUT) the template. + // + // Tabs with a `senderRequired` value of true cannot be deleted from an envelope. + SenderRequired DSBool `json:"senderRequired,omitempty"` + // Metadata that indicates whether the `senderRequired` property is editable. + SenderRequiredMetadata *PropertyMetadata `json:"senderRequiredMetadata,omitempty"` + // When set to **true**, this tab is shared. + Shared DSBool `json:"shared,omitempty"` + // Metadata that indicates whether the `shared` property is editable. + SharedMetadata *PropertyMetadata `json:"sharedMetadata,omitempty"` + // + SmartContractInformation *SmartContractInformation `json:"smartContractInformation,omitempty"` + // Metadata that indicates whether the `toolTip` property is editable. + ToolTipMetadata *PropertyMetadata `json:"toolTipMetadata,omitempty"` + // The text of a tooltip that appears when a user hovers over a form field or tab. + Tooltip string `json:"tooltip,omitempty"` + // The message displayed if the custom tab fails input validation (either custom of embedded). + ValidationMessage string `json:"validationMessage,omitempty"` + // Metadata that indicates whether the `validationMessage` property is editable. + ValidationMessageMetadata *PropertyMetadata `json:"validationMessageMetadata,omitempty"` + // A regular expression used to validate input for the tab. + ValidationPattern string `json:"validationPattern,omitempty"` + // Metadata that indicates whether the `validationPattern` property is editable. + ValidationPatternMetadata *PropertyMetadata `json:"validationPatternMetadata,omitempty"` + // The width of the tab in pixels. + Width string `json:"width,omitempty"` + // Metadata that indicates whether the `width` property is editable. + WidthMetadata *PropertyMetadata `json:"widthMetadata,omitempty"` +} + +// EmailAddress is a tab that displays the recipient's email as entered in the +// recipient information. +// +type EmailAddress struct { + TabBase + TabGuidedForm + TabPosition + TabStyle + TabValue + // + AnchorAllowWhiteSpaceInCharacters string `json:"anchorAllowWhiteSpaceInCharacters,omitempty"` + // + AnchorAllowWhiteSpaceInCharactersMetadata *PropertyMetadata `json:"anchorAllowWhiteSpaceInCharactersMetadata,omitempty"` + // The height of the tab in pixels. + Height string `json:"height,omitempty"` + // Metadata that indicates whether the `height` property is editable. + HeightMetadata *PropertyMetadata `json:"heightMetadata,omitempty"` + // Reserved for DocuSign. + LocalePolicy *LocalePolicyTab `json:"localePolicy,omitempty"` + // + MergeFieldXML string `json:"mergeFieldXml,omitempty"` + // + SmartContractInformation *SmartContractInformation `json:"smartContractInformation,omitempty"` + // Metadata that indicates whether the `toolTip` property is editable. + ToolTipMetadata *PropertyMetadata `json:"toolTipMetadata,omitempty"` + // The text of a tooltip that appears when a user hovers over a form field or tab. + Tooltip string `json:"tooltip,omitempty"` + // The width of the tab in pixels. + Width string `json:"width,omitempty"` + // Metadata that indicates whether the `width` property is editable. + WidthMetadata *PropertyMetadata `json:"widthMetadata,omitempty"` +} + +// EmailSettings is a complex element that allows the sender to override some envelope email setting information. This can be used to override the Reply To email address and name associated with the envelope and to override the BCC email addresses to which an envelope is sent. +// +// When the emailSettings information is used for an envelope, it only applies to that envelope. +// +// **IMPORTANT**: The emailSettings information is not returned in the GET for envelope status. Use GET /email_settings to return information about the emailSettings. +// +// EmailSettings consists of: +// +// * replyEmailAddressOverride - The Reply To email used for the envelope. DocuSign will verify that a correct email format is used, but does not verify that the email is active. Maximum Length: 100 characters. +// * replyEmailNameOverride - The name associated with the Reply To email address. Maximum Length: 100 characters. +// * bccEmailAddresses - An array of up to five email addresses to which the envelope is sent to as a BCC email. Only users with canManageAccount setting set to true can use this option. +// DocuSign verifies that the email format is correct, but does not verify that the email is active. Using this overrides the BCC for Email Archive information setting for this envelope. Maximum Length: 100 characters. +// *Example*: if your account has BCC for Email Archive set up for the email address 'archive@mycompany.com' and you send an envelope using the BCC Email Override to send a BCC email to 'salesarchive@mycompany.com', then a copy of the envelope is only sent to the 'salesarchive@mycompany.com' email address. +type EmailSettings struct { + // An array containing the email address that should receive a copy of all email communications related to an envelope for archiving purposes. Maximum Length: 100 characters. + // + // While this property is an array, note that it takes only a single email address. + // + // **Note**: Only users with the `canManageAccount` setting set to **true** can use this option. + // + // DocuSign verifies that the email format is correct, but does not verify that the email address is active. You can use this for archiving purposes. However, using this property overrides the BCC for Email Archive information setting for this envelope. + // + // **Example**: if your account has BCC for Email Archive set up for the email address archive@mycompany.com and you send an envelope using the BCC Email Override to send a BCC email to salesarchive@mycompany.com, then a copy of the envelope is only sent to the salesarchive@mycompany.com email address. + BccEmailAddresses []BccEmailAddress `json:"bccEmailAddresses,omitempty"` + // The Reply To email address to use for email replies, instead of the one that is configured at the account level. DocuSign verifies that the email address is in a correct format, but does not verify that it is active. Maximum Length: 100 characters. + ReplyEmailAddressOverride string `json:"replyEmailAddressOverride,omitempty"` + // The name to associate with the Reply To email address, instead of the name that is configured at the account level. Maximum Length: 100 characters. + ReplyEmailNameOverride string `json:"replyEmailNameOverride,omitempty"` +} + +type Envelope struct { + // Reserved for DocuSign. + AccessControlListBase64 string `json:"accessControlListBase64,omitempty"` + // When set to **true**, users can add comments to the documents in the envelope. For example, if a signer has a question about the text in the document, they can add a comment to the document. + AllowComments string `json:"allowComments,omitempty"` + // When set to **true**, the Document Markup feature is enabled. + // + // **Note**: To use this feature, Document Markup must be enabled at both the account and envelope levels. Only Admin users can change this setting for at the account level. + AllowMarkup DSBool `json:"allowMarkup,omitempty"` + // When **true**, the recipient can redirect an envelope to a more appropriate recipient. + AllowReassign DSBool `json:"allowReassign,omitempty"` + // When set to **true**, recipients can view the history of the envelope. + AllowViewHistory DSBool `json:"allowViewHistory,omitempty"` + // Deprecated. This feature has been replaced by signing groups. + AnySigner string `json:"anySigner,omitempty"` + // When **true**, the envelope is queued for + // processing and the value of the `status` property + // is set to `Processing`. Additionally, GET status + // calls return `Processing` until completed. + // + // + // **Note**: A `transactionId` is required for this + // call to work correctly. When the envelope is + // created, the status is `Processing` and an + // `envelopeId` is not returned in the response. To + // get the `envelopeId`, use a GET envelope query by + // using the + // [transactionId](https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/Envelopes/create/) or by checking the + // Connect notification. + Asynchronous DSBool `json:"asynchronous,omitempty"` + // Contains a URL for retrieving the attachments that are associated with the envelope. + AttachmentsURI string `json:"attachmentsUri,omitempty"` + // When **true**, marks all of the documents in the envelope as authoritative copies. + // + // **Note**: You can override this value for a specific document. For example, you can set the `authoritativeCopy` property to **true** at the envelope level, but turn it off for a single document by setting the `authoritativeCopy` property for the document to **false**. + AuthoritativeCopy DSBool `json:"authoritativeCopy,omitempty"` + // The default `authoritativeCopy` setting for documents in this envelope that do not have `authoritativeCopy` set. + // If this property is not set, each document defaults to the envelope's `authoritativeCopy`. + AuthoritativeCopyDefault string `json:"authoritativeCopyDefault,omitempty"` + // When set to **true**, autonavigation is set for the recipient. + // + AutoNavigation string `json:"autoNavigation,omitempty"` + // The id of the brand. + BrandID string `json:"brandId,omitempty"` + // When **true**, the `brandId` for the envelope is locked and senders cannot change the brand used for the envelope. + BrandLock string `json:"brandLock,omitempty"` + // The URI for retrieving certificate information. + CertificateURI string `json:"certificateUri,omitempty"` + // Specifies the date and time this item was completed. + CompletedDateTime *time.Time `json:"completedDateTime,omitempty"` + // + CopyRecipientData string `json:"copyRecipientData,omitempty"` + // The UTC DateTime when the item was created. + CreatedDateTime *time.Time `json:"createdDateTime,omitempty"` + // An optional array of strings that enables the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each `customField` string can be a maximum of 100 characters. + CustomFields *CustomFields `json:"customFields,omitempty"` + // The URI for retrieving custom fields. + CustomFieldsURI string `json:"customFieldsUri,omitempty"` + // The date and time the recipient declined the document. Read only. + DeclinedDateTime *time.Time `json:"declinedDateTime,omitempty"` + // Reserved for DocuSign. + DeletedDateTime *time.Time `json:"deletedDateTime,omitempty"` + // The date and time that the envelope was delivered to the recipient. Read only. + DeliveredDateTime *time.Time `json:"deliveredDateTime,omitempty"` + // When set to **true**, responsive documents are disabled for the envelope. + DisableResponsiveDocument string `json:"disableResponsiveDocument,omitempty"` + // The URI for retrieving all of the documents associated with the envelope as a single PDF file. + DocumentsCombinedURI string `json:"documentsCombinedUri,omitempty"` + // The URI for retrieving all of the documents associated with the envelope as separate files. + DocumentsURI string `json:"documentsUri,omitempty"` + // This is the same as the email body. If specified it is included in email body for all envelope recipients. + EmailBlurb string `json:"emailBlurb,omitempty"` + // A complex type that contains email settings. + EmailSettings *EmailSettings `json:"emailSettings,omitempty"` + // The subject line of the email message that is sent to all recipients. + // + // For information about adding merge field information to the email subject, see [Template Email Subject Merge Fields](https://developers.docusign.com/docs/esign-rest-api/reference/Templates/Templates/create#template-email-subject-merge-fields). + // + EmailSubject string `json:"emailSubject,omitempty"` + // When set to **true**, the signer is allowed to print the document and sign it on paper. + EnableWetSign DSBool `json:"enableWetSign,omitempty"` + // When set to **true**, signers can only view the documents on which they have tabs. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all of the documents in an envelope, unless they are specifically excluded by using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded by using this setting when an envelope is sent. + // + // **Note**: To use this functionality, [Document Visibility][docviz] must be enabled for the account by making the account setting `allowDocumentVisibility` **true**. + // + // [docviz]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeDocumentVisibility/ + EnforceSignerVisibility DSBool `json:"enforceSignerVisibility,omitempty"` + // An array of attachment objects that provide information about the attachments that are associated with the envelope. + EnvelopeAttachments []Attachment `json:"envelopeAttachments,omitempty"` + // An array containing information about the documents that are included in the envelope. + EnvelopeDocuments []EnvelopeDocument `json:"envelopeDocuments,omitempty"` + // The envelope ID of the envelope status that failed to post. + EnvelopeID string `json:"envelopeId,omitempty"` + // When set to **true**, [Envelope ID Stamping](https://support.docusign.com/en/guides/ndse-user-guide-set-advanced-document-options) is enabled. + // After a document or attachment is stamped with an Envelope ID, + // the ID is seen by all recipients + // and becomes a permanent part of the document + // and cannot be removed. + EnvelopeIDStamping DSBool `json:"envelopeIdStamping,omitempty"` + // Reserved for DocuSign. + EnvelopeLocation string `json:"envelopeLocation,omitempty"` + // Provides information about the features and services that are enabled for the envelope, including the Correct feature, the Advanced Correct feature, and DocuSign eNotary service. + EnvelopeMetadata *EnvelopeMetadata `json:"envelopeMetadata,omitempty"` + // The URI for retrieving the envelope or envelopes. + EnvelopeURI string `json:"envelopeUri,omitempty"` + // An integer specifying the number of days that a sent envelope remains active before it expires. A negative number in a response indicates that the envelope has already expired. + ExpireAfter string `json:"expireAfter,omitempty"` + // The date and time the envelope is set to expire. + ExpireDateTime string `json:"expireDateTime,omitempty"` + // When set to **true**, the envelope expires (is no longer available for signing) after the specified number of days after it is sent (`sentDateTime`). Set `expireAfter` to set the number of days until an envelope expires. When **false**, the account default setting is used. If the account does not have an expiration setting, the DocuSign default value of 120 days is used. + ExpireEnabled string `json:"expireEnabled,omitempty"` + // May contain an external identifier for the envelope. + ExternalEnvelopeID string `json:"externalEnvelopeId,omitempty"` + // A list of folder objects. + Folders []Folder `json:"folders,omitempty"` + // When set to **true**, indicates that users have added comments to the envelope. + HasComments string `json:"hasComments,omitempty"` + // When set to **true**, indicates that the data collected through form fields on a document has changed. + HasFormDataChanged string `json:"hasFormDataChanged,omitempty"` + // When set to **true**, indicates that a .wav file used for voice authentication is included in the envelope. + HasWavFile string `json:"hasWavFile,omitempty"` + // Reserved for DocuSign. + Holder string `json:"holder,omitempty"` + // The date and time the envelope was initially sent. + InitialSentDateTime *time.Time `json:"initialSentDateTime,omitempty"` + // When **true**, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES). + Is21CFRPart11 DSBool `json:"is21CFRPart11,omitempty"` + // When set to **true**, indicates that the envelope is a dynamic envelope. + IsDynamicEnvelope string `json:"isDynamicEnvelope,omitempty"` + // When set to **true**, indicates that the envelope is a signature-provided envelope. + IsSignatureProviderEnvelope DSBool `json:"isSignatureProviderEnvelope,omitempty"` + // The date and time that the item was last modified. + LastModifiedDateTime *time.Time `json:"lastModifiedDateTime,omitempty"` + // Reserved for DocuSign. + Location string `json:"location,omitempty"` + // Provides lock information about an envelope that a user has locked. + LockInformation *LockInformation `json:"lockInformation,omitempty"` + // When set to **true**, prevents senders from changing the contents of `emailBlurb` and `emailSubject` properties for the envelope. + // + // Additionally, this prevents users from making changes to the contents of `emailBlurb` and `emailSubject` properties when correcting envelopes. + // + // However, if the `messageLock` node is set to **true** and the `emailSubject` property is empty, senders and correctors are able to add a subject to the envelope. + MessageLock DSBool `json:"messageLock,omitempty"` + // + Notification DSBool `json:"notification,omitempty"` + // The URI for retrieving notifications. + NotificationURI string `json:"notificationUri,omitempty"` + // Information about any PowerForms that are included in the envelope. + PowerForm *PowerForm `json:"powerForm,omitempty"` + // The date that a purge was completed. + PurgeCompletedDate string `json:"purgeCompletedDate,omitempty"` + // The date that a purge was requested. + PurgeRequestDate string `json:"purgeRequestDate,omitempty"` + // Shows the current purge state for the envelope. The possible values are: + // + // * `unpurged`: There has been no successful request to purge documents. + // * `documents_queued`: The envelope documents have been added to the purge queue, but have not been purged. + // * `documents_dequeued`: The envelope documents have been taken out of the purge queue. + // * `documents_and_metadata_queued`: The envelope documents and metadata have been added to the purge queue, but have not yet been purged. + // * `documents_purged`: The envelope documents have been successfully purged. + // * `documents_and_metadata_purged`: The envelope documents and metadata have been successfully purged. + // + // + PurgeState string `json:"purgeState,omitempty"` + // An array of recipient objects that provides details about the recipients of the envelope. + Recipients *Recipients `json:"recipients,omitempty"` + // When set to **true**, prevents senders from changing, correcting, or deleting the recipient information for the envelope. + RecipientsLock DSBool `json:"recipientsLock,omitempty"` + // Contains a URI for an endpoint that you can use to retrieve the recipients. + RecipientsURI string `json:"recipientsUri,omitempty"` + // Information about the sender of the envelope. + Sender *UserInfo `json:"sender,omitempty"` + // The UTC DateTime when the envelope was sent. Read only. + SentDateTime *time.Time `json:"sentDateTime,omitempty"` + // When set to **true**, recipients can sign on a mobile device. + // + // **Note**: Only Admin users can change this setting. + // + SignerCanSignOnMobile DSBool `json:"signerCanSignOnMobile,omitempty"` + // Specifies the physical location where the signing takes place. It can have two enumeration values; `inPerson` and `online`. The default value is `online`. + SigningLocation string `json:"signingLocation,omitempty"` + // Indicates the envelope status. Valid values are: + // + // * `completed`: The recipients have finished working with the envelope: the documents are signed and all required tabs are filled in. + // * `created`: The envelope is created as a draft. It can be modified and sent later. + // * `declined`: The envelope has been declined by the recipients. + // * `delivered`: The envelope has been delivered to the recipients. + // * `sent`: The envelope will be sent to the recipients after the envelope is created. + // * `signed`: The envelope has been signed by the recipients. + // * `voided`: The envelope is no longer valid and recipients cannot access or sign the envelope. + // + Status string `json:"status,omitempty"` + // The data and time that the status changed. + StatusChangedDateTime *time.Time `json:"statusChangedDateTime,omitempty"` + // The DateTime that the envelope changed status (i.e. was created or sent.) + StatusDateTime string `json:"statusDateTime,omitempty"` + // The URI for retrieving the templates. + TemplatesURI string `json:"templatesUri,omitempty"` + // Specifies the Transaction ID from the AppStore. + TransactionID string `json:"transactionId,omitempty"` + // When set to **true**, the disclosure is shown to recipients in accordance with the account's Electronic Record and Signature Disclosure frequency setting. When set to **false**, the Electronic Record and Signature Disclosure is not shown to any envelope recipients. + // + // If the `useDisclosure` property is not set, then the account's normal disclosure setting is used and the value of the `useDisclosure` property is not returned in responses when getting envelope information. + UseDisclosure DSBool `json:"useDisclosure,omitempty"` + // The date and time the envelope or template was voided. + VoidedDateTime *time.Time `json:"voidedDateTime,omitempty"` + // The reason the envelope or template was voided. + VoidedReason string `json:"voidedReason,omitempty"` + // + Workflow *Workflow `json:"workflow,omitempty"` +} + +type EnvelopeAttachment struct { + // Valid values are `sender` and `senderAndAllRecipients`. + AccessControl string `json:"accessControl,omitempty"` + // The unique identifier for the attachment. + AttachmentID string `json:"attachmentId,omitempty"` + // Specifies the type of the attachment for the recipient. Possible values are: + // + // - `.htm` + // - `.xml` + AttachmentType string `json:"attachmentType,omitempty"` + // This object describes errors that occur. It is only valid for responses and ignored in requests. + ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` + // + Label string `json:"label,omitempty"` + // + Name string `json:"name,omitempty"` +} + +type EnvelopeAttachmentsRequest struct { + // An object that contains information about the attachment. + Attachments []Attachment `json:"attachments,omitempty"` +} + +type EnvelopeAttachmentsResult struct { + // An array of attachment objects that contain information about the attachments. + Attachments []EnvelopeAttachment `json:"attachments,omitempty"` +} + +type EnvelopeAuditEvent struct { + // + EventFields []NameValue `json:"eventFields,omitempty"` +} + +type EnvelopeAuditEventResponse struct { + // Reserved: TBD + AuditEvents []EnvelopeAuditEvent `json:"auditEvents,omitempty"` +} + +// EnvelopeDefinition envelope object definition. +type EnvelopeDefinition struct { + // Reserved for DocuSign. + AccessControlListBase64 string `json:"accessControlListBase64,omitempty"` + // Sets the document reading zones for screen reader applications. This element can only be used if Document Accessibility is enabled for the account. + // + // **Note**: This information is currently generated from the DocuSign web console by setting the reading zones when creating a template, exporting the reading zone string information, and adding it here. + Accessibility string `json:"accessibility,omitempty"` + // When **true**, comments are allowed on the envelope. + AllowComments string `json:"allowComments,omitempty"` + // When set to **true**, the Document Markup feature is enabled. + // + // **Note**: To use this feature, Document Markup must be enabled at both the account and envelope levels. Only Admin users can change this setting for at the account level. + AllowMarkup DSBool `json:"allowMarkup,omitempty"` + // When **true**, the recipient can redirect an envelope to a more appropriate recipient. + AllowReassign DSBool `json:"allowReassign,omitempty"` + // When set to **true**, this enables the Recursive Recipients feature and allows a recipient to appear more than once in the routing order. + AllowRecipientRecursion DSBool `json:"allowRecipientRecursion,omitempty"` + // When **true**, users can view the history of the envelope. + AllowViewHistory DSBool `json:"allowViewHistory,omitempty"` + // Deprecated. This feature has been replaced by signing groups. + AnySigner string `json:"anySigner,omitempty"` + // When **true**, the envelope is queued for + // processing and the value of the `status` property + // is set to `Processing`. Additionally, GET status + // calls return `Processing` until completed. + // + // + // **Note**: A `transactionId` is required for this + // call to work correctly. When the envelope is + // created, the status is `Processing` and an + // `envelopeId` is not returned in the response. To + // get the `envelopeId`, use a GET envelope query by + // using the + // [transactionId](https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/Envelopes/create/) or by checking the + // Connect notification. + Asynchronous DSBool `json:"asynchronous,omitempty"` + // An array of attachment objects containing details about any envelope attachments. + Attachments []Attachment `json:"attachments,omitempty"` + // The URI for retrieving the envelope attachments. + AttachmentsURI string `json:"attachmentsUri,omitempty"` + // When **true**, marks all of the documents in the envelope as authoritative copies. + // + // **Note**: You can override this value for a specific document. For example, you can set the `authoritativeCopy` property to **true** at the envelope level, but turn it off for a single document by setting the `authoritativeCopy` property for the document to **false**. + AuthoritativeCopy DSBool `json:"authoritativeCopy,omitempty"` + // The default `authoritativeCopy` setting for documents in this envelope that do not have `authoritativeCopy` set. + // If this property is not set, each document defaults to the envelope's `authoritativeCopy`. + AuthoritativeCopyDefault string `json:"authoritativeCopyDefault,omitempty"` + // When set to **true**, autonavigation is set for the recipient. + // + AutoNavigation string `json:"autoNavigation,omitempty"` + // The id of the brand, or text and formatting, to use for the envelope. To use brands, account branding must be enabled for the account. + BrandID string `json:"brandId,omitempty"` + // When **true**, the `brandId` for the envelope is locked and senders cannot change the brand used for the envelope. + BrandLock string `json:"brandLock,omitempty"` + // The URI for retrieving certificate information. + CertificateURI string `json:"certificateUri,omitempty"` + // The date and time that the envelope was completed. + CompletedDateTime *time.Time `json:"completedDateTime,omitempty"` + // A complex type that can be added to create envelopes from a combination of DocuSign templates and PDF forms. The basic envelope remains the same, while the Composite Template adds new document and template overlays into the envelope. There can be any number of Composite Template structures in the envelope. + CompositeTemplates []CompositeTemplate `json:"compositeTemplates,omitempty"` + // + CopyRecipientData string `json:"copyRecipientData,omitempty"` + // The date and time that the envelope was created. + CreatedDateTime *time.Time `json:"createdDateTime,omitempty"` + // An optional array of strings that enables the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each `customField` string can be a maximum of 100 characters. + CustomFields *CustomFields `json:"customFields,omitempty"` + // The URI for retrieving custom fields. + CustomFieldsURI string `json:"customFieldsUri,omitempty"` + // The date and time that the recipient declined the envelope. + DeclinedDateTime *time.Time `json:"declinedDateTime,omitempty"` + // The date and time that the envelope was deleted. + DeletedDateTime *time.Time `json:"deletedDateTime,omitempty"` + // The date and time that the envelope was delivered to the recipient. Read only. + DeliveredDateTime *time.Time `json:"deliveredDateTime,omitempty"` + // When set to **true**, the responsive document feature is turned off for the envelope. + DisableResponsiveDocument string `json:"disableResponsiveDocument,omitempty"` + // A complex element that contains details about the documents associated with the envelope. + Documents []Document `json:"documents,omitempty"` + // The URI for retrieving all of the documents associated with the envelope as a single PDF file. + DocumentsCombinedURI string `json:"documentsCombinedUri,omitempty"` + // The URI for retrieving all of the documents associated with the envelope as separate files. + DocumentsURI string `json:"documentsUri,omitempty"` + // This optional element holds the body of the email message that is sent to all envelope recipients. + // + // Maximum Length: 10000 characters. + EmailBlurb string `json:"emailBlurb,omitempty"` + // This optional complex element enables the sender to override some envelope email setting information. This can be used to override the Reply To email address and name associated with the envelope, as well as the BCC email addresses to which an envelope is sent. When the `emailSettings` information is used for an envelope, it only applies to that envelope. + // + // **Important Note**: The `emailSettings` information is not returned in the GET method for envelope status. Use GET /email_settings to return information about the emailSettings. + EmailSettings *EmailSettings `json:"emailSettings,omitempty"` + // The subject line of the email message that is sent to all recipients. + // + // For information about adding merge field information to the email subject, see [Template Email Subject Merge Fields](https://developers.docusign.com/docs/esign-rest-api/reference/Templates/Templates/create#template-email-subject-merge-fields). + // + EmailSubject string `json:"emailSubject,omitempty"` + // When set to **true**, the signer is allowed to print the document and sign it on paper. + EnableWetSign DSBool `json:"enableWetSign,omitempty"` + // When set to **true**, signers can only view the documents on which they have tabs. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all of the documents in an envelope, unless they are specifically excluded by using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded by using this setting when an envelope is sent. + // + // **Note**: To use this functionality, [Document Visibility][docviz] must be enabled for the account by making the account setting `allowDocumentVisibility` **true**. + // + // [docviz]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeDocumentVisibility/ + EnforceSignerVisibility DSBool `json:"enforceSignerVisibility,omitempty"` + // An array of attachment objects that provide information about the attachments that are associated with the envelope. + EnvelopeAttachments []Attachment `json:"envelopeAttachments,omitempty"` + // An array containing information about the documents that are included in the envelope. + EnvelopeDocuments []EnvelopeDocument `json:"envelopeDocuments,omitempty"` + // The envelope ID of the envelope status that failed to post. + EnvelopeID string `json:"envelopeId,omitempty"` + // When set to **true**, [Envelope ID Stamping](https://support.docusign.com/en/guides/ndse-user-guide-set-advanced-document-options) is enabled. + // After a document or attachment is stamped with an Envelope ID, + // the ID is seen by all recipients + // and becomes a permanent part of the document + // and cannot be removed. + EnvelopeIDStamping DSBool `json:"envelopeIdStamping,omitempty"` + // Reserved for DocuSign. + EnvelopeLocation string `json:"envelopeLocation,omitempty"` + // Metadata about the features that are enabled for the envelope. + EnvelopeMetadata *EnvelopeMetadata `json:"envelopeMetadata,omitempty"` + // The URI for retrieving the envelope or envelopes. + EnvelopeURI string `json:"envelopeUri,omitempty"` + // + EventNotification *EventNotification `json:"eventNotification,omitempty"` + // An integer specifying the number of days that a sent envelope remains active before it expires. A negative number in a response indicates that the envelope has already expired. + ExpireAfter string `json:"expireAfter,omitempty"` + // The date and time the envelope is set to expire. + ExpireDateTime string `json:"expireDateTime,omitempty"` + // When set to **true**, the envelope expires (is no longer available for signing) after the specified number of days after it is sent (`sentDateTime`). Set `expireAfter` to set the number of days until an envelope expires. When **false**, the account default setting is used. If the account does not have an expiration setting, the DocuSign default value of 120 days is used. + ExpireEnabled string `json:"expireEnabled,omitempty"` + // May contain an external identifier for the envelope. + ExternalEnvelopeID string `json:"externalEnvelopeId,omitempty"` + // An array of folders that the envelope belongs to. + Folders []Folder `json:"folders,omitempty"` + // When set to **true**, indicates that users have added comments to the envelope. + HasComments string `json:"hasComments,omitempty"` + // When set to **true**, indicates that the form data associated with the envelope has changed since it was sent. If **false**, this property does not appear in the response. + HasFormDataChanged string `json:"hasFormDataChanged,omitempty"` + // When set to **true**, indicates that a wave file (voice recording) is part of the envelope. + HasWavFile string `json:"hasWavFile,omitempty"` + // Reserved for DocuSign. + Holder string `json:"holder,omitempty"` + // The date and time that the envelope was first sent. + InitialSentDateTime *time.Time `json:"initialSentDateTime,omitempty"` + // When **true**, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES). + Is21CFRPart11 DSBool `json:"is21CFRPart11,omitempty"` + // When set to **true**, indicates that the envelope is a dynamic envelope. + IsDynamicEnvelope string `json:"isDynamicEnvelope,omitempty"` + // When set to **true**, indicates that the envelope is a signature-provided envelope. + IsSignatureProviderEnvelope DSBool `json:"isSignatureProviderEnvelope,omitempty"` + // The date and time that the item was last modified. + LastModifiedDateTime *time.Time `json:"lastModifiedDateTime,omitempty"` + // Reserved for DocuSign. + Location string `json:"location,omitempty"` + // Provides lock information about an envelope that a user has locked. + LockInformation *LockInformation `json:"lockInformation,omitempty"` + // When set to **true**, prevents senders from changing the contents of `emailBlurb` and `emailSubject` properties for the envelope. + // + // Additionally, this prevents users from making changes to the contents of `emailBlurb` and `emailSubject` properties when correcting envelopes. + // + // However, if the `messageLock` node is set to **true** and the `emailSubject` property is empty, senders and correctors are able to add a subject to the envelope. + MessageLock DSBool `json:"messageLock,omitempty"` + // An optional complex element that specifies the notification options for the envelope. + Notification *Notification `json:"notification,omitempty"` + // The URI for retrieving notifications. + NotificationURI string `json:"notificationUri,omitempty"` + // The user's encrypted password hash. + Password string `json:"password,omitempty"` + // Information about any PowerForms that are included in the envelope. + PowerForm *PowerForm `json:"powerForm,omitempty"` + // The date that a purge was completed. + PurgeCompletedDate string `json:"purgeCompletedDate,omitempty"` + // The date that a purge was requested. + PurgeRequestDate string `json:"purgeRequestDate,omitempty"` + // Initiates a purge request. Valid values are: + // * `documents_queued`: Places envelope documents in the purge queue. + // * `documents_and_metadata_queued`: Places envelope documents and metadata in the purge queue. + // + PurgeState string `json:"purgeState,omitempty"` + // Specifies the envelope recipients. + Recipients *Recipients `json:"recipients,omitempty"` + // When set to **true**, prevents senders from changing, correcting, or deleting the recipient information for the envelope. + RecipientsLock DSBool `json:"recipientsLock,omitempty"` + // Contains a URI for an endpoint that you can use to retrieve the recipients. + RecipientsURI string `json:"recipientsUri,omitempty"` + // Information about the sender of the envelope. + Sender *UserInfo `json:"sender,omitempty"` + // The UTC DateTime when the envelope was sent. Read only. + SentDateTime *time.Time `json:"sentDateTime,omitempty"` + // When set to **true**, recipients can sign on a mobile device. + // + // **Note**: Only Admin users can change this setting. + // + SignerCanSignOnMobile DSBool `json:"signerCanSignOnMobile,omitempty"` + // Specifies the physical location where the signing takes place. It can have two enumeration values; `inPerson` and `online`. The default value is `online`. + SigningLocation string `json:"signingLocation,omitempty"` + // Indicates the envelope status. Valid values when creating an envelope are: + // + // * `created`: The envelope is created as a draft. It can be modified and sent later. + // * `sent`: The envelope will be sent to the recipients after the envelope is created. + // + // You can query these additional statuses once the recipients have interacted with the envelope. + // + // * `completed`: The recipients have finished working with the envelope: the documents are signed and all required tabs are filled in. + // * `declined`: The envelope has been declined by the recipients. + // * `delivered`: The envelope has been delivered to the recipients. + // * `signed`: The envelope has been signed by the recipients. + // * `voided`: The envelope is no longer valid and recipients cannot access or sign the envelope. + // + Status string `json:"status,omitempty"` + // The data and time that the status changed. + StatusChangedDateTime *time.Time `json:"statusChangedDateTime,omitempty"` + // The DateTime that the envelope changed status (i.e. was created or sent.) + StatusDateTime string `json:"statusDateTime,omitempty"` + // The id of the template. If a value is not provided, DocuSign generates a value. + TemplateID string `json:"templateId,omitempty"` + // This object specifies the template recipients. Each `roleName` in the template must have a recipient assigned to it. This object is comprised of the following elements: + // + // * `email`: The recipient's email address. + // * `name`: The recipient's name. + // * `roleName`: The template roleName associated with the recipient. + // * `clientUserId`: An optional property that specifies whether the recipient is embedded or remote. If the `clientUserId` is not null, then the recipient is embedded. Note that if a `clientUserId` is used and the account settings `signerMustHaveAccount` or `signerMustLoginToSign` are **true**, an error is generated on sending. + // * `defaultRecipient`: Optional, When set to **true**, this recipient is the default recipient and any tabs generated by the `transformPdfFields` option are mapped to this recipient. + // * `routingOrder`: This specifies the routing order of the recipient in the envelope. + // * `accessCode`: This optional element specifies the access code a recipient has to enter to validate the identity. Maximum Length: 50 characters. + // * `inPersonSignerName`: Optional. If the template role is an in-person signer, this is the full legal name of the signer. Maximum Length: 100 characters. + // * `emailNotification`: This is an optional complex element that has a role-specific `emailSubject`, `emailBody`, and `language`. It follows the same format as the `emailNotification` property for recipients. + // * `tabs`: This property enables the tab values to be specified for matching to tabs in the template. + // + TemplateRoles []TemplateRole `json:"templateRoles,omitempty"` + // The URI for retrieving any templates associated with the envelope. + TemplatesURI string `json:"templatesUri,omitempty"` + // Used to identify an envelope. The id is a sender-generated value and is valid in the DocuSign system for 7 days. We recommend that you use a transaction ID for offline signing to ensure that an envelope is not sent multiple times. You can use the `transactionId` property to determine an envelope's status (i.e. was it created or not) in cases where the Internet connection was lost before the envelope status was returned. + TransactionID string `json:"transactionId,omitempty"` + // When set to **true**, the disclosure is shown to recipients in accordance with the account's Electronic Record and Signature Disclosure frequency setting. When set to **false**, the Electronic Record and Signature Disclosure is not shown to any envelope recipients. + // + // If the `useDisclosure` property is not set, then the account's normal disclosure setting is used and the value of the `useDisclosure` property is not returned in responses when getting envelope information. + UseDisclosure DSBool `json:"useDisclosure,omitempty"` + // The date and time the envelope or template was voided. + VoidedDateTime *time.Time `json:"voidedDateTime,omitempty"` + // The reason the envelope or template was voided. + VoidedReason string `json:"voidedReason,omitempty"` + // Describes the workflow for this envelope. + Workflow *Workflow `json:"workflow,omitempty"` +} + +// EnvelopeDocument this object contains details about the envelope document. +type EnvelopeDocument struct { + // If recipients were added by converting form fields into tabs, their ids appear here. Read only. + AddedRecipientIds []string `json:"addedRecipientIds,omitempty"` + // If this document is an attachment to another document in the envelope, this is the id of the attachment tab it is associated with on the other document. + AttachmentTabID string `json:"attachmentTabId,omitempty"` + // When **true**, marks all of the documents in the envelope as authoritative copies. + // + // **Note**: You can override this value for a specific document. For example, you can set the `authoritativeCopy` property to **true** at the envelope level, but turn it off for a single document by setting the `authoritativeCopy` property for the document to **false**. + AuthoritativeCopy DSBool `json:"authoritativeCopy,omitempty"` + // Metadata that indicates if the sender can edit the `authoritativeCopy` property. Not applicable for template documents. + AuthoritativeCopyMetadata *PropertyMetadata `json:"authoritativeCopyMetadata,omitempty"` + // + AvailableDocumentTypes []SignatureType `json:"availableDocumentTypes,omitempty"` + // When **true**, the document has editable form fields that are made available through a PDF format. + ContainsPdfFormFields string `json:"containsPdfFormFields,omitempty"` + // This string sets the display and behavior properties of + // the document during signing. The possible values are: + // + // * `modal`
+ // The document is shown as a supplement action strip + // and can be viewed, downloaded, or printed in a modal window. + // This is the recommended value for supplemental documents. + // + // * `download`
+ // The document is shown as a supplement action strip + // and can be viewed, downloaded, or printed in a new browser window. + // + // * `inline`
+ // The document is shown in the normal signing window. + // This value is not used with supplemental documents, + // but is the default value for all other documents. + // + Display string `json:"display,omitempty"` + // Metadata that indicates if the sender can edit the `display` property. Not applicable for template documents. + DisplayMetadata *PropertyMetadata `json:"displayMetadata,omitempty"` + // An object containing information about the custom fields on the document. + DocumentFields []NameValue `json:"documentFields,omitempty"` + // The id of the document that the tab is placed on. This value must refer to the id of an existing document. + DocumentID string `json:"documentId,omitempty"` + // The GUID of the document. + DocumentIDGUID string `json:"documentIdGuid,omitempty"` + // This object describes errors that occur. It is only valid for responses and ignored in requests. + ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` + // When set to **true**, + // the document is included in the combined document download (`documentsCombinedUri`). + // The default value is **true**. + // + IncludeInDownload DSBool `json:"includeInDownload,omitempty"` + // Metadata that indicates if the sender can edit the `includeInDowload` property. Not applicable for template documents. + IncludeInDownloadMetadata *PropertyMetadata `json:"includeInDownloadMetadata,omitempty"` + // The document's file name. + // + // Example: `Q1-Report.docx` + Name string `json:"name,omitempty"` + // Metadata that indicates if the sender can edit the `name` property. Not applicable for template documents. + NameMetadata *PropertyMetadata `json:"nameMetadata,omitempty"` + // (Optional) The order in which to sort the results. + // + // Valid values are: + // + // + // * `asc`: Ascending order. + // * `desc`: Descending order. + Order string `json:"order,omitempty"` + // An array of page objects that contain information about the pages in the document. + Pages []Page `json:"pages,omitempty"` + // Sets how the signer interacts with the supplemental document. + // The possible values are: + // + // * `no_interaction`
+ // No recipient action is required. + // + // * `view`
+ // The recipient is required to view the document. + // + // * `accept`
+ // The recipient is required to accept the document by selecting accept during signing, but is not required to view the document. + // + // * `view_accept`
+ // The recipient is required to view and accept the document. + // + // + SignerMustAcknowledge string `json:"signerMustAcknowledge,omitempty"` + // Metadata that indicates if the sender can edit the `signerMustAcknowledge` property. Not applicable for template documents. + SignerMustAcknowledgeMetadata *PropertyMetadata `json:"signerMustAcknowledgeMetadata,omitempty"` + // + SizeBytes string `json:"sizeBytes,omitempty"` + // When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. + TemplateLocked string `json:"templateLocked,omitempty"` + // When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. + TemplateRequired string `json:"templateRequired,omitempty"` + // + Type string `json:"type,omitempty"` + // The URI for retrieving the document. + URI string `json:"uri,omitempty"` +} + +type EnvelopeDocumentsResult struct { + // An array containing information about the documents that are included in the envelope. + EnvelopeDocuments []EnvelopeDocument `json:"envelopeDocuments,omitempty"` + // The envelope ID of the envelope status that failed to post. + EnvelopeID string `json:"envelopeId,omitempty"` +} + +// EnvelopeEvent for which envelope events should your webhook be called? +type EnvelopeEvent struct { + // An envelope status for which your webhook should be called. Values: Draft, Sent, Delivered, Completed, Declined, or Voided. + EnvelopeEventStatusCode string `json:"envelopeEventStatusCode,omitempty"` + // When set to **true**, the PDF documents are included in the message along with the updated XML. + IncludeDocuments string `json:"includeDocuments,omitempty"` +} + +// EnvelopeFormData this object contains the data that recipients have entered into the form fields associated with an envelope. +type EnvelopeFormData struct { + // The subject line of the email message that is sent to all recipients. + // + // For information about adding merge field information to the email subject, see [Template Email Subject Merge Fields](https://developers.docusign.com/docs/esign-rest-api/reference/Templates/Templates/create#template-email-subject-merge-fields). + // + EmailSubject string `json:"emailSubject,omitempty"` + // The id of the envelope. + EnvelopeID string `json:"envelopeId,omitempty"` + // An array of form data objects. + FormData []FormDataItem `json:"formData,omitempty"` + // + PrefillFormData []FormDataItem `json:"prefillFormData,omitempty"` + // An array of form data objects that are associated with specific recipients. + RecipientFormData []RecipientFormData `json:"recipientFormData,omitempty"` + // The UTC DateTime when the envelope was sent. Read only. + SentDateTime *time.Time `json:"sentDateTime,omitempty"` + // Indicates the envelope status. Valid values are: + // + // * `completed`: The recipients have finished working with the envelope: the documents are signed and all required tabs are filled in. + // * `created`: The envelope is created as a draft. It can be modified and sent later. + // * `declined`: The envelope has been declined by the recipients. + // * `delivered`: The envelope has been delivered to the recipients. + // * `sent`: The envelope will be sent to the recipients after the envelope is created. + // * `signed`: The envelope has been signed by the recipients. + // * `voided`: The envelope is no longer valid and recipients cannot access or sign the envelope. + // + Status string `json:"status,omitempty"` +} + +// EnvelopeID is a tab that displays the envelope ID. Recipients cannot enter +// or change the information in this tab. +// +type EnvelopeID struct { + TabBase + TabGuidedForm + TabPosition + TabStyle + // + AnchorAllowWhiteSpaceInCharacters string `json:"anchorAllowWhiteSpaceInCharacters,omitempty"` + // + AnchorAllowWhiteSpaceInCharactersMetadata *PropertyMetadata `json:"anchorAllowWhiteSpaceInCharactersMetadata,omitempty"` + // The height of the tab in pixels. + Height string `json:"height,omitempty"` + // Metadata that indicates whether the `height` property is editable. + HeightMetadata *PropertyMetadata `json:"heightMetadata,omitempty"` + // Reserved for DocuSign. + LocalePolicy *LocalePolicyTab `json:"localePolicy,omitempty"` + // + MergeFieldXML string `json:"mergeFieldXml,omitempty"` + // + SmartContractInformation *SmartContractInformation `json:"smartContractInformation,omitempty"` + // Metadata that indicates whether the `toolTip` property is editable. + ToolTipMetadata *PropertyMetadata `json:"toolTipMetadata,omitempty"` + // The text of a tooltip that appears when a user hovers over a form field or tab. + Tooltip string `json:"tooltip,omitempty"` + // The width of the tab in pixels. + Width string `json:"width,omitempty"` + // Metadata that indicates whether the `width` property is editable. + WidthMetadata *PropertyMetadata `json:"widthMetadata,omitempty"` +} + +// EnvelopeIdsRequest lists of envelope and transaction IDs to use in the results. +type EnvelopeIdsRequest struct { + // A comma-separated list of envelope IDs to include in the results. + EnvelopeIds []string `json:"envelopeIds,omitempty"` + // A comma-separated list of transaction IDs to include in the results. Note that transaction IDs are valid for seven days. + TransactionIds []string `json:"transactionIds,omitempty"` +} + +type EnvelopeMetadata struct { + // Specifies if the Advanced Correct feature is enabled for the envelope. This feature enables you to correct the details of in process envelopes that you sent or are shared with you. It offers more functionality than the Correct feature. + AllowAdvancedCorrect string `json:"allowAdvancedCorrect,omitempty"` + // Specifies if the Correct feature is enabled for the envelope. This feature enables you to correct the details of in process envelopes that you sent or are shared with you, including the recipient, envelope, and document information. + AllowCorrect string `json:"allowCorrect,omitempty"` + // Specifies if DocuSign eNotary service is enabled for the envelope. + EnableSignWithNotary string `json:"enableSignWithNotary,omitempty"` +} + +// EnvelopeNotificationRequest is a complex element that specifies the notification settings for the envelope. +type EnvelopeNotificationRequest struct { + // A complex element that specifies the expiration settings for the envelope. + Expirations *Expirations `json:"expirations,omitempty"` + // A complex element that specifies reminder settings for the envelope + Reminders *Reminders `json:"reminders,omitempty"` + // When set to **true**, the account default notification settings are used for the envelope, overriding the reminders and expirations settings. When set to **false**, the reminders and expirations settings specified in this request are used. + UseAccountDefaults DSBool `json:"useAccountDefaults,omitempty"` +} + +// EnvelopePurgeConfiguration contains information about the current envelope purge configuration for an account, which enables account administrators to purge documents from completed and voided envelopes after a set number of days (`retentionDays`). +type EnvelopePurgeConfiguration struct { + // When set to **true**, purging is enabled. + PurgeEnvelopes string `json:"purgeEnvelopes,omitempty"` + // When set to **true**, the system also redacts personally identifiable information (PII). + // + // **Note**: To redact PII, you must also set the property `removeTabsAndEnvelopeAttachments` to **true**. + RedactPII string `json:"redactPII,omitempty"` + // When set to **true**, the system also purges the tabs and attachments associated with the envelopes. + RemoveTabsAndEnvelopeAttachments string `json:"removeTabsAndEnvelopeAttachments,omitempty"` + // The number of days to retain envelope documents before purging them. This value must be a number between `0` and `999`. + RetentionDays string `json:"retentionDays,omitempty"` +} + +// EnvelopeSummary This object describes an envelope. +type EnvelopeSummary struct { + // An object that describes the status of the bulk send envelopes. + BulkEnvelopeStatus *BulkEnvelopeStatus `json:"bulkEnvelopeStatus,omitempty"` + // The envelope ID of the envelope status that failed to post. + EnvelopeID string `json:"envelopeId,omitempty"` + // This object describes errors that occur. It is only valid for responses and ignored in requests. + ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` + // Indicates the envelope status. Valid values are: + // + // * `completed`: The recipients have finished working with the envelope: the documents are signed and all required tabs are filled in. + // * `created`: The envelope is created as a draft. It can be modified and sent later. + // * `declined`: The envelope has been declined by the recipients. + // * `delivered`: The envelope has been delivered to the recipients. + // * `sent`: The envelope will be sent to the recipients after the envelope is created. + // * `signed`: The envelope has been signed by the recipients. + // * `voided`: The envelope is no longer valid and recipients cannot access or sign the envelope. + // + Status string `json:"status,omitempty"` + // The DateTime that the envelope changed status (i.e. was created or sent.) + StatusDateTime *time.Time `json:"statusDateTime,omitempty"` + // A URI containing the user ID. + URI string `json:"uri,omitempty"` +} + +// EnvelopeTemplate template management +type EnvelopeTemplate struct { + // Reserved for DocuSign. + AccessControlListBase64 string `json:"accessControlListBase64,omitempty"` + // When set to **true**, indicates that comments are allowed on the envelope. + AllowComments string `json:"allowComments,omitempty"` + // When set to **true**, the Document Markup feature is enabled. + // + // **Note**: To use this feature, Document Markup must be enabled at both the account and envelope levels. Only Admin users can change this setting for at the account level. + AllowMarkup DSBool `json:"allowMarkup,omitempty"` + // When **true**, the recipient can redirect an envelope to a more appropriate recipient. + AllowReassign DSBool `json:"allowReassign,omitempty"` + // When set to **true**, recipients can view the history of the envelope. + AllowViewHistory DSBool `json:"allowViewHistory,omitempty"` + // Deprecated. This feature has been replaced by signing groups. + AnySigner string `json:"anySigner,omitempty"` + // When **true**, the envelope is queued for + // processing and the value of the `status` property + // is set to `Processing`. Additionally, GET status + // calls return `Processing` until completed. + // + // + // **Note**: A `transactionId` is required for this + // call to work correctly. When the envelope is + // created, the status is `Processing` and an + // `envelopeId` is not returned in the response. To + // get the `envelopeId`, use a GET envelope query by + // using the + // [transactionId](https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/Envelopes/create/) or by checking the + // Connect notification. + Asynchronous DSBool `json:"asynchronous,omitempty"` + // Contains a URL for retrieving the attachments that are associated with the envelope. + AttachmentsURI string `json:"attachmentsUri,omitempty"` + // When **true**, marks all of the documents in the envelope as authoritative copies. + // + // **Note**: You can override this value for a specific document. For example, you can set the `authoritativeCopy` property to **true** at the envelope level, but turn it off for a single document by setting the `authoritativeCopy` property for the document to **false**. + AuthoritativeCopy DSBool `json:"authoritativeCopy,omitempty"` + // The default `authoritativeCopy` setting for documents in this envelope that do not have `authoritativeCopy` set. + // If this property is not set, each document defaults to the envelope's `authoritativeCopy`. + AuthoritativeCopyDefault string `json:"authoritativeCopyDefault,omitempty"` + // By default, templates that have been used within + // the last 60 days are included in auto-matching. + // + // By explicitly setting `autoMatch`, + // you can permanently include or exclude the template + // in auto matching. + // + // When **true** the template is included in auto-matching + // regardless of when it was last used. + // + // When **false** the template is never included in auto-matching. + AutoMatch string `json:"autoMatch,omitempty"` + // If **true**, the template has been explicitly included in or excluded from auto-matching. The default is false. + // This is a read-only property. + AutoMatchSpecifiedByUser string `json:"autoMatchSpecifiedByUser,omitempty"` + // When set to **true**, autonavigation is set for the recipient. + // + AutoNavigation string `json:"autoNavigation,omitempty"` + // The id of the brand. + BrandID string `json:"brandId,omitempty"` + // When **true**, the `brandId` for the envelope is locked and senders cannot change the brand used for the envelope. + BrandLock string `json:"brandLock,omitempty"` + // The URI for retrieving certificate information. + CertificateURI string `json:"certificateUri,omitempty"` + // Specifies the date and time this item was completed. + CompletedDateTime *time.Time `json:"completedDateTime,omitempty"` + // + CopyRecipientData string `json:"copyRecipientData,omitempty"` + // The UTC DateTime when the workspace user authorization was created. + Created string `json:"created,omitempty"` + // The UTC DateTime when the item was created. + CreatedDateTime *time.Time `json:"createdDateTime,omitempty"` + // An optional array of strings that enables the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each `customField` string can be a maximum of 100 characters. + CustomFields *CustomFields `json:"customFields,omitempty"` + // The URI for retrieving custom fields. + CustomFieldsURI string `json:"customFieldsUri,omitempty"` + // The date and time the recipient declined the document. Read only. + DeclinedDateTime *time.Time `json:"declinedDateTime,omitempty"` + // Reserved for DocuSign. + DeletedDateTime *time.Time `json:"deletedDateTime,omitempty"` + // The date and time that the envelope was delivered to the recipient. Read only. + DeliveredDateTime *time.Time `json:"deliveredDateTime,omitempty"` + // A sender-defined description of the line item. + // + Description string `json:"description,omitempty"` + // When set to **true**, responsive documents are disabled for the envelope. + DisableResponsiveDocument string `json:"disableResponsiveDocument,omitempty"` + // A complex element that contains details about the documents associated with the envelope. + Documents []Document `json:"documents,omitempty"` + // The URI for retrieving all of the documents associated with the envelope as a single PDF file. + DocumentsCombinedURI string `json:"documentsCombinedUri,omitempty"` + // The URI for retrieving all of the documents associated with the envelope as separate files. + DocumentsURI string `json:"documentsUri,omitempty"` + // This is the same as the email body. If the sender enters an email blurb, it is included in the email body for all envelope recipients. + EmailBlurb string `json:"emailBlurb,omitempty"` + // A complex type that contains email settings. + EmailSettings *EmailSettings `json:"emailSettings,omitempty"` + // The subject line of the email message that is sent to all recipients. + // + // For information about adding merge field information to the email subject, see [Template Email Subject Merge Fields](https://developers.docusign.com/docs/esign-rest-api/reference/Templates/Templates/create#template-email-subject-merge-fields). + // + EmailSubject string `json:"emailSubject,omitempty"` + // When set to **true**, the signer is allowed to print the document and sign it on paper. + EnableWetSign DSBool `json:"enableWetSign,omitempty"` + // When set to **true**, signers can only view the documents on which they have tabs. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all of the documents in an envelope, unless they are specifically excluded by using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded by using this setting when an envelope is sent. + // + // **Note**: To use this functionality, [Document Visibility][docviz] must be enabled for the account by making the account setting `allowDocumentVisibility` **true**. + // + // [docviz]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeDocumentVisibility/ + EnforceSignerVisibility DSBool `json:"enforceSignerVisibility,omitempty"` + // An array of attachment objects that provide information about the attachments that are associated with the envelope. + EnvelopeAttachments []Attachment `json:"envelopeAttachments,omitempty"` + // An array containing information about the documents that are included in the envelope. + EnvelopeDocuments []EnvelopeDocument `json:"envelopeDocuments,omitempty"` + // The envelope ID of the envelope status that failed to post. + EnvelopeID string `json:"envelopeId,omitempty"` + // When set to **true**, [Envelope ID Stamping](https://support.docusign.com/en/guides/ndse-user-guide-set-advanced-document-options) is enabled. + // After a document or attachment is stamped with an Envelope ID, + // the ID is seen by all recipients + // and becomes a permanent part of the document + // and cannot be removed. + EnvelopeIDStamping DSBool `json:"envelopeIdStamping,omitempty"` + // Reserved for DocuSign. + EnvelopeLocation string `json:"envelopeLocation,omitempty"` + // Provides information about the features and services that are enabled for the envelope, including the Correct feature, the Advanced Correct feature, and DocuSign eNotary service. + EnvelopeMetadata *EnvelopeMetadata `json:"envelopeMetadata,omitempty"` + // The URI for retrieving the envelope or envelopes. + EnvelopeURI string `json:"envelopeUri,omitempty"` + // An integer specifying the number of days that a sent envelope remains active before it expires. A negative number in a response indicates that the envelope has already expired. + ExpireAfter string `json:"expireAfter,omitempty"` + // The date and time the envelope is set to expire. + ExpireDateTime string `json:"expireDateTime,omitempty"` + // When set to **true**, the envelope expires (is no longer available for signing) after the specified number of days after it is sent (`sentDateTime`). Set `expireAfter` to set the number of days until an envelope expires. When **false**, the account default setting is used. If the account does not have an expiration setting, the DocuSign default value of 120 days is used. + ExpireEnabled string `json:"expireEnabled,omitempty"` + // May contain an external identifier for the envelope. + ExternalEnvelopeID string `json:"externalEnvelopeId,omitempty"` + // + FavoritedByMe string `json:"favoritedByMe,omitempty"` + // The unique identifier for the folder that the template belongs to. + FolderID string `json:"folderId,omitempty"` + // An array of folder IDs that the template is in. + FolderIds []string `json:"folderIds,omitempty"` + // The name of the folder the template belongs to. + FolderName string `json:"folderName,omitempty"` + // A list of folder objects. + Folders []Folder `json:"folders,omitempty"` + // When set to **true**, indicates that users have added comments to the envelope. + HasComments string `json:"hasComments,omitempty"` + // Specifies if the `EnvelopeFormData` associated with any forms in the template has changed. + HasFormDataChanged string `json:"hasFormDataChanged,omitempty"` + // When set to **true**, indicates that the template includes a .wav file. + HasWavFile string `json:"hasWavFile,omitempty"` + // Reserved for DocuSign. + Holder string `json:"holder,omitempty"` + // The date and time the envelope that used the template was initially sent. + InitialSentDateTime *time.Time `json:"initialSentDateTime,omitempty"` + // When **true**, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES). + Is21CFRPart11 DSBool `json:"is21CFRPart11,omitempty"` + // When set to **true**, indicates that the envelope is a dynamic envelope. + IsDynamicEnvelope string `json:"isDynamicEnvelope,omitempty"` + // When set to **true**, indicates that the envelope is a signature-provided envelope. + IsSignatureProviderEnvelope DSBool `json:"isSignatureProviderEnvelope,omitempty"` + // The UTC date and time that the comment was last updated. + // + // **Note**: This can only be done by the creator. + LastModified string `json:"lastModified,omitempty"` + // The userId of the user who last modified the template. + LastModifiedBy *UserInfo `json:"lastModifiedBy,omitempty"` + // The date and time the template was last modified. + LastModifiedDateTime *time.Time `json:"lastModifiedDateTime,omitempty"` + // The date and time the template was last used. + LastUsed string `json:"lastUsed,omitempty"` + // Reserved for DocuSign. + Location string `json:"location,omitempty"` + // Provides lock information about an envelope that a user has locked. + LockInformation *LockInformation `json:"lockInformation,omitempty"` + // When set to **true**, prevents senders from changing the contents of `emailBlurb` and `emailSubject` properties for the envelope. + // + // Additionally, this prevents users from making changes to the contents of `emailBlurb` and `emailSubject` properties when correcting envelopes. + // + // However, if the `messageLock` node is set to **true** and the `emailSubject` property is empty, senders and correctors are able to add a subject to the envelope. + MessageLock DSBool `json:"messageLock,omitempty"` + // The name of the template. + Name string `json:"name,omitempty"` + // The user's new password. + NewPassword string `json:"newPassword,omitempty"` + // A complex element that specifies the notification options for envelopes that use the template. + Notification *Notification `json:"notification,omitempty"` + // The URI for retrieving notifications. + NotificationURI string `json:"notificationUri,omitempty"` + // The owner of the template. + Owner *UserInfo `json:"owner,omitempty"` + // An integer value specifying the number of document pages in the template. + PageCount string `json:"pageCount,omitempty"` + // The password for editing the template. + Password string `json:"password,omitempty"` + // If **true**, a password is required to edit the template. + PasswordProtected string `json:"passwordProtected,omitempty"` + // A PowerForm objects that contain information about any PowerForms that are included in the template. + PowerForm *PowerForm `json:"powerForm,omitempty"` + // An array of PowerForm objects that contain information about any PowerForms that are included in the template. + PowerForms []PowerForm `json:"powerForms,omitempty"` + // The date that a purge was completed. + PurgeCompletedDate string `json:"purgeCompletedDate,omitempty"` + // The date that a purge was requested. + PurgeRequestDate string `json:"purgeRequestDate,omitempty"` + // Shows the current purge state for the envelope. The possible values are: + // + // * `unpurged`: There has been no successful request to purge documents. + // * `documents_queued`: The envelope documents have been added to the purge queue, but have not been purged. + // * `documents_dequeued`: The envelope documents have been taken out of the purge queue. + // * `documents_and_metadata_queued`: The envelope documents and metadata have been added to the purge queue, but have not yet been purged. + // * `documents_purged`: The envelope documents have been successfully purged. + // * `documents_and_metadata_purged`: The envelope documents and metadata have been successfully purged. + // + // + PurgeState string `json:"purgeState,omitempty"` + // An array of recipient objects. + Recipients *Recipients `json:"recipients,omitempty"` + // When set to **true**, prevents senders from changing, correcting, or deleting the recipient information for the envelope. + RecipientsLock DSBool `json:"recipientsLock,omitempty"` + // Contains a URI for an endpoint that you can use to retrieve the recipients. + RecipientsURI string `json:"recipientsUri,omitempty"` + // Information about the sender. + Sender *UserInfo `json:"sender,omitempty"` + // The UTC DateTime when the envelope was sent. Read only. + SentDateTime *time.Time `json:"sentDateTime,omitempty"` + // When **true**, indicates the template is shared with the **Everyone** group, + // and is shared with all users on the account. + // + // If **false**, the template is only shared with the **Administrator** group. + // + Shared string `json:"shared,omitempty"` + // When set to **true**, recipients can sign on a mobile device. + // + // **Note**: Only Admin users can change this setting. + // + SignerCanSignOnMobile DSBool `json:"signerCanSignOnMobile,omitempty"` + // Specifies the physical location where the signing takes place. It can have two enumeration values; `inPerson` and `online`. The default value is `online`. + SigningLocation string `json:"signingLocation,omitempty"` + // Indicates the envelope status. Valid values are: + // + // * `completed`: The recipients have finished working with the envelope: the documents are signed and all required tabs are filled in. + // * `created`: The envelope is created as a draft. It can be modified and sent later. + // * `declined`: The envelope has been declined by the recipients. + // * `delivered`: The envelope has been delivered to the recipients. + // * `sent`: The envelope will be sent to the recipients after the envelope is created. + // * `signed`: The envelope has been signed by the recipients. + // * `voided`: The envelope is no longer valid and recipients cannot access or sign the envelope. + // + Status string `json:"status,omitempty"` + // The data and time that the status changed. + StatusChangedDateTime *time.Time `json:"statusChangedDateTime,omitempty"` + // The DateTime that the envelope changed status (i.e. was created or sent.) + StatusDateTime string `json:"statusDateTime,omitempty"` + // The unique identifier of the template. If this is not provided, DocuSign will generate a value. + TemplateID string `json:"templateId,omitempty"` + // The URI for retrieving the templates. + TemplatesURI string `json:"templatesUri,omitempty"` + // Used to identify an envelope. The id is a sender-generated value and is valid in the DocuSign system for 7 days. It is recommended that a transaction ID is used for offline signing to ensure that an envelope is not sent multiple times. The `transactionId` property can be used determine an envelope's status (i.e. was it created or not) in cases where the internet connection was lost before the envelope status was returned. + TransactionID string `json:"transactionId,omitempty"` + // Contains a URI that you can use to retreve the template. + URI string `json:"uri,omitempty"` + // When set to **true**, the disclosure is shown to recipients in accordance with the account's Electronic Record and Signature Disclosure frequency setting. When set to **false**, the Electronic Record and Signature Disclosure is not shown to any envelope recipients. + // + // If the `useDisclosure` property is not set, then the account's normal disclosure setting is used and the value of the `useDisclosure` property is not returned in responses when getting envelope information. + UseDisclosure DSBool `json:"useDisclosure,omitempty"` + // The date and time the envelope or template was voided. + VoidedDateTime *time.Time `json:"voidedDateTime,omitempty"` + // The reason the envelope or template was voided. + VoidedReason string `json:"voidedReason,omitempty"` + // + Workflow *Workflow `json:"workflow,omitempty"` +} + +// EnvelopeTemplateResults information about templates. +type EnvelopeTemplateResults struct { + // The last index position in the result set. + EndPosition string `json:"endPosition,omitempty"` + // The list of requested templates. + EnvelopeTemplates []EnvelopeTemplate `json:"envelopeTemplates,omitempty"` + // A list of folder objects. + Folders []Folder `json:"folders,omitempty"` + // The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. + NextURI string `json:"nextUri,omitempty"` + // The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. + PreviousURI string `json:"previousUri,omitempty"` + // The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`. + ResultSetSize string `json:"resultSetSize,omitempty"` + // The starting index position of the current result set. + StartPosition string `json:"startPosition,omitempty"` + // The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`. + TotalSetSize string `json:"totalSetSize,omitempty"` +} + +type EnvelopeTransactionStatus struct { + // The envelope ID of the envelope status that failed to post. + EnvelopeID string `json:"envelopeId,omitempty"` + // This object describes errors that occur. It is only valid for responses and ignored in requests. + ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` + // Indicates the envelope status. Valid values are: + // + // * `completed`: The recipients have finished working with the envelope: the documents are signed and all required tabs are filled in. + // * `created`: The envelope is created as a draft. It can be modified and sent later. + // * `declined`: The envelope has been declined by the recipients. + // * `delivered`: The envelope has been delivered to the recipients. + // * `sent`: The envelope will be sent to the recipients after the envelope is created. + // * `signed`: The envelope has been signed by the recipients. + // * `voided`: The envelope is no longer valid and recipients cannot access or sign the envelope. + // + Status string `json:"status,omitempty"` + // Used to identify an envelope. The id is a sender-generated value and is valid in the DocuSign system for 7 days. It is recommended that a transaction ID is used for offline signing to ensure that an envelope is not sent multiple times. The `transactionId` property can be used determine an envelope's status (i.e. was it created or not) in cases where the internet connection was lost before the envelope status was returned. + TransactionID string `json:"transactionId,omitempty"` +} + +// EnvelopeTransferRule this object contains details about an envelope transfer rule. +type EnvelopeTransferRule struct { + // When set to **true**, the original owner is added as a carbon copy recipient after envelope transfer. The default value is **false**. + CarbonCopyOriginalOwner string `json:"carbonCopyOriginalOwner,omitempty"` + // When set to **true**, the envelope transfer rule is active. + Enabled string `json:"enabled,omitempty"` + // The id of the envelope transfer rule. The system generates this id when the rule is first created. + EnvelopeTransferRuleID string `json:"envelopeTransferRuleId,omitempty"` + // The type of envelope event that triggers the transfer. Valid values are: + // + // - `sent` + // - `before sent` + // - `completed` + EventType string `json:"eventType,omitempty"` + // Information about the group that triggers the transfer. + FromGroup *Group `json:"fromGroup,omitempty"` + // Information about the user who triggers the transfer. + FromUser *UserInformation `json:"fromUser,omitempty"` + // The UTC DateTime when the envelope transfer rule was last modified. This property is read only. + ModifiedDate string `json:"modifiedDate,omitempty"` + // Information about the user who last modified the envelope transfer rule. + ModifiedUser *UserInformation `json:"modifiedUser,omitempty"` + // Information about the destination folder to which the envelope is transferred. + ToFolder *Folder `json:"toFolder,omitempty"` + // Information about the user to which the envelope is transferred. + ToUser *UserInformation `json:"toUser,omitempty"` +} + +// EnvelopeTransferRuleInformation this resource provides methods that enable account administrators to create and manage envelope transfer rules. +type EnvelopeTransferRuleInformation struct { + // The last index position in the result set. + EndPosition string `json:"endPosition,omitempty"` + // Contains information about a specific envelope transfer rule. + EnvelopeTransferRules []EnvelopeTransferRule `json:"envelopeTransferRules,omitempty"` + // The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. + NextURI string `json:"nextUri,omitempty"` + // The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. + PreviousURI string `json:"previousUri,omitempty"` + // The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`. + ResultSetSize string `json:"resultSetSize,omitempty"` + // The starting index position of the current result set. + StartPosition string `json:"startPosition,omitempty"` + // The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`. + TotalSetSize string `json:"totalSetSize,omitempty"` +} + +// EnvelopeTransferRuleRequest this object contains details about the envelope transfer rule that you want to create. +type EnvelopeTransferRuleRequest struct { + // When set to **true**, the original owner is added as a carbon copy recipient after envelope transfer. The default value is **false**. + CarbonCopyOriginalOwner string `json:"carbonCopyOriginalOwner,omitempty"` + // When set to **true**, the envelope transfer rule is active. + Enabled string `json:"enabled,omitempty"` + // The id of the envelope transfer rule. The system generates this id when the rule is first created. + EnvelopeTransferRuleID string `json:"envelopeTransferRuleId,omitempty"` + // The type of envelope event that triggers the transfer. Valid values are: + // + // - `sent` + // - `before sent` + // - `completed` + EventType string `json:"eventType,omitempty"` + // Information about the group that triggers the transfer. + FromGroups []Group `json:"fromGroups,omitempty"` + // Information about the user who triggers the transfer. + FromUsers []UserInformation `json:"fromUsers,omitempty"` + // The UTC DateTime when the envelope transfer rule was last modified. This property is read only. + ModifiedDate string `json:"modifiedDate,omitempty"` + // Information about the user who last modified the envelope transfer rule. + ModifiedUser *UserInformation `json:"modifiedUser,omitempty"` + // Information about the destination folder to which the envelope is transferred. + ToFolder *Folder `json:"toFolder,omitempty"` + // Information about the user to which the envelope is transferred. + ToUser *UserInformation `json:"toUser,omitempty"` +} + +type EnvelopeUpdateSummary struct { + // An object that describes the status of the bulk send envelopes. + BulkEnvelopeStatus *BulkEnvelopeStatus `json:"bulkEnvelopeStatus,omitempty"` + // The envelope ID of the envelope status that failed to post. + EnvelopeID string `json:"envelopeId,omitempty"` + // This object describes errors that occur. It is only valid for responses and ignored in requests. + ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` + // + ListCustomFieldUpdateResults []ListCustomField `json:"listCustomFieldUpdateResults,omitempty"` + // Provides lock information about an envelope that a user has locked. + LockInformation *LockInformation `json:"lockInformation,omitempty"` + // Shows the current purge state for the envelope. The possible values are: + // + // * `unpurged`: There has been no successful request to purge documents. + // * `documents_queued`: The envelope documents have been added to the purge queue, but have not been purged. + // * `documents_dequeued`: The envelope documents have been taken out of the purge queue. + // * `documents_and_metadata_queued`: The envelope documents and metadata have been added to the purge queue, but have not yet been purged. + // * `documents_purged`: The envelope documents have been successfully purged. + // * `documents_and_metadata_purged`: The envelope documents and metadata have been successfully purged. + // + // + PurgeState string `json:"purgeState,omitempty"` + // An array of `recipientUpdateResults` objects that contain details about the recipients. + RecipientUpdateResults []RecipientUpdateResponse `json:"recipientUpdateResults,omitempty"` + // + TabUpdateResults *Tabs `json:"tabUpdateResults,omitempty"` + // + TextCustomFieldUpdateResults []TextCustomField `json:"textCustomFieldUpdateResults,omitempty"` +} + +// EnvelopesInformation result set for the Envelopes: listStatusChanges method +type EnvelopesInformation struct { + // A token returned by an earlier API call that you can use with a new call to resume a search query at the point where it left off. This token system enhances the performance of the API. + ContinuationToken string `json:"continuationToken,omitempty"` + // The last index position in the result set. + EndPosition string `json:"endPosition,omitempty"` + // Array of envelope statuses and transaction IDs in the result set. + EnvelopeTransactionStatuses []EnvelopeTransactionStatus `json:"envelopeTransactionStatuses,omitempty"` + // Set of envelope information + Envelopes []Envelope `json:"envelopes,omitempty"` + // A list of folder objects. + Folders []Folder `json:"folders,omitempty"` + // The last time that a query was performed. + LastQueriedDateTime string `json:"lastQueriedDateTime,omitempty"` + // The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`. + ResultSetSize string `json:"resultSetSize,omitempty"` + // The starting index position of the current result set. + StartPosition string `json:"startPosition,omitempty"` + // The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`. + TotalSetSize string `json:"totalSetSize,omitempty"` +} + +// ErrorDetails this object describes errors that occur. It is only valid for responses and ignored in requests. +type ErrorDetails struct { + // The code associated with the error condition. + ErrorCode string `json:"errorCode,omitempty"` + // A brief message describing the error condition. + Message string `json:"message,omitempty"` +} + +// EventNotification use this object to configure a [DocuSign Connect webhook](https://developers.docusign.com/platform/webhooks/connect/). +type EventNotification struct { + // A list of envelope-level event statuses that will trigger Connect to send updates to the endpoint specified in the `url` property. + // + // To receive notifications, you must include either an `envelopeEvents` node or a `recipientEvents` node. You do not need to specify both. + EnvelopeEvents []EnvelopeEvent `json:"envelopeEvents,omitempty"` + // Allows you to specify the format of the information the Connect webhooks returns. For more information, see [Connect webhooks with JSON notifications](https://www.docusign.com/blog/developers/connect-webhooks-json-notifications) + EventData *ConnectEventData `json:"eventData,omitempty"` + // When set to **true**, the Connect Service includes the Certificate of Completion with completed envelopes. + IncludeCertificateOfCompletion DSBool `json:"includeCertificateOfCompletion,omitempty"` + // When set to **true**, the Connect service will digitally sign the XML data. The signature will be included in the XML message. + IncludeCertificateWithSoap DSBool `json:"includeCertificateWithSoap,omitempty"` + // When set to **true**, the Document Fields associated with the envelope's documents are included in the notification messages. Document Fields are optional custom name-value pairs added to documents using the API. + IncludeDocumentFields DSBool `json:"includeDocumentFields,omitempty"` + // When set to **true**, the XML webhook messages will include the envelope's PDF documents. Including the PDF documents will greatly increase the size of the notification messages. Ensure that your listener can handle incoming messages that are 25MB or larger. + IncludeDocuments DSBool `json:"includeDocuments,omitempty"` + // When set to **true**, this tells the Connect Service to include the void reason, as entered by the person that voided the envelope, in the message. + IncludeEnvelopeVoidReason DSBool `json:"includeEnvelopeVoidReason,omitempty"` + // When set to **true**, HMAC headers will be included with the webhook notifications. + // + // **Note**: [HMAC must enabled](https://developers.docusign.com/platform/webhooks/connect/hmac/) at the account level with [one or more HMAC secrets](https://developers.docusign.com/platform/webhooks/connect/setting-up-hmac/). + IncludeHMAC string `json:"includeHMAC,omitempty"` + // When set to **true**, Connect will include the sender account as Custom Field in the data. + IncludeSenderAccountAsCustomField DSBool `json:"includeSenderAccountAsCustomField,omitempty"` + // When set to **true**, the envelope's time zone information is included in the webhook messages. + IncludeTimeZone DSBool `json:"includeTimeZone,omitempty"` + // When set to **true**, the webhook messages are logged. They can be viewed on the DocuSign Administration Web Tool in the Connect section. Logged messages can also be downloaded via the [ConnectEvents resource](https://developers.docusign.com/docs/esign-rest-api/reference/connect/connectevents/). + LoggingEnabled DSBool `json:"loggingEnabled,omitempty"` + // A list of recipient event statuses that will trigger Connect to send updates to the endpoint specified in the url property. + // + // To receive notifications, you must include either an `envelopeEvents` node or a `recipientEvents` node. You do not need to specify both. + RecipientEvents []RecipientEvent `json:"recipientEvents,omitempty"` + // When set to **true**, the DocuSign Connect service checks that the message was received and retries on failures. + RequireAcknowledgment DSBool `json:"requireAcknowledgment,omitempty"` + // When set to **true**, Mutual TLS will be enabled for notifications. Mutual TLS must be initiated by the listener (the customer's web server) during the TLS handshake protocol. + SignMessageWithX509Cert DSBool `json:"signMessageWithX509Cert,omitempty"` + // The namespace of the SOAP interface. + // + // The namespace value must be set if useSoapInterface is set to true. + SoapNameSpace string `json:"soapNameSpace,omitempty"` + // The endpoint to which webhook notification messages are sent via an HTTPS POST request. The url must start with https. The customer's web server must use an SSL/TLS certificate whose CA is in the Microsoft list of trusted CAs. Self-signed certificates are not ok. Free certificates from Let's Encrypt can be used. + URL string `json:"url,omitempty"` + // When set to **true**, this tells the Connect service that the user's endpoint has implemented a SOAP interface. + UseSoapInterface DSBool `json:"useSoapInterface,omitempty"` +} + +// EventResult information about the result of an event. +type EventResult struct { + // Date/time of the event. + EventTimestamp string `json:"eventTimestamp,omitempty"` + // Reason for failure, if the event failed. + FailureDescription string `json:"failureDescription,omitempty"` + // Event status. + Status string `json:"status,omitempty"` + // Failure status code, if the event failed. + VendorFailureStatusCode string `json:"vendorFailureStatusCode,omitempty"` +} + +// Expirations is a complex element that specifies the expiration settings for the envelope. +type Expirations struct { + // An integer that sets the number of days the envelope is active. + ExpireAfter string `json:"expireAfter,omitempty"` + // When set to **true**, the envelope expires (is no longer available for signing) in the set number of days. If false, the account default setting is used. If the account does not have an expiration setting, the DocuSign default value of 120 days is used. + ExpireEnabled DSBool `json:"expireEnabled,omitempty"` + // An integer that specifying the number of days before the envelope expires that an expiration warning email is sent to the recipient. If set to 0 (zero), no warning email is sent. + ExpireWarn string `json:"expireWarn,omitempty"` +} + +// ExternalClaim Claims about the user from an external provider. This object is reserved for DocuSign internal use. +type ExternalClaim struct { + // Reserved for DocuSign. + AcquiredTime string `json:"acquiredTime,omitempty"` + // Reserved for DocuSign. + ClaimName string `json:"claimName,omitempty"` + // Reserved for DocuSign. + Provider string `json:"provider,omitempty"` + // Reserved for DocuSign. + Value string `json:"value,omitempty"` +} + +type ExternalDocServiceErrorDetails struct { + // Reserved: TBD + AuthenticationURL string `json:"authenticationUrl,omitempty"` + // A code associated with the error condition. + ErrorCode string `json:"errorCode,omitempty"` + // + Message string `json:"message,omitempty"` +} + +// ExternalDocumentSources is a complex object specifying the external document sources. +type ExternalDocumentSources struct { + // The account is enabled to allow external documents to be attached from BoxNet. + BoxnetEnabled string `json:"boxnetEnabled,omitempty"` + // Metadata indicating whether the `boxnetEnabled` property is editable. + BoxnetMetadata *SettingsMetadata `json:"boxnetMetadata,omitempty"` + // The account is enabled to allow external documents to be attached from DropBox. + DropboxEnabled string `json:"dropboxEnabled,omitempty"` + // Metadata indicating whether the `dropboxEnabled` property is editable. + DropboxMetadata *SettingsMetadata `json:"dropboxMetadata,omitempty"` + // The account is enabled to allow external documents to be attached from Google Drive. + GoogleDriveEnabled string `json:"googleDriveEnabled,omitempty"` + // Metadata indicating whether the `googleDriveEnabled` property is editable. + GoogleDriveMetadata *SettingsMetadata `json:"googleDriveMetadata,omitempty"` + // The account is enabled to allow external documents to be attached from OneDrive. + OneDriveEnabled string `json:"oneDriveEnabled,omitempty"` + // Metadata indicating whether the `oneDriveEnabled` property is editable. + OneDriveMetadata *SettingsMetadata `json:"oneDriveMetadata,omitempty"` + // The account is enabled to allow external documents to be attached from Salesforce. + SalesforceEnabled string `json:"salesforceEnabled,omitempty"` + // Metadata indicating whether the `salesforceEnabled` property is editable. + SalesforceMetadata *SettingsMetadata `json:"salesforceMetadata,omitempty"` +} + +// ExternalFile this object contains information about a file or folder in cloud storage. +type ExternalFile struct { + // The UTC date and time that the file or folder was last modified. + Date string `json:"date,omitempty"` + // The storage provider's id for the file or folder. + ID string `json:"id,omitempty"` + // The file extension for a file. + // + // **Note**: If the item is a folder, this value is null. + Img string `json:"img,omitempty"` + // The full name of a file. + Name string `json:"name,omitempty"` + // The size of the file. The file size limit varies based on the cloud storage provider. + Size string `json:"size,omitempty"` + // When set to **true**, DocuSign supports the file type for upload. + Supported string `json:"supported,omitempty"` + // The type of cloud storage item. Valid values are: + // + // - `file` + // - `folder` + Type string `json:"type,omitempty"` + // The URI for the file or folder. + URI string `json:"uri,omitempty"` +} + +type ExternalFolder struct { + // The last index position in the result set. + EndPosition string `json:"endPosition,omitempty"` + // This object describes errors that occur. It is only valid for responses and ignored in requests. + ErrorDetails *ExternalDocServiceErrorDetails `json:"errorDetails,omitempty"` + // A unique ID for the Salesforce object. + ID string `json:"id,omitempty"` + // If the tab is a list, this represents the values that are possible for the tab. + Items []ExternalFile `json:"items,omitempty"` + // + Name string `json:"name,omitempty"` + // The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. + NextURI string `json:"nextUri,omitempty"` + // The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. + PreviousURI string `json:"previousUri,omitempty"` + // The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`. + ResultSetSize string `json:"resultSetSize,omitempty"` + // The starting index position of the current result set. + StartPosition string `json:"startPosition,omitempty"` + // The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`. + TotalSetSize string `json:"totalSetSize,omitempty"` +} + +type FavoriteTemplatesContentItem struct { + // This object describes errors that occur. It is only valid for responses and ignored in requests. + ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` + // + FavoritedDate string `json:"favoritedDate,omitempty"` + // The unique identifier of the template. If this is not provided, DocuSign will generate a value. + TemplateID string `json:"templateId,omitempty"` +} + +type FavoriteTemplatesInfo struct { + // This object describes errors that occur. It is only valid for responses and ignored in requests. + ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` + // + FavoriteTemplates []FavoriteTemplatesContentItem `json:"favoriteTemplates,omitempty"` + // + TemplatesUpdatedCount int32 `json:"templatesUpdatedCount,omitempty"` +} + +type FeatureAvailableMetadata struct { + // + Availabilty string `json:"availabilty,omitempty"` + // + FeatureName string `json:"featureName,omitempty"` +} + +// FeatureSet this object provides details about a feature set, or add-on product that is associated with an account. It is reserved for DocuSign internal use only. +type FeatureSet struct { + // Reserved for DocuSign. + CurrencyFeatureSetPrices []CurrencyFeatureSetPrice `json:"currencyFeatureSetPrices,omitempty"` + // Reserved for DocuSign. + EnvelopeFee string `json:"envelopeFee,omitempty"` + // Reserved for DocuSign. + FeatureSetID string `json:"featureSetId,omitempty"` + // Reserved for DocuSign. + FixedFee string `json:"fixedFee,omitempty"` + // Reserved for DocuSign. + Is21CFRPart11 DSBool `json:"is21CFRPart11,omitempty"` + // Reserved for DocuSign. + IsActive DSBool `json:"isActive,omitempty"` + // When set to **true**, the feature set is actively enabled as part of the plan. + IsEnabled DSBool `json:"isEnabled,omitempty"` + // Reserved for DocuSign. + Name string `json:"name,omitempty"` + // Reserved for DocuSign. + SeatFee string `json:"seatFee,omitempty"` +} + +type FileType struct { + // + FileExtension string `json:"fileExtension,omitempty"` + // The mime-type of a file type listed in a fileTypes collection. + MimeType string `json:"mimeType,omitempty"` +} + +type FileTypeList struct { + // A collection of file types. + FileTypes []FileType `json:"fileTypes,omitempty"` +} + +// Filter use this object to create a filtered view of the items in a folder. +type Filter struct { + // When set to **true**, the current user needs to take action on the item. + ActionRequired string `json:"actionRequired,omitempty"` + // The number of days a sent envelope remains active before it expires. + Expires string `json:"expires,omitempty"` + // Filters for any combination of folder ids and folder types. The possible folder types are: + // + // - `awaiting_my_signature` + // - `completed` + // - `draft` + // - `drafts` + // - `expiring_soon` + // - `inbox` + // - `out_for_signature` + // - `recyclebin` + // - `sentitems` + // - `waiting_for_others` + FolderIds string `json:"folderIds,omitempty"` + // The UTC DateTime of the beginning of a date range. If no value is provided, the default search is the previous 30 days. + FromDateTime *time.Time `json:"fromDateTime,omitempty"` + // When set to **true**, the item is a template. + IsTemplate DSBool `json:"isTemplate,omitempty"` + // (Optional) The order in which to sort the results. + // + // Valid values are: + // + // + // * `asc`: Ascending order. + // * `desc`: Descending order. + Order string `json:"order,omitempty"` + // The field used to sort the results. + // + // Example: `Created` + OrderBy string `json:"orderBy,omitempty"` + // Reserved for DocuSign. + SearchTarget string `json:"searchTarget,omitempty"` + // A free text search field for searching across the items in a folder. The search looks for the text that you enter in the recipient names and emails, envelope custom fields, sender name, and subject. + SearchText string `json:"searchText,omitempty"` + // The status of the envelope. By default, all statuses are returned. + // + // For details, see [Envelope Status Code Descriptions](https://developers.docusign.com/esign-rest-api/guides/status-and-error-codes#envelope-status-code-descriptions). + Status string `json:"status,omitempty"` + // The UTC DateTime of the end of a date range. If no value is provided, the default search is to the current date. + ToDateTime *time.Time `json:"toDateTime,omitempty"` +} + +// FirstName is a tab that displays the recipient's first name. This tab +// takes the recipient's name as entered in the recipient +// information, splits it into sections based on spaces and +// uses the first section as the first name. +// +type FirstName struct { + TabBase + TabGuidedForm + TabPosition + TabStyle + TabValue + // + AnchorAllowWhiteSpaceInCharacters string `json:"anchorAllowWhiteSpaceInCharacters,omitempty"` + // + AnchorAllowWhiteSpaceInCharactersMetadata *PropertyMetadata `json:"anchorAllowWhiteSpaceInCharactersMetadata,omitempty"` + // The height of the tab in pixels. + Height string `json:"height,omitempty"` + // Metadata that indicates whether the `height` property is editable. + HeightMetadata *PropertyMetadata `json:"heightMetadata,omitempty"` + // Reserved for DocuSign. + LocalePolicy *LocalePolicyTab `json:"localePolicy,omitempty"` + // + MergeFieldXML string `json:"mergeFieldXml,omitempty"` + // + SmartContractInformation *SmartContractInformation `json:"smartContractInformation,omitempty"` + // Metadata that indicates whether the `toolTip` property is editable. + ToolTipMetadata *PropertyMetadata `json:"toolTipMetadata,omitempty"` + // The text of a tooltip that appears when a user hovers over a form field or tab. + Tooltip string `json:"tooltip,omitempty"` + // The width of the tab in pixels. + Width string `json:"width,omitempty"` + // Metadata that indicates whether the `width` property is editable. + WidthMetadata *PropertyMetadata `json:"widthMetadata,omitempty"` +} + +// Folder this object contains details about a folder. +type Folder struct { + // This object describes errors that occur. It is only valid for responses and ignored in requests. + ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` + // An object used to present a filtered view of the items in a folder. + Filter *Filter `json:"filter,omitempty"` + // The id of the folder. + FolderID string `json:"folderId,omitempty"` + // A list of envelopes and templates that the folder contains. + FolderItems []FolderItemV2 `json:"folderItems,omitempty"` + // A collection of folder objects returned in a response. + Folders []Folder `json:"folders,omitempty"` + // When set to **true**, the current user has access to the folder. + HasAccess string `json:"hasAccess,omitempty"` + // When set to **true**, the folder has subfolders. + HasSubFolders string `json:"hasSubFolders,omitempty"` + // The number of items in the folder. + ItemCount string `json:"itemCount,omitempty"` + // The name of the folder. + Name string `json:"name,omitempty"` + // Information about the user who owns the folder. + Owner *UserInfo `json:"owner,omitempty"` + // The id of the parent folder, or the special value `root` for the root folder. + ParentFolderID string `json:"parentFolderId,omitempty"` + // The URI of the parent folder. + ParentFolderURI string `json:"parentFolderUri,omitempty"` + // The number of subfolders. + SubFolderCount string `json:"subFolderCount,omitempty"` + // The type of folder. Possible values include: + // + // - `draft` + // - `inbox` + // - `normal` (a system-generated folder) + // - `recyclebin` + // - `sentitems` + // - `custom` (a custom folder created by a user) + Type string `json:"type,omitempty"` + // The URI for the folder. + URI string `json:"uri,omitempty"` +} + +// FolderItemResponse results from a folder item request. +type FolderItemResponse struct { + // The last index position in the result set. + EndPosition string `json:"endPosition,omitempty"` + // A list of the envelopes in the specified folder or folders. + FolderItems []FolderItemV2 `json:"folderItems,omitempty"` + // The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. + NextURI string `json:"nextUri,omitempty"` + // The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. + PreviousURI string `json:"previousUri,omitempty"` + // The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`. + ResultSetSize string `json:"resultSetSize,omitempty"` + // The starting index position of the current result set. + StartPosition string `json:"startPosition,omitempty"` + // The total number of items in the result. + TotalRows string `json:"totalRows,omitempty"` +} + +// FolderItemV2 information about folder item results. +type FolderItemV2 struct { + // If the item is an envelope, this is the UTC DateTime when the envelope was completed. + CompletedDateTime *time.Time `json:"completedDateTime,omitempty"` + // The UTC DateTime when the item was created. + CreatedDateTime *time.Time `json:"createdDateTime,omitempty"` + // If the item is an envelope, this is the id of the envelope. + EnvelopeID string `json:"envelopeId,omitempty"` + // If the item is an envelope, this is the URI for retrieving it. + EnvelopeURI string `json:"envelopeUri,omitempty"` + // The date and time the envelope is set to expire. + ExpireDateTime *time.Time `json:"expireDateTime,omitempty"` + // The id of the folder. + FolderID string `json:"folderId,omitempty"` + // If the item is a subfolder, this is the URI for retrieving it. + FolderURI string `json:"folderUri,omitempty"` + // When **true**, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES). + Is21CFRPart11 DSBool `json:"is21CFRPart11,omitempty"` + // The name of the user who owns the folder. + OwnerName string `json:"ownerName,omitempty"` + // An array of recipient objects that provides details about the recipients of the envelope. + Recipients *Recipients `json:"recipients,omitempty"` + // Contains a URI for an endpoint that you can use to retrieve the recipients. + RecipientsURI string `json:"recipientsUri,omitempty"` + // The name of the sender's company. + SenderCompany string `json:"senderCompany,omitempty"` + // The sender's email address. + SenderEmail string `json:"senderEmail,omitempty"` + // The sender's name. + SenderName string `json:"senderName,omitempty"` + // The sender's id. + SenderUserID string `json:"senderUserId,omitempty"` + // The UTC DateTime when the envelope was sent. Read only. + SentDateTime *time.Time `json:"sentDateTime,omitempty"` + // Indicates the envelope status. Valid values are: + // + // * sent - The envelope is sent to the recipients. + // * created - The envelope is saved as a draft and can be modified and sent later. + Status string `json:"status,omitempty"` + // The subject of the envelope. + Subject string `json:"subject,omitempty"` + // The unique identifier of the template. If this is not provided, DocuSign will generate a value. + TemplateID string `json:"templateId,omitempty"` + // The URI for retrieving the template. + TemplateURI string `json:"templateUri,omitempty"` +} + +type FolderItemsResponse struct { + // The last index position in the result set. + EndPosition string `json:"endPosition,omitempty"` + // An array containing PowerForm data. + Envelopes []EnvelopeSummary `json:"envelopes,omitempty"` + // A list of folder objects. + Folders []Folder `json:"folders,omitempty"` + // The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. + NextURI string `json:"nextUri,omitempty"` + // The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. + PreviousURI string `json:"previousUri,omitempty"` + // The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`. + ResultSetSize string `json:"resultSetSize,omitempty"` + // The starting index position of the current result set. + StartPosition string `json:"startPosition,omitempty"` + // The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`. + TotalSetSize string `json:"totalSetSize,omitempty"` +} + +type FolderSharedItem struct { + // This object describes errors that occur. It is only valid for responses and ignored in requests. + ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` + // The id of the folder. + FolderID string `json:"folderId,omitempty"` + // The name of the folder. + Name string `json:"name,omitempty"` + // Information about the user who owns the folder. + Owner *UserInfo `json:"owner,omitempty"` + // The id of the parent folder. + ParentFolderID string `json:"parentFolderId,omitempty"` + // The URI for the parent folder. + ParentFolderURI string `json:"parentFolderUri,omitempty"` + // Indicates how the folder is shared. Valid values are: + // + // - `not_shared` + // - `shared_to` + Shared string `json:"shared,omitempty"` + // A list of groups that share the folder. + SharedGroups []MemberGroupSharedItem `json:"sharedGroups,omitempty"` + // A list of users that share the folder. + SharedUsers []UserSharedItem `json:"sharedUsers,omitempty"` + // A URI containing the user ID. + URI string `json:"uri,omitempty"` + // Information about the user associated with the folder. + User *UserInfo `json:"user,omitempty"` +} + +// FoldersRequest information for a folder request. +type FoldersRequest struct { + // A comma-separated list of envelope IDs. + EnvelopeIds []string `json:"envelopeIds,omitempty"` + // A list of folder objects. + Folders []Folder `json:"folders,omitempty"` + // The id of the folder that the envelope is being moved from. + FromFolderID string `json:"fromFolderId,omitempty"` +} + +// FoldersResponse folder management +type FoldersResponse struct { + // The last index position in the result set. + EndPosition string `json:"endPosition,omitempty"` + // A list of envelopes in this folder. + Envelopes []EnvelopeSummary `json:"envelopes,omitempty"` + // A list of folder objects. + Folders []Folder `json:"folders,omitempty"` + // The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. + NextURI string `json:"nextUri,omitempty"` + // The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. + PreviousURI string `json:"previousUri,omitempty"` + // The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`. + ResultSetSize string `json:"resultSetSize,omitempty"` + // The starting index position of the current result set. + StartPosition string `json:"startPosition,omitempty"` + // The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`. + TotalSetSize string `json:"totalSetSize,omitempty"` +} + +// ForgottenPasswordInformation is a complex element that has up to four Question/Answer pairs for forgotten password information. +type ForgottenPasswordInformation struct { + // The answer to the first forgotten password challenge question. + ForgottenPasswordAnswer1 string `json:"forgottenPasswordAnswer1,omitempty"` + // The answer to the second forgotten password challenge question. + ForgottenPasswordAnswer2 string `json:"forgottenPasswordAnswer2,omitempty"` + // The answer to the third forgotten password challenge question. + ForgottenPasswordAnswer3 string `json:"forgottenPasswordAnswer3,omitempty"` + // The answer to the fourth forgotten password challenge question. + ForgottenPasswordAnswer4 string `json:"forgottenPasswordAnswer4,omitempty"` + // The first challenge question presented to a user who has forgotten their password. + ForgottenPasswordQuestion1 string `json:"forgottenPasswordQuestion1,omitempty"` + // The second challenge question presented to a user who has forgotten their password. + ForgottenPasswordQuestion2 string `json:"forgottenPasswordQuestion2,omitempty"` + // The third challenge question presented to a user who has forgotten their password. + ForgottenPasswordQuestion3 string `json:"forgottenPasswordQuestion3,omitempty"` + // The fourth challenge question presented to a user who has forgotten their password. + ForgottenPasswordQuestion4 string `json:"forgottenPasswordQuestion4,omitempty"` +} + +type FormDataItem struct { + // This object describes errors that occur. It is only valid for responses and ignored in requests. + ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` + // The selected value in a list. + ListSelectedValue string `json:"listSelectedValue,omitempty"` + // The name of the form field. + Name string `json:"name,omitempty"` + // The initial value associated with the form field. + OriginalValue string `json:"originalValue,omitempty"` + // The current value associated with the form field. + Value string `json:"value,omitempty"` +} + +// FormulaTab is the value of a formula tab is calculated +// from the values of other +// number or date tabs in the document. +// When the recipient completes the underlying fields, +// the formula tab calculates and displays the result. +// +// The `formula` property of the tab +// contains the references +// to the underlying tabs. +// See [Calculated Fields][calculatedfields] +// in the DocuSign Support Center +// to learn more about formulas. +// +// If a formula tab contains +// a `paymentDetails` property, +// the tab is considered a payment item. +// See [Requesting Payments Along with Signatures][paymentguide] +// in the DocuSign Support Center +// to learn more about payments. +// +// [calculatedfields]: https://support.docusign.com/en/guides/ndse-user-guide-calculated-fields +// [paymentguide]: https://support.docusign.com/en/guides/requesting-payments-along-with-signatures +// +type FormulaTab struct { + TabBase + TabGuidedForm + TabPosition + TabStyle + TabValue + // + AnchorAllowWhiteSpaceInCharacters string `json:"anchorAllowWhiteSpaceInCharacters,omitempty"` + // + AnchorAllowWhiteSpaceInCharactersMetadata *PropertyMetadata `json:"anchorAllowWhiteSpaceInCharactersMetadata,omitempty"` + // When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. + // + // When an envelope is completed the information is only available to the sender through the Form Data link in the DocuSign Console. The information on the downloaded document remains masked by asterisks. + // + // This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. + ConcealValueOnDocument DSBool `json:"concealValueOnDocument,omitempty"` + // Metadata that indicates whether the `concealValueOnDocument` property is editable. + ConcealValueOnDocumentMetadata *PropertyMetadata `json:"concealValueOnDocumentMetadata,omitempty"` + // When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. + DisableAutoSize DSBool `json:"disableAutoSize,omitempty"` + // Metadata that indicates whether the `disableAutoSize` property is editable. + DisableAutoSizeMetadata *PropertyMetadata `json:"disableAutoSizeMetadata,omitempty"` + // Contains the formula + // for calculating the value of + // this tab. + // + // Use a tab's `tabLabel`, + // enclosed in brackets, + // to refer to it. + // + // For example, + // you want to present the total cost + // of two items, tax included. + // + // The cost of each item is stored + // in number tabs labeled Item1 and Item2. + // The tax rate is in a number tab + // labeled TaxRate. + // + // The formula string for this property + // would be: + // `([Item1] + [Item2]) * (1 + [TaxRate])` + // + // See [Calculated Fields][calculatedfields] + // in the DocuSign Support Center + // to learn more about formulas. + // + // Maximum Length: 2000 characters + // + // [calculatedfields]: https://support.docusign.com/en/guides/ndse-user-guide-calculated-fields + // + Formula string `json:"formula,omitempty"` + // Metadata indicating if the sender can edit the `formula` property. + FormulaMetadata *PropertyMetadata `json:"formulaMetadata,omitempty"` + // The height of the tab in pixels. + Height string `json:"height,omitempty"` + // Metadata that indicates whether the `height` property is editable. + HeightMetadata *PropertyMetadata `json:"heightMetadata,omitempty"` + // If this is a regular formula (no `paymentDetails` property is present): + // + // * **true**: The tab is hidden. + // * **false**: The tab is shown. + // + // If the formula is payment item (a `paymentDetails` property is present): + // + // * **true**: The tab is displayed as a payment. + // * **false**: The tab is displayed as a regular formula. + // + Hidden string `json:"hidden,omitempty"` + // Metadata that indicates whether the `hidden` property is editable. + HiddenMetadata *PropertyMetadata `json:"hiddenMetadata,omitempty"` + // Reserved for DocuSign. + IsPaymentAmountMetadata *PropertyMetadata `json:"isPaymentAmountMetadata,omitempty"` + // Reserved for DocuSign. + LocalePolicy *LocalePolicyTab `json:"localePolicy,omitempty"` + // When set to **true**, the signer cannot change the data of the custom tab. + Locked DSBool `json:"locked,omitempty"` + // Metadata that indicates whether the `locked` property is editable. + LockedMetadata *PropertyMetadata `json:"lockedMetadata,omitempty"` + // An optional value that describes the maximum length of the property when the property is a string. + MaxLength string `json:"maxLength,omitempty"` + // Metadata that indicates whether the `maxLength` property is editable. + MaxLengthMetadata *PropertyMetadata `json:"maxLengthMetadata,omitempty"` + // + MergeFieldXML string `json:"mergeFieldXml,omitempty"` + // The initial value of the tab when it was sent to the recipient. + OriginalValue string `json:"originalValue,omitempty"` + // Metadata that indicates whether the `originalValue` property is editable. + OriginalValueMetadata *PropertyMetadata `json:"originalValueMetadata,omitempty"` + // This property indicates + // that this formula tab + // is a payment item. + // See [Requesting Payments Along with Signatures][paymentguide] + // in the DocuSign Support Center + // to learn more about payments. + // + // [paymentguide]: https://support.docusign.com/en/guides/requesting-payments-along-with-signatures + // + PaymentDetails *PaymentDetails `json:"paymentDetails,omitempty"` + // When set to **true** and shared is true, information must be entered in this field to complete the envelope. + RequireAll DSBool `json:"requireAll,omitempty"` + // Metadata that indicates whether the `requireAll` property is editable. + RequireAllMetadata *PropertyMetadata `json:"requireAllMetadata,omitempty"` + // Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field. + RequireInitialOnSharedChange DSBool `json:"requireInitialOnSharedChange,omitempty"` + // Metadata that indicates whether the `requireInitialOnSharedChange` property is editable. + RequireInitialOnSharedChangeMetadata *PropertyMetadata `json:"requireInitialOnSharedChangeMetadata,omitempty"` + // When set to **true**, the signer is required to fill out this tab. + Required TabRequired `json:"required,omitempty"` + // Metadata that indicates whether the `required` property is editable. + RequiredMetadata *PropertyMetadata `json:"requiredMetadata,omitempty"` + // The number of decimal places to round to. + RoundDecimalPlaces string `json:"roundDecimalPlaces,omitempty"` + // Metadata that indicates whether the `roundDecimalPlaces` property is editable. + RoundDecimalPlacesMetadata *PropertyMetadata `json:"roundDecimalPlacesMetadata,omitempty"` + // When set to **true**, the sender must populate the tab before an envelope can be sent using the template. + // + // This value tab can only be changed by modifying (PUT) the template. + // + // Tabs with a `senderRequired` value of true cannot be deleted from an envelope. + SenderRequired DSBool `json:"senderRequired,omitempty"` + // Metadata that indicates whether the `senderRequired` property is editable. + SenderRequiredMetadata *PropertyMetadata `json:"senderRequiredMetadata,omitempty"` + // When set to **true**, this custom tab is shared. + Shared DSBool `json:"shared,omitempty"` + // Metadata that indicates whether the `shared` property is editable. + SharedMetadata *PropertyMetadata `json:"sharedMetadata,omitempty"` + // + SmartContractInformation *SmartContractInformation `json:"smartContractInformation,omitempty"` + // Metadata that indicates whether the `toolTip` property is editable. + ToolTipMetadata *PropertyMetadata `json:"toolTipMetadata,omitempty"` + // The text of a tooltip that appears when a user hovers over a form field or tab. + Tooltip string `json:"tooltip,omitempty"` + // The message displayed if the custom tab fails input validation (either custom of embedded). + ValidationMessage string `json:"validationMessage,omitempty"` + // Metadata that indicates whether the `validationMessage` property is editable. + ValidationMessageMetadata *PropertyMetadata `json:"validationMessageMetadata,omitempty"` + // A regular expression used to validate input for the tab. + ValidationPattern string `json:"validationPattern,omitempty"` + // Metadata that indicates whether the `validationPattern` property is editable. + ValidationPatternMetadata *PropertyMetadata `json:"validationPatternMetadata,omitempty"` + // The width of the tab in pixels. + Width string `json:"width,omitempty"` + // Metadata that indicates whether the `width` property is editable. + WidthMetadata *PropertyMetadata `json:"widthMetadata,omitempty"` +} + +// FullName is a tab that displays the recipient's full name. +// +type FullName struct { + TabBase + TabGuidedForm + TabPosition + TabStyle + TabValue + // + AnchorAllowWhiteSpaceInCharacters string `json:"anchorAllowWhiteSpaceInCharacters,omitempty"` + // + AnchorAllowWhiteSpaceInCharactersMetadata *PropertyMetadata `json:"anchorAllowWhiteSpaceInCharactersMetadata,omitempty"` + // The height of the tab in pixels. + Height string `json:"height,omitempty"` + // Metadata that indicates whether the `height` property is editable. + HeightMetadata *PropertyMetadata `json:"heightMetadata,omitempty"` + // Reserved for DocuSign. + LocalePolicy *LocalePolicyTab `json:"localePolicy,omitempty"` + // + MergeFieldXML string `json:"mergeFieldXml,omitempty"` + // + SmartContractInformation *SmartContractInformation `json:"smartContractInformation,omitempty"` + // Metadata that indicates whether the `toolTip` property is editable. + ToolTipMetadata *PropertyMetadata `json:"toolTipMetadata,omitempty"` + // The text of a tooltip that appears when a user hovers over a form field or tab. + Tooltip string `json:"tooltip,omitempty"` + // The width of the tab in pixels. + Width string `json:"width,omitempty"` + // Metadata that indicates whether the `width` property is editable. + WidthMetadata *PropertyMetadata `json:"widthMetadata,omitempty"` +} + +type GraphicsContext struct { + // The fill color to use for the overlay. Colors are typically specified by their RGB hex values, but you can also use a [friendly CSS color name](https://developer.mozilla.org/en-US/docs/Web/CSS/color_value). + FillColor string `json:"fillColor,omitempty"` + // The line color to use for the overlay. Colors are typically specified by their RGB hex values, but you can also use a [friendly CSS color name](https://developer.mozilla.org/en-US/docs/Web/CSS/color_value). + LineColor string `json:"lineColor,omitempty"` + // The line weight or thickness to use for the overlay. + LineWeight string `json:"lineWeight,omitempty"` +} + +// Group this object contains information about a group. +type Group struct { + // This object describes errors that occur. It is only valid for responses and ignored in requests. + ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` + // The DocuSign group ID for the group. + GroupID string `json:"groupId,omitempty"` + // The name of the group. + GroupName string `json:"groupName,omitempty"` + // The group type. + GroupType string `json:"groupType,omitempty"` + // The ID of the permission profile associated with the group. Possible values include: + // + // - `2301416` (for the `DocuSign Viewer` profile) + // - `2301415` (for the `DocuSign Sender` profile) + // - `2301414` (for the `Account Administrator` profile) + PermissionProfileID string `json:"permissionProfileId,omitempty"` + // A list of the users in the group. + Users []UserInfo `json:"users,omitempty"` + // The total number of users in the group. + UsersCount string `json:"usersCount,omitempty"` +} + +type GroupInformation struct { + // The last index position in the result set. + EndPosition string `json:"endPosition,omitempty"` + // A collection group objects containing information about the groups. + Groups []Group `json:"groups,omitempty"` + // The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. + NextURI string `json:"nextUri,omitempty"` + // The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. + PreviousURI string `json:"previousUri,omitempty"` + // The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`. + ResultSetSize string `json:"resultSetSize,omitempty"` + // The starting index position of the current result set. + StartPosition string `json:"startPosition,omitempty"` + // The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`. + TotalSetSize string `json:"totalSetSize,omitempty"` +} + +// IDCheckConfiguration is a complex object specifying ID check configuration. +type IDCheckConfiguration struct { + // A list of ID check security steps, each specifying an authorization type. + AuthSteps []IDCheckSecurityStep `json:"authSteps,omitempty"` + // Boolean that specifies whether the signature is the default signature for the user. + IsDefault string `json:"isDefault,omitempty"` + // The name of the signature. + Name string `json:"name,omitempty"` +} + +// IDCheckInformationInput is a complex element that contains input information related to a recipient ID check. +type IDCheckInformationInput struct { + // An object that specifies recipient address information and how it is displayed. + AddressInformationInput *AddressInformationInput `json:"addressInformationInput,omitempty"` + // An object that specifies recipient date of birth information and how it is displayed. + DobInformationInput *DobInformationInput `json:"dobInformationInput,omitempty"` + // An object that specifies the last four digits of the recipient's Social Security Number (SSN). + Ssn4InformationInput *Ssn4InformationInput `json:"ssn4InformationInput,omitempty"` + // An object that specifies the recipient's Social Security Number (SSN) information. Note that ssn9 information cannot be returned in a response. + Ssn9InformationInput *Ssn9InformationInput `json:"ssn9InformationInput,omitempty"` +} + +type IDCheckSecurityStep struct { + // Type of authorization used for the security check. + AuthType string `json:"authType,omitempty"` +} + +// InPersonSigner contains information about an in-person recipient. This is a DocuSign user, +// acting as a Signing Host, +// who is in the same physical location as the signer. +// To learn about the fields used +// for the eNotary feature, +// see the [EnvelopeRecipients resource][resource]. +// +// [resource]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipients#in-person-signer-recipient +// +type InPersonSigner struct { + // If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. + // + // Maximum Length: 50 characters and it must conform to the account's access code format setting. + // + // If blank, but the signer `accessCode` property is set in the envelope, then that value is used. + // + // If blank and the signer `accessCode` property is not set, then the access code is not required. + AccessCode string `json:"accessCode,omitempty"` + // Metadata that indicates whether the `accessCode` property is editable. Read only. + AccessCodeMetadata *PropertyMetadata `json:"accessCodeMetadata,omitempty"` + // Optional. When set to **true**, the access code will be added to the email sent to the recipient. This nullifies the security measure of `accessCode` on the recipient. + AddAccessCodeToEmail string `json:"addAccessCodeToEmail,omitempty"` + // + AllowSystemOverrideForLockedRecipient string `json:"allowSystemOverrideForLockedRecipient,omitempty"` + // When set to **true**, autonavigation is set for the recipient. + // + AutoNavigation string `json:"autoNavigation,omitempty"` + // When set to **true**, specifies that the signer can perform the signing ceremony offline. + CanSignOffline DSBool `json:"canSignOffline,omitempty"` + // Specifies whether the recipient is embedded or remote. + // + // If the `clientUserId` property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing. + // + // Note: if the `clientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true**, an error is generated on sending. + // + // Maximum length: 100 characters. + ClientUserID string `json:"clientUserId,omitempty"` + // Indicates the number of times that the recipient has been through a signing completion. + // + // If this number is greater than `0` for a signing group, only the user who previously completed may sign again. + CompletedCount string `json:"completedCount,omitempty"` + // The reason why the recipient was created (for example, `sender`). Read only. + CreationReason string `json:"creationReason,omitempty"` + // An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters. + CustomFields []string `json:"customFields,omitempty"` + // The date and time the recipient declined the document. Read only. + DeclinedDateTime *time.Time `json:"declinedDateTime,omitempty"` + // The reason the recipient declined the document. Read only. + DeclinedReason string `json:"declinedReason,omitempty"` + // When set to **true**, + // this is the default recipient for the envelope. + // This option is used when creating an envelope from a template. + // + DefaultRecipient DSBool `json:"defaultRecipient,omitempty"` + // The date and time that the envelope was delivered to the recipient. Read only. + DeliveredDateTime *time.Time `json:"deliveredDateTime,omitempty"` + // Reserved for DocuSign. + DeliveryMethod string `json:"deliveryMethod,omitempty"` + // Reserved for DocuSign. + DeliveryMethodMetadata *PropertyMetadata `json:"deliveryMethodMetadata,omitempty"` + // + DesignatorID string `json:"designatorId,omitempty"` + // + DesignatorIDGUID string `json:"designatorIdGuid,omitempty"` + // A list of `documentVisibility` objects. Each object in the list specifies whether a document in the envelope is visible to this recipient. For the envelope to use this functionality, Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true**. + DocumentVisibility []DocumentVisibility `json:"documentVisibility,omitempty"` + // The signer's email address in an eNotary flow. + // + // Use only when `inPersonSigningType` is `notary`. + // For regular in-person-signer flow, use `signerEmail` instead. + // + Email string `json:"email,omitempty"` + // Metadata that indicates whether the `email` property is editable. Read only. + EmailMetadata *PropertyMetadata `json:"emailMetadata,omitempty"` + // An optional complex type that sets a specific email subject and body for this recipient's notification email. + // + // **Note**: You can set the `emailNotification` property separately for each recipient. If you set the value only for certain recipients, the other recipients will inherit the this value from the top-level `emailSubject` and `emailBlurb`. + EmailNotification *RecipientEmailNotification `json:"emailNotification,omitempty"` + // Specifies a sender-provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. + // + // If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation launched by a partner. + // + // It is important to understand that in a typical embedded workflow, the authentication of an embedded recipient is the responsibility of the sending application. DocuSign expects that senders will follow their own processes for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process is initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process, bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. + // + // If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: `envelopeId`, `recipientId`, `recipientName`, `recipientEmail`, and `customFields`. The `customFields` property must be set for the recipient or envelope. The merge fields are enclosed in double brackets. + // + // *Example*: + // + // `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` + EmbeddedRecipientStartURL string `json:"embeddedRecipientStartURL,omitempty"` + // This object describes errors that occur. It is only valid for responses and ignored in requests. + ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` + // Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true** for the envelope to use this. + // + // When enforce signer visibility is enabled, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent. + ExcludedDocuments []string `json:"excludedDocuments,omitempty"` + // Reserved for DocuSign. + FaxNumber string `json:"faxNumber,omitempty"` + // Reserved for DocuSign. + FaxNumberMetadata *PropertyMetadata `json:"faxNumberMetadata,omitempty"` + // The email address of the signing host. + // This is the DocuSign user that is hosting the in-person signing session. + // + // Required when `inPersonSigningType` is `inPersonSigner`. + // For eNotary flow, use `email` instead. + // + // Maximum Length: 100 characters. + // + HostEmail string `json:"hostEmail,omitempty"` + // Metadata that indicates whether the `hostEmail` property is editable. + HostEmailMetadata *PropertyMetadata `json:"hostEmailMetadata,omitempty"` + // The name of the signing host. + // This is the DocuSign user that is hosting the in-person signing session. + // + // Required when `inPersonSigningType` is `inPersonSigner`. + // For eNotary flow, use `name` instead. + // + // Maximum Length: 100 characters. + // + HostName string `json:"hostName,omitempty"` + // Metadata that indicates whether the `hostName` property is editable. + HostNameMetadata *PropertyMetadata `json:"hostNameMetadata,omitempty"` + // The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are: + // + // - `Phone Auth $`: The recipient must authenticate by using two-factor authentication (2FA). You provide the phone number to use for 2FA in the `phoneAuthentication` object. + // - `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object. + // - `ID Check $`: The recipient must answer detailed security questions. + // + // **Example**: Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node. + IDCheckConfigurationName string `json:"idCheckConfigurationName,omitempty"` + // Metadata that indicates whether the `idCheckConfigurationName` property is editable. Read only. + IDCheckConfigurationNameMetadata *PropertyMetadata `json:"idCheckConfigurationNameMetadata,omitempty"` + // An object that contains input information related to a recipient ID check. + IDCheckInformationInput *IDCheckInformationInput `json:"idCheckInformationInput,omitempty"` + // Specifies the ID Verification workflow applied on an envelope by workflow ID.
See the [list](https://developers.docusign.com/docs/esign-rest-api/reference/Accounts/IdentityVerifications/list) method in the [IdentityVerifications](https://developers.docusign.com/docs/esign-rest-api/reference/Accounts/IdentityVerifications) resource for more information on how to retrieve workflow IDs available for an account.
This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods.
Note that ID Verification and ID Check are two distinct methods. ID Verification checks recipients' identity by verifying their ID while ID Check relies on data available on public records (such as current and former address). + IdentityVerification *RecipientIdentityVerification `json:"identityVerification,omitempty"` + // Specifies whether the envelope uses the eNotary feature. + // Valid values: + // + // * `inPersonSigner`: The envelope uses the normal in-person signing flow. + // * `notary`: The envelope uses the eNotary in-person signing flow. + // + InPersonSigningType string `json:"inPersonSigningType,omitempty"` + // Metadata that indicates whether the `inPersonSigningType` property is editable. + InPersonSigningTypeMetadata *PropertyMetadata `json:"inPersonSigningTypeMetadata,omitempty"` + // When set to **true** and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account. + InheritEmailNotificationConfiguration DSBool `json:"inheritEmailNotificationConfiguration,omitempty"` + // Reserved for DocuSign. + LockedRecipientPhoneAuthEditable string `json:"lockedRecipientPhoneAuthEditable,omitempty"` + // Reserved for DocuSign. + LockedRecipientSmsEditable string `json:"lockedRecipientSmsEditable,omitempty"` + // The signer's full legal name in an eNotary flow. + // + // Required when `inPersonSigningType` is `notary`. + // For a regular in-person-signer flow, use `signerName` instead. + // + // Maximum Length: 100 characters. + // + Name string `json:"name,omitempty"` + // Metadata that indicates whether the `name` property is editable. Read only. + NameMetadata *PropertyMetadata `json:"nameMetadata,omitempty"` + // Information about the notary host. The following information is required when using the eNotary in-person signing flow: + // + // - `name`: The name of the notary. + // - `email`: The email address of the notary. + // - `recipientId`: A unique ID number for the notary signing host. + NotaryHost *NotaryHost `json:"notaryHost,omitempty"` + // + NotaryID string `json:"notaryId,omitempty"` + // A note sent to the in-person signer in the signing email. + // This note is visible only to this recipient. + // + // Maximum Length: 1000 characters. + // + Note string `json:"note,omitempty"` + // Metadata that indicates whether the `note` property is editable. Read only. + NoteMetadata *PropertyMetadata `json:"noteMetadata,omitempty"` + // When `idCheckConfigurationName` is set to `Phone Auth $`, you use this complex type to provide the recipient authentication method details. It contains the following elements: + // + // * `recipMayProvideNumber`: Boolean. When set to **true**, the recipient can use whatever phone number they choose. + // * `senderProvidedNumbers`: ArrayOfStrings. A list of phone numbers the recipient can use. + // * `recordVoicePrint`: Reserved for DocuSign. + // * `validateRecipProvidedNumber`: Reserved for DocuSign. + // + // + PhoneAuthentication DSBool `json:"phoneAuthentication,omitempty"` + // Reserved for DocuSign. + RecipientAttachments []RecipientAttachment `json:"recipientAttachments,omitempty"` + // Information about the recipient's authentication status. Read only. + RecipientAuthenticationStatus *AuthenticationStatus `json:"recipientAuthenticationStatus,omitempty"` + // Metadata about the features that are supported for the recipient type. Read only. + RecipientFeatureMetadata []FeatureAvailableMetadata `json:"recipientFeatureMetadata,omitempty"` + // Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the document. + RecipientID string `json:"recipientId,omitempty"` + // The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only. + RecipientIDGUID string `json:"recipientIdGuid,omitempty"` + // The default signature provider is the DocuSign Electronic signature system. This parameter is used to specify one or more Standards Based Signature (digital signature) providers for the signer to use. [More information.](https://developers.docusign.com/esign-rest-api/guides/standards-based-signatures) + RecipientSignatureProviders []RecipientSignatureProvider `json:"recipientSignatureProviders,omitempty"` + // When set to **true**, specifies that the recipient creates the tabs. + RecipientSuppliesTabs string `json:"recipientSuppliesTabs,omitempty"` + // The recipient type, as specified by the following values: + // - `agent`: Agent recipients can add name and email information for recipients that appear after the agent in routing order. + // - `carbonCopy`: Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date, or add information to any of the documents. This type of recipient can be used in any routing order. + // - `certifiedDelivery`: Certified delivery recipients must receive the completed documents for the envelope to be completed. They don't need to sign, initial, date, or add information to any of the documents. + // - `editor`: Editors have the same management and access rights for the envelope as the sender. Editors can add name and email information, add or change the routing order, set authentication options, and can edit signature/initial tabs and data fields for the remaining recipients. + // - `inPersonSigner`: In-person recipients are DocuSign users who act as signing hosts in the same physical location as the signer. + // - `intermediaries`: Intermediary recipients can optionally add name and email information for recipients at the same or subsequent level in the routing order. + // - `seal`: Electronic seal recipients represent legal entities. + // - `signer`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope. + // - `witness`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope. + RecipientType string `json:"recipientType,omitempty"` + // Metadata that indicates whether the `recipientType` property is editable. Read only. + RecipientTypeMetadata *PropertyMetadata `json:"recipientTypeMetadata,omitempty"` + // When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. + RequireIDLookup DSBool `json:"requireIdLookup,omitempty"` + // Metadata that indicates whether the `requireIdLookup` property is editable. Read only. + RequireIDLookupMetadata *PropertyMetadata `json:"requireIdLookupMetadata,omitempty"` + // When set to **true**, the signer must print, sign, and upload or fax the signed documents to DocuSign. + RequireSignOnPaper DSBool `json:"requireSignOnPaper,omitempty"` + // By default, DocuSign signers create electronic signatures. This field can be used to require the signer to use a SAFE-BioPharma digital certificate for signing. + // + // This parameter should only be used to select a SAFE-BioPharma certificate. New integrations should use the `recipientSignatureProviders` parameter for other types of digital certificates. + // + // Set this parameter to `safe` to use a SAFE-BioPharma certificate. + // + // The signer must be enrolled in the SAFE program to sign with a SAFE certificate. + RequireSignerCertificate string `json:"requireSignerCertificate,omitempty"` + // When set to **true**, the signer is required to upload a new signature, even if they have a pre-adopted signature in their personal DocuSign account. + RequireUploadSignature string `json:"requireUploadSignature,omitempty"` + // Optional element. Specifies the role name associated with the recipient.

This property is required when you are working with template recipients. + RoleName string `json:"roleName,omitempty"` + // Specifies the routing order of the recipient in the envelope. + RoutingOrder string `json:"routingOrder,omitempty"` + // Metadata that indicates whether the `routingOrder` property is editable. Read only. + RoutingOrderMetadata *PropertyMetadata `json:"routingOrderMetadata,omitempty"` + // The UTC DateTime when the envelope was sent. Read only. + SentDateTime *time.Time `json:"sentDateTime,omitempty"` + // When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab (instead of adopting a signature/initial style or only drawing a signature/initial once). + SignInEachLocation DSBool `json:"signInEachLocation,omitempty"` + // Metadata that indicates whether the `signInEachLocation` property is editable. Read only. + SignInEachLocationMetadata *PropertyMetadata `json:"signInEachLocationMetadata,omitempty"` + // Allows the sender to pre-specify the signature name, signature initials and signature font used in the signature stamp for the recipient. + // + // Used only with recipient types In Person Signers and Signers. + SignatureInfo *RecipientSignatureInformation `json:"signatureInfo,omitempty"` + // Reserved for DocuSign. + SignedDateTime *time.Time `json:"signedDateTime,omitempty"` + // The in-person signer's email address. + // + // Required when `inPersonSigningType` is `inPersonSigner`. + // For eNotary flow, use `email` instead. + // + // Maximum Length: 100 characters. + // + // + SignerEmail string `json:"signerEmail,omitempty"` + // Metadata that indicates if the sender can edit the in-person signer's email address. + SignerEmailMetadata *PropertyMetadata `json:"signerEmailMetadata,omitempty"` + // The signer's first name. + SignerFirstName string `json:"signerFirstName,omitempty"` + // Metadata that indicates if the `signerFirstName` property is editable. + SignerFirstNameMetadata *PropertyMetadata `json:"signerFirstNameMetadata,omitempty"` + // The signer's last name. + SignerLastName string `json:"signerLastName,omitempty"` + // Metadata that indicates whether the `signerLastName` property is editable. + SignerLastNameMetadata *PropertyMetadata `json:"signerLastNameMetadata,omitempty"` + // Required. The full legal name of a signer for the envelope. + // + // Maximum Length: 100 characters. + // + // + // + SignerName string `json:"signerName,omitempty"` + // Metadata that indicates whether the `signerName` property is editable. + SignerNameMetadata *PropertyMetadata `json:"signerNameMetadata,omitempty"` + // Not applicable. You cannot use a signing group for an in-person signer. + SigningGroupID string `json:"signingGroupId,omitempty"` + // Not applicable. + SigningGroupIDMetadata *PropertyMetadata `json:"signingGroupIdMetadata,omitempty"` + // Not applicable. + SigningGroupName string `json:"signingGroupName,omitempty"` + // Not applicable. + SigningGroupUsers []UserInfo `json:"signingGroupUsers,omitempty"` + // When `idCheckConfigurationName` is set to `SMS Auth $`, you use this complex type to provide the recipient authentication method details. It contains the element `senderProvidedNumbers`, which is an array of phone numbers that the recipient can use for SMS text authentication. + // + // + SmsAuthentication *RecipientSMSAuthentication `json:"smsAuthentication,omitempty"` + // Deprecated. + SocialAuthentications []SocialAuthentication `json:"socialAuthentications,omitempty"` + // The recipient's status. Read only. + // + // Possible values: + // + // - `autoresponded`: The recipient's email system auto-responded to the email from DocuSign. This status is used in the web console to inform senders about the bounced-back email. This recipient status is only used if **Send-on-behalf-of** is turned off for the account. + // - `completed`: The recipient has completed their actions (signing or other required actions if not a signer) for an envelope. + // - `created`: The recipient is in a draft state. This value is only associated with draft envelopes (envelopes that have a status of `created`). + // - `declined`: The recipient declined to sign the document(s) in the envelope. + // - `delivered`: The recipient has viewed the document(s) in an envelope through the DocuSign signing website. This is not an email delivery of the documents in an envelope. + // - `faxPending`: The recipient has finished signing and the system is waiting for a fax attachment from the recipient before completing their signing step. + // - `sent`: The recipient has been sent an email notification that it is their turn to sign an envelope. + // - `signed`: The recipient has completed (signed) all required tags in an envelope. This is a temporary state during processing, after which the recipient's status automatically switches to `completed`. + Status string `json:"status,omitempty"` + // The code associated with the recipient's status. Read only. + StatusCode string `json:"statusCode,omitempty"` + // When set to **true**, email notifications are suppressed for the recipient, and they must access envelopes and documents from their DocuSign inbox. + SuppressEmails string `json:"suppressEmails,omitempty"` + // A list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients. + Tabs *Tabs `json:"tabs,omitempty"` + // When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. + TemplateLocked DSBool `json:"templateLocked,omitempty"` + // When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. + TemplateRequired DSBool `json:"templateRequired,omitempty"` + // The total number of tabs in the documents. Read only. + TotalTabCount string `json:"totalTabCount,omitempty"` + // The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing. + // + UserID string `json:"userId,omitempty"` +} + +// InitialHere is a tab that allows the recipient to initial the document. May +// be optional. +// +type InitialHere struct { + TabBase + TabGuidedForm + TabPosition + // + AnchorAllowWhiteSpaceInCharacters string `json:"anchorAllowWhiteSpaceInCharacters,omitempty"` + // + AnchorAllowWhiteSpaceInCharactersMetadata *PropertyMetadata `json:"anchorAllowWhiteSpaceInCharactersMetadata,omitempty"` + // The height of the tab in pixels. + Height string `json:"height,omitempty"` + // Metadata that indicates whether the `height` property is editable. + HeightMetadata *PropertyMetadata `json:"heightMetadata,omitempty"` + // + MergeFieldXML string `json:"mergeFieldXml,omitempty"` + // The name of the tab. For example, `Sign Here` or `Initial Here`. + Name string `json:"name,omitempty"` + // Metadata that indicates whether the `name` property is editable. Read only. + NameMetadata *PropertyMetadata `json:"nameMetadata,omitempty"` + // When set to **true**, the recipient does not need to complete this tab to complete the signing process. + Optional DSBool `json:"optional,omitempty"` + // Metadata that indicates whether the `optional` property is editable. + OptionalMetadata *PropertyMetadata `json:"optionalMetadata,omitempty"` + // Sets the size for the InitialHere tab. It can be value from 0.5 to 1.0, where 1.0 represents full size and 0.5 is 50% size. + ScaleValue string `json:"scaleValue,omitempty"` + // Metadata that indicates whether the `scaleValue` property is editable. + ScaleValueMetadata *PropertyMetadata `json:"scaleValueMetadata,omitempty"` + // + SmartContractInformation *SmartContractInformation `json:"smartContractInformation,omitempty"` + // Metadata that indicates whether the `toolTip` property is editable. + ToolTipMetadata *PropertyMetadata `json:"toolTipMetadata,omitempty"` + // The text of a tooltip that appears when a user hovers over a form field or tab. + Tooltip string `json:"tooltip,omitempty"` + // The width of the tab in pixels. + Width string `json:"width,omitempty"` + // Metadata that indicates whether the `width` property is editable. + WidthMetadata *PropertyMetadata `json:"widthMetadata,omitempty"` +} + +type InlineTemplate struct { + // An optional array of strings that enables the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each `customField` string can be a maximum of 100 characters. + CustomFields *CustomFields `json:"customFields,omitempty"` + // A complex element that contains details about the documents associated with the envelope. + Documents []Document `json:"documents,omitempty"` + // A container used to send documents to recipients. The envelope carries information about the sender and timestamps to indicate the progress of the delivery procedure. It can contain collections of Documents, Tabs and Recipients. + Envelope *Envelope `json:"envelope,omitempty"` + // An array of recipient objects that provides details about the recipients of the envelope. + Recipients *Recipients `json:"recipients,omitempty"` + // Specifies the order in which templates are overlaid. + Sequence string `json:"sequence,omitempty"` +} + +type IntegratedUserInfoList struct { + // + AllUsersSelected string `json:"allUsersSelected,omitempty"` + // The last index position in the result set. + EndPosition string `json:"endPosition,omitempty"` + // The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. + NextURI string `json:"nextUri,omitempty"` + // The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. + PreviousURI string `json:"previousUri,omitempty"` + // The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`. + ResultSetSize string `json:"resultSetSize,omitempty"` + // The starting index position of the current result set. + StartPosition string `json:"startPosition,omitempty"` + // The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`. + TotalSetSize string `json:"totalSetSize,omitempty"` + // User management information. + Users []UserInfo `json:"users,omitempty"` +} + +// Intermediary contains information about an intermediary recipient. An intermediary is a recipient who can, but is not required to, add name and email information for recipients at the same or subsequent level in the routing order, unless subsequent agents, editors or intermediaries are added. +type Intermediary struct { + // If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. + // + // Maximum Length: 50 characters and it must conform to the account's access code format setting. + // + // If blank, but the signer `accessCode` property is set in the envelope, then that value is used. + // + // If blank and the signer `accessCode` property is not set, then the access code is not required. + AccessCode string `json:"accessCode,omitempty"` + // Metadata that indicates whether the `accessCode` property is editable. Read only. + AccessCodeMetadata *PropertyMetadata `json:"accessCodeMetadata,omitempty"` + // Optional. When set to **true**, the access code will be added to the email sent to the recipient. This nullifies the security measure of `accessCode` on the recipient. + AddAccessCodeToEmail string `json:"addAccessCodeToEmail,omitempty"` + // An array of additional notification objects. + AdditionalNotifications []RecipientAdditionalNotification `json:"additionalNotifications,omitempty"` + // + AllowSystemOverrideForLockedRecipient string `json:"allowSystemOverrideForLockedRecipient,omitempty"` + // Specifies whether the recipient is embedded or remote. + // + // If the `clientUserId` property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing. + // + // Note: if the `clientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true**, an error is generated on sending. + // + // Maximum length: 100 characters. + ClientUserID string `json:"clientUserId,omitempty"` + // Indicates the number of times that the recipient has been through a signing completion for the envelope. If this number is greater than 0 for a signing group, only the user who previously completed may sign again. Read only. + CompletedCount string `json:"completedCount,omitempty"` + // An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters. + CustomFields []string `json:"customFields,omitempty"` + // The date and time the recipient declined the document. Read only. + DeclinedDateTime *time.Time `json:"declinedDateTime,omitempty"` + // The reason the recipient declined the document. Read only. + DeclinedReason string `json:"declinedReason,omitempty"` + // The date and time that the envelope was delivered to the recipient. Read only. + DeliveredDateTime *time.Time `json:"deliveredDateTime,omitempty"` + // Reserved for DocuSign. + DeliveryMethod string `json:"deliveryMethod,omitempty"` + // Reserved for DocuSign. + DeliveryMethodMetadata *PropertyMetadata `json:"deliveryMethodMetadata,omitempty"` + // + DesignatorID string `json:"designatorId,omitempty"` + // + DesignatorIDGUID string `json:"designatorIdGuid,omitempty"` + // A list of `documentVisibility` objects. Each object in the list specifies whether a document in the envelope is visible to this recipient. For the envelope to use this functionality, Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true**. + DocumentVisibility []DocumentVisibility `json:"documentVisibility,omitempty"` + // The recipient's email address. Notification of the document to sign is sent to this email address. + // + // Maximum length: 100 characters. + Email string `json:"email,omitempty"` + // Metadata that indicates whether the `email` property is editable. Read only. + EmailMetadata *PropertyMetadata `json:"emailMetadata,omitempty"` + // An optional complex type that sets a specific email subject and body for this recipient's notification email. + // + // **Note**: You can set the `emailNotification` property separately for each recipient. If you set the value only for certain recipients, the other recipients will inherit the this value from the top-level `emailSubject` and `emailBlurb`. + EmailNotification *RecipientEmailNotification `json:"emailNotification,omitempty"` + // Specifies a sender-provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. + // + // If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation launched by a partner. + // + // It is important to understand that in a typical embedded workflow, the authentication of an embedded recipient is the responsibility of the sending application. DocuSign expects that senders will follow their own processes for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process is initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process, bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. + // + // If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: `envelopeId`, `recipientId`, `recipientName`, `recipientEmail`, and `customFields`. The `customFields` property must be set for the recipient or envelope. The merge fields are enclosed in double brackets. + // + // *Example*: + // + // `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` + EmbeddedRecipientStartURL string `json:"embeddedRecipientStartURL,omitempty"` + // This object describes errors that occur. It is only valid for responses and ignored in requests. + ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` + // Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true** for the envelope to use this. + // + // When enforce signer visibility is enabled, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent. + ExcludedDocuments DSBool `json:"excludedDocuments,omitempty"` + // Reserved for DocuSign. + FaxNumber string `json:"faxNumber,omitempty"` + // Reserved for DocuSign. + FaxNumberMetadata *PropertyMetadata `json:"faxNumberMetadata,omitempty"` + // The recipient's first name. Maximum Length: 50 characters. + FirstName string `json:"firstName,omitempty"` + // Metadata that indicates whether the `firstame` property is editable. Read only. + FirstNameMetadata *PropertyMetadata `json:"firstNameMetadata,omitempty"` + // Reserved for DocuSign. + FullName string `json:"fullName,omitempty"` + // Reserved for DocuSign. + FullNameMetadata *PropertyMetadata `json:"fullNameMetadata,omitempty"` + // The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are: + // + // - `Phone Auth $`: The recipient must authenticate by using two-factor authentication (2FA). You provide the phone number to use for 2FA in the `phoneAuthentication` object. + // - `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object. + // - `ID Check $`: The recipient must answer detailed security questions. + // + // **Example**: Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node. + IDCheckConfigurationName string `json:"idCheckConfigurationName,omitempty"` + // Metadata that indicates whether the `idCheckConfigurationName` property is editable. Read only. + IDCheckConfigurationNameMetadata *PropertyMetadata `json:"idCheckConfigurationNameMetadata,omitempty"` + // An object that contains input information related to a recipient ID check. + IDCheckInformationInput *IDCheckInformationInput `json:"idCheckInformationInput,omitempty"` + // Specifies the ID Verification workflow applied on an envelope by workflow ID.
See the [list](https://developers.docusign.com/docs/esign-rest-api/reference/Accounts/IdentityVerifications/list) method in the [IdentityVerifications](https://developers.docusign.com/docs/esign-rest-api/reference/Accounts/IdentityVerifications) resource for more information on how to retrieve workflow IDs available for an account.
This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods.
Note that ID Verification and ID Check are two distinct methods. ID Verification checks recipients' identity by verifying their ID while ID Check relies on data available on public records (such as current and former address). + IdentityVerification *RecipientIdentityVerification `json:"identityVerification,omitempty"` + // When set to **true** and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account. + InheritEmailNotificationConfiguration DSBool `json:"inheritEmailNotificationConfiguration,omitempty"` + // The recipient's last name. + LastName string `json:"lastName,omitempty"` + // Metadata that indicates whether the `lastName` property is editable. Read only. + LastNameMetadata *PropertyMetadata `json:"lastNameMetadata,omitempty"` + // Reserved for DocuSign. + LockedRecipientPhoneAuthEditable string `json:"lockedRecipientPhoneAuthEditable,omitempty"` + // Reserved for DocuSign. + LockedRecipientSmsEditable string `json:"lockedRecipientSmsEditable,omitempty"` + // The full legal name of the recipient. Maximum Length: 100 characters. + // + // **Note**: You must always set a value for this property in requests, even if `firstName` and `lastName` are set. + Name string `json:"name,omitempty"` + // Metadata that indicates whether the `name` property is editable. Read only. + NameMetadata *PropertyMetadata `json:"nameMetadata,omitempty"` + // A note sent to the recipient in the signing email. + // This note is unique to this recipient. + // In the user interface, + // it appears near the upper left corner + // of the document + // on the signing screen. + // + // Maximum Length: 1000 characters. + // + Note string `json:"note,omitempty"` + // Metadata that indicates whether the `note` property is editable. Read only. + NoteMetadata *PropertyMetadata `json:"noteMetadata,omitempty"` + // When `idCheckConfigurationName` is set to `Phone Auth $`, you use this complex type to provide the recipient authentication method details. It contains the following elements: + // + // * `recipMayProvideNumber`: Boolean. When set to **true**, the recipient can use whatever phone number they choose. + // * `senderProvidedNumbers`: ArrayOfStrings. A list of phone numbers the recipient can use. + // * `recordVoicePrint`: Reserved for DocuSign. + // * `validateRecipProvidedNumber`: Reserved for DocuSign. + // + // + PhoneAuthentication DSBool `json:"phoneAuthentication,omitempty"` + // Reserved for DocuSign. + RecipientAttachments []RecipientAttachment `json:"recipientAttachments,omitempty"` + // Information about the recipient's authentication status. Read only. + RecipientAuthenticationStatus *AuthenticationStatus `json:"recipientAuthenticationStatus,omitempty"` + // Metadata about the features that are supported for the recipient type. Read only. + RecipientFeatureMetadata []FeatureAvailableMetadata `json:"recipientFeatureMetadata,omitempty"` + // Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the document. + RecipientID string `json:"recipientId,omitempty"` + // The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only. + RecipientIDGUID string `json:"recipientIdGuid,omitempty"` + // The recipient type, as specified by the following values: + // - `agent`: Agent recipients can add name and email information for recipients that appear after the agent in routing order. + // - `carbonCopy`: Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date, or add information to any of the documents. This type of recipient can be used in any routing order. + // - `certifiedDelivery`: Certified delivery recipients must receive the completed documents for the envelope to be completed. They don't need to sign, initial, date, or add information to any of the documents. + // - `editor`: Editors have the same management and access rights for the envelope as the sender. Editors can add name and email information, add or change the routing order, set authentication options, and can edit signature/initial tabs and data fields for the remaining recipients. + // - `inPersonSigner`: In-person recipients are DocuSign users who act as signing hosts in the same physical location as the signer. + // - `intermediaries`: Intermediary recipients can optionally add name and email information for recipients at the same or subsequent level in the routing order. + // - `seal`: Electronic seal recipients represent legal entities. + // - `signer`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope. + // - `witness`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope. + RecipientType string `json:"recipientType,omitempty"` + // Metadata that indicates whether the `recipientType` property is editable. Read only. + RecipientTypeMetadata *PropertyMetadata `json:"recipientTypeMetadata,omitempty"` + // When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. + RequireIDLookup DSBool `json:"requireIdLookup,omitempty"` + // Metadata that indicates whether the `requireIdLookup` property is editable. Read only. + RequireIDLookupMetadata *PropertyMetadata `json:"requireIdLookupMetadata,omitempty"` + // Optional element. Specifies the role name associated with the recipient.

This property is required when you are working with template recipients. + RoleName string `json:"roleName,omitempty"` + // Specifies the routing order of the recipient in the envelope. + RoutingOrder string `json:"routingOrder,omitempty"` + // Metadata that indicates whether the `routingOrder` property is editable. Read only. + RoutingOrderMetadata *PropertyMetadata `json:"routingOrderMetadata,omitempty"` + // The UTC DateTime when the envelope was sent. Read only. + SentDateTime *time.Time `json:"sentDateTime,omitempty"` + // Reserved for DocuSign. + SignedDateTime *time.Time `json:"signedDateTime,omitempty"` + // When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once). + SigningGroupID string `json:"signingGroupId,omitempty"` + // Metadata that indicates whether the `signingGroupId` property is editable. Read only. + SigningGroupIDMetadata *PropertyMetadata `json:"signingGroupIdMetadata,omitempty"` + // Optional. The name of the signing group. + // + // Maximum Length: 100 characters. + SigningGroupName string `json:"signingGroupName,omitempty"` + // A complex type that contains information about users in the signing group. + SigningGroupUsers []UserInfo `json:"signingGroupUsers,omitempty"` + // When `idCheckConfigurationName` is set to `SMS Auth $`, you use this complex type to provide the recipient authentication method details. It contains the element `senderProvidedNumbers`, which is an array of phone numbers that the recipient can use for SMS text authentication. + // + // + SmsAuthentication *RecipientSMSAuthentication `json:"smsAuthentication,omitempty"` + // Deprecated. + SocialAuthentications []SocialAuthentication `json:"socialAuthentications,omitempty"` + // The recipient's status. Read only. + // + // Possible values: + // + // - `autoresponded`: The recipient’s email system auto-responded to the email from DocuSign. This status is used in the web console to inform senders about the bounced-back email. This recipient status is only used if **Send-on-behalf-of** is turned off for the account. + // - `completed`: The recipient has completed their actions (signing or other required actions if not a signer) for an envelope. + // - `created`: The recipient is in a draft state. This value is only associated with draft envelopes (envelopes that have a status of `created`). + // - `declined`: The recipient declined to sign the document(s) in the envelope. + // - `delivered`: The recipient has viewed the document(s) in an envelope through the DocuSign signing website. This is not an email delivery of the documents in an envelope. + // - `faxPending`: The recipient has finished signing and the system is waiting for a fax attachment from the recipient before completing their signing step. + // - `sent`: The recipient has been sent an email notification that it is their turn to sign an envelope. + // - `signed`: The recipient has completed (signed) all required tags in an envelope. This is a temporary state during processing, after which the recipient's status automatically switches to `completed`. + // + Status string `json:"status,omitempty"` + // The code associated with the recipient's status. Read only. + StatusCode string `json:"statusCode,omitempty"` + // When set to **true**, email notifications are suppressed for the recipient, and they must access envelopes and documents from their DocuSign inbox. + SuppressEmails string `json:"suppressEmails,omitempty"` + // When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. + TemplateLocked DSBool `json:"templateLocked,omitempty"` + // When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. + TemplateRequired DSBool `json:"templateRequired,omitempty"` + // The total number of tabs in the documents. Read only. + TotalTabCount string `json:"totalTabCount,omitempty"` + // The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing. + // + UserID string `json:"userId,omitempty"` +} + +// Jurisdiction describes the jurisdiction of a notary. +// This is read-only object. +type Jurisdiction struct { + // If **true**, the seal can be generated by the platform. + AllowSystemCreatedSeal DSBool `json:"allowSystemCreatedSeal,omitempty"` + // If **true**, the seal can be uploaded by the user. + AllowUserUploadedSeal DSBool `json:"allowUserUploadedSeal,omitempty"` + // If **true**, the notary's `comissionId` appears in the seal. + CommissionIDInSeal DSBool `json:"commissionIdInSeal,omitempty"` + // The county of the jurisdiction. + County string `json:"county,omitempty"` + // If **true**, the county name appears in the seal. + CountyInSeal DSBool `json:"countyInSeal,omitempty"` + // If **true**, this jurisdiction is enabled. + Enabled DSBool `json:"enabled,omitempty"` + // The ID of the jurisdiction. + // The following jurisdictions + // are supported: + // + // - `5 - California` + // - `6 - Colorado` + // - `9 - Florida` + // - `10 - Georgia` + // - `12 - Idaho` + // - `13 - Illinois` + // - `14 - Indiana` + // - `15 - Iowa` + // - `17 - Kentucky` + // - `23 - Minnesota` + // - `25 - Missouri` + // - `30 - New Jersey` + // - `32 - New York` + // - `33 - North Carolina` + // - `35 - Ohio` + // - `37 - Oregon` + // - `38 - Pennsylvania` + // - `40 - South Carolina` + // - `43 - Texas` + // - `44 - Utah` + // - `47 - Washington` + // - `48 - West Virginia` + // - `49 - Wisconsin` + // - `62 - Florida Commissioner of Deeds` + // + JurisdictionID string `json:"jurisdictionId,omitempty"` + // The name of the jurisdiction. Typically the state name. + Name string `json:"name,omitempty"` + // If **true**, the name of the notary appears in the seal. + NotaryPublicInSeal DSBool `json:"notaryPublicInSeal,omitempty"` + // If **true**, the name of the state appears in the seal. + StateNameInSeal DSBool `json:"stateNameInSeal,omitempty"` +} + +// LastName is a tab that displays the recipient's last name. This tab +// takes the recipient's name as entered in the recipient +// information, splits it into sections based on spaces and +// uses the last section as the last name. +// +type LastName struct { + TabBase + TabGuidedForm + TabPosition + TabStyle + TabValue + // + AnchorAllowWhiteSpaceInCharacters string `json:"anchorAllowWhiteSpaceInCharacters,omitempty"` + // + AnchorAllowWhiteSpaceInCharactersMetadata *PropertyMetadata `json:"anchorAllowWhiteSpaceInCharactersMetadata,omitempty"` + // The height of the tab in pixels. + Height string `json:"height,omitempty"` + // Metadata that indicates whether the `height` property is editable. + HeightMetadata *PropertyMetadata `json:"heightMetadata,omitempty"` + // Reserved for DocuSign. + LocalePolicy *LocalePolicyTab `json:"localePolicy,omitempty"` + // + MergeFieldXML string `json:"mergeFieldXml,omitempty"` + // + SmartContractInformation *SmartContractInformation `json:"smartContractInformation,omitempty"` + // Metadata that indicates whether the `toolTip` property is editable. + ToolTipMetadata *PropertyMetadata `json:"toolTipMetadata,omitempty"` + // The text of a tooltip that appears when a user hovers over a form field or tab. + Tooltip string `json:"tooltip,omitempty"` + // The width of the tab in pixels. + Width string `json:"width,omitempty"` + // Metadata that indicates whether the `width` property is editable. + WidthMetadata *PropertyMetadata `json:"widthMetadata,omitempty"` +} + +// List this tab offers a list of options to choose from. +// The `listItems` +// property contains a list of +// [`listItem`](https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/) +// objects to specify the selectable options. +// +type List struct { + TabBase + TabGuidedForm + TabPosition + TabValue + // + AnchorAllowWhiteSpaceInCharacters string `json:"anchorAllowWhiteSpaceInCharacters,omitempty"` + // + AnchorAllowWhiteSpaceInCharactersMetadata *PropertyMetadata `json:"anchorAllowWhiteSpaceInCharactersMetadata,omitempty"` + // When set to **true**, the information in the tab is bold. + Bold string `json:"bold,omitempty"` + // Metadata that indicates whether the `bold` property is editable. + BoldMetadata *PropertyMetadata `json:"boldMetadata,omitempty"` + // The font to be used for the tab value. Supported fonts include: + // + // - Default + // - Arial + // - ArialNarrow + // - Calibri + // - CourierNew + // - Garamond + // - Georgia + // - Helvetica + // - LucidaConsole + // - MSGothic + // - MSMincho + // - OCR-A + // - Tahoma + // - TimesNewRoman + // - Trebuchet + // - Verdana + // + Font string `json:"font,omitempty"` + // The font color to use for the information in the tab. Possible values are: + // + // - Black + // - BrightBlue + // - BrightRed + // - DarkGreen + // - DarkRed + // - Gold + // - Green + // - NavyBlue + // - Purple + // - White + // + FontColor string `json:"fontColor,omitempty"` + // Metadata that indicates whether the `fontColor` property is editable. + FontColorMetadata *PropertyMetadata `json:"fontColorMetadata,omitempty"` + // Metadata that indicates whether the `font` property is editable. + FontMetadata *PropertyMetadata `json:"fontMetadata,omitempty"` + // The font size used for the information in the tab. Possible values are: + // + // - Size7 + // - Size8 + // - Size9 + // - Size10 + // - Size11 + // - Size12 + // - Size14 + // - Size16 + // - Size18 + // - Size20 + // - Size22 + // - Size24 + // - Size26 + // - Size28 + // - Size36 + // - Size48 + // - Size72 + FontSize string `json:"fontSize,omitempty"` + // Metadata that indicates whether the `fontSize` property is editable. + FontSizeMetadata *PropertyMetadata `json:"fontSizeMetadata,omitempty"` + // The height of the tab in pixels. + Height string `json:"height,omitempty"` + // Metadata that indicates whether the `height` property is editable. + HeightMetadata *PropertyMetadata `json:"heightMetadata,omitempty"` + // When set to **true**, the information in the tab is italic. + Italic string `json:"italic,omitempty"` + // Metadata that indicates whether the `italic` property is editable. + ItalicMetadata *PropertyMetadata `json:"italicMetadata,omitempty"` + // The list of values that can be selected by senders. The list values are separated by semi-colons. Example: [one;two;three;four] + // + // Maximum Length of listItems: 2048 characters. + // Maximum Length of items in the list: 100 characters. + // + ListItems []ListItem `json:"listItems,omitempty"` + // The value in the list that is selected by default. + ListSelectedValue string `json:"listSelectedValue,omitempty"` + // Metadata that indicates whether the `listSelectedValue` property is editable. + ListSelectedValueMetadata *PropertyMetadata `json:"listSelectedValueMetadata,omitempty"` + // Reserved for DocuSign. + LocalePolicy *LocalePolicyTab `json:"localePolicy,omitempty"` + // When set to **true**, the signer cannot change the data of the custom tab. + Locked DSBool `json:"locked,omitempty"` + // Metadata that indicates whether the `locked` property is editable. + LockedMetadata *PropertyMetadata `json:"lockedMetadata,omitempty"` + // + MergeFieldXML string `json:"mergeFieldXml,omitempty"` + // When set to **true** and shared is true, information must be entered in this field to complete the envelope. + RequireAll DSBool `json:"requireAll,omitempty"` + // Metadata that indicates whether the `requireAll` property is editable. + RequireAllMetadata *PropertyMetadata `json:"requireAllMetadata,omitempty"` + // Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field. + RequireInitialOnSharedChange DSBool `json:"requireInitialOnSharedChange,omitempty"` + // Metadata that indicates whether the `requireInitialOnSharedChange` property is editable. + RequireInitialOnSharedChangeMetadata *PropertyMetadata `json:"requireInitialOnSharedChangeMetadata,omitempty"` + // When set to **true**, the signer is required to fill out this tab. + Required TabRequired `json:"required,omitempty"` + // Metadata that indicates whether the `required` property is editable. + RequiredMetadata *PropertyMetadata `json:"requiredMetadata,omitempty"` + // When set to **true**, the sender must populate the tab before an envelope can be sent using the template. + // + // This value tab can only be changed by modifying (PUT) the template. + // + // Tabs with a `senderRequired` value of true cannot be deleted from an envelope. + SenderRequired DSBool `json:"senderRequired,omitempty"` + // Metadata that indicates whether the `senderRequired` property is editable. + SenderRequiredMetadata *PropertyMetadata `json:"senderRequiredMetadata,omitempty"` + // When set to **true**, this custom tab is shared. + Shared DSBool `json:"shared,omitempty"` + // Metadata that indicates whether the `shared` property is editable. + SharedMetadata *PropertyMetadata `json:"sharedMetadata,omitempty"` + // + SmartContractInformation *SmartContractInformation `json:"smartContractInformation,omitempty"` + // Metadata that indicates whether the `toolTip` property is editable. + ToolTipMetadata *PropertyMetadata `json:"toolTipMetadata,omitempty"` + // The text of a tooltip that appears when a user hovers over a form field or tab. + Tooltip string `json:"tooltip,omitempty"` + // When set to **true**, the information in the tab is underlined. + Underline string `json:"underline,omitempty"` + // Metadata that indicates whether the `underline` property is editable. + UnderlineMetadata *PropertyMetadata `json:"underlineMetadata,omitempty"` + // The width of the tab in pixels. + Width string `json:"width,omitempty"` + // Metadata that indicates whether the `width` property is editable. + WidthMetadata *PropertyMetadata `json:"widthMetadata,omitempty"` +} + +// ListCustomField this object represents a list custom field from which envelope creators and senders can select custom data. +type ListCustomField struct { + // If you are using merge fields, this property specifies the type of the merge field. The only supported value is `salesforce`. + ConfigurationType string `json:"configurationType,omitempty"` + // This object describes errors that occur. It is only valid for responses and ignored in requests. + ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` + // The id of the custom field. + FieldID string `json:"fieldId,omitempty"` + // An array of strings that represents the options in a list. + // + // Maximum length: 2048 characters, but each individual option string can only be a maximum of 100 characters. + ListItems []string `json:"listItems,omitempty"` + // The name of the custom field. + Name string `json:"name,omitempty"` + // When set to **true**, senders are required to select an option from the list before they can send the envelope. + Required TabRequired `json:"required,omitempty"` + // When set to **true**, the field displays in the **Envelope Custom Fields** section when a user creates or sends an envelope. + Show DSBool `json:"show,omitempty"` + // The value of the custom field. This is the value that the user who creates or sends the envelope selects from the list. + Value string `json:"value,omitempty"` +} + +// ListItem one of the selectable items +// in the `listItems` property +// of a [`list`](https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/) tab. +type ListItem struct { + // When set to **true**, indicates that this item is the default selection shown to a signer. + // + // Only one selection can be set as the default. + Selected DSBool `json:"selected,omitempty"` + // Metadata that indicates whether the `selected` property is editable. + SelectedMetadata *PropertyMetadata `json:"selectedMetadata,omitempty"` + // Specifies the text that is shown in the dropdown list. + Text string `json:"text,omitempty"` + // + TextMetadata *PropertyMetadata `json:"textMetadata,omitempty"` + // Specifies the value that is used when the list item is selected. + Value string `json:"value,omitempty"` + // Metadata that indicates whether the `value` property is editable. + ValueMetadata *PropertyMetadata `json:"valueMetadata,omitempty"` +} + +type LocalePolicy struct { + // + AddressFormat string `json:"addressFormat,omitempty"` + // + AddressFormatMetadata *SettingsMetadata `json:"addressFormatMetadata,omitempty"` + // + AllowRegion string `json:"allowRegion,omitempty"` + // + CalendarType string `json:"calendarType,omitempty"` + // + CalendarTypeMetadata *SettingsMetadata `json:"calendarTypeMetadata,omitempty"` + // + CultureName string `json:"cultureName,omitempty"` // - // * sent - The envelope is sent to the recipients. - // * created - The envelope is saved as a draft and can be modified and sent later. - Status string `json:"status,omitempty"` - // Used to identify an envelope. The id is a sender-generated value and is valid in the DocuSign system for 7 days. It is recommended that a transaction ID is used for offline signing to ensure that an envelope is not sent multiple times. The `transactionId` property can be used determine an envelope's status (i.e. was it created or not) in cases where the internet connection was lost before the envelope status was returned. - TransactionID string `json:"transactionId,omitempty"` -} - -type EnvelopeTransferRule struct { + CultureNameMetadata *SettingsMetadata `json:"cultureNameMetadata,omitempty"` + // The currency code for the account, based on the [ISO 4217 currency code](https://www.iso.org/iso-4217-currency-codes.html). + CurrencyCode string `json:"currencyCode,omitempty"` + // Metadata that indicates whether the `currencyCode` property is editable. + CurrencyCodeMetadata *SettingsMetadata `json:"currencyCodeMetadata,omitempty"` // - CarbonCopyOriginalOwner string `json:"carbonCopyOriginalOwner,omitempty"` + CurrencyNegativeFormat string `json:"currencyNegativeFormat,omitempty"` // - Enabled string `json:"enabled,omitempty"` + CurrencyNegativeFormatMetadata *SettingsMetadata `json:"currencyNegativeFormatMetadata,omitempty"` // - EnvelopeTransferRuleID string `json:"envelopeTransferRuleId,omitempty"` + CurrencyPositiveFormat string `json:"currencyPositiveFormat,omitempty"` // - EventType string `json:"eventType,omitempty"` + CurrencyPositiveFormatMetadata *SettingsMetadata `json:"currencyPositiveFormatMetadata,omitempty"` // - FromGroup *Group `json:"fromGroup,omitempty"` + CustomDateFormat string `json:"customDateFormat,omitempty"` // - FromUser *UserInformation `json:"fromUser,omitempty"` - // Most recent date on which this user record was modified. - ModifiedDate string `json:"modifiedDate,omitempty"` + CustomSignDateFormat string `json:"customSignDateFormat,omitempty"` // - ModifiedUser *UserInformation `json:"modifiedUser,omitempty"` + CustomSignTimeFormat string `json:"customSignTimeFormat,omitempty"` // - ToFolder *Folder `json:"toFolder,omitempty"` + CustomTimeFormat string `json:"customTimeFormat,omitempty"` // - ToUser *UserInformation `json:"toUser,omitempty"` -} - -type EnvelopeTransferRuleInformation struct { - // The last position in the result set. - EndPosition string `json:"endPosition,omitempty"` + DateFormat string `json:"dateFormat,omitempty"` // - EnvelopeTransferRules []EnvelopeTransferRule `json:"envelopeTransferRules,omitempty"` - // The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. - NextURI string `json:"nextUri,omitempty"` - // The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. - PreviousURI string `json:"previousUri,omitempty"` - // The number of results returned in this response. Because you can filter which entries are included in the response, this value is always less than or equal to `totalSetSize`. - ResultSetSize string `json:"resultSetSize,omitempty"` - // The starting position of the current result set. - StartPosition string `json:"startPosition,omitempty"` - // The total number of items in the search's result set. This value is always greater than or equal to the value of `resultSetSize`. - TotalSetSize string `json:"totalSetSize,omitempty"` -} - -type EnvelopeTransferRuleRequest struct { + DateFormatMetadata *SettingsMetadata `json:"dateFormatMetadata,omitempty"` // - CarbonCopyOriginalOwner string `json:"carbonCopyOriginalOwner,omitempty"` + EffectiveAddressFormat string `json:"effectiveAddressFormat,omitempty"` // - Enabled string `json:"enabled,omitempty"` + EffectiveCalendarType string `json:"effectiveCalendarType,omitempty"` // - EnvelopeTransferRuleID string `json:"envelopeTransferRuleId,omitempty"` + EffectiveCurrencyCode string `json:"effectiveCurrencyCode,omitempty"` // - EventType string `json:"eventType,omitempty"` + EffectiveCurrencyNegativeFormat string `json:"effectiveCurrencyNegativeFormat,omitempty"` // - FromGroups []Group `json:"fromGroups,omitempty"` + EffectiveCurrencyPositiveFormat string `json:"effectiveCurrencyPositiveFormat,omitempty"` // - FromUsers []UserInformation `json:"fromUsers,omitempty"` - // Most recent date on which this user record was modified. - ModifiedDate string `json:"modifiedDate,omitempty"` + EffectiveCustomDateFormat string `json:"effectiveCustomDateFormat,omitempty"` // - ModifiedUser *UserInformation `json:"modifiedUser,omitempty"` + EffectiveCustomTimeFormat string `json:"effectiveCustomTimeFormat,omitempty"` // - ToFolder *Folder `json:"toFolder,omitempty"` + EffectiveDateFormat string `json:"effectiveDateFormat,omitempty"` // - ToUser *UserInformation `json:"toUser,omitempty"` -} - -type EnvelopeUpdateSummary struct { + EffectiveInitialFormat string `json:"effectiveInitialFormat,omitempty"` // - BulkEnvelopeStatus *BulkEnvelopeStatus `json:"bulkEnvelopeStatus,omitempty"` - // The envelope ID of the envelope status that failed to post. - EnvelopeID string `json:"envelopeId,omitempty"` - // This object describes errors that occur. It is only valid for responses and ignored in requests. - ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` + EffectiveNameFormat string `json:"effectiveNameFormat,omitempty"` // - ListCustomFieldUpdateResults []ListCustomField `json:"listCustomFieldUpdateResults,omitempty"` - // Provides lock information about an envelope that a user has locked. - LockInformation *LockInformation `json:"lockInformation,omitempty"` - // Shows the current purge state for the envelope. The possible values are: + EffectiveTimeFormat string `json:"effectiveTimeFormat,omitempty"` // - // * `unpurged`: There has been no successful request to purge documents. - // * `documents_queued`: The envelope documents have been added to the purge queue, but have not been purged. - // * `documents_dequeued`: The envelope documents have been taken out of the purge queue. - // * `documents_and_metadata_queued`: The envelope documents and metadata have been added to the purge queue, but have not yet been purged. - // * `documents_purged`: The envelope documents have been successfully purged. - // * `documents_and_metadata_purged`: The envelope documents and metadata have been successfully purged. + EffectiveTimeZone string `json:"effectiveTimeZone,omitempty"` // + InitialFormat string `json:"initialFormat,omitempty"` // - PurgeState string `json:"purgeState,omitempty"` - // An array of `recipientUpdateResults` objects that contain details about the recipients. - RecipientUpdateResults []RecipientUpdateResponse `json:"recipientUpdateResults,omitempty"` + InitialFormatMetadata *SettingsMetadata `json:"initialFormatMetadata,omitempty"` // - TabUpdateResults *Tabs `json:"tabUpdateResults,omitempty"` + NameFormat string `json:"nameFormat,omitempty"` // - TextCustomFieldUpdateResults []TextCustomField `json:"textCustomFieldUpdateResults,omitempty"` -} - -// EnvelopesInformation result set for the Envelopes: listStatusChanges method -type EnvelopesInformation struct { - // A token returned by an earlier API call that you can use with a new call to resume a search query at the point where it left off. This token system enhances the performance of the API. - ContinuationToken string `json:"continuationToken,omitempty"` - // The last position in the result set. - EndPosition string `json:"endPosition,omitempty"` - // Array of envelope statuses and transaction IDs in the result set. - EnvelopeTransactionStatuses []EnvelopeTransactionStatus `json:"envelopeTransactionStatuses,omitempty"` - // Set of envelope information - Envelopes []Envelope `json:"envelopes,omitempty"` - // A collection of folder objects returned in a response. - Folders []Folder `json:"folders,omitempty"` - // The last time that a query was performed. - LastQueriedDateTime string `json:"lastQueriedDateTime,omitempty"` - // The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. - NextURI string `json:"nextUri,omitempty"` - // The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. - PreviousURI string `json:"previousUri,omitempty"` - // The number of results returned in this response. Because you can filter which entries are included in the response, this value is always less than or equal to `totalSetSize`. - ResultSetSize string `json:"resultSetSize,omitempty"` - // The starting position of the current result set. - StartPosition string `json:"startPosition,omitempty"` - // The total number of items in the search's result set. This value is always greater than or equal to the value of `resultSetSize`. - TotalSetSize string `json:"totalSetSize,omitempty"` -} - -// ErrorDetails this object describes errors that occur. It is only valid for responses and ignored in requests. -type ErrorDetails struct { - // The code associated with the error condition. - ErrorCode string `json:"errorCode,omitempty"` - // A brief message describing the error condition. - Message string `json:"message,omitempty"` -} - -// EventNotification register a Connect webhook for a specific envelope -type EventNotification struct { - // A list of envelope-level event statuses that will trigger Connect to send updates to the endpoint specified in the `url` property. + NameFormatMetadata *SettingsMetadata `json:"nameFormatMetadata,omitempty"` + // The format for the signature date. Valid values are: // - // To receive notifications, you must include either an `envelopeEvents` node or a `recipientEvents` node. You do not need to specify both. - EnvelopeEvents []EnvelopeEvent `json:"envelopeEvents,omitempty"` - // When set to **true**, the Connect Service includes the Certificate of Completion with completed envelopes. - IncludeCertificateOfCompletion DSBool `json:"includeCertificateOfCompletion,omitempty"` - // When set to **true**, the Connect service will digitally sign the XML data. The signature will be included in the XML message. - IncludeCertificateWithSoap DSBool `json:"includeCertificateWithSoap,omitempty"` - // When set to **true**, the Document Fields associated with the envelope's documents are included in the notification messages. Document Fields are optional custom name-value pairs added to documents using the API. - IncludeDocumentFields DSBool `json:"includeDocumentFields,omitempty"` - // When set to **true**, the XML webhook messages will include the envelope's PDF documents. Including the PDF documents will greatly increase the size of the notification messages. Ensure that your listener can handle incoming messages that are 25MB or larger. - IncludeDocuments DSBool `json:"includeDocuments,omitempty"` - // When set to **true**, if the envelope is voided, the Connect Service notification will include the void reason, as entered by the person that voided the envelope. - IncludeEnvelopeVoidReason DSBool `json:"includeEnvelopeVoidReason,omitempty"` - // When set to **true**, Connect will include the sender account as Custom Field in the data. - IncludeSenderAccountAsCustomField DSBool `json:"includeSenderAccountAsCustomField,omitempty"` - // When set to **true**, the envelope's time zone information is included in the webhook messages. - IncludeTimeZone DSBool `json:"includeTimeZone,omitempty"` - // When set to **true**, the webhook messages are logged. They can be viewed on the DocuSign Administration Web Tool in the Connect section. Logged messages can also be downloaded via the [ConnectEvents resource](https://developers.docusign.com/esign-rest-api/reference/Connect/ConnectEvents). - LoggingEnabled DSBool `json:"loggingEnabled,omitempty"` - // An array of recipient event statuses that will trigger Connect to send notifications to your webhook listener at the url endpoint specified in the `url` property. + // - `d/M/yyyy` + // - `dd-MM-yy` + // - `dd-MMM-yy` + // - `dd-MM-yyyy` + // - `dd.MM.yyyy` + // - `dd-MMM-yyyy` + // - `dd MMMM yyyy` + // - `M/d/yyyy` + // - `MM-dd-yyyy` + // - `MM/dd/yyyy` + // - `MM/dd/yy` + // - `MMM-dd-yyyy` + // - `MMM d, yyyy` + // - `MMMM d, yyyy` + // - `yyyy-MM-dd` + // - `yyyy-MMM-dd` + // - `yyyy/MM/dd` + // - `yyyy MMMM d` // - // To receive notifications, you must include either an `envelopeEvents` node or a `recipientEvents` node. You do not need to specify both. - RecipientEvents []RecipientEvent `json:"recipientEvents,omitempty"` - // When set to **true**, the DocuSign Connect service checks that the message was received and retries on failures. - RequireAcknowledgment DSBool `json:"requireAcknowledgment,omitempty"` - // When set to **true**, Mutual TLS will be enabled for notifications. Mutual TLS must be initiated by the listener (the customer's web server) during the TLS handshake protocol. - SignMessageWithX509Cert DSBool `json:"signMessageWithX509Cert,omitempty"` - // The namespace of the SOAP interface. + // **Note**: Only Admin users can change this setting. // - // The namespace value must be set if useSoapInterface is set to true. - SoapNameSpace string `json:"soapNameSpace,omitempty"` - // The endpoint to which webhook notification messages are sent via an HTTPS POST request. The url must start with https. The customer's web server must use an SSL/TLS certificate whose CA is in the Microsoft list of trusted CAs. Self-signed certificates are not ok. Free certificates from Let's Encrypt can be used. - URL string `json:"url,omitempty"` - // When set to **true**, the notifications are sent to your endpoint as SOAP requests. - UseSoapInterface DSBool `json:"useSoapInterface,omitempty"` -} - -// EventResult information about the result of an event. -type EventResult struct { - // Date/time of the event. - EventTimestamp string `json:"eventTimestamp,omitempty"` - // Reason for failure, if the event failed. - FailureDescription string `json:"failureDescription,omitempty"` - // Event status. - Status string `json:"status,omitempty"` - // Failure status code, if the event failed. - VendorFailureStatusCode string `json:"vendorFailureStatusCode,omitempty"` -} - -// Expirations is a complex element that specifies the expiration settings for the envelope. -type Expirations struct { - // An integer specifying the number of days that a sent envelope remains active before it expires. A negative number in a response indicates that the envelope has already expired. - ExpireAfter string `json:"expireAfter,omitempty"` - // When set to **true**, the envelope expires (is no longer available for signing) after the specified number of days after it is sent (`sentDateTime`). Set `expireAfter` to set the number of days until an envelope expires. When **false**, the account default setting is used. If the account does not have an expiration setting, the DocuSign default value of 120 days is used. - ExpireEnabled DSBool `json:"expireEnabled,omitempty"` - // An integer that specifying the number of days before the envelope expires that an expiration warning email is sent to the recipient. If set to 0 (zero), no warning email is sent. - ExpireWarn string `json:"expireWarn,omitempty"` -} - -type ExternalClaim struct { + SignDateFormat string `json:"signDateFormat,omitempty"` + // Metadata that indicates whether the `signDateFormat` property is editable. // - AcquiredTime string `json:"acquiredTime,omitempty"` + SignDateFormatMetadata *SettingsMetadata `json:"signDateFormatMetadata,omitempty"` + // The format for the signature time. Valid values are: // - ClaimName string `json:"claimName,omitempty"` - // The social account provider (Facebook, Yahoo, etc.) - Provider string `json:"provider,omitempty"` - // Specifies the value of the tab. - Value string `json:"value,omitempty"` -} - -type ExternalDocServiceErrorDetails struct { - // Reserved: TBD - AuthenticationURL string `json:"authenticationUrl,omitempty"` - // A code associated with the error condition. - ErrorCode string `json:"errorCode,omitempty"` + // - `none` + // - `HH:mm` + // - `h:mm` + // - `HH:mm:ss` + // - `h:mm:ss` // - Message string `json:"message,omitempty"` -} - -// ExternalDocumentSources is a complex object specifying the external document sources. -type ExternalDocumentSources struct { - // The account is enabled to allow external documents to be attached from BoxNet. - BoxnetEnabled string `json:"boxnetEnabled,omitempty"` - // Metadata indicating whether the `boxnetEnabled` property is editable. - BoxnetMetadata *SettingsMetadata `json:"boxnetMetadata,omitempty"` - // The account is enabled to allow external documents to be attached from DropBox. - DropboxEnabled string `json:"dropboxEnabled,omitempty"` - // Metadata indicating whether the `dropboxEnabled` property is editable. - DropboxMetadata *SettingsMetadata `json:"dropboxMetadata,omitempty"` - // The account is enabled to allow external documents to be attached from Google Drive. - GoogleDriveEnabled string `json:"googleDriveEnabled,omitempty"` - // Metadata indicating whether the `googleDriveEnabled` property is editable. - GoogleDriveMetadata *SettingsMetadata `json:"googleDriveMetadata,omitempty"` - // The account is enabled to allow external documents to be attached from OneDrive. - OneDriveEnabled string `json:"oneDriveEnabled,omitempty"` - // Metadata indicating whether the `oneDriveEnabled` property is editable. - OneDriveMetadata *SettingsMetadata `json:"oneDriveMetadata,omitempty"` - // The account is enabled to allow external documents to be attached from Salesforce. - SalesforceEnabled string `json:"salesforceEnabled,omitempty"` - // Metadata indicating whether the `salesforceEnabled` property is editable. - SalesforceMetadata *SettingsMetadata `json:"salesforceMetadata,omitempty"` -} - -type ExternalFile struct { + SignTimeFormat string `json:"signTimeFormat,omitempty"` + // Metadata that indicates whether the `signTimeFormat` property is editable. // - Date string `json:"date,omitempty"` - // A unique ID for the Salesforce object. - ID string `json:"id,omitempty"` + SignTimeFormatMetadata *SettingsMetadata `json:"signTimeFormatMetadata,omitempty"` // - Img string `json:"img,omitempty"` + TimeFormat string `json:"timeFormat,omitempty"` // - Name string `json:"name,omitempty"` - // Reserved: TBD - Size string `json:"size,omitempty"` + TimeFormatMetadata *SettingsMetadata `json:"timeFormatMetadata,omitempty"` // - Supported string `json:"supported,omitempty"` - // Type of user: - // - `type_owner` - // - `type_participant` - Type string `json:"type,omitempty"` - // URI containing the user ID. - URI string `json:"uri,omitempty"` + TimeZone string `json:"timeZone,omitempty"` + // + TimeZoneMetadata *SettingsMetadata `json:"timeZoneMetadata,omitempty"` } -type ExternalFolder struct { - // The last position in the result set. - EndPosition string `json:"endPosition,omitempty"` - // This object describes errors that occur. It is only valid for responses and ignored in requests. - ErrorDetails *ExternalDocServiceErrorDetails `json:"errorDetails,omitempty"` - // A unique ID for the Salesforce object. - ID string `json:"id,omitempty"` +type LocalePolicyTab struct { // - Items []ExternalFile `json:"items,omitempty"` + AddressFormat string `json:"addressFormat,omitempty"` // - Name string `json:"name,omitempty"` - // The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. - NextURI string `json:"nextUri,omitempty"` - // The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. - PreviousURI string `json:"previousUri,omitempty"` - // The number of results returned in this response. Because you can filter which entries are included in the response, this value is always less than or equal to `totalSetSize`. - ResultSetSize string `json:"resultSetSize,omitempty"` - // The starting position of the current result set. - StartPosition string `json:"startPosition,omitempty"` - // The total number of items in the search's result set. This value is always greater than or equal to the value of `resultSetSize`. - TotalSetSize string `json:"totalSetSize,omitempty"` -} - -type FeatureAvailableMetadata struct { + CalendarType string `json:"calendarType,omitempty"` // - Availabilty string `json:"availabilty,omitempty"` + CultureName string `json:"cultureName,omitempty"` + // The currency code for the account, based on the [ISO 4217 currency code](https://www.iso.org/iso-4217-currency-codes.html). + CurrencyCode string `json:"currencyCode,omitempty"` // - FeatureName string `json:"featureName,omitempty"` -} - -// FeatureSet this object provides details about a feature set, or add-on product that is associated with an account. It is reserved for DocuSign internal use only. -type FeatureSet struct { - // Reserved for DocuSign. - CurrencyFeatureSetPrices []CurrencyFeatureSetPrice `json:"currencyFeatureSetPrices,omitempty"` - // Reserved for DocuSign. - EnvelopeFee string `json:"envelopeFee,omitempty"` - // Reserved for DocuSign. - FeatureSetID string `json:"featureSetId,omitempty"` - // Reserved for DocuSign. - FixedFee string `json:"fixedFee,omitempty"` - // Reserved for DocuSign. - Is21CFRPart11 DSBool `json:"is21CFRPart11,omitempty"` - // Reserved for DocuSign. - IsActive DSBool `json:"isActive,omitempty"` - // Reserved for DocuSign. - IsEnabled DSBool `json:"isEnabled,omitempty"` - // Reserved for DocuSign. - Name string `json:"name,omitempty"` - // Reserved for DocuSign. - SeatFee string `json:"seatFee,omitempty"` -} - -type FileType struct { + CurrencyNegativeFormat string `json:"currencyNegativeFormat,omitempty"` // - FileExtension string `json:"fileExtension,omitempty"` - // The mime-type of a file type listed in a fileTypes collection. - MimeType string `json:"mimeType,omitempty"` -} - -type FileTypeList struct { - // A collection of file types. - FileTypes []FileType `json:"fileTypes,omitempty"` -} - -type Filter struct { - // Action required. - ActionRequired string `json:"actionRequired,omitempty"` + CurrencyPositiveFormat string `json:"currencyPositiveFormat,omitempty"` // - Expires string `json:"expires,omitempty"` + CustomDateFormat string `json:"customDateFormat,omitempty"` // - FolderIds string `json:"folderIds,omitempty"` + CustomTimeFormat string `json:"customTimeFormat,omitempty"` // - FromDateTime *time.Time `json:"fromDateTime,omitempty"` + DateFormat string `json:"dateFormat,omitempty"` // - IsTemplate DSBool `json:"isTemplate,omitempty"` - // (Optional) The order in which to sort the results. + InitialFormat string `json:"initialFormat,omitempty"` // - // Valid values are: + NameFormat string `json:"nameFormat,omitempty"` // + TimeFormat string `json:"timeFormat,omitempty"` // - // * `asc`: Ascending order. - // * `desc`: Descending order. - Order string `json:"order,omitempty"` + TimeZone string `json:"timeZone,omitempty"` +} + +type LockInformation struct { + // This object describes errors that occur. It is only valid for responses and ignored in requests. + ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` + // The number of seconds to lock the envelope for editing. This value must be greater than `0` seconds. + LockDurationInSeconds string `json:"lockDurationInSeconds,omitempty"` + // A unique identifier provided to the owner of the lock. You must use this token with subsequent calls to prove ownership of the lock. + LockToken string `json:"lockToken,omitempty"` + // The type of lock. Currently `edit` is the only supported type. + LockType string `json:"lockType,omitempty"` + // The human-readable name of the application that is locking the envelope or template. This value displays to the user in error messages when lock conflicts occur. + LockedByApp string `json:"lockedByApp,omitempty"` + // A complex type containing information about the user that has the envelope or template locked. + LockedByUser *UserInfo `json:"lockedByUser,omitempty"` + // The date and time that the lock expires. + LockedUntilDateTime *time.Time `json:"lockedUntilDateTime,omitempty"` + // When set to **true**, a scratchpad is used to edit information. // - OrderBy string `json:"orderBy,omitempty"` + UseScratchPad string `json:"useScratchPad,omitempty"` +} + +// LockRequest this request object contains information about the lock that you want to create or update. +type LockRequest struct { + // The number of seconds to lock the envelope for editing. Must be greater than 0 seconds. + LockDurationInSeconds string `json:"lockDurationInSeconds,omitempty"` + // The type of lock. Currently `edit` is the only supported type. + LockType string `json:"lockType,omitempty"` + // A friendly name of the application used to lock the envelope. Will be used in error messages to the user when lock conflicts occur. + LockedByApp string `json:"lockedByApp,omitempty"` + // The [password for the template](https://support.docusign.com/en/guides/ndse-user-guide-template-passwords). If you are using a lock for a template that has a password or an envelope that is based on a template that has a password, you must enter the `templatePassword` to save the changes. + TemplatePassword string `json:"templatePassword,omitempty"` + // When set to **true**, a scratchpad is used to edit information. // - SearchTarget string `json:"searchTarget,omitempty"` + UseScratchPad string `json:"useScratchPad,omitempty"` +} + +type LoginAccount struct { + // The account ID associated with the envelope. + AccountID string `json:"accountId,omitempty"` + // The GUID associated with the account ID. + AccountIDGUID string `json:"accountIdGuid,omitempty"` + // The URL that should be used for successive calls to this account. It includes the protocal (https), the DocuSign server where the account is located, and the account number. Use this Url to make API calls against this account. Many of the API calls provide Uri's that are relative to this baseUrl. + BaseURL string `json:"baseUrl,omitempty"` + // The email address for the user. + Email string `json:"email,omitempty"` + // This value is true if this is the default account for the user, otherwise false is returned. + IsDefault DSBool `json:"isDefault,omitempty"` + // A list of settings on the acccount that indicate what features are available. + LoginAccountSettings []NameValue `json:"loginAccountSettings,omitempty"` + // A list of user-level settings that indicate what user-specific features are available. + LoginUserSettings []NameValue `json:"loginUserSettings,omitempty"` + // The name associated with the account. + Name string `json:"name,omitempty"` + // An optional descirption of the site that hosts the account. + SiteDescription string `json:"siteDescription,omitempty"` + // The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing. // - SearchText string `json:"searchText,omitempty"` - // Filter status. - Status string `json:"status,omitempty"` - // Latest date to filter. - ToDateTime *time.Time `json:"toDateTime,omitempty"` + UserID string `json:"userId,omitempty"` + // The name of this user as defined by the account. + UserName string `json:"userName,omitempty"` } -// FirstName is a tab that displays the recipient's first name. This tab -// takes the recipient's name as entered in the recipient -// information, splits it into sections based on spaces and -// uses the first section as the first name. -// -type FirstName struct { - TabBase - TabGuidedForm - TabPosition - TabStyle - TabValue +type LoginInformation struct { + // Contains a token that can be used for authentication in API calls instead of using the user name and password. + APIPassword string `json:"apiPassword,omitempty"` + // The list of accounts that authenticating user is a member of. + LoginAccounts []LoginAccount `json:"loginAccounts,omitempty"` +} + +type MatchBox struct { // The height of the tab in pixels. Height string `json:"height,omitempty"` - // Metadata that indicates whether the `height` property is editable. - HeightMetadata *PropertyMetadata `json:"heightMetadata,omitempty"` - // Reserved for DocuSign. - LocalePolicy *LocalePolicyTab `json:"localePolicy,omitempty"` - // Metadata that indicates whether the `toolTip` property is editable. - ToolTipMetadata *PropertyMetadata `json:"toolTipMetadata,omitempty"` - // The text of a tooltip that appears when a user hovers over a form field or tab. - Tooltip string `json:"tooltip,omitempty"` + // Specifies the page number on which the tab is located. + // Must be 1 for supplemental documents. + // + PageNumber string `json:"pageNumber,omitempty"` // The width of the tab in pixels. Width string `json:"width,omitempty"` - // Metadata that indicates whether the `width` property is editable. - WidthMetadata *PropertyMetadata `json:"widthMetadata,omitempty"` + // This property indicates the horizontal offset of the object on the page. + // DocuSign uses 72 DPI when determining position. + // Required. May be zero. + // + XPosition string `json:"xPosition,omitempty"` + // This property indicates the vertical offset of the object on the page. + // DocuSign uses 72 DPI when determining position. + // Required. May be zero. + // + YPosition string `json:"yPosition,omitempty"` } -type Folder struct { +// MemberGroupSharedItem information about items shared among groups. +type MemberGroupSharedItem struct { // This object describes errors that occur. It is only valid for responses and ignored in requests. ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` + // The group sharing the item. + Group *Group `json:"group,omitempty"` + // How the item is shared. One of: // - Filter *Filter `json:"filter,omitempty"` - // Unique identifier for the folder. - FolderID string `json:"folderId,omitempty"` - // A list of the envelopes in the specified folder or folders. - FolderItems []FolderItemV2 `json:"folderItems,omitempty"` - // A collection of folder objects returned in a response. - Folders []Folder `json:"folders,omitempty"` - // - HasAccess string `json:"hasAccess,omitempty"` - // - HasSubFolders string `json:"hasSubFolders,omitempty"` - // - ItemCount string `json:"itemCount,omitempty"` // - Name string `json:"name,omitempty"` + // - `not_shared`: The item is not shared. // - Owner *UserInfo `json:"owner,omitempty"` + // - `shared_to`: The item is shared. + Shared DSBool `json:"shared,omitempty"` +} + +// MemberSharedItems information about shared items. +type MemberSharedItems struct { + // List of information about shared envelopes. + Envelopes []SharedItem `json:"envelopes,omitempty"` + // This object describes errors that occur. It is only valid for responses and ignored in requests. + ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` + // List of information about shared folders. + Folders []FolderSharedItem `json:"folders,omitempty"` + // List of information about shared templates. + Templates []TemplateSharedItem `json:"templates,omitempty"` + // Information about the user requesting sharing information. + User *UserInfo `json:"user,omitempty"` +} + +// MergeField contains information for transfering values between Salesforce data fields and DocuSign Tabs. +type MergeField struct { + // When **true**, the sender can modify the value of the `mergeField` tab during the sending process. + AllowSenderToEdit DSBool `json:"allowSenderToEdit,omitempty"` + // Metadata that indicates if the sender can edit the `allowSenderToEdit` property. + AllowSenderToEditMetadata *PropertyMetadata `json:"allowSenderToEditMetadata,omitempty"` + // If you are using merge fields, this property specifies the type of the merge field. The only supported value is `salesforce`. + ConfigurationType string `json:"configurationType,omitempty"` + // Metadata that indicates if the sender can edit the `configurationType` property. + ConfigurationTypeMetadata *PropertyMetadata `json:"configurationTypeMetadata,omitempty"` + // Sets the object associated with the custom tab. Currently this is the Salesforce Object. + Path string `json:"path,omitempty"` + // Reserved for DocuSign. + PathExtended []PathExtendedElement `json:"pathExtended,omitempty"` + // Reserved for DocuSign. + PathExtendedMetadata *PropertyMetadata `json:"pathExtendedMetadata,omitempty"` + // Metadata that indicates whether the `path` property is editable. // - ParentFolderID string `json:"parentFolderId,omitempty"` + PathMetadata *PropertyMetadata `json:"pathMetadata,omitempty"` + // Specifies the row number in a Salesforce table that the merge field value corresponds to. + Row string `json:"row,omitempty"` + // Metadata that indicates whether the `row` property is editable. // - ParentFolderURI string `json:"parentFolderUri,omitempty"` + RowMetadata *PropertyMetadata `json:"rowMetadata,omitempty"` + // When **true**, data entered into the merge field during Signing will update the mapped Salesforce field. + WriteBack string `json:"writeBack,omitempty"` + // Metadata that indicates if the sender can edit the `writeBack` property. + WriteBackMetadata *PropertyMetadata `json:"writeBackMetadata,omitempty"` +} + +type MobileNotifierConfiguration struct { // - SubFolderCount string `json:"subFolderCount,omitempty"` - // Type of user: - // - `type_owner` - // - `type_participant` - Type string `json:"type,omitempty"` - // URI containing the user ID. - URI string `json:"uri,omitempty"` + DeviceID string `json:"deviceId,omitempty"` + // This object describes errors that occur. It is only valid for responses and ignored in requests. + ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` + // The Platform of the client application + Platform string `json:"platform,omitempty"` } -// FolderItemResponse results from a folder item request. -type FolderItemResponse struct { - // The last position in the result set. - EndPosition string `json:"endPosition,omitempty"` - // A list of the envelopes in the specified folder or folders. - FolderItems []FolderItemV2 `json:"folderItems,omitempty"` - // The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. - NextURI string `json:"nextUri,omitempty"` - // The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. - PreviousURI string `json:"previousUri,omitempty"` - // The number of results returned in this response. Because you can filter which entries are included in the response, this value is always less than or equal to `totalSetSize`. - ResultSetSize string `json:"resultSetSize,omitempty"` - // The starting position of the current result set. - StartPosition string `json:"startPosition,omitempty"` - // The total number of items in the result. - TotalRows string `json:"totalRows,omitempty"` +type MobileNotifierConfigurationInformation struct { + // + MobileNotifierConfigurations []MobileNotifierConfiguration `json:"mobileNotifierConfigurations,omitempty"` } -// FolderItemV2 information about folder item results. -type FolderItemV2 struct { - // Specifies the date and time this item was completed. - CompletedDateTime *time.Time `json:"completedDateTime,omitempty"` - // The date and time the item was created. - CreatedDateTime *time.Time `json:"createdDateTime,omitempty"` - // The envelope ID of the envelope status that failed to post. - EnvelopeID string `json:"envelopeId,omitempty"` - // URI that you can use to retrieve the bulk envelopes. - EnvelopeURI string `json:"envelopeUri,omitempty"` - // The date and time the envelope is set to expire. - ExpireDateTime *time.Time `json:"expireDateTime,omitempty"` - // Unique identifier for the folder. - FolderID string `json:"folderId,omitempty"` +// Money describes information +// about the `total` of a payment. +// +type Money struct { + // The total payment amount + // in the currency's base unit. + // For example, for USD + // the base currency is one cent. // - FolderURI string `json:"folderUri,omitempty"` - // When **true**, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES). - Is21CFRPart11 DSBool `json:"is21CFRPart11,omitempty"` + AmountInBaseUnit string `json:"amountInBaseUnit,omitempty"` + // The three-letter + // [ISO 4217][ISO4217] currency code for the payment. // - OwnerName string `json:"ownerName,omitempty"` - // An array of recipient objects that provides details about the recipients of the envelope. - Recipients *Recipients `json:"recipients,omitempty"` - // Contains a URI for an endpoint that you can use to retrieve the recipients. - RecipientsURI string `json:"recipientsUri,omitempty"` + // For example: // - SenderCompany string `json:"senderCompany,omitempty"` + // * AUD Australian dollar + // * CAD Canadian dollar + // * EUR Euro + // * GBP Great Britain pound + // * USD United States dollar // - SenderEmail string `json:"senderEmail,omitempty"` + // This is a read-only property. // - SenderName string `json:"senderName,omitempty"` + // [ISO4217]: https://en.wikipedia.org/wiki/ISO_4217 // - SenderUserID string `json:"senderUserId,omitempty"` - // The date and time the envelope was sent. - SentDateTime *time.Time `json:"sentDateTime,omitempty"` - // The status of the item. - Status string `json:"status,omitempty"` + Currency string `json:"currency,omitempty"` + // The payment amount as displayed + // in the `currency`. // - Subject string `json:"subject,omitempty"` - // The ID of the template. - TemplateID string `json:"templateId,omitempty"` + // For example, if the payment amount + // is USD 12.59, + // the `amountInBaseUnit` is 1259 (cents), + // and the displayed amount is `$12.59 USD`. // - TemplateURI string `json:"templateUri,omitempty"` -} - -type FolderItemsResponse struct { - // The last position in the result set. - EndPosition string `json:"endPosition,omitempty"` - // An array containing PowerForm data. - Envelopes []EnvelopeSummary `json:"envelopes,omitempty"` - // A collection of folder objects returned in a response. - Folders []Folder `json:"folders,omitempty"` - // The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. - NextURI string `json:"nextUri,omitempty"` - // The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. - PreviousURI string `json:"previousUri,omitempty"` - // The number of results returned in this response. Because you can filter which entries are included in the response, this value is always less than or equal to `totalSetSize`. - ResultSetSize string `json:"resultSetSize,omitempty"` - // The starting position of the current result set. - StartPosition string `json:"startPosition,omitempty"` - // The total number of items in the search's result set. This value is always greater than or equal to the value of `resultSetSize`. - TotalSetSize string `json:"totalSetSize,omitempty"` + // This is a read-only property. + // + DisplayAmount string `json:"displayAmount,omitempty"` } -type FolderSharedItem struct { +// NameValue is a name-value pair that describes an item and provides a value for the item. +type NameValue struct { // This object describes errors that occur. It is only valid for responses and ignored in requests. ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` - // Unique identifier for the folder. - FolderID string `json:"folderId,omitempty"` - // The folder name. + // The name of the item. Name string `json:"name,omitempty"` - // Information about the user who owns the folder. - Owner *UserInfo `json:"owner,omitempty"` - // Unique identifier for the parent folder. - ParentFolderID string `json:"parentFolderId,omitempty"` - // URI for the parent folder. - ParentFolderURI string `json:"parentFolderUri,omitempty"` - // How the folder is shared. One of: - // - // - `not_shared` - // - `shared_to` - // - `shared_from` - // - `shared_to_and_from` - Shared string `json:"shared,omitempty"` - // List of groups that share the folder. - SharedGroups []MemberGroupSharedItem `json:"sharedGroups,omitempty"` - // List of users that share the folder. - SharedUsers []UserSharedItem `json:"sharedUsers,omitempty"` - // URI containing the user ID. - URI string `json:"uri,omitempty"` - // Information about the user associated with the folder. - User *UserInfo `json:"user,omitempty"` + // The initial value of the item. + OriginalValue string `json:"originalValue,omitempty"` + // The current value of the item. + Value string `json:"value,omitempty"` } -// FoldersRequest information for a folder request. -type FoldersRequest struct { - // A comma-separated list of envelope IDs. - EnvelopeIds []string `json:"envelopeIds,omitempty"` - // A collection of folder objects returned in a response. - Folders []Folder `json:"folders,omitempty"` - // The folder ID the envelope is being moved from. - FromFolderID string `json:"fromFolderId,omitempty"` +type NewAccountDefinition struct { + // The account name for the new account. + AccountName string `json:"accountName,omitempty"` + // The list of + // account settings accountsettings + // that determine + // the features available for the account. + // Note that some features are determined + // by the plan used to create the account and cannot be overridden. + // + // + AccountSettings *AccountSettingsInformation `json:"accountSettings,omitempty"` + // A complex type that contains the following information for the new account: `Street1`, `Street2`, `City`, `State`, `Zip`, `Phone`, and `Fax`. + AddressInformation *AccountAddress `json:"addressInformation,omitempty"` + // A complex type that has information about the credit card used to pay for this account. + CreditCardInformation *CreditCardInformation `json:"creditCardInformation,omitempty"` + // Information about the bank that processes direct debits for the payment plan. + DirectDebitProcessorInformation *DirectDebitProcessorInformation `json:"directDebitProcessorInformation,omitempty"` + // The Distributor Code that you received from DocuSign. + DistributorCode string `json:"distributorCode,omitempty"` + // The password for the `distributorCode`. + DistributorPassword string `json:"distributorPassword,omitempty"` + // Reserved for DocuSign. + EnvelopePartitionID string `json:"envelopePartitionId,omitempty"` + // A complex type with the initial user information for the new account. Note that some user information is set internally based on the plan and cannot be overridden. + InitialUser *UserInformation `json:"initialUser,omitempty"` + // The payment method used for the billing plan. Valid values are: + // + // - `NotSupported` + // - `CreditCard` + // - `PurchaseOrder` + // - `Premium` + // - `Freemium` + // - `FreeTrial` + // - `AppStore` + // - `DigitalExternal` + // - `DirectDebit` + PaymentMethod string `json:"paymentMethod,omitempty"` + // Information about the entity that processes payments for the billing plan. + PaymentProcessorInformation *PaymentProcessorInformation `json:"paymentProcessorInformation,omitempty"` + // An object used to identify the features and attributes of the account being created. + PlanInformation *PlanInformation `json:"planInformation,omitempty"` + // A complex type that contains properties for entering referral and discount information. + ReferralInformation *ReferralInformation `json:"referralInformation,omitempty"` + // Contains properties that map a DocuSign user to a social account such as Facebook or Yahoo. + SocialAccountInformation *SocialAccountInformation `json:"socialAccountInformation,omitempty"` } -// FoldersResponse folder management -type FoldersResponse struct { - // The last position in the result set. - EndPosition string `json:"endPosition,omitempty"` - // A list of envelopes in this folder. - Envelopes []EnvelopeSummary `json:"envelopes,omitempty"` - // A collection of folder objects returned in a response. - Folders []Folder `json:"folders,omitempty"` - // The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. - NextURI string `json:"nextUri,omitempty"` - // The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. - PreviousURI string `json:"previousUri,omitempty"` - // The number of results returned in this response. Because you can filter which entries are included in the response, this value is always less than or equal to `totalSetSize`. - ResultSetSize string `json:"resultSetSize,omitempty"` - // The starting position of the current result set. - StartPosition string `json:"startPosition,omitempty"` - // The total number of items in the search's result set. This value is always greater than or equal to the value of `resultSetSize`. - TotalSetSize string `json:"totalSetSize,omitempty"` +type NewAccountSummary struct { + // The account ID associated with the envelope. + AccountID string `json:"accountId,omitempty"` + // The GUID associated with the account ID. + AccountIDGUID string `json:"accountIdGuid,omitempty"` + // The account name for the new account. + AccountName string `json:"accountName,omitempty"` + // Contains a token that can be used for authentication in API calls instead of using the user name and password. + APIPassword string `json:"apiPassword,omitempty"` + // The URL that should be used for successive calls to this account. It includes the protocal (https), the DocuSign server where the account is located, and the account number. Use this Url to make API calls against this account. Many of the API calls provide Uri's that are relative to this baseUrl. + BaseURL string `json:"baseUrl,omitempty"` + // + BillingPlanPreview *BillingPlanPreview `json:"billingPlanPreview,omitempty"` + // Specifies the user ID of the new user. + UserID string `json:"userId,omitempty"` } -// ForgottenPasswordInformation is a complex element that has up to four Question/Answer pairs for forgotten password information. -type ForgottenPasswordInformation struct { - // The answer to the first forgotten password challenge question. - ForgottenPasswordAnswer1 string `json:"forgottenPasswordAnswer1,omitempty"` - // The answer to the second forgotten password challenge question. - ForgottenPasswordAnswer2 string `json:"forgottenPasswordAnswer2,omitempty"` - // The answer to the third forgotten password challenge question. - ForgottenPasswordAnswer3 string `json:"forgottenPasswordAnswer3,omitempty"` - // The answer to the fourth forgotten password challenge question. - ForgottenPasswordAnswer4 string `json:"forgottenPasswordAnswer4,omitempty"` - // The first challenge question presented to a user who has forgotten their password. - ForgottenPasswordQuestion1 string `json:"forgottenPasswordQuestion1,omitempty"` - // The second challenge question presented to a user who has forgotten their password. - ForgottenPasswordQuestion2 string `json:"forgottenPasswordQuestion2,omitempty"` - // The third challenge question presented to a user who has forgotten their password. - ForgottenPasswordQuestion3 string `json:"forgottenPasswordQuestion3,omitempty"` - // The fourth challenge question presented to a user who has forgotten their password. - ForgottenPasswordQuestion4 string `json:"forgottenPasswordQuestion4,omitempty"` +// NewUser object representing a new user. +type NewUser struct { + // Contains a token that can be used for authentication in API calls instead of using the user name and password. + APIPassword string `json:"apiPassword,omitempty"` + // The UTC DateTime when the item was created. + CreatedDateTime *time.Time `json:"createdDateTime,omitempty"` + // The user's email address. + Email string `json:"email,omitempty"` + // This object describes errors that occur. It is only valid for responses and ignored in requests. + ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` + // The user's membership ID. + MembershipID string `json:"membershipId,omitempty"` + // The ID of the permission profile. Possible values include: + // + // - `2301416` (for the `DocuSign Viewer` profile) + // - `2301415` (for the `DocuSign Sender` profile) + // - `2301414` (for the `Account Administrator` profile) + // + // In addition, any custom permission profiles associated with your account will have an automatically generated `permissionProfileId`. + PermissionProfileID string `json:"permissionProfileId,omitempty"` + // The name of the account permission profile. + // + // Example: `Account Administrator` + PermissionProfileName string `json:"permissionProfileName,omitempty"` + // A URI containing the user ID. + URI string `json:"uri,omitempty"` + // Specifies the user ID for the new user. + UserID string `json:"userId,omitempty"` + // The name of the user. + UserName string `json:"userName,omitempty"` + // Status of the user's account. One of: + // + // - `ActivationRequired` + // - `ActivationSent` + // - `Active` + // - `Closed` + // - `Disabled` + // + UserStatus string `json:"userStatus,omitempty"` } -type FormDataItem struct { - // This object describes errors that occur. It is only valid for responses and ignored in requests. - ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` - // The selected value in a list. - ListSelectedValue string `json:"listSelectedValue,omitempty"` - // The name of the form field. - Name string `json:"name,omitempty"` - // The initial value associated with the form field. - OriginalValue string `json:"originalValue,omitempty"` - // The current value associated with the form field. - Value string `json:"value,omitempty"` +type NewUsersDefinition struct { + // A list of one or more new users. + NewUsers []UserInformation `json:"newUsers,omitempty"` } -// FormulaTab is the value of a formula tab is calculated -// from the values of other -// number or date tabs in the document. -// When the recipient completes the underlying fields, -// the formula tab calculates and displays the result. -// -// The `formula` property of the tab -// contains the references -// to the underlying tabs. -// See [Calculated Fields][calculatedfields] -// in the DocuSign Support Center -// to learn more about formulas. -// -// If a formula tab contains -// a `paymentDetails` property, -// the tab is considered a payment item. -// See [Requesting Payments Along with Signatures][paymentguide] -// in the DocuSign Support Center -// to learn more about payments. -// -// [calculatedfields]: https://support.docusign.com/en/guides/ndse-user-guide-calculated-fields -// [paymentguide]: https://support.docusign.com/en/guides/requesting-payments-along-with-signatures -// -type FormulaTab struct { +// NewUsersSummary object representing a summary of data for new users. +type NewUsersSummary struct { + // A list of one or more new users. + NewUsers []NewUser `json:"newUsers,omitempty"` +} + +// Notarize is a tab that alerts notary recipients that +// they must take action on the page. +// Only one notarize tab can appear on a page. +type Notarize struct { TabBase TabGuidedForm - TabPosition - TabStyle - TabValue - // When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. // - // When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. + AnchorAllowWhiteSpaceInCharacters string `json:"anchorAllowWhiteSpaceInCharacters,omitempty"` // - // This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. - ConcealValueOnDocument DSBool `json:"concealValueOnDocument,omitempty"` - // Metadata that indicates whether the `concealValueOnDocument` property is editable. - ConcealValueOnDocumentMetadata *PropertyMetadata `json:"concealValueOnDocumentMetadata,omitempty"` - // When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. - DisableAutoSize DSBool `json:"disableAutoSize,omitempty"` - // Metadata that indicates whether the `disableAutoSize` property is editable. - DisableAutoSizeMetadata *PropertyMetadata `json:"disableAutoSizeMetadata,omitempty"` - // Contains the formula - // for calculating the value of - // this tab. + AnchorAllowWhiteSpaceInCharactersMetadata *PropertyMetadata `json:"anchorAllowWhiteSpaceInCharactersMetadata,omitempty"` + // This property controls how [anchor tabs][AnchorTabs] are placed. When **true**, the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false**. // - // Use a tab's `tabLabel`, - // enclosed in brackets, - // to refer to it. + // For example, when set to **true**, if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When set to **false**, `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. // - // For example, - // you want to present the total cost - // of two items, tax included. + // This functionality uses the following rules: // - // The cost of each item is stored - // in number tabs labeled Item1 and Item2. - // The tax rate is in a number tab - // labeled TaxRate. + // - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: // - // The formula string for this property - // would be: - // `([Item1] + [Item2]) * (1 + [TaxRate])` + // $~><|^+= // - // See [Calculated Fields][calculatedfields] - // in the DocuSign Support Center - // to learn more about formulas. + // For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` // - // Maximum Length: 2000 characters + // - Strings embedded in other strings are ignored during the matching process. // - // [calculatedfields]: https://support.docusign.com/en/guides/ndse-user-guide-calculated-fields + // - In words that have dashes, the parts separated by dashes are treated as distinct words. // - Formula string `json:"formula,omitempty"` - // Metadata indicating if the sender can edit the `formula` property. - FormulaMetadata *PropertyMetadata `json:"formulaMetadata,omitempty"` - // The height of the tab in pixels. - Height string `json:"height,omitempty"` - // Metadata that indicates whether the `height` property is editable. - HeightMetadata *PropertyMetadata `json:"heightMetadata,omitempty"` - // If this is a regular formula (no `paymentDetails` property is present): + // Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**. // - // * **true**: The tab is hidden. - // * **false**: The tab is shown. + // - Letters with accent marks are treated as distinct characters from their unaccented counterparts. // - // If the formula is payment item (a `paymentDetails` property is present): + // - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. // - // * **true**: The tab is displayed as a payment. - // * **false**: The tab is displayed as a regular formula. + // Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. // - Hidden string `json:"hidden,omitempty"` - // Metadata that indicates whether the `hidden` property is editable. - HiddenMetadata *PropertyMetadata `json:"hiddenMetadata,omitempty"` - // When set to **true**, sets this as a payment tab. Can only be used with Text, Number, Formula, or List tabs. The value of the tab must be a number. - IsPaymentAmount DSBool `json:"isPaymentAmount,omitempty"` - // Metadata that indicates whether the `isPaymentAmount` property is editable. - IsPaymentAmountMetadata *PropertyMetadata `json:"isPaymentAmountMetadata,omitempty"` + // - Unlike punctuation, numbers are not ignored when finding anchor words. + // + // Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). + // + // **Note**: You can only specify the value of this property in POST requests. + // + // [AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place + AnchorCaseSensitive string `json:"anchorCaseSensitive,omitempty"` + // Metadata that indicates whether the `anchorCaseSensitive` property is editable. + AnchorCaseSensitiveMetadata *PropertyMetadata `json:"anchorCaseSensitiveMetadata,omitempty"` + // This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are : + // + // - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. + // - `right`: Aligns the tab’s left side with the last character of the matching anchor word. + // + // **Note**: You can only specify the value of this property in POST requests. + // + // [AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place + // + AnchorHorizontalAlignment string `json:"anchorHorizontalAlignment,omitempty"` + // Metadata that indicates whether the `anchorHorizontalAlignment` property is editable. + AnchorHorizontalAlignmentMetadata *PropertyMetadata `json:"anchorHorizontalAlignmentMetadata,omitempty"` + // When set to **true**, this tab is ignored if the `anchorString` is not found in the document. + AnchorIgnoreIfNotPresent string `json:"anchorIgnoreIfNotPresent,omitempty"` + // Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable. + AnchorIgnoreIfNotPresentMetadata *PropertyMetadata `json:"anchorIgnoreIfNotPresentMetadata,omitempty"` + // When set to **true**, the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false**. + // + // For example, when set to **true**, if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When set to **false**, if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. + // + // This functionality uses the following rules: + // + // - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: + // + // $~><|^+= + // + // For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` + // + // - Strings embedded in other strings are ignored during the matching process. + // + // - In words that have dashes, the parts separated by dashes are treated as distinct words. + // + // Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**. + // + // - Letters with accent marks are treated as distinct characters from their unaccented counterparts. + // + // - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. + // + // Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. + // + // - Unlike punctuation, numbers are not ignored when finding anchor words. + // + // Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). + // + // + // **Note**: You can only specify the value of this property in POST requests. + // + // [AnchorTab]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place + // + AnchorMatchWholeWord string `json:"anchorMatchWholeWord,omitempty"` + // Metadata that indicates whether the `anchorMatchWholeWord` property is editable. + AnchorMatchWholeWordMetadata *PropertyMetadata `json:"anchorMatchWholeWordMetadata,omitempty"` + // Specifies the string to find in the document and use as the basis for tab placement. + AnchorString string `json:"anchorString,omitempty"` + // Metadata that indicates whether the `anchorString` property is editable. + AnchorStringMetadata *PropertyMetadata `json:"anchorStringMetadata,omitempty"` // Reserved for DocuSign. - LocalePolicy *LocalePolicyTab `json:"localePolicy,omitempty"` + AnchorTabProcessorVersion string `json:"anchorTabProcessorVersion,omitempty"` + // Reserved for DocuSign. + AnchorTabProcessorVersionMetadata *PropertyMetadata `json:"anchorTabProcessorVersionMetadata,omitempty"` + // Specifies units of the + // `anchorXOffset` and + // `anchorYOffset`. + // Valid units are: + // + // - `pixels` + // - `inches` + // - `mms` + // - `cms` + // + AnchorUnits string `json:"anchorUnits,omitempty"` + // Metadata that indicates whether the `anchorUnits` property is editable. + AnchorUnitsMetadata *PropertyMetadata `json:"anchorUnitsMetadata,omitempty"` + // Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. + // + AnchorXOffset string `json:"anchorXOffset,omitempty"` + // Metadata that indicates whether the `anchorXOffset` property is editable. + AnchorXOffsetMetadata *PropertyMetadata `json:"anchorXOffsetMetadata,omitempty"` + // Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. + // + AnchorYOffset string `json:"anchorYOffset,omitempty"` + // Metadata that indicates whether the `anchorYOffset` property is editable. + AnchorYOffsetMetadata *PropertyMetadata `json:"anchorYOffsetMetadata,omitempty"` + // The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. + CustomTabID string `json:"customTabId,omitempty"` + // Metadata that indicates whether the `customTabId` property is editable. + CustomTabIDMetadata *PropertyMetadata `json:"customTabIdMetadata,omitempty"` + // This object describes errors that occur. It is only valid for responses and ignored in requests. + ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` + // The height of the tab in pixels. + Height string `json:"height,omitempty"` + // Metadata that indicates whether the `height` property is editable. + HeightMetadata *PropertyMetadata `json:"heightMetadata,omitempty"` // When set to **true**, the signer cannot change the data of the custom tab. Locked DSBool `json:"locked,omitempty"` // Metadata that indicates whether the `locked` property is editable. LockedMetadata *PropertyMetadata `json:"lockedMetadata,omitempty"` - // An optional value that describes the maximum length of the property when the property is a string. - MaxLength string `json:"maxLength,omitempty"` - // Metadata that indicates whether the `maxLength` property is editable. - MaxLengthMetadata *PropertyMetadata `json:"maxLengthMetadata,omitempty"` - // The initial value of the tab when it was sent to the recipient. - OriginalValue string `json:"originalValue,omitempty"` - // Metadata that indicates whether the `originalValue` property is editable. - OriginalValueMetadata *PropertyMetadata `json:"originalValueMetadata,omitempty"` - // This property indicates - // that this formula tab - // is a payment item. - // See [Requesting Payments Along with Signatures][paymentguide] - // in the DocuSign Support Center - // to learn more about payments. - // - // [paymentguide]: https://support.docusign.com/en/guides/requesting-payments-along-with-signatures + // Contains the information necessary to map the tab to a field in SalesForce. + MergeField *MergeField `json:"mergeField,omitempty"` // - PaymentDetails *PaymentDetails `json:"paymentDetails,omitempty"` - // When set to **true** and shared is true, information must be entered in this field to complete the envelope. - RequireAll DSBool `json:"requireAll,omitempty"` - // Metadata that indicates whether the `requireAll` property is editable. - RequireAllMetadata *PropertyMetadata `json:"requireAllMetadata,omitempty"` - // Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field. - RequireInitialOnSharedChange DSBool `json:"requireInitialOnSharedChange,omitempty"` - // Metadata that indicates whether the `requireInitialOnSharedChange` property is editable. - RequireInitialOnSharedChangeMetadata *PropertyMetadata `json:"requireInitialOnSharedChangeMetadata,omitempty"` + MergeFieldXML string `json:"mergeFieldXml,omitempty"` + // Specifies the page number on which the tab is located. + PageNumber string `json:"pageNumber,omitempty"` + // Metadata that indicates whether the `pageNumber` property is editable. + PageNumberMetadata *PropertyMetadata `json:"pageNumberMetadata,omitempty"` // When set to **true**, the signer is required to fill out this tab. Required TabRequired `json:"required,omitempty"` // Metadata that indicates whether the `required` property is editable. RequiredMetadata *PropertyMetadata `json:"requiredMetadata,omitempty"` - // The number of decimal places to round to. - RoundDecimalPlaces string `json:"roundDecimalPlaces,omitempty"` - // Metadata that indicates whether the `roundDecimalPlaces` property is editable. - RoundDecimalPlacesMetadata *PropertyMetadata `json:"roundDecimalPlacesMetadata,omitempty"` - // When set to **true**, the sender must populate the tab before an envelope can be sent using the template. // - // This value tab can only be changed by modifying (PUT) the template. + SmartContractInformation *SmartContractInformation `json:"smartContractInformation,omitempty"` + // The status of the tab. Possible values are: // - // Tabs with a `senderRequired` value of true cannot be deleted from an envelope. - SenderRequired DSBool `json:"senderRequired,omitempty"` - // Metadata that indicates whether the `senderRequired` property is editable. - SenderRequiredMetadata *PropertyMetadata `json:"senderRequiredMetadata,omitempty"` - // When set to **true**, this custom tab is shared. - Shared DSBool `json:"shared,omitempty"` - // Metadata that indicates whether the `shared` property is editable. - SharedMetadata *PropertyMetadata `json:"sharedMetadata,omitempty"` - // Metadata that indicates whether the `toolTip` property is editable. - ToolTipMetadata *PropertyMetadata `json:"toolTipMetadata,omitempty"` - // The text of a tooltip that appears when a user hovers over a form field or tab. - Tooltip string `json:"tooltip,omitempty"` - // The message displayed if the custom tab fails input validation (either custom of embedded). - ValidationMessage string `json:"validationMessage,omitempty"` - // Metadata that indicates whether the `validationMessage` property is editable. - ValidationMessageMetadata *PropertyMetadata `json:"validationMessageMetadata,omitempty"` - // A regular expression used to validate input for the tab. - ValidationPattern string `json:"validationPattern,omitempty"` - // Metadata that indicates whether the `validationPattern` property is editable. - ValidationPatternMetadata *PropertyMetadata `json:"validationPatternMetadata,omitempty"` - // The width of the tab in pixels. - Width string `json:"width,omitempty"` - // Metadata that indicates whether the `width` property is editable. - WidthMetadata *PropertyMetadata `json:"widthMetadata,omitempty"` -} - -// FullName is a tab that displays the recipient's full name. -// -type FullName struct { - TabBase - TabGuidedForm - TabPosition - TabStyle - TabValue - // The height of the tab in pixels. - Height string `json:"height,omitempty"` - // Metadata that indicates whether the `height` property is editable. - HeightMetadata *PropertyMetadata `json:"heightMetadata,omitempty"` - // Reserved for DocuSign. - LocalePolicy *LocalePolicyTab `json:"localePolicy,omitempty"` + // - `active`: The tab is active, but the recipient has not yet interacted with it. + // - `signed`: The recipient signed the tab. + // - `declined`: The recipient declined the envelope. + // - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). + Status string `json:"status,omitempty"` + // Metadata that indicates whether the `status` property is editable. + StatusMetadata *PropertyMetadata `json:"statusMetadata,omitempty"` + // The unique identifier for the tab. + TabID string `json:"tabId,omitempty"` + // Metadata that indicates whether the `tabId` property is editable. + TabIDMetadata *PropertyMetadata `json:"tabIdMetadata,omitempty"` + // A positive integer that sets the order the tab is navigated to during signing. + // + // Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. + TabOrder string `json:"tabOrder,omitempty"` + // Metadata that indicates whether the `tabOrder` property is editable. + TabOrderMetadata *PropertyMetadata `json:"tabOrderMetadata,omitempty"` + // When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. + TemplateLocked string `json:"templateLocked,omitempty"` + // Metadata that indicates whether the `templateLocked` property is editable. + TemplateLockedMetadata *PropertyMetadata `json:"templateLockedMetadata,omitempty"` + // When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. + TemplateRequired string `json:"templateRequired,omitempty"` + // Metadata that indicates whether the `templateRequired` property is editable. + TemplateRequiredMetadata *PropertyMetadata `json:"templateRequiredMetadata,omitempty"` // Metadata that indicates whether the `toolTip` property is editable. ToolTipMetadata *PropertyMetadata `json:"toolTipMetadata,omitempty"` // The text of a tooltip that appears when a user hovers over a form field or tab. @@ -7937,99 +13581,46 @@ type FullName struct { Width string `json:"width,omitempty"` // Metadata that indicates whether the `width` property is editable. WidthMetadata *PropertyMetadata `json:"widthMetadata,omitempty"` -} - -type GraphicsContext struct { - // The fill color to use for the overlay. Colors are typically specified by their RGB hex values, but you can also use a [friendly CSS color name](https://developer.mozilla.org/en-US/docs/Web/CSS/color_value). - FillColor string `json:"fillColor,omitempty"` - // The line color to use for the overlay. Colors are typically specified by their RGB hex values, but you can also use a [friendly CSS color name](https://developer.mozilla.org/en-US/docs/Web/CSS/color_value). - LineColor string `json:"lineColor,omitempty"` - // The line weight or thickness to use for the overlay. - LineWeight string `json:"lineWeight,omitempty"` -} - -// Group information about groups. -type Group struct { - // This object describes errors that occur. It is only valid for responses and ignored in requests. - ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` - // The DocuSign group ID for the group. - GroupID string `json:"groupId,omitempty"` - // The name of the group. - GroupName string `json:"groupName,omitempty"` - // The group type. Potential values for POST and PUT requests include: + // This property indicates the horizontal offset of the object on the page. + // DocuSign uses 72 DPI when determining position. + // Required. May be zero. // - // - `adminstrators` - // - `everyone` - // - `customGroup` // - // - GroupType string `json:"groupType,omitempty"` - // The ID of the permission profile associated with the group. Possible values include: + XPosition string `json:"xPosition,omitempty"` + // Metadata that indicates whether the `xPosition` property is editable. + XPositionMetadata *PropertyMetadata `json:"xPositionMetadata,omitempty"` + // This property indicates the vertical offset of the object on the page. + // DocuSign uses 72 DPI when determining position. + // Required. May be zero. // - // - `2301416` (for the `DocuSign Viewer` profile) - // - `2301415` (for the `DocuSign Sender` profile) - // - `2301414` (for the `Account Administrator` profile) - PermissionProfileID string `json:"permissionProfileId,omitempty"` - // A list of the users in the group. - Users []UserInfo `json:"users,omitempty"` - // The total number of users in the group. - UsersCount string `json:"usersCount,omitempty"` -} - -type GroupInformation struct { - // The last position in the result set. - EndPosition string `json:"endPosition,omitempty"` - // A collection group objects containing information about the groups. - Groups []Group `json:"groups,omitempty"` - // The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. - NextURI string `json:"nextUri,omitempty"` - // The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. - PreviousURI string `json:"previousUri,omitempty"` - // The number of results returned in this response. Because you can filter which entries are included in the response, this value is always less than or equal to `totalSetSize`. - ResultSetSize string `json:"resultSetSize,omitempty"` - // The starting position of the current result set. - StartPosition string `json:"startPosition,omitempty"` - // The total number of items in the search's result set. This value is always greater than or equal to the value of `resultSetSize`. - TotalSetSize string `json:"totalSetSize,omitempty"` -} - -// IDCheckConfiguration is a complex object specifying ID check configuration. -type IDCheckConfiguration struct { - // A list of ID check security steps, each specifying an authorization type. - AuthSteps []IDCheckSecurityStep `json:"authSteps,omitempty"` - // Boolean that specifies whether the signature is the default signature for the user. - IsDefault string `json:"isDefault,omitempty"` - // The name of the signature. - Name string `json:"name,omitempty"` -} - -// IDCheckInformationInput is a complex element that contains input information related to a recipient ID check. -type IDCheckInformationInput struct { - // An object that specifies recipient address information and how it is displayed. - AddressInformationInput *AddressInformationInput `json:"addressInformationInput,omitempty"` - // An object that specifies recipient date of birth information and how it is displayed. - DobInformationInput *DobInformationInput `json:"dobInformationInput,omitempty"` - // An object that specifies the last four digits of the recipient's Social Security Number (SSN). - Ssn4InformationInput *Ssn4InformationInput `json:"ssn4InformationInput,omitempty"` - // An object that specifies the recipient's Social Security Number (SSN) information. Note that ssn9 information cannot be returned in a response. - Ssn9InformationInput *Ssn9InformationInput `json:"ssn9InformationInput,omitempty"` + // + YPosition string `json:"yPosition,omitempty"` + // Metadata that indicates whether the `yPosition` property is editable. + YPositionMetadata *PropertyMetadata `json:"yPositionMetadata,omitempty"` } -type IDCheckSecurityStep struct { - // Type of authorization used for the security check. - AuthType string `json:"authType,omitempty"` +type Notary struct { + // The creation date of the account in UTC timedate format. + CreatedDate string `json:"createdDate,omitempty"` + // The date the this object was created. + Enabled string `json:"enabled,omitempty"` + // If **true**, this notary is searchable. + Searchable string `json:"searchable,omitempty"` + // Information about the user registering to be a notary. + UserInfo *UserInformation `json:"userInfo,omitempty"` } -// InPersonSigner is an in-person recipient is a DocuSign user, -// acting as a Signing Host, -// who is in the same physical location as the signer. -// To learn about fields used -// for eNotary feature, -// see the [EnvelopeRecipients resource][enveloperecipientsInPerson]. +// NotaryHost this object is used only when `inPersonSigningType` in the `inPersonSigner` object is `notary`. +// +// It describes information about the notary host. +// The following information is required +// when using the eNotary in-person signing flow: // -// [enveloperecipientsInPerson]: /https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipients/#in-person-signers-recipient +// * `name`: Specifies the notary's full legal name. +// * `email`: Specifies the notary's email address. +// * `recipientId`: A unique ID number for the notary signing host. // -type InPersonSigner struct { +type NotaryHost struct { // If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. // // Maximum Length: 50 characters and it must conform to the account's access code format setting. @@ -8038,16 +13629,12 @@ type InPersonSigner struct { // // If blank and the signer `accessCode` property is not set, then the access code is not required. AccessCode string `json:"accessCode,omitempty"` - // Metadata that indicates whether the `accessCode` property is editable. - // + // Metadata that indicates whether the `accessCode` property is editable. Read only. AccessCodeMetadata *PropertyMetadata `json:"accessCodeMetadata,omitempty"` - // This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient. + // Optional. When set to **true**, the access code will be added to the email sent to the recipient. This nullifies the security measure of `accessCode` on the recipient. AddAccessCodeToEmail string `json:"addAccessCodeToEmail,omitempty"` - // When **true**, auto navigation is set for the recipient. // - AutoNavigation string `json:"autoNavigation,omitempty"` - // When set to **true**, specifies that the signer can perform the signing ceremony offline. - CanSignOffline DSBool `json:"canSignOffline,omitempty"` + AllowSystemOverrideForLockedRecipient string `json:"allowSystemOverrideForLockedRecipient,omitempty"` // Specifies whether the recipient is embedded or remote. // // If the `clientUserId` property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing. @@ -8056,45 +13643,38 @@ type InPersonSigner struct { // // Maximum length: 100 characters. ClientUserID string `json:"clientUserId,omitempty"` - // Indicates the number of times that the recipient has been through a signing completion. - // - // If this number is greater than `0` for a signing group, only the user who previously completed may sign again. + // Indicates the number of times that the recipient has been through a signing completion for the envelope. If this number is greater than 0 for a signing group, only the user who previously completed may sign again. Read only. CompletedCount string `json:"completedCount,omitempty"` - // Payment status for payment services. - CreationReason string `json:"creationReason,omitempty"` // An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters. CustomFields []string `json:"customFields,omitempty"` - // The date and time the recipient declined the document. + // The date and time the recipient declined the document. Read only. DeclinedDateTime *time.Time `json:"declinedDateTime,omitempty"` - // The reason the recipient declined the document. + // The reason the recipient declined the document. Read only. DeclinedReason string `json:"declinedReason,omitempty"` - // When set to **true**, - // this is the default recipient for the envelope. - // This option is used when creating an envelope from a template. - // - DefaultRecipient DSBool `json:"defaultRecipient,omitempty"` - // The date and time that the envelope was delivered to the recipient. + // The date and time that the envelope was delivered to the recipient. Read only. DeliveredDateTime *time.Time `json:"deliveredDateTime,omitempty"` // Reserved for DocuSign. DeliveryMethod string `json:"deliveryMethod,omitempty"` - // Metadata that indicates whether the `deliveryMethod` property is editable. - // + // Reserved for DocuSign. DeliveryMethodMetadata *PropertyMetadata `json:"deliveryMethodMetadata,omitempty"` - // Specifies if the documents are visible to this recipient. Document Visibility must be enabled for the account and the enforceSignerVisibility property must be set to true for the envelope to use this. + // + DesignatorID string `json:"designatorId,omitempty"` + // + DesignatorIDGUID string `json:"designatorIdGuid,omitempty"` + // A list of `documentVisibility` objects. Each object in the list specifies whether a document in the envelope is visible to this recipient. For the envelope to use this functionality, Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true**. DocumentVisibility []DocumentVisibility `json:"documentVisibility,omitempty"` - // The signer's email address in an eNotary flow. + // The notary's email address. // - // Use only when `inPersonSigningType` is `notary`. - // For regular in-person-signer flow, use `signerEmail` instead. + // Maximum Length: 100 characters. // Email string `json:"email,omitempty"` - // Metadata that indicates if the sender can edit the signer's email address in an eNotary flow. + // Metadata that indicates whether the `email` property is editable. Read only. EmailMetadata *PropertyMetadata `json:"emailMetadata,omitempty"` // An optional complex type that sets a specific email subject and body for this recipient's notification email. // - // **Note**: If you use this field to set a specific email notification for one recipient, you must also set the email notification for the other recipients. Using this field for one or more recipients negates the Envelope `Subject` and `EmailBlurb` property settings. + // **Note**: You can set the `emailNotification` property separately for each recipient. If you set the value only for certain recipients, the other recipients will inherit the this value from the top-level `emailSubject` and `emailBlurb`. EmailNotification *RecipientEmailNotification `json:"emailNotification,omitempty"` - // Specifies a sender-provided valid URL string for redirecting an embedded recipient. When this option is used, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the recipient clicks the document link in the email, the recipient is redirected through DocuSign to the specified URL to complete the required actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. + // Specifies a sender-provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. // // If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation launched by a partner. // @@ -8108,287 +13688,239 @@ type InPersonSigner struct { EmbeddedRecipientStartURL string `json:"embeddedRecipientStartURL,omitempty"` // This object describes errors that occur. It is only valid for responses and ignored in requests. ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` - // Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true** for the envelope to use this. - // - // When enforce signer visibility is enabled, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent. - ExcludedDocuments []string `json:"excludedDocuments,omitempty"` // Reserved for DocuSign. FaxNumber string `json:"faxNumber,omitempty"` // Reserved for DocuSign. FaxNumberMetadata *PropertyMetadata `json:"faxNumberMetadata,omitempty"` - // The email address of the signing host. - // This is the DocuSign user that is hosting the in-person signing session. - // - // Required when `inPersonSigningType` is `inPersonSigner`. - // For eNotary flow, use `email` instead. // - // Maximum Length: 100 characters. - // - HostEmail string `json:"hostEmail,omitempty"` - // Metadata that indicates if the sender can edit the email address of the signing host. - HostEmailMetadata *PropertyMetadata `json:"hostEmailMetadata,omitempty"` - // The name of the signing host. - // This is the DocuSign user that is hosting the in-person signing session. - // - // Required when `inPersonSigningType` is `inPersonSigner`. - // For eNotary flow, use `name` instead. - // - // Maximum Length: 100 characters. - // - HostName string `json:"hostName,omitempty"` - // Metadata that indicates whether the `hostName` property is editable. + HostRecipientID string `json:"hostRecipientId,omitempty"` + // The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are: // - HostNameMetadata *PropertyMetadata `json:"hostNameMetadata,omitempty"` - // The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. + // - `Phone Auth $`: The recipient must authenticate by using two-factor authentication (2FA). You provide the phone number to use for 2FA in the `phoneAuthentication` object. + // - `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object. + // - `ID Check $`: The recipient must answer detailed security questions. // // **Example**: Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node. IDCheckConfigurationName string `json:"idCheckConfigurationName,omitempty"` - // Metadata that indicates whether the `idCheckConfigurationName` property is editable. - // + // Metadata that indicates whether the `idCheckConfigurationName` property is editable. Read only. IDCheckConfigurationNameMetadata *PropertyMetadata `json:"idCheckConfigurationNameMetadata,omitempty"` // An object that contains input information related to a recipient ID check. IDCheckInformationInput *IDCheckInformationInput `json:"idCheckInformationInput,omitempty"` - // Specifies whether the envelope uses the eNotary feature. - // Valid values: - // - // * `inPersonSigner` The envelope uses the normal in-person signing flow. - // * `notary`: The envelope uses the eNotary in-person signing flow. - // - InPersonSigningType string `json:"inPersonSigningType,omitempty"` - // Metadata that indicates whether the `inPersonSigningType` property is editable. - // - InPersonSigningTypeMetadata *PropertyMetadata `json:"inPersonSigningTypeMetadata,omitempty"` + // Specifies the ID Verification workflow applied on an envelope by workflow ID.
See the [list](https://developers.docusign.com/docs/esign-rest-api/reference/Accounts/IdentityVerifications/list) method in the [IdentityVerifications](https://developers.docusign.com/docs/esign-rest-api/reference/Accounts/IdentityVerifications) resource for more information on how to retrieve workflow IDs available for an account.
This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods.
Note that ID Verification and ID Check are two distinct methods. ID Verification checks recipients' identity by verifying their ID while ID Check relies on data available on public records (such as current and former address). + IdentityVerification *RecipientIdentityVerification `json:"identityVerification,omitempty"` // When set to **true** and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account. InheritEmailNotificationConfiguration DSBool `json:"inheritEmailNotificationConfiguration,omitempty"` // Reserved for DocuSign. LockedRecipientPhoneAuthEditable string `json:"lockedRecipientPhoneAuthEditable,omitempty"` // Reserved for DocuSign. LockedRecipientSmsEditable string `json:"lockedRecipientSmsEditable,omitempty"` - // The signer's full legal name in an eNotary flow. - // - // Required when `inPersonSigningType` is `notary`. - // For regular in-person-signer flow, use `signerName` instead. + // The notary's full legal name. // // Maximum Length: 100 characters. // Name string `json:"name,omitempty"` - // Metadata that indicates if the sender can edit the signer's full legal name in an eNotary flow. + // Metadata that indicates whether the `name` property is editable. Read only. NameMetadata *PropertyMetadata `json:"nameMetadata,omitempty"` - // Information about the notary host. The following information is required when using the eNotary in-person signing flow: - // - // - `name`: The name of the notary. - // - `email`: The email address of the notary. - // - `recipientId`: A unique ID number for the notary signing host. - NotaryHost *NotaryHost `json:"notaryHost,omitempty"` - // A note sent to the in-person signer in the signing email. - // This note is visible only to this recipient. + // A note sent to the notary in the signing email. + // This note is visible only to this notary. // // Maximum Length: 1000 characters. // Note string `json:"note,omitempty"` - // Metadata that indicates if the sender can edit the note sent to the in-person signer in the signing email. + // Metadata that indicates whether the `note` property is editable. Read only. NoteMetadata *PropertyMetadata `json:"noteMetadata,omitempty"` - // A complex type that contains the following elements: + // When `idCheckConfigurationName` is set to `Phone Auth $`, you use this complex type to provide the recipient authentication method details. It contains the following elements: + // + // * `recipMayProvideNumber`: Boolean. When set to **true**, the recipient can use whatever phone number they choose. + // * `senderProvidedNumbers`: ArrayOfStrings. A list of phone numbers the recipient can use. + // * `recordVoicePrint`: Reserved for DocuSign. + // * `validateRecipProvidedNumber`: Reserved for DocuSign. + // // - // * `recipMayProvideNumber` - Boolean. When set to **true**, the recipient can use whatever phone number they choose. - // * `senderProvidedNumbers` - ArrayOfString. A list of phone numbers the recipient can use. - // * `recordVoicePrint` - Reserved. - // * `validateRecipProvidedNumber` - Reserved. PhoneAuthentication DSBool `json:"phoneAuthentication,omitempty"` // Reserved for DocuSign. RecipientAttachments []RecipientAttachment `json:"recipientAttachments,omitempty"` - // Information about the recipient's authentication status. + // Information about the recipient's authentication status. Read only. RecipientAuthenticationStatus *AuthenticationStatus `json:"recipientAuthenticationStatus,omitempty"` - // Metadata that indicates whether the `recipientFeature` property is editable. - // + // Metadata about the features that are supported for the recipient type. Read only. RecipientFeatureMetadata []FeatureAvailableMetadata `json:"recipientFeatureMetadata,omitempty"` // Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. RecipientID string `json:"recipientId,omitempty"` - // The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. + // The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only. RecipientIDGUID string `json:"recipientIdGuid,omitempty"` - // The default signature provider is the DocuSign Electronic signature system. This parameter is used to specify one or more Standards Based Signature (digital signature) providers for the signer to use. [More information.](https://developers.docusign.com/esign-rest-api/guides/standards-based-signatures) - RecipientSignatureProviders []RecipientSignatureProvider `json:"recipientSignatureProviders,omitempty"` - // Specifies whether the recipient creates the tabs. - RecipientSuppliesTabs string `json:"recipientSuppliesTabs,omitempty"` // The recipient type, as specified by the following values: - // - `agents`: Agent recipients can add name and email information for recipients that appear after the agent in routing order. - // - `carbonCopies`: Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date, or add information to any of the documents. This type of recipient can be used in any routing order. - // - `certifiedDeliveries`: Certified delivery recipients must receive the completed documents for the envelope to be completed. They don't need to sign, initial, date, or add information to any of the documents. - // - `editors`: Editors have the same management and access rights for the envelope as the sender. Editors can add name and email information, add or change the routing order, set authentication options, and can edit signature/initial tabs and data fields for the remaining recipients. - // - `inPersonSigners`: In-person recipients are DocuSign users who act as signing hosts in the same physical location as the signer. + // - `agent`: Agent recipients can add name and email information for recipients that appear after the agent in routing order. + // - `carbonCopy`: Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date, or add information to any of the documents. This type of recipient can be used in any routing order. + // - `certifiedDelivery`: Certified delivery recipients must receive the completed documents for the envelope to be completed. They don't need to sign, initial, date, or add information to any of the documents. + // - `editor`: Editors have the same management and access rights for the envelope as the sender. Editors can add name and email information, add or change the routing order, set authentication options, and can edit signature/initial tabs and data fields for the remaining recipients. + // - `inPersonSigner`: In-person recipients are DocuSign users who act as signing hosts in the same physical location as the signer. // - `intermediaries`: Intermediary recipients can optionally add name and email information for recipients at the same or subsequent level in the routing order. - // - `seals`: Electronic seal recipients represent legal entities. - // - `signers`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope. - // - `witnesses`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope. + // - `seal`: Electronic seal recipients represent legal entities. + // - `signer`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope. + // - `witness`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope. RecipientType string `json:"recipientType,omitempty"` - // Metadata that indicates whether the `recipientType` property is editable. - // + // Metadata that indicates whether the `recipientType` property is editable. Read only. RecipientTypeMetadata *PropertyMetadata `json:"recipientTypeMetadata,omitempty"` // When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. RequireIDLookup DSBool `json:"requireIdLookup,omitempty"` - // Metadata that indicates whether the `requireIdLookup` property is editable. - // + // Metadata that indicates whether the `requireIdLookup` property is editable. Read only. RequireIDLookupMetadata *PropertyMetadata `json:"requireIdLookupMetadata,omitempty"` - // When set to **true**, the signer must print, sign, and upload or fax the signed documents to DocuSign. - RequireSignOnPaper DSBool `json:"requireSignOnPaper,omitempty"` - // By default, DocuSign signers create electronic signatures. This field can be used to require the signer to use a SAFE-BioPharma digital certificate for signing. - // - // This parameter should only be used to select a SAFE-BioPharma certificate. New integrations should use the `recipientSignatureProviders` parameter for other types of digital certificates. - // - // Set this parameter to `safe` to use a SAFE-BioPharma certificate. - // - // The signer must be enrolled in the SAFE program to sign with a SAFE certificate. - RequireSignerCertificate string `json:"requireSignerCertificate,omitempty"` - // Optional element. Specifies the role name associated with the recipient.

This is required when working with template recipients. + // Optional element. Specifies the role name associated with the recipient.

This property is required when you are working with template recipients. RoleName string `json:"roleName,omitempty"` // Specifies the routing order of the recipient in the envelope. RoutingOrder string `json:"routingOrder,omitempty"` - // Metadata that indicates whether the `routingOrder` property is editable. - // + // Metadata that indicates whether the `routingOrder` property is editable. Read only. RoutingOrderMetadata *PropertyMetadata `json:"routingOrderMetadata,omitempty"` - // The date and time the envelope was sent. + // The UTC DateTime when the envelope was sent. Read only. SentDateTime *time.Time `json:"sentDateTime,omitempty"` - // When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab (instead of adopting a signature/initial style or only drawing a signature/initial once). - SignInEachLocation DSBool `json:"signInEachLocation,omitempty"` - // Metadata that indicates if the sender can edit the `signInEachLocation` property. - SignInEachLocationMetadata *PropertyMetadata `json:"signInEachLocationMetadata,omitempty"` - // Allows the sender to pre-specify the signature name, signature initials and signature font used in the signature stamp for the recipient. - // - // Used only with recipient types In Person Signers and Signers. - // - SignatureInfo *RecipientSignatureInformation `json:"signatureInfo,omitempty"` // Reserved for DocuSign. SignedDateTime *time.Time `json:"signedDateTime,omitempty"` - // The in-person signer's email address. - // - // Required when `inPersonSigningType` is `inPersonSigner`. - // For eNotary flow, use `email` instead. - // - // Maximum Length: 100 characters. - // - // - SignerEmail string `json:"signerEmail,omitempty"` - // Metadata that indicates if the sender can edit the in-person signer's email address. - SignerEmailMetadata *PropertyMetadata `json:"signerEmailMetadata,omitempty"` - // The first name of the in-person signer. - SignerFirstName string `json:"signerFirstName,omitempty"` - // Metadata that indicates if the sender can edit the first name of the in-person signer. - SignerFirstNameMetadata *PropertyMetadata `json:"signerFirstNameMetadata,omitempty"` - // The last name of the in-person siger. - SignerLastName string `json:"signerLastName,omitempty"` - // Metadata that indicates if the sender can edit the last name of the in-person signer. - SignerLastNameMetadata *PropertyMetadata `json:"signerLastNameMetadata,omitempty"` - // The in-person signer's full legal name. - // - // Required when `inPersonSigningType` is `inPersonSigner`. - // For eNotary flow, use `name` instead. - // - // Maximum Length: 100 characters. - // - SignerName string `json:"signerName,omitempty"` - // Metadata that indicates if the sender can edit the in-person signer's full legal name. - SignerNameMetadata *PropertyMetadata `json:"signerNameMetadata,omitempty"` - // The id of the signing group of which the in-person signer is a member. + // When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once). SigningGroupID string `json:"signingGroupId,omitempty"` - // Metadata that indicates whether the `signingGroupId` property is editable. - // + // Metadata that indicates whether the `signingGroupId` property is editable. Read only. SigningGroupIDMetadata *PropertyMetadata `json:"signingGroupIdMetadata,omitempty"` - // The display name for the signing group. + // Optional. The name of the signing group. // // Maximum Length: 100 characters. SigningGroupName string `json:"signingGroupName,omitempty"` // A complex type that contains information about users in the signing group. SigningGroupUsers []UserInfo `json:"signingGroupUsers,omitempty"` - // Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication. + // When `idCheckConfigurationName` is set to `SMS Auth $`, you use this complex type to provide the recipient authentication method details. It contains the element `senderProvidedNumbers`, which is an array of phone numbers that the recipient can use for SMS text authentication. + // // SmsAuthentication *RecipientSMSAuthentication `json:"smsAuthentication,omitempty"` - // Lists the social ID type that can be used for recipient authentication. + // Deprecated. SocialAuthentications []SocialAuthentication `json:"socialAuthentications,omitempty"` - // Recipient status. - // - // + // The recipient's status. Read only. + // + // Possible values: + // + // - `autoresponded`: The recipient's email system auto-responded to the email from DocuSign. This status is used in the web console to inform senders about the bounced-back email. This recipient status is only used if **Send-on-behalf-of** is turned off for the account. + // - `completed`: The recipient has completed their actions (signing or other required actions if not a signer) for an envelope. + // - `created`: The recipient is in a draft state. This value is only associated with draft envelopes (envelopes that have a status of `created`). + // - `declined`: The recipient declined to sign the document(s) in the envelope. + // - `delivered`: The recipient has viewed the document(s) in an envelope through the DocuSign signing website. This is not an email delivery of the documents in an envelope. + // - `faxPending`: The recipient has finished signing and the system is waiting for a fax attachment from the recipient before completing their signing step. + // - `sent`: The recipient has been sent an email notification that it is their turn to sign an envelope. + // - `signed`: The recipient has completed (signed) all required tags in an envelope. This is a temporary state during processing, after which the recipient's status automatically switches to `completed`. Status string `json:"status,omitempty"` - // Reserved for DocuSign. + // The code associated with the recipient's status. Read only. StatusCode string `json:"statusCode,omitempty"` - // A list of `signHere` tabs, which can be used to add a visual representation for an electronic seal in a document. + // When set to **true**, email notifications are suppressed for the recipient, and they must access envelopes and documents from their DocuSign inbox. + SuppressEmails string `json:"suppressEmails,omitempty"` + // A list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients. Tabs *Tabs `json:"tabs,omitempty"` // When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. TemplateLocked DSBool `json:"templateLocked,omitempty"` // When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. TemplateRequired DSBool `json:"templateRequired,omitempty"` - // The total number of tabs in the documents. + // The total number of tabs in the documents. Read only. TotalTabCount string `json:"totalTabCount,omitempty"` // The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing. // - UserID string `json:"userId,omitempty"` + UserID string `json:"userId,omitempty"` +} + +type NotaryJournal struct { + // The creation date of the account in UTC timedate format. + CreatedDate string `json:"createdDate,omitempty"` + // + DocumentName string `json:"documentName,omitempty"` + // + Jurisdiction *Jurisdiction `json:"jurisdiction,omitempty"` + // + NotaryJournalID string `json:"notaryJournalId,omitempty"` + // + NotaryJournalMetaData *NotaryJournalMetaData `json:"notaryJournalMetaData,omitempty"` + // The in-person signer's full legal name. + // + // Required when `inPersonSigningType` is `inPersonSigner`. + // For eNotary flow, use `name` instead. + // + // Maximum Length: 100 characters. + // + SignerName string `json:"signerName,omitempty"` } -// InitialHere is a tab that allows the recipient to initial the document. May -// be optional. -// -type InitialHere struct { - TabBase - TabGuidedForm - TabPosition - // The height of the tab in pixels. - Height string `json:"height,omitempty"` - // Metadata that indicates whether the `height` property is editable. - HeightMetadata *PropertyMetadata `json:"heightMetadata,omitempty"` - // The name of the tab. For example, `Sign Here` or `Initial Here`. +type NotaryJournalCredibleWitness struct { + // The user's address. + Address string `json:"address,omitempty"` + // Name string `json:"name,omitempty"` - // Metadata that indicates whether the `name` property is editable. - NameMetadata *PropertyMetadata `json:"nameMetadata,omitempty"` - // When set to **true**, the recipient does not need to complete this tab to complete the signing process. - Optional DSBool `json:"optional,omitempty"` - // Metadata that indicates whether the `optional` property is editable. - OptionalMetadata *PropertyMetadata `json:"optionalMetadata,omitempty"` - // Sets the size of the tab. This field accepts values from `0.5` to `1.0`, where `1.0` represents full size and `0.5` is 50% of full size. - ScaleValue string `json:"scaleValue,omitempty"` - // Metadata that indicates whether the `scaleValue` property is editable. - ScaleValueMetadata *PropertyMetadata `json:"scaleValueMetadata,omitempty"` - // Metadata that indicates whether the `toolTip` property is editable. - ToolTipMetadata *PropertyMetadata `json:"toolTipMetadata,omitempty"` - // The text of a tooltip that appears when a user hovers over a form field or tab. - Tooltip string `json:"tooltip,omitempty"` - // The width of the tab in pixels. - Width string `json:"width,omitempty"` - // Metadata that indicates whether the `width` property is editable. - WidthMetadata *PropertyMetadata `json:"widthMetadata,omitempty"` + // + SignatureImage string `json:"signatureImage,omitempty"` } -type InlineTemplate struct { - // An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters. - CustomFields *CustomFields `json:"customFields,omitempty"` - // Complex element contains the details on the documents in the envelope. - Documents []Document `json:"documents,omitempty"` - // A container used to send documents to recipients. The envelope carries information about the sender and timestamps to indicate the progress of the delivery procedure. It can contain collections of Documents, Tabs and Recipients. - Envelope *Envelope `json:"envelope,omitempty"` - // An array of recipient objects that provides details about the recipients of the envelope. - Recipients *Recipients `json:"recipients,omitempty"` - // Specifies the order in which templates are overlaid. - Sequence string `json:"sequence,omitempty"` +type NotaryJournalList struct { + // The last index position in the result set. + EndPosition string `json:"endPosition,omitempty"` + // The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. + NextURI string `json:"nextUri,omitempty"` + // + NotaryJournals []NotaryJournal `json:"notaryJournals,omitempty"` + // The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. + PreviousURI string `json:"previousUri,omitempty"` + // The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`. + ResultSetSize string `json:"resultSetSize,omitempty"` + // The starting index position of the current result set. + StartPosition string `json:"startPosition,omitempty"` + // The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`. + TotalSetSize string `json:"totalSetSize,omitempty"` } -type IntegratedUserInfoList struct { +type NotaryJournalMetaData struct { // - AllUsersSelected string `json:"allUsersSelected,omitempty"` - // The last position in the result set. + Comment string `json:"comment,omitempty"` + // + CredibleWitnesses []NotaryJournalCredibleWitness `json:"credibleWitnesses,omitempty"` + // + SignatureImage string `json:"signatureImage,omitempty"` + // + SignerIDType string `json:"signerIdType,omitempty"` +} + +// NotaryJurisdiction is a notary jurisdiction. +type NotaryJurisdiction struct { + // The expiration date of the notary's commission in format: `MM/DD/YYYY`. + CommissionExpiration string `json:"commissionExpiration,omitempty"` + // The notary's commission identification. This varies from jurisdiction to jurisdiction. + CommissionID string `json:"commissionId,omitempty"` + // The county that the commission is valid in. + County string `json:"county,omitempty"` + // This object describes errors that occur. It is only valid for responses and ignored in requests. + ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` + // Description of the jurisdiction for this notary. + // This is a read-only property. + Jurisdiction *Jurisdiction `json:"jurisdiction,omitempty"` + // The registered name of the notary. + RegisteredName string `json:"registeredName,omitempty"` + // The seal type used for this juridiction. + // + // - `not_available` + // - `system_created` + // - `user_uploaded` + SealType string `json:"sealType,omitempty"` +} + +// NotaryJurisdictionList is a paged list of jurisdictions. +type NotaryJurisdictionList struct { + // The last index position in the result set. EndPosition string `json:"endPosition,omitempty"` // The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. NextURI string `json:"nextUri,omitempty"` + // An array of jurisdictions. + NotaryJurisdictions []NotaryJurisdiction `json:"notaryJurisdictions,omitempty"` // The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. PreviousURI string `json:"previousUri,omitempty"` - // The number of results returned in this response. Because you can filter which entries are included in the response, this value is always less than or equal to `totalSetSize`. + // The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`. ResultSetSize string `json:"resultSetSize,omitempty"` - // The starting position of the current result set. + // The starting index position of the current result set. StartPosition string `json:"startPosition,omitempty"` - // The total number of items in the search's result set. This value is always greater than or equal to the value of `resultSetSize`. + // The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`. TotalSetSize string `json:"totalSetSize,omitempty"` - // User management information. - Users []UserInfo `json:"users,omitempty"` } -type Intermediary struct { +type NotaryRecipient struct { // If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. // // Maximum Length: 50 characters and it must conform to the account's access code format setting. @@ -8397,10 +13929,25 @@ type Intermediary struct { // // If blank and the signer `accessCode` property is not set, then the access code is not required. AccessCode string `json:"accessCode,omitempty"` - // Metadata that indicates if the sender can edit the `accessCode` property. + // Metadata that indicates whether the `accessCode` property is editable. Read only. AccessCodeMetadata *PropertyMetadata `json:"accessCodeMetadata,omitempty"` - // This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient. + // Optional. When set to **true**, the access code will be added to the email sent to the recipient. This nullifies the security measure of `accessCode` on the recipient. AddAccessCodeToEmail string `json:"addAccessCodeToEmail,omitempty"` + // An array of additional notification objects. + AdditionalNotifications []RecipientAdditionalNotification `json:"additionalNotifications,omitempty"` + // Optional element. When set to **true**, the agents recipient associated with this recipient can change the recipient's pre-populated email address. This element is only active if enabled for the account. + AgentCanEditEmail string `json:"agentCanEditEmail,omitempty"` + // Optional element. When set to **true**, the agents recipient associated with this recipient can change the recipient's pre-populated name. This element is only active if enabled for the account. + AgentCanEditName string `json:"agentCanEditName,omitempty"` + // + AllowSystemOverrideForLockedRecipient string `json:"allowSystemOverrideForLockedRecipient,omitempty"` + // When set to **true**, autonavigation is set for the recipient. + // + AutoNavigation string `json:"autoNavigation,omitempty"` + // Reserved for DocuSign. + BulkRecipientsURI string `json:"bulkRecipientsUri,omitempty"` + // When set to **true**, specifies that the signer can perform the signing ceremony offline. + CanSignOffline string `json:"canSignOffline,omitempty"` // Specifies whether the recipient is embedded or remote. // // If the `clientUserId` property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing. @@ -8409,35 +13956,39 @@ type Intermediary struct { // // Maximum length: 100 characters. ClientUserID string `json:"clientUserId,omitempty"` - // Indicates the number of times that the recipient has been through a signing completion for the envelope. - // - // If this number is greater than 0 for a signing group, only the user who previously completed may sign again. + // Indicates the number of times that the recipient has been through a signing completion for the envelope. If this number is greater than 0 for a signing group, only the user who previously completed may sign again. Read only. CompletedCount string `json:"completedCount,omitempty"` + // The reason why the item was created. + CreationReason string `json:"creationReason,omitempty"` // An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters. CustomFields []string `json:"customFields,omitempty"` - // The date and time the recipient declined the document. - DeclinedDateTime *time.Time `json:"declinedDateTime,omitempty"` - // The reason the recipient declined the document. + // The date and time the recipient declined the document. Read only. + DeclinedDateTime string `json:"declinedDateTime,omitempty"` + // The reason the recipient declined the document. Read only. DeclinedReason string `json:"declinedReason,omitempty"` - // The date and time that the envelope was delivered to the recipient. - DeliveredDateTime *time.Time `json:"deliveredDateTime,omitempty"` + // When set to **true**, this recipient is the default recipient and any tabs generated by the transformPdfFields option are mapped to this recipient. + DefaultRecipient string `json:"defaultRecipient,omitempty"` + // The date and time that the envelope was delivered to the recipient. Read only. + DeliveredDateTime string `json:"deliveredDateTime,omitempty"` // Reserved for DocuSign. DeliveryMethod string `json:"deliveryMethod,omitempty"` // Reserved for DocuSign. DeliveryMethodMetadata *PropertyMetadata `json:"deliveryMethodMetadata,omitempty"` - // A list of documentVisibility objects, which define a recipient's read/write access to a document. + // + DesignatorID string `json:"designatorId,omitempty"` + // + DesignatorIDGUID string `json:"designatorIdGuid,omitempty"` + // A list of `documentVisibility` objects. Each object in the list specifies whether a document in the envelope is visible to this recipient. For the envelope to use this functionality, Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true**. DocumentVisibility []DocumentVisibility `json:"documentVisibility,omitempty"` - // Email id of the recipient. Notification of the document to sign is sent to this email id. // - // Maximum length: 100 characters. Email string `json:"email,omitempty"` - // Metadata that indicates if the sender can edit the email id of the recipient. + // Metadata that indicates whether the `email` property is editable. Read only. EmailMetadata *PropertyMetadata `json:"emailMetadata,omitempty"` // An optional complex type that sets a specific email subject and body for this recipient's notification email. // - // **Note**: If you use this field to set a specific email notification for one recipient, you must also set the email notification for the other recipients. Using this field for one or more recipients negates the Envelope `Subject` and `EmailBlurb` property settings. + // **Note**: You can set the `emailNotification` property separately for each recipient. If you set the value only for certain recipients, the other recipients will inherit the this value from the top-level `emailSubject` and `emailBlurb`. EmailNotification *RecipientEmailNotification `json:"emailNotification,omitempty"` - // Specifies a sender-provided valid URL string for redirecting an embedded recipient. When this option is used, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the recipient clicks the document link in the email, the recipient is redirected through DocuSign to the specified URL to complete the required actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. + // Specifies a sender-provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. // // If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation launched by a partner. // @@ -8454,42 +14005,62 @@ type Intermediary struct { // Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true** for the envelope to use this. // // When enforce signer visibility is enabled, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent. - ExcludedDocuments DSBool `json:"excludedDocuments,omitempty"` + ExcludedDocuments []string `json:"excludedDocuments,omitempty"` // Reserved for DocuSign. FaxNumber string `json:"faxNumber,omitempty"` - // Metadata that indicates whether the `faxNumber` property is editable. - // + // Reserved for DocuSign. FaxNumberMetadata *PropertyMetadata `json:"faxNumberMetadata,omitempty"` - // The recipient's first name. Maximum Length: 50 characters. + // The user's first name. + // Maximum Length: 50 characters. FirstName string `json:"firstName,omitempty"` - // Metadata that indicates if the sender can edit the recipient's first name. + // Metadata that indicates whether the `firstame` property is editable. Read only. FirstNameMetadata *PropertyMetadata `json:"firstNameMetadata,omitempty"` // Reserved for DocuSign. FullName string `json:"fullName,omitempty"` // Reserved for DocuSign. FullNameMetadata *PropertyMetadata `json:"fullNameMetadata,omitempty"` - // The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. + // The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are: + // + // - `Phone Auth $`: The recipient must authenticate by using two-factor authentication (2FA). You provide the phone number to use for 2FA in the `phoneAuthentication` object. + // - `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object. + // - `ID Check $`: The recipient must answer detailed security questions. // // **Example**: Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node. IDCheckConfigurationName string `json:"idCheckConfigurationName,omitempty"` - // Metadata that indicates if the sender can edit the `idCheckConfigurationName` property. + // Metadata that indicates whether the `idCheckConfigurationName` property is editable. Read only. IDCheckConfigurationNameMetadata *PropertyMetadata `json:"idCheckConfigurationNameMetadata,omitempty"` // An object that contains input information related to a recipient ID check. IDCheckInformationInput *IDCheckInformationInput `json:"idCheckInformationInput,omitempty"` + // Specifies the ID Verification workflow applied on an envelope by workflow ID.
See the [list](https://developers.docusign.com/docs/esign-rest-api/reference/Accounts/IdentityVerifications/list) method in the [IdentityVerifications](https://developers.docusign.com/docs/esign-rest-api/reference/Accounts/IdentityVerifications) resource for more information on how to retrieve workflow IDs available for an account.
This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods.
Note that ID Verification and ID Check are two distinct methods. ID Verification checks recipients' identity by verifying their ID while ID Check relies on data available on public records (such as current and former address). + IdentityVerification *RecipientIdentityVerification `json:"identityVerification,omitempty"` // When set to **true** and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account. - InheritEmailNotificationConfiguration DSBool `json:"inheritEmailNotificationConfiguration,omitempty"` - // The recipient's last name. + InheritEmailNotificationConfiguration string `json:"inheritEmailNotificationConfiguration,omitempty"` + // Reserved for DocuSign. + // + IsBulkRecipient string `json:"isBulkRecipient,omitempty"` + // Reserved for DocuSign. + IsBulkRecipientMetadata *PropertyMetadata `json:"isBulkRecipientMetadata,omitempty"` + // The user's last name. + // Maximum Length: 50 characters. LastName string `json:"lastName,omitempty"` - // Metadata that indicates if the sender can edit the recipient's last name. + // Metadata that indicates whether the `lastName` property is editable. Read only. LastNameMetadata *PropertyMetadata `json:"lastNameMetadata,omitempty"` + // + LiveOakStartURL string `json:"liveOakStartURL,omitempty"` // Reserved for DocuSign. LockedRecipientPhoneAuthEditable string `json:"lockedRecipientPhoneAuthEditable,omitempty"` // Reserved for DocuSign. LockedRecipientSmsEditable string `json:"lockedRecipientSmsEditable,omitempty"` - // The full legal name of the recipient. + // Name string `json:"name,omitempty"` - // Metadata that indicates if the sender can edit the full legal name of the recipient. + // Metadata that indicates whether the `name` property is editable. Read only. NameMetadata *PropertyMetadata `json:"nameMetadata,omitempty"` + // + NotaryID string `json:"notaryId,omitempty"` + // + NotarySigners []string `json:"notarySigners,omitempty"` + // + NotaryType string `json:"notaryType,omitempty"` // A note sent to the recipient in the signing email. // This note is unique to this recipient. // In the user interface, @@ -8500,125 +14071,405 @@ type Intermediary struct { // Maximum Length: 1000 characters. // Note string `json:"note,omitempty"` - // Metadata that indicates if the sender can edit the note to the recipient. + // Metadata that indicates whether the `note` property is editable. Read only. NoteMetadata *PropertyMetadata `json:"noteMetadata,omitempty"` - // A complex type that contains the following elements: + // Reserved for DocuSign. + OfflineAttributes interface{} `json:"offlineAttributes,omitempty"` + // When `idCheckConfigurationName` is set to `Phone Auth $`, you use this complex type to provide the recipient authentication method details. It contains the following elements: // - // * `recipMayProvideNumber` - Boolean. When set to **true**, the recipient can use whatever phone number they choose. - // * `senderProvidedNumbers` - ArrayOfString. A list of phone numbers the recipient can use. - // * `recordVoicePrint` - Reserved. - // * `validateRecipProvidedNumber` - Reserved. - PhoneAuthentication DSBool `json:"phoneAuthentication,omitempty"` + // * `recipMayProvideNumber`: Boolean. When set to **true**, the recipient can use whatever phone number they choose. + // * `senderProvidedNumbers`: ArrayOfStrings. A list of phone numbers the recipient can use. + // * `recordVoicePrint`: Reserved for DocuSign. + // * `validateRecipProvidedNumber`: Reserved for DocuSign. + // + // + PhoneAuthentication *RecipientPhoneAuthentication `json:"phoneAuthentication,omitempty"` + // + ProofFile *RecipientProofFile `json:"proofFile,omitempty"` // Reserved for DocuSign. RecipientAttachments []RecipientAttachment `json:"recipientAttachments,omitempty"` - // Information about the recipient's authentication status. + // Information about the recipient's authentication status. Read only. RecipientAuthenticationStatus *AuthenticationStatus `json:"recipientAuthenticationStatus,omitempty"` - // Metadata about the features that are supported for the recipient type. + // Metadata about the features that are supported for the recipient type. Read only. RecipientFeatureMetadata []FeatureAvailableMetadata `json:"recipientFeatureMetadata,omitempty"` // Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. RecipientID string `json:"recipientId,omitempty"` - // The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. + // The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only. RecipientIDGUID string `json:"recipientIdGuid,omitempty"` + // The default signature provider is the DocuSign Electronic signature system. This parameter is used to specify one or more Standards Based Signature (digital signature) providers for the signer to use. [More information.](https://developers.docusign.com/esign-rest-api/guides/standards-based-signatures) + RecipientSignatureProviders []RecipientSignatureProvider `json:"recipientSignatureProviders,omitempty"` + // When set to **true**, specifies that the recipient creates the tabs. + RecipientSuppliesTabs string `json:"recipientSuppliesTabs,omitempty"` // The recipient type, as specified by the following values: - // - `agents`: Agent recipients can add name and email information for recipients that appear after the agent in routing order. - // - `carbonCopies`: Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date, or add information to any of the documents. This type of recipient can be used in any routing order. - // - `certifiedDeliveries`: Certified delivery recipients must receive the completed documents for the envelope to be completed. They don't need to sign, initial, date, or add information to any of the documents. - // - `editors`: Editors have the same management and access rights for the envelope as the sender. Editors can add name and email information, add or change the routing order, set authentication options, and can edit signature/initial tabs and data fields for the remaining recipients. - // - `inPersonSigners`: In-person recipients are DocuSign users who act as signing hosts in the same physical location as the signer. + // - `agent`: Agent recipients can add name and email information for recipients that appear after the agent in routing order. + // - `carbonCopy`: Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date, or add information to any of the documents. This type of recipient can be used in any routing order. + // - `certifiedDelivery`: Certified delivery recipients must receive the completed documents for the envelope to be completed. They don't need to sign, initial, date, or add information to any of the documents. + // - `editor`: Editors have the same management and access rights for the envelope as the sender. Editors can add name and email information, add or change the routing order, set authentication options, and can edit signature/initial tabs and data fields for the remaining recipients. + // - `inPersonSigner`: In-person recipients are DocuSign users who act as signing hosts in the same physical location as the signer. // - `intermediaries`: Intermediary recipients can optionally add name and email information for recipients at the same or subsequent level in the routing order. - // - `seals`: Electronic seal recipients represent legal entities. - // - `signers`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope. - // - `witnesses`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope. + // - `seal`: Electronic seal recipients represent legal entities. + // - `signer`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope. + // - `witness`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope. RecipientType string `json:"recipientType,omitempty"` - // Metadata that indicates if the sender can edit the recipient type. + // Metadata that indicates whether the `recipientType` property is editable. Read only. RecipientTypeMetadata *PropertyMetadata `json:"recipientTypeMetadata,omitempty"` // When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. - RequireIDLookup DSBool `json:"requireIdLookup,omitempty"` - // Metadata that indicates whether the `requireIdLookup` property is editable. - // + RequireIDLookup string `json:"requireIdLookup,omitempty"` + // Metadata that indicates whether the `requireIdLookup` property is editable. Read only. RequireIDLookupMetadata *PropertyMetadata `json:"requireIdLookupMetadata,omitempty"` - // Optional element. Specifies the role name associated with the recipient.

This is required when working with template recipients. + // When set to **true**, the signer must print, sign, and upload or fax the signed documents to DocuSign. + RequireSignOnPaper string `json:"requireSignOnPaper,omitempty"` + // By default, DocuSign signers create electronic signatures. This field can be used to require the signer to use a SAFE-BioPharma digital certificate for signing. + // + // This parameter should only be used to select a SAFE-BioPharma certificate. New integrations should use the `recipientSignatureProviders` parameter for other types of digital certificates. + // + // Set this parameter to `safe` to use a SAFE-BioPharma certificate. + // + // The signer must be enrolled in the SAFE program to sign with a SAFE certificate. + RequireSignerCertificate string `json:"requireSignerCertificate,omitempty"` + // When set to **true**, the signer is required to upload a new signature, even if they have a pre-adopted signature in their personal DocuSign account. + RequireUploadSignature string `json:"requireUploadSignature,omitempty"` + // Optional element. Specifies the role name associated with the recipient.

This property is required when you are working with template recipients. RoleName string `json:"roleName,omitempty"` // Specifies the routing order of the recipient in the envelope. RoutingOrder string `json:"routingOrder,omitempty"` - // Metadata that indicates if the sender can edit the routing order for the recipient. + // Metadata that indicates whether the `routingOrder` property is editable. Read only. RoutingOrderMetadata *PropertyMetadata `json:"routingOrderMetadata,omitempty"` - // The date and time the envelope was sent. - SentDateTime *time.Time `json:"sentDateTime,omitempty"` + // The UTC DateTime when the envelope was sent. Read only. + SentDateTime string `json:"sentDateTime,omitempty"` + // When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab (instead of adopting a signature/initial style or only drawing a signature/initial once). + SignInEachLocation string `json:"signInEachLocation,omitempty"` + // Metadata that indicates whether the `signInEachLocation` property is editable. Read only. + SignInEachLocationMetadata *PropertyMetadata `json:"signInEachLocationMetadata,omitempty"` + // Allows the sender to pre-specify the signature name, signature initials and signature font used in the signature stamp for the recipient. + // + // Used only with recipient types In Person Signers and Signers. + SignatureInfo *RecipientSignatureInformation `json:"signatureInfo,omitempty"` // Reserved for DocuSign. - SignedDateTime *time.Time `json:"signedDateTime,omitempty"` - // The id of the signing group of which the recipient is a member, if applicable. + SignedDateTime string `json:"signedDateTime,omitempty"` + // When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once). SigningGroupID string `json:"signingGroupId,omitempty"` - // Metadata that indicates if the sender can edit the signing group id. + // Metadata that indicates whether the `signingGroupId` property is editable. Read only. SigningGroupIDMetadata *PropertyMetadata `json:"signingGroupIdMetadata,omitempty"` - // The display name for the signing group. + // Optional. The name of the signing group. // // Maximum Length: 100 characters. SigningGroupName string `json:"signingGroupName,omitempty"` // A complex type that contains information about users in the signing group. SigningGroupUsers []UserInfo `json:"signingGroupUsers,omitempty"` - // Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication. + // When `idCheckConfigurationName` is set to `SMS Auth $`, you use this complex type to provide the recipient authentication method details. It contains the element `senderProvidedNumbers`, which is an array of phone numbers that the recipient can use for SMS text authentication. + // // SmsAuthentication *RecipientSMSAuthentication `json:"smsAuthentication,omitempty"` - // Lists the social ID type that can be used for recipient authentication. + // Deprecated. SocialAuthentications []SocialAuthentication `json:"socialAuthentications,omitempty"` - // Recipient status. - // + // Indicates the envelope status. Valid values are: // + // * sent - The envelope is sent to the recipients. + // * created - The envelope is saved as a draft and can be modified and sent later. Status string `json:"status,omitempty"` // Reserved for DocuSign. StatusCode string `json:"statusCode,omitempty"` + // When set to **true**, email notifications are suppressed for the recipient, and they must access envelopes and documents from their DocuSign inbox. + SuppressEmails string `json:"suppressEmails,omitempty"` + // A list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients. + Tabs *Tabs `json:"tabs,omitempty"` // When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. - TemplateLocked DSBool `json:"templateLocked,omitempty"` + TemplateLocked string `json:"templateLocked,omitempty"` // When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. - TemplateRequired DSBool `json:"templateRequired,omitempty"` - // The total number of tabs in the documents. + TemplateRequired string `json:"templateRequired,omitempty"` + // The total number of tabs in the documents. Read only. TotalTabCount string `json:"totalTabCount,omitempty"` // The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing. // - UserID string `json:"userId,omitempty"` -} - -type Jurisdiction struct { + UserID string `json:"userId,omitempty"` +} + +// NotaryResult describes a single notary jurisdiction. +type NotaryResult struct { + // + Jurisdictions []Jurisdiction `json:"jurisdictions,omitempty"` + // + Notary *Notary `json:"notary,omitempty"` +} + +type NotarySeal struct { + // + AnchorAllowWhiteSpaceInCharacters string `json:"anchorAllowWhiteSpaceInCharacters,omitempty"` + // + AnchorAllowWhiteSpaceInCharactersMetadata *PropertyMetadata `json:"anchorAllowWhiteSpaceInCharactersMetadata,omitempty"` + // This property controls how [anchor tabs][AnchorTabs] are placed. When **true**, the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false**. + // + // For example, when set to **true**, if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When set to **false**, `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. + // + // This functionality uses the following rules: + // + // - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: + // + // $~><|^+= + // + // For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` + // + // - Strings embedded in other strings are ignored during the matching process. + // + // - In words that have dashes, the parts separated by dashes are treated as distinct words. + // + // Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**. + // + // - Letters with accent marks are treated as distinct characters from their unaccented counterparts. + // + // - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. + // + // Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. + // + // - Unlike punctuation, numbers are not ignored when finding anchor words. + // + // Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). + // + // **Note**: You can only specify the value of this property in POST requests. + // + // [AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place + AnchorCaseSensitive string `json:"anchorCaseSensitive,omitempty"` + // Metadata that indicates whether the `anchorCaseSensitive` property is editable. + AnchorCaseSensitiveMetadata *PropertyMetadata `json:"anchorCaseSensitiveMetadata,omitempty"` + // This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are : + // + // - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. + // - `right`: Aligns the tab’s left side with the last character of the matching anchor word. + // + // **Note**: You can only specify the value of this property in POST requests. + // + // [AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place + // + AnchorHorizontalAlignment string `json:"anchorHorizontalAlignment,omitempty"` + // Metadata that indicates whether the `anchorHorizontalAlignment` property is editable. + AnchorHorizontalAlignmentMetadata *PropertyMetadata `json:"anchorHorizontalAlignmentMetadata,omitempty"` + // When set to **true**, this tab is ignored if the `anchorString` is not found in the document. + AnchorIgnoreIfNotPresent string `json:"anchorIgnoreIfNotPresent,omitempty"` + // Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable. + AnchorIgnoreIfNotPresentMetadata *PropertyMetadata `json:"anchorIgnoreIfNotPresentMetadata,omitempty"` + // When set to **true**, the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false**. + // + // For example, when set to **true**, if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When set to **false**, if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. + // + // This functionality uses the following rules: + // + // - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: + // + // $~><|^+= + // + // For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` + // + // - Strings embedded in other strings are ignored during the matching process. + // + // - In words that have dashes, the parts separated by dashes are treated as distinct words. + // + // Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**. + // + // - Letters with accent marks are treated as distinct characters from their unaccented counterparts. + // + // - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. + // + // Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. + // + // - Unlike punctuation, numbers are not ignored when finding anchor words. + // + // Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). + // + // + // **Note**: You can only specify the value of this property in POST requests. + // + // [AnchorTab]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place + // + AnchorMatchWholeWord string `json:"anchorMatchWholeWord,omitempty"` + // Metadata that indicates whether the `anchorMatchWholeWord` property is editable. + AnchorMatchWholeWordMetadata *PropertyMetadata `json:"anchorMatchWholeWordMetadata,omitempty"` + // Specifies the string to find in the document and use as the basis for tab placement. + AnchorString string `json:"anchorString,omitempty"` + // Metadata that indicates whether the `anchorString` property is editable. + AnchorStringMetadata *PropertyMetadata `json:"anchorStringMetadata,omitempty"` + // Reserved for DocuSign. + AnchorTabProcessorVersion string `json:"anchorTabProcessorVersion,omitempty"` + // Reserved for DocuSign. + AnchorTabProcessorVersionMetadata *PropertyMetadata `json:"anchorTabProcessorVersionMetadata,omitempty"` + // Specifies units of the + // `anchorXOffset` and + // `anchorYOffset`. + // Valid units are: + // + // - `pixels` + // - `inches` + // - `mms` + // - `cms` + // + AnchorUnits string `json:"anchorUnits,omitempty"` + // Metadata that indicates whether the `anchorUnits` property is editable. + AnchorUnitsMetadata *PropertyMetadata `json:"anchorUnitsMetadata,omitempty"` + // Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. + // + AnchorXOffset string `json:"anchorXOffset,omitempty"` + // Metadata that indicates whether the `anchorXOffset` property is editable. + AnchorXOffsetMetadata *PropertyMetadata `json:"anchorXOffsetMetadata,omitempty"` + // Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. + // + AnchorYOffset string `json:"anchorYOffset,omitempty"` + // Metadata that indicates whether the `anchorYOffset` property is editable. + AnchorYOffsetMetadata *PropertyMetadata `json:"anchorYOffsetMetadata,omitempty"` + // For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility. + ConditionalParentLabel string `json:"conditionalParentLabel,omitempty"` + // Metadata that indicates whether the `conditionalParentLabel` property is editable. + ConditionalParentLabelMetadata *PropertyMetadata `json:"conditionalParentLabelMetadata,omitempty"` + // For conditional fields, this is the value of the parent tab that controls the tab's visibility. + // + // If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. // - AllowSystemCreatedSeal DSBool `json:"allowSystemCreatedSeal,omitempty"` + ConditionalParentValue string `json:"conditionalParentValue,omitempty"` + // Metadata that indicates whether the `conditionalParentValue` property is editable. + ConditionalParentValueMetadata *PropertyMetadata `json:"conditionalParentValueMetadata,omitempty"` + // The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. + CustomTabID string `json:"customTabId,omitempty"` + // Metadata that indicates whether the `customTabId` property is editable. + CustomTabIDMetadata *PropertyMetadata `json:"customTabIdMetadata,omitempty"` + // Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. + DocumentID string `json:"documentId,omitempty"` + // Metadata that indicates whether the `documentId` property is editable. + DocumentIDMetadata *PropertyMetadata `json:"documentIdMetadata,omitempty"` + // This object describes errors that occur. It is only valid for responses and ignored in requests. + ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` + // An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. + FormOrder string `json:"formOrder,omitempty"` + // Metadata that indicates whether the `formOrder` property is editable. + FormOrderMetadata *PropertyMetadata `json:"formOrderMetadata,omitempty"` + // A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. + FormPageLabel string `json:"formPageLabel,omitempty"` + // Metadata that indicates whether the `formPageLabel` property is editable. + FormPageLabelMetadata *PropertyMetadata `json:"formPageLabelMetadata,omitempty"` + // An integer specifying the order in which to present the guided form pages. + FormPageNumber string `json:"formPageNumber,omitempty"` + // Metadata that indicates whether the `fromPageNumber` property is editable. + FormPageNumberMetadata *PropertyMetadata `json:"formPageNumberMetadata,omitempty"` + // The height of the tab in pixels. + Height string `json:"height,omitempty"` + // Metadata that indicates whether the `height` property is editable. + HeightMetadata *PropertyMetadata `json:"heightMetadata,omitempty"` + // Contains the information necessary to map the tab to a field in SalesForce. + MergeField *MergeField `json:"mergeField,omitempty"` // - AllowUserUploadedSeal DSBool `json:"allowUserUploadedSeal,omitempty"` + MergeFieldXML string `json:"mergeFieldXml,omitempty"` // - CommissionIDInSeal DSBool `json:"commissionIdInSeal,omitempty"` + Name string `json:"name,omitempty"` + // Metadata that indicates whether the `name` property is editable. Read only. + NameMetadata *PropertyMetadata `json:"nameMetadata,omitempty"` + // Specifies the page number on which the tab is located. + PageNumber string `json:"pageNumber,omitempty"` + // Metadata that indicates whether the `pageNumber` property is editable. + PageNumberMetadata *PropertyMetadata `json:"pageNumberMetadata,omitempty"` + // Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. + RecipientID string `json:"recipientId,omitempty"` + // The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only. + RecipientIDGUID string `json:"recipientIdGuid,omitempty"` + // Metadata that indicates whether the `recipientIdGuid` property is editable. + RecipientIDGUIDMetadata *PropertyMetadata `json:"recipientIdGuidMetadata,omitempty"` + // Metadata that indicates whether the `recipientId` property is editable. + RecipientIDMetadata *PropertyMetadata `json:"recipientIdMetadata,omitempty"` + // Sets the size of the tab. This field accepts values from `0.5` to `1.0`, where `1.0` represents full size and `0.5` is 50% of full size. + ScaleValue string `json:"scaleValue,omitempty"` + // Metadata that indicates whether the `scaleValue` property is editable. + ScaleValueMetadata *PropertyMetadata `json:"scaleValueMetadata,omitempty"` // - County string `json:"county,omitempty"` + SmartContractInformation *SmartContractInformation `json:"smartContractInformation,omitempty"` + // Indicates the envelope status. Valid values are: // - CountyInSeal DSBool `json:"countyInSeal,omitempty"` + // * sent - The envelope is sent to the recipients. + // * created - The envelope is saved as a draft and can be modified and sent later. + Status string `json:"status,omitempty"` + // Metadata that indicates whether the `status` property is editable. + StatusMetadata *PropertyMetadata `json:"statusMetadata,omitempty"` + // An array of tab group labels that uniquely identify tab groups. To assign a tab to a `tabGroup`, you assign the `TabGroupLabel` to the `Tab.TabGroupLabels` array. + TabGroupLabels []string `json:"tabGroupLabels,omitempty"` + // Metadata that indicates whether the `tabGroupLabels` property is editable. + TabGroupLabelsMetadata *PropertyMetadata `json:"tabGroupLabelsMetadata,omitempty"` + // The unique identifier for the tab. + TabID string `json:"tabId,omitempty"` + // Metadata that indicates whether the `tabId` property is editable. + TabIDMetadata *PropertyMetadata `json:"tabIdMetadata,omitempty"` + // The label associated with the tab. This value may be an empty string. + // If no value is provided, the tab type is used as the value. // - Enabled DSBool `json:"enabled,omitempty"` + // Maximum Length: 500 characters. // - JurisdictionID string `json:"jurisdictionId,omitempty"` + TabLabel string `json:"tabLabel,omitempty"` + // Metadata that indicates whether the `tabLabel` property is editable. + TabLabelMetadata *PropertyMetadata `json:"tabLabelMetadata,omitempty"` + // A positive integer that sets the order the tab is navigated to during signing. // - Name string `json:"name,omitempty"` + // Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. + TabOrder string `json:"tabOrder,omitempty"` + // Metadata that indicates whether the `tabOrder` property is editable. + TabOrderMetadata *PropertyMetadata `json:"tabOrderMetadata,omitempty"` + // Indicates the type of tab (for example, `signHere` or `initialHere`). + TabType string `json:"tabType,omitempty"` + // Metadata that indicates whether the `tabType` property is editable. + TabTypeMetadata *PropertyMetadata `json:"tabTypeMetadata,omitempty"` + // When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. + TemplateLocked string `json:"templateLocked,omitempty"` + // Metadata that indicates whether the `templateLocked` property is editable. + TemplateLockedMetadata *PropertyMetadata `json:"templateLockedMetadata,omitempty"` + // When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. + TemplateRequired string `json:"templateRequired,omitempty"` + // Metadata that indicates whether the `templateRequired` property is editable. + TemplateRequiredMetadata *PropertyMetadata `json:"templateRequiredMetadata,omitempty"` + // Metadata that indicates whether the `toolTip` property is editable. + ToolTipMetadata *PropertyMetadata `json:"toolTipMetadata,omitempty"` + // The text of a tooltip that appears when a user hovers over a form field or tab. + Tooltip string `json:"tooltip,omitempty"` + // The width of the tab in pixels. + Width string `json:"width,omitempty"` + // Metadata that indicates whether the `width` property is editable. + WidthMetadata *PropertyMetadata `json:"widthMetadata,omitempty"` + // This property indicates the horizontal offset of the object on the page. + // DocuSign uses 72 DPI when determining position. + // Required. May be zero. // - NotaryPublicInSeal DSBool `json:"notaryPublicInSeal,omitempty"` + XPosition string `json:"xPosition,omitempty"` + // Metadata that indicates whether the `xPosition` property is editable. + XPositionMetadata *PropertyMetadata `json:"xPositionMetadata,omitempty"` + // This property indicates the vertical offset of the object on the page. + // DocuSign uses 72 DPI when determining position. + // Required. May be zero. // - StateNameInSeal DSBool `json:"stateNameInSeal,omitempty"` + YPosition string `json:"yPosition,omitempty"` + // Metadata that indicates whether the `yPosition` property is editable. + YPositionMetadata *PropertyMetadata `json:"yPositionMetadata,omitempty"` } -// LastName is a tab that displays the recipient's last name. This tab -// takes the recipient's name as entered in the recipient -// information, splits it into sections based on spaces and -// uses the last section as the last name. +// Note is a tab that displays additional information, in the form of a +// note, for the recipient. // -type LastName struct { +type Note struct { TabBase TabGuidedForm TabPosition TabStyle TabValue + // + AnchorAllowWhiteSpaceInCharacters string `json:"anchorAllowWhiteSpaceInCharacters,omitempty"` + // + AnchorAllowWhiteSpaceInCharactersMetadata *PropertyMetadata `json:"anchorAllowWhiteSpaceInCharactersMetadata,omitempty"` // The height of the tab in pixels. Height string `json:"height,omitempty"` // Metadata that indicates whether the `height` property is editable. HeightMetadata *PropertyMetadata `json:"heightMetadata,omitempty"` // Reserved for DocuSign. LocalePolicy *LocalePolicyTab `json:"localePolicy,omitempty"` + // + MergeFieldXML string `json:"mergeFieldXml,omitempty"` + // When set to **true**, this custom tab is shared. + Shared DSBool `json:"shared,omitempty"` + // Metadata that indicates whether the `shared` property is editable. + SharedMetadata *PropertyMetadata `json:"sharedMetadata,omitempty"` + // + SmartContractInformation *SmartContractInformation `json:"smartContractInformation,omitempty"` // Metadata that indicates whether the `toolTip` property is editable. ToolTipMetadata *PropertyMetadata `json:"toolTipMetadata,omitempty"` // The text of a tooltip that appears when a user hovers over a form field or tab. @@ -8629,105 +14480,120 @@ type LastName struct { WidthMetadata *PropertyMetadata `json:"widthMetadata,omitempty"` } -// List this tab offers a list of options to choose from. -// The `listItems` -// property contains a list of -// [`listItem`](https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/listItem) -// objects to specify the selectable options. +// Notification is a complex element that specifies the notification settings for the envelope. +type Notification struct { + // A complex element that specifies the expiration settings for the envelope. + Expirations *Expirations `json:"expirations,omitempty"` + // A complex element that specifies reminder settings for the envelope + Reminders *Reminders `json:"reminders,omitempty"` + // When set to **true**, the account default notification settings are used for the envelope, overriding the reminders and expirations settings. When set to **false**, the reminders and expirations settings specified in this request are used. + UseAccountDefaults DSBool `json:"useAccountDefaults,omitempty"` +} + +// NotificationDefaultSettings contains details about the default notification settings for the envelope notifications that senders and signers receive. +type NotificationDefaultSettings struct { + // + // An array of email notifications that sets the email the user receives when they are a sender. When the specific email notification is set to true, the user will receive those types of email notifications from DocuSign. + // + // The user inherits the default account sender email notification settings when the user is created. The email notifications are: + // + // * envelopeComplete + // * changedSigner + // * senderEnvelopeDeclined + // * withdrawnConsent + // * recipientViewed + // * deliveryFailed + // + SenderEmailNotifications *SenderEmailNotifications `json:"senderEmailNotifications,omitempty"` + // An array of email notifications that specifies the email the user receives when they are a sender. When the specific email notification is set to true, the user receives those types of email notifications from DocuSign. The user inherits the default account sender email notification settings when the user is created. + SignerEmailNotifications *SignerEmailNotifications `json:"signerEmailNotifications,omitempty"` +} + +// NotificationDefaults is the `NotificationDefaults` resource provides methods that enable you to manage the default notifications for envelopes. +type NotificationDefaults struct { + // The default notification settings for envelopes sent by using the console. + APIEmailNotifications *NotificationDefaultSettings `json:"apiEmailNotifications,omitempty"` + // The default notification settings for envelopes sent by using the API. + EmailNotifications *NotificationDefaultSettings `json:"emailNotifications,omitempty"` +} + +// Number is a tab that allows the recipient to enter numbers and decimal +// (.) points. // -type List struct { +type Number struct { TabBase TabGuidedForm TabPosition + TabStyle TabValue - // When set to **true**, the information in the tab is bold. - Bold string `json:"bold,omitempty"` - // Metadata that indicates whether the `bold` property is editable. - BoldMetadata *PropertyMetadata `json:"boldMetadata,omitempty"` - // The font to be used for the tab value. Supported fonts include: // - // - Default - // - Arial - // - ArialNarrow - // - Calibri - // - CourierNew - // - Garamond - // - Georgia - // - Helvetica - // - LucidaConsole - // - MSGothic - // - MSMincho - // - OCR-A - // - Tahoma - // - TimesNewRoman - // - Trebuchet - // - Verdana + AnchorAllowWhiteSpaceInCharacters string `json:"anchorAllowWhiteSpaceInCharacters,omitempty"` // - Font string `json:"font,omitempty"` - // The font color to use for the information in the tab. Possible values are: + AnchorAllowWhiteSpaceInCharactersMetadata *PropertyMetadata `json:"anchorAllowWhiteSpaceInCharactersMetadata,omitempty"` + // When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. // - // - Black - // - BrightBlue - // - BrightRed - // - DarkGreen - // - DarkRed - // - Gold - // - Green - // - NavyBlue - // - Purple - // - White + // When an envelope is completed the information is only available to the sender through the Form Data link in the DocuSign Console. The information on the downloaded document remains masked by asterisks. // - FontColor string `json:"fontColor,omitempty"` - // Metadata that indicates whether the `fontColor` property is editable. - FontColorMetadata *PropertyMetadata `json:"fontColorMetadata,omitempty"` - // Metadata that indicates whether the `font` property is editable. - FontMetadata *PropertyMetadata `json:"fontMetadata,omitempty"` - // The font size used for the information in the tab. Possible values are: + // This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. + ConcealValueOnDocument DSBool `json:"concealValueOnDocument,omitempty"` + // Metadata that indicates whether the `concealValueOnDocument` property is editable. + ConcealValueOnDocumentMetadata *PropertyMetadata `json:"concealValueOnDocumentMetadata,omitempty"` + // When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. + DisableAutoSize DSBool `json:"disableAutoSize,omitempty"` + // Metadata that indicates whether the `disableAutoSize` property is editable. + DisableAutoSizeMetadata *PropertyMetadata `json:"disableAutoSizeMetadata,omitempty"` + // Contains the formula + // for calculating the value of + // this tab. + // + // Use a tab's `tabLabel`, + // enclosed in brackets, + // to refer to it. + // + // For example, + // you want to present the total cost + // of two items, tax included. + // + // The cost of each item is stored + // in number tabs labeled Item1 and Item2. + // The tax rate is in a number tab + // labeled TaxRate. + // + // The formula string for this property + // would be: + // `([Item1] + [Item2]) * (1 + [TaxRate])` + // + // See [Calculated Fields][calculatedfields] + // in the DocuSign Support Center + // to learn more about formulas. + // + // Maximum Length: 2000 characters + // + // [calculatedfields]: https://support.docusign.com/en/guides/ndse-user-guide-calculated-fields // - // - Size7 - // - Size8 - // - Size9 - // - Size10 - // - Size11 - // - Size12 - // - Size14 - // - Size16 - // - Size18 - // - Size20 - // - Size22 - // - Size24 - // - Size26 - // - Size28 - // - Size36 - // - Size48 - // - Size72 - FontSize string `json:"fontSize,omitempty"` - // Metadata that indicates whether the `fontSize` property is editable. - FontSizeMetadata *PropertyMetadata `json:"fontSizeMetadata,omitempty"` + Formula string `json:"formula,omitempty"` + // Metadata indicating if the sender can edit the `formula` property. + FormulaMetadata *PropertyMetadata `json:"formulaMetadata,omitempty"` // The height of the tab in pixels. Height string `json:"height,omitempty"` // Metadata that indicates whether the `height` property is editable. HeightMetadata *PropertyMetadata `json:"heightMetadata,omitempty"` - // When set to **true**, the information in the tab is italic. - Italic string `json:"italic,omitempty"` - // Metadata that indicates whether the `italic` property is editable. - ItalicMetadata *PropertyMetadata `json:"italicMetadata,omitempty"` - // The list of values that can be selected by senders. The list values are separated by semi-colons. Example: [one;two;three;four] - // - // Maximum Length of listItems: 2048 characters. - // Maximum Length of items in the list: 100 characters. - // - ListItems []ListItem `json:"listItems,omitempty"` - // The value in the list that is selected by default. - ListSelectedValue string `json:"listSelectedValue,omitempty"` - // Metadata that indicates whether the `listSelectedValue` property is editable. - ListSelectedValueMetadata *PropertyMetadata `json:"listSelectedValueMetadata,omitempty"` // Reserved for DocuSign. LocalePolicy *LocalePolicyTab `json:"localePolicy,omitempty"` // When set to **true**, the signer cannot change the data of the custom tab. Locked DSBool `json:"locked,omitempty"` // Metadata that indicates whether the `locked` property is editable. LockedMetadata *PropertyMetadata `json:"lockedMetadata,omitempty"` + // An optional value that describes the maximum length of the property when the property is a string. + MaxLength string `json:"maxLength,omitempty"` + // Metadata that indicates whether the `maxLength` property is editable. + MaxLengthMetadata *PropertyMetadata `json:"maxLengthMetadata,omitempty"` + // + MergeFieldXML string `json:"mergeFieldXml,omitempty"` + // The initial value of the tab when it was sent to the recipient. + OriginalValue string `json:"originalValue,omitempty"` + // Metadata that indicates whether the `originalValue` property is editable. + OriginalValueMetadata *PropertyMetadata `json:"originalValueMetadata,omitempty"` // When set to **true** and shared is true, information must be entered in this field to complete the envelope. RequireAll DSBool `json:"requireAll,omitempty"` // Metadata that indicates whether the `requireAll` property is editable. @@ -8752,500 +14618,420 @@ type List struct { Shared DSBool `json:"shared,omitempty"` // Metadata that indicates whether the `shared` property is editable. SharedMetadata *PropertyMetadata `json:"sharedMetadata,omitempty"` + // + SmartContractInformation *SmartContractInformation `json:"smartContractInformation,omitempty"` // Metadata that indicates whether the `toolTip` property is editable. ToolTipMetadata *PropertyMetadata `json:"toolTipMetadata,omitempty"` // The text of a tooltip that appears when a user hovers over a form field or tab. Tooltip string `json:"tooltip,omitempty"` - // When set to **true**, the information in the tab is underlined. - Underline string `json:"underline,omitempty"` - // Metadata that indicates whether the `underline` property is editable. - UnderlineMetadata *PropertyMetadata `json:"underlineMetadata,omitempty"` + // The message displayed if the custom tab fails input validation (either custom of embedded). + ValidationMessage string `json:"validationMessage,omitempty"` + // Metadata that indicates whether the `validationMessage` property is editable. + ValidationMessageMetadata *PropertyMetadata `json:"validationMessageMetadata,omitempty"` + // A regular expression used to validate input for the tab. + ValidationPattern string `json:"validationPattern,omitempty"` + // Metadata that indicates whether the `validationPattern` property is editable. + ValidationPatternMetadata *PropertyMetadata `json:"validationPatternMetadata,omitempty"` // The width of the tab in pixels. Width string `json:"width,omitempty"` // Metadata that indicates whether the `width` property is editable. WidthMetadata *PropertyMetadata `json:"widthMetadata,omitempty"` } -type ListCustomField struct { - // If merge fields are being used, specifies the type of the merge field. The only supported value is **salesforce**. - ConfigurationType string `json:"configurationType,omitempty"` - // This object describes errors that occur. It is only valid for responses and ignored in requests. - ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` - // An ID used to specify a custom field. - FieldID string `json:"fieldId,omitempty"` - // An array of strings that represent the items in a list. - ListItems []string `json:"listItems,omitempty"` - // The name of the custom field. - Name string `json:"name,omitempty"` - // When set to **true**, the signer is required to fill out this tab. - Required TabRequired `json:"required,omitempty"` - // A boolean indicating if the value should be displayed. If this value is set to **true**, the custom field is displayed at the top of the certificate of completion. If this value is left blank/ or set to **false**, then it does not appear in the certificate of completion. - Show DSBool `json:"show,omitempty"` - // The value of the custom field. +type OauthAccess struct { + // Access token information. + AccessToken string `json:"access_token,omitempty"` + // A Base64-encoded representation of the attachment that is used to upload and download the file. File attachments may be up to 50 MB in size. + Data []NameValue `json:"data,omitempty"` // - // Maximum Length: 100 characters. - Value string `json:"value,omitempty"` -} - -// ListItem one of the selectable items -// in the `listItems` property -// of a [`list`](https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/list) tab. -type ListItem struct { - // When set to **true**, indicates that this item is the default selection shown to a signer. + ExpiresIn string `json:"expires_in,omitempty"` // - // Only one selection can be set as the default. - Selected DSBool `json:"selected,omitempty"` - // Metadata that indicates whether the `selected` property is editable. - SelectedMetadata *PropertyMetadata `json:"selectedMetadata,omitempty"` - // Specifies the text that is shown in the dropdown list. - Text string `json:"text,omitempty"` + RefreshToken string `json:"refresh_token,omitempty"` + // Must be set to "api". + Scope string `json:"scope,omitempty"` // - TextMetadata *PropertyMetadata `json:"textMetadata,omitempty"` - // Specifies the value that is used when the list item is selected. - Value string `json:"value,omitempty"` - // Metadata that indicates whether the `value` property is editable. - ValueMetadata *PropertyMetadata `json:"valueMetadata,omitempty"` + TokenType string `json:"token_type,omitempty"` } -type LocalePolicy struct { - // - AddressFormat string `json:"addressFormat,omitempty"` - // - AddressFormatMetadata *SettingsMetadata `json:"addressFormatMetadata,omitempty"` - // - AllowRegion string `json:"allowRegion,omitempty"` - // - CalendarType string `json:"calendarType,omitempty"` - // - CalendarTypeMetadata *SettingsMetadata `json:"calendarTypeMetadata,omitempty"` - // - CultureName string `json:"cultureName,omitempty"` - // - CultureNameMetadata *SettingsMetadata `json:"cultureNameMetadata,omitempty"` - // The currency code for the account, based on the [ISO 4217 currency code](https://www.iso.org/iso-4217-currency-codes.html). - CurrencyCode string `json:"currencyCode,omitempty"` - // - CurrencyCodeMetadata *SettingsMetadata `json:"currencyCodeMetadata,omitempty"` - // - CurrencyNegativeFormat string `json:"currencyNegativeFormat,omitempty"` - // - CurrencyNegativeFormatMetadata *SettingsMetadata `json:"currencyNegativeFormatMetadata,omitempty"` - // - CurrencyPositiveFormat string `json:"currencyPositiveFormat,omitempty"` - // - CurrencyPositiveFormatMetadata *SettingsMetadata `json:"currencyPositiveFormatMetadata,omitempty"` - // - CustomDateFormat string `json:"customDateFormat,omitempty"` - // - CustomSignDateFormat string `json:"customSignDateFormat,omitempty"` - // - CustomSignTimeFormat string `json:"customSignTimeFormat,omitempty"` - // - CustomTimeFormat string `json:"customTimeFormat,omitempty"` - // - DateFormat string `json:"dateFormat,omitempty"` - // - DateFormatMetadata *SettingsMetadata `json:"dateFormatMetadata,omitempty"` - // - EffectiveAddressFormat string `json:"effectiveAddressFormat,omitempty"` - // - EffectiveCalendarType string `json:"effectiveCalendarType,omitempty"` - // - EffectiveCurrencyCode string `json:"effectiveCurrencyCode,omitempty"` - // - EffectiveCurrencyNegativeFormat string `json:"effectiveCurrencyNegativeFormat,omitempty"` - // - EffectiveCurrencyPositiveFormat string `json:"effectiveCurrencyPositiveFormat,omitempty"` - // - EffectiveCustomDateFormat string `json:"effectiveCustomDateFormat,omitempty"` - // - EffectiveCustomTimeFormat string `json:"effectiveCustomTimeFormat,omitempty"` - // - EffectiveDateFormat string `json:"effectiveDateFormat,omitempty"` - // - EffectiveInitialFormat string `json:"effectiveInitialFormat,omitempty"` - // - EffectiveNameFormat string `json:"effectiveNameFormat,omitempty"` - // - EffectiveTimeFormat string `json:"effectiveTimeFormat,omitempty"` - // - EffectiveTimeZone string `json:"effectiveTimeZone,omitempty"` - // - InitialFormat string `json:"initialFormat,omitempty"` - // - InitialFormatMetadata *SettingsMetadata `json:"initialFormatMetadata,omitempty"` - // - NameFormat string `json:"nameFormat,omitempty"` - // - NameFormatMetadata *SettingsMetadata `json:"nameFormatMetadata,omitempty"` - // The format for the signature date. Valid values are: - // - // - // - `d/M/yyyy` - // - `dd-MM-yy` - // - `dd-MMM-yy` - // - `dd-MM-yyyy` - // - `dd.MM.yyyy` - // - `dd-MMM-yyyy` - // - `dd MMMM yyyy` - // - `M/d/yyyy` - // - `MM-dd-yyyy` - // - `MM/dd/yyyy` - // - `MM/dd/yy` - // - `MMM-dd-yyyy` - // - `MMM d, yyyy` - // - `MMMM d, yyyy` - // - `yyyy-MM-dd` - // - `yyyy-MMM-dd` - // - `yyyy/MM/dd` - // - `yyyy MMMM d` - // +// Page description of a page of a document. +type Page struct { + // The number of dots per inch used for the page image. + Dpi string `json:"dpi,omitempty"` + // If an error occurs, this property describes the error. + ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` + // The height of the page in pixels. + Height string `json:"height,omitempty"` + // The number of image bytes. + ImageBytes string `json:"imageBytes,omitempty"` + // The MIME type. + MimeType string `json:"mimeType,omitempty"` + // The id of the page. + PageID string `json:"pageId,omitempty"` + // The sequence of the page in the document, or page number. + Sequence string `json:"sequence,omitempty"` + // The width of the page in pixels. + Width string `json:"width,omitempty"` +} + +type PageImages struct { + // The last index position in the result set. + EndPosition string `json:"endPosition,omitempty"` + // The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. + NextURI string `json:"nextUri,omitempty"` + // An array of page objects. + Pages []Page `json:"pages,omitempty"` + // The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. + PreviousURI string `json:"previousUri,omitempty"` + // The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`. + ResultSetSize string `json:"resultSetSize,omitempty"` + // The starting index position of the current result set. + StartPosition string `json:"startPosition,omitempty"` + // The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`. + TotalSetSize string `json:"totalSetSize,omitempty"` +} + +type PageRequest struct { + // The user's encrypted password hash. + Password string `json:"password,omitempty"` + // Sets the direction the page image is rotated. The possible settings are: left or right + Rotate string `json:"rotate,omitempty"` +} + +type PathExtendedElement struct { // + Name string `json:"name,omitempty"` // - SignDateFormat string `json:"signDateFormat,omitempty"` - // Metadata that indicates whether the `signDateFormat` property is editable. + Type string `json:"type,omitempty"` // - SignDateFormatMetadata *SettingsMetadata `json:"signDateFormatMetadata,omitempty"` - // The format for the signature time. Valid values are: + TypeName string `json:"typeName,omitempty"` +} + +type PayPalLegacySettings struct { + // The three-letter + // [ISO 4217][ISO4217] currency code for the payment. // - // - `none` - // - `HH:mm` - // - `h:mm` - // - `HH:mm:ss` - // - `h:mm:ss` + // For example: // - SignTimeFormat string `json:"signTimeFormat,omitempty"` - // Metadata that indicates whether the `signTimeFormat` property is editable. + // * AUD Australian dollar + // * CAD Canadian dollar + // * EUR Euro + // * GBP Great Britain pound + // * USD United States dollar // - SignTimeFormatMetadata *SettingsMetadata `json:"signTimeFormatMetadata,omitempty"` + // This is a read-only property. // - TimeFormat string `json:"timeFormat,omitempty"` + // [ISO4217]: https://en.wikipedia.org/wiki/ISO_4217 // - TimeFormatMetadata *SettingsMetadata `json:"timeFormatMetadata,omitempty"` + Currency string `json:"currency,omitempty"` // - TimeZone string `json:"timeZone,omitempty"` + Partner string `json:"partner,omitempty"` + // The user's encrypted password hash. + Password string `json:"password,omitempty"` + // The name of the user. + UserName string `json:"userName,omitempty"` // - TimeZoneMetadata *SettingsMetadata `json:"timeZoneMetadata,omitempty"` + Vendor string `json:"vendor,omitempty"` } -type LocalePolicyTab struct { +// PaymentDetails when a formula tab +// has a `paymentDetails` property, +// the formula tab +// is a payment item. +// See [Requesting Payments Along with Signatures][paymentguide] +// in the DocuSign Support Center +// to learn more about payments. +// +// [paymentguide]: https://support.docusign.com/en/guides/requesting-payments-along-with-signatures +// +type PaymentDetails struct { + // An array of accepted payment methods: // - AddressFormat string `json:"addressFormat,omitempty"` + // * `CreditCard` + // * `ApplePay` + // * `AndroidPay` + // * `BankAccount` // - CalendarType string `json:"calendarType,omitempty"` + // For example, if you only accept credit cards and ACH transfers, you would set this property to: // - CultureName string `json:"cultureName,omitempty"` + // `'["BankAccount", "CreditCard"]'` // - CurrencyNegativeFormat string `json:"currencyNegativeFormat,omitempty"` + // Do not specify `BankAccount` (ACH) if you are also using in-person signing. // - CurrencyPositiveFormat string `json:"currencyPositiveFormat,omitempty"` + AllowedPaymentMethods []string `json:"allowedPaymentMethods,omitempty"` + // The GUID set by the payment gateway (such as Stripe) that identifies a transaction. The `chargeId` is created when authorizing a payment and must be referenced when completing a payment. + ChargeID string `json:"chargeId,omitempty"` + // Specifies the three-letter + // [ISO 4217][ISO4217] currency code for the payment. // - CustomDateFormat string `json:"customDateFormat,omitempty"` + // Supported currencies are: // - CustomTimeFormat string `json:"customTimeFormat,omitempty"` + // * AUD: Australian dollar + // * CAD: Canadian dollar + // * EUR: Euro + // * GBP: Great Britain pound + // * USD: United States dollar // - DateFormat string `json:"dateFormat,omitempty"` + // Specifying any other ISO 4217 code for payments is an error. // - InitialFormat string `json:"initialFormat,omitempty"` + // [ISO4217]: https://en.wikipedia.org/wiki/ISO_4217 // - NameFormat string `json:"nameFormat,omitempty"` + CurrencyCode string `json:"currencyCode,omitempty"` + // Metadata that indicates whether the `currencyCode` property is editable. + CurrencyCodeMetadata *PropertyMetadata `json:"currencyCodeMetadata,omitempty"` + // This is a sender-defined field that passes any extra metadata about the payment that will show up in the Authorize.net transaction under **Description** in the merchant gateway portal. The custom metadata will be recorded in downloaded Authorize.net reports. // - TimeFormat string `json:"timeFormat,omitempty"` + // The following example shows what the **Description** field of the transaction will look like: // - TimeZone string `json:"timeZone,omitempty"` -} - -// LockInformation template locks -type LockInformation struct { - // This object describes errors that occur. It is only valid for responses and ignored in requests. - ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` - // Sets the time, in seconds, until the lock expires when there is no activity on the envelope. + // `, ` + CustomMetadata string `json:"customMetadata,omitempty"` + // A sender-defined field that specifies whether custom metadata is required for the transaction. When set to **true**, custom metadata is required. This property only applies if you are using an Authorize.net payment gateway account. + CustomMetadataRequired bool `json:"customMetadataRequired,omitempty"` + // The customer ID. + CustomerID string `json:"customerId,omitempty"` + // A GUID that identifies the payment gateway + // connected to the sender's DocuSign account. // - // If no value is entered, then the default value of 300 seconds is used. The maximum value is 1,800 seconds. + // There is no public API + // for connecting payment gateway accounts + // You must connect and manage payment gateway accounts + // through the DocuSign Admin console + // and through your chosen payment gateway. // - // The lock duration can be extended. + // You can get the gateway account ID + // in the Payments section + // of the DocuSign Admin console. // - LockDurationInSeconds string `json:"lockDurationInSeconds,omitempty"` - // A unique identifier provided to the owner of the lock. You must use this token with subsequent calls to prove ownership of the lock. - LockToken string `json:"lockToken,omitempty"` - // The type of lock. Currently `edit` is the only supported type. - LockType string `json:"lockType,omitempty"` - // Specifies the friendly name of the application that is locking the envelope. - LockedByApp string `json:"lockedByApp,omitempty"` - // A complex type containing information about the user that has the envelope or template locked. - LockedByUser *UserInfo `json:"lockedByUser,omitempty"` - // The date and time that the lock expires. - LockedUntilDateTime *time.Time `json:"lockedUntilDateTime,omitempty"` - // Indicates whether a scratchpad is used for editing information. // - UseScratchPad string `json:"useScratchPad,omitempty"` -} - -type LockRequest struct { - // The number of seconds to lock the envelope for editing. This value must be greater than `0` seconds. - LockDurationInSeconds string `json:"lockDurationInSeconds,omitempty"` - // The type of lock. Currently `edit` is the only supported type. - LockType string `json:"lockType,omitempty"` - // The friendly name of the application that is locking the envelope or template. It appears in error messages to the user when lock conflicts occur. - LockedByApp string `json:"lockedByApp,omitempty"` + // [paymentgateways]: https://support.docusign.com/en/guides/managing-payment-gateways // - TemplatePassword string `json:"templatePassword,omitempty"` - // Indicates whether a scratchpad is used for editing information. + GatewayAccountID string `json:"gatewayAccountId,omitempty"` + // Metadata that indicates whether the `gatewayAccountId` property is editable. + GatewayAccountIDMetadata *PropertyMetadata `json:"gatewayAccountIdMetadata,omitempty"` + // Display name of the gateway connected to sender's Docusign account. // - UseScratchPad string `json:"useScratchPad,omitempty"` -} - -type LoginAccount struct { - // The account ID associated with the envelope. - AccountID string `json:"accountId,omitempty"` - // The GUID associated with the account ID. - AccountIDGUID string `json:"accountIdGuid,omitempty"` - // The URL that should be used for successive calls to this account. It includes the protocal (https), the DocuSign server where the account is located, and the account number. Use this Url to make API calls against this account. Many of the API calls provide Uri's that are relative to this baseUrl. - BaseURL string `json:"baseUrl,omitempty"` - // The email address for the user. - Email string `json:"email,omitempty"` - // This value is true if this is the default account for the user, otherwise false is returned. - IsDefault DSBool `json:"isDefault,omitempty"` - // A list of settings on the acccount that indicate what features are available. - LoginAccountSettings []NameValue `json:"loginAccountSettings,omitempty"` - // A list of user-level settings that indicate what user-specific features are available. - LoginUserSettings []NameValue `json:"loginUserSettings,omitempty"` - // The name associated with the account. - Name string `json:"name,omitempty"` - // An optional descirption of the site that hosts the account. - SiteDescription string `json:"siteDescription,omitempty"` - // The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing. + // Possible values are: Stripe, Braintree, Authorize.Net. + GatewayDisplayName string `json:"gatewayDisplayName,omitempty"` + // Name of the gateway connected to sender's DocuSign account. // - UserID string `json:"userId,omitempty"` - // The name of this user as defined by the account. - UserName string `json:"userName,omitempty"` -} - -type LoginInformation struct { - // Contains a token that can be used for authentication in API calls instead of using the user name and password. - APIPassword string `json:"apiPassword,omitempty"` - // The list of accounts that authenticating user is a member of. - LoginAccounts []LoginAccount `json:"loginAccounts,omitempty"` -} - -type MatchBox struct { - // The height of the tab in pixels. - Height string `json:"height,omitempty"` - // Specifies the page number on which the tab is located. - // Must be 1 for supplemental documents. + // Possible values are: // - PageNumber string `json:"pageNumber,omitempty"` - // The width of the tab in pixels. - Width string `json:"width,omitempty"` - // This property indicates the horizontal offset of the object on the page. - // DocuSign uses 72 DPI when determining position. - // Required. May be zero. + // * `Stripe` + // * `Braintree` + // * `AuthorizeDotNet` + GatewayName string `json:"gatewayName,omitempty"` + // A payment formula can have + // one or more line items + // that provide detail about + // individual items in a payment request. // - XPosition string `json:"xPosition,omitempty"` - // This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. - YPosition string `json:"yPosition,omitempty"` -} - -// MemberGroupSharedItem information about items shared among groups. -type MemberGroupSharedItem struct { - // This object describes errors that occur. It is only valid for responses and ignored in requests. - ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` - // The group sharing the item. - Group *Group `json:"group,omitempty"` - // How the item is shared. One of: + // The list of line items + // are returned as metadata + // to the payment gateway. // + LineItems []PaymentLineItem `json:"lineItems,omitempty"` + // This property specifies how the signer's collected payment details will be used. // - // - `not_shared`: The item is not shared. + // Possible values: // - // - `shared_to`: The item is shared. - Shared DSBool `json:"shared,omitempty"` -} - -// MemberSharedItems information about shared items. -type MemberSharedItems struct { - // List of information about shared envelopes. - Envelopes []SharedItem `json:"envelopes,omitempty"` - // This object describes errors that occur. It is only valid for responses and ignored in requests. - ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` - // List of information about shared folders. - Folders []FolderSharedItem `json:"folders,omitempty"` - // List of information about shared templates. - Templates []TemplateSharedItem `json:"templates,omitempty"` - // Information about the user requesting sharing information. - User *UserInfo `json:"user,omitempty"` -} - -// MergeField contains information for transfering values between Salesforce data fields and DocuSign Tabs. -type MergeField struct { - // When **true**, the sender can modify the value of the `mergeField` tab during the sending process. - AllowSenderToEdit DSBool `json:"allowSenderToEdit,omitempty"` - // Metadata that indicates if the sender can edit the `allowSenderToEdit` property. - AllowSenderToEditMetadata *PropertyMetadata `json:"allowSenderToEditMetadata,omitempty"` - // If merge fields are being used, specifies the type of the merge field. The only supported value is **salesforce**. - ConfigurationType string `json:"configurationType,omitempty"` - // Metadata that indicates if the sender can edit the `configurationType` property. - ConfigurationTypeMetadata *PropertyMetadata `json:"configurationTypeMetadata,omitempty"` - // Sets the object associated with the custom tab. Currently this is the Salesforce Object. - Path string `json:"path,omitempty"` - // Reserved for DocuSign. - PathExtended []PathExtendedElement `json:"pathExtended,omitempty"` - // Reserved for DocuSign. - PathExtendedMetadata *PropertyMetadata `json:"pathExtendedMetadata,omitempty"` - // Metadata that indicates whether the `path` property is editable. + // - `authorize`: The payment details will be used to collect payment. This is the default value. + // - `save`: The signer's payment method (credit card or bank account) will be saved to the sender's payment gateway. + // - `save_and_authorize`: The signer's payment method (credit card or bank account) will be saved to the sender's payment gateway and will also be used to collect payment. + PaymentOption string `json:"paymentOption,omitempty"` + // The payment source ID. + PaymentSourceID string `json:"paymentSourceId,omitempty"` // - PathMetadata *PropertyMetadata `json:"pathMetadata,omitempty"` - // Specifies the row number in a Salesforce table that the merge field value corresponds to. - Row string `json:"row,omitempty"` - // Metadata that indicates whether the `row` property is editable. + SignerValues *PaymentSignerValues `json:"signerValues,omitempty"` + // This read-only property describes the status of a payment. // - RowMetadata *PropertyMetadata `json:"rowMetadata,omitempty"` - // When **true**, data entered into the merge field during Signing will update the mapped Salesforce field. - WriteBack string `json:"writeBack,omitempty"` - // Metadata that indicates if the sender can edit the `writeBack` property. - WriteBackMetadata *PropertyMetadata `json:"writeBackMetadata,omitempty"` -} - -type MobileNotifierConfiguration struct { + // * `new`
+ // This is a new payment request. + // The envelope has been created, + // but no payment authorizations have been made. // - DeviceID string `json:"deviceId,omitempty"` - // This object describes errors that occur. It is only valid for responses and ignored in requests. - ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` - // The Platform of the client application - Platform string `json:"platform,omitempty"` -} - -type MobileNotifierConfigurationInformation struct { + // * `auth_complete`
+ // A recipient has entered their credit card information, + // but the envelope has not been completed. + // The card has not been charged. + // + // * `payment_complete`
+ // The recipient's card has been charged. + // + // * `payment_capture_failed`
+ // Final charge failed. + // This can happen when too much time + // passes between authorizing the payment + // and completing the document. + // + // * `future_payment_saved`
+ // The recipient's payment method has been saved to the sender's payment gateway. + // + Status string `json:"status,omitempty"` + // This read-only property + // is a currency-formatted string + // that represents the total + // of all the line items. + // The total is available + // only after the document is completed, + // which is when all recipients have paid and + // have completed all required fields. // - MobileNotifierConfigurations []MobileNotifierConfiguration `json:"mobileNotifierConfigurations,omitempty"` + Total *Money `json:"total,omitempty"` } -// Money describes information -// about the `total` of a payment. -// -type Money struct { - // The total payment amount - // in the currency's base unit. - // For example, for USD - // the base currency is one cent. +// PaymentGatewayAccount this object contains details about a payment gateway account. +type PaymentGatewayAccount struct { + // When **true**, the sender can pass custom metadata about the payment to the payment gateway. You pass in this metadata on an EnvelopeRecipientTab, in the `customMetadata` property under `paymentDetails`. // - AmountInBaseUnit string `json:"amountInBaseUnit,omitempty"` - // The three-letter - // [ISO 4217][ISO4217] currency code for the payment. + // For example, this property is set to **true** for the Authorize.net gateway by default. As a result, the extra metadata that you send displays for the Authorize.net transaction in the merchant gateway portal under **Description**. // - // For example: + // **Note**: This property is read only and cannot be changed. + AllowCustomMetadata bool `json:"allowCustomMetadata,omitempty"` + // This property contains metadata about the payment gateway account's configuration such as the API key, `userId`, and `merchantId` details. + Config *PaymentGatewayAccountSetting `json:"config,omitempty"` + // A user-defined name for a connected gateway account. // - // * AUD Australian dollar - // * CAD Canadian dollar - // * EUR Euro - // * GBP Great Britain pound - // * USD United States dollar + // This name is used in the Admin panel in the list of connected accounts and in Tagger in the payment gateway selector. // - // This is a read-only property. + // The human-readable version of `paymentGatewayAccountId`. + DisplayName string `json:"displayName,omitempty"` + // When **true**, the payment gateway account is enabled. + IsEnabled string `json:"isEnabled,omitempty"` + // Reserved for DocuSign. + IsLegacy string `json:"isLegacy,omitempty"` + // The UTC DateTime that the payment gateway account was last updated. + LastModified string `json:"lastModified,omitempty"` + // Reserved for DocuSign. + PayPalLegacySettings *PayPalLegacySettings `json:"payPalLegacySettings,omitempty"` + // Payment gateway used by the connected gateway account. + // This is the name used by the API. + // For a human-readable version use `paymentGatewayDisplayName`. // - // [ISO4217]: https://en.wikipedia.org/wiki/ISO_4217 + // Possible values are: // - Currency string `json:"currency,omitempty"` - // The payment amount as displayed - // in the `currency`. + // * `Stripe` + // * `Braintree` + // * `AuthorizeDotNet` + PaymentGateway string `json:"paymentGateway,omitempty"` + // A GUID that identifies the payment gateway account. For a human-readable version use `displayName`. + PaymentGatewayAccountID string `json:"paymentGatewayAccountId,omitempty"` + // The display name of the payment gateway that the connected gateway account uses. + // This is the human-readable version of `paymentGateway`. // - // For example, if the payment amount - // is USD 12.59, - // the `amountInBaseUnit` is 1259 (cents), - // and the displayed amount is `$12.59 USD`. + // Possible values are: // - // This is a read-only property. + // * Stripe + // * Braintree + // * Authorize.Net + PaymentGatewayDisplayName string `json:"paymentGatewayDisplayName,omitempty"` + // A list of ISO 4217 currency codes for the currencies that the payment gateway account supports. // - DisplayAmount string `json:"displayAmount,omitempty"` + // Examples: + // + // - `USD` + // - `CAD` + // - `EUR` + // - `HKD` + SupportedCurrencies []string `json:"supportedCurrencies,omitempty"` + // An array of paymentMethodWithOptions objects that specify the payment methods that are available for the gateway. + SupportedPaymentMethods []string `json:"supportedPaymentMethods,omitempty"` + // An array of `paymentMethodWithOptions` objects that specify the payment methods that are available for the gateway, as well as the payment options that are compatible with each payment method. + SupportedPaymentMethodsWithOptions []PaymentMethodWithOptions `json:"supportedPaymentMethodsWithOptions,omitempty"` + // + ZeroDecimalCurrencies []string `json:"zeroDecimalCurrencies,omitempty"` } -type NameValue struct { - // This object describes errors that occur. It is only valid for responses and ignored in requests. - ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` - // The name of the item. - Name string `json:"name,omitempty"` - // The initial value of the item. - OriginalValue string `json:"originalValue,omitempty"` - // The current value of the item. - Value string `json:"value,omitempty"` +type PaymentGatewayAccountSetting struct { + // + APIFields string `json:"apiFields,omitempty"` + // + AuthorizationCode string `json:"authorizationCode,omitempty"` + // + CredentialStatus string `json:"credentialStatus,omitempty"` + // + MerchantID string `json:"merchantId,omitempty"` } -type NewAccountDefinition struct { - // The account name for the new account. - AccountName string `json:"accountName,omitempty"` - // The list of - // [account settings][accountsettings] - // that determine - // the features available for the account. - // Note that some features are determined - // by the plan used to create the account and cannot be overridden. +// PaymentGatewayAccountsInfo holds information about connected payment accounts. +type PaymentGatewayAccountsInfo struct { + // A list of payment gateway accounts. + PaymentGatewayAccounts []PaymentGatewayAccount `json:"paymentGatewayAccounts,omitempty"` +} + +// PaymentLineItem is a line item describes details +// about an individual line item +// in a payment request. +// +// +type PaymentLineItem struct { + // This is a the `tabLabel` + // that specifies the amount paid + // for the line items. // - // [accountsettings]: https://developers.docusign.com/esign-rest-api/reference/Accounts/Accounts/create/#account-settings // - AccountSettings *AccountSettingsInformation `json:"accountSettings,omitempty"` - // A complex type that contains the following information for the new account: `Street1`, `Street2`, `City`, `State`, `Zip`, `Phone`, and `Fax`. - AddressInformation *AccountAddress `json:"addressInformation,omitempty"` - // A complex type that has information about the credit card used to pay for this account. - CreditCardInformation *CreditCardInformation `json:"creditCardInformation,omitempty"` - // Information about the bank that processes direct debits for the payment plan. - DirectDebitProcessorInformation *DirectDebitProcessorInformation `json:"directDebitProcessorInformation,omitempty"` - // The code that identifies the billing plan groups and plans for the new account. - DistributorCode string `json:"distributorCode,omitempty"` - // The password for the distributorCode. - DistributorPassword string `json:"distributorPassword,omitempty"` - // A complex type with the initial user information for the new account. Note that some user information is set internally based on the plan and cannot be overridden. - InitialUser *UserInformation `json:"initialUser,omitempty"` - // The payment method used for the billing plan. Valid values are: + AmountReference string `json:"amountReference,omitempty"` + // A sender-defined description of the line item. // - // - `NotSupported` - // - `CreditCard` - // - `PurchaseOrder` - // - `Premium` - // - `Freemium` - // - `FreeTrial` - // - `AppStore` - // - `DigitalExternal` - // - `DirectDebit` - PaymentMethod string `json:"paymentMethod,omitempty"` - // Information about the entity that processes payments for the billing plan. - PaymentProcessorInformation *PaymentProcessorInformation `json:"paymentProcessorInformation,omitempty"` - // An object used to identify the features and attributes of the account being created. - PlanInformation *PlanInformation `json:"planInformation,omitempty"` - // A complex type that contains the following information for entering referral and discount information. The following items are included in the referral information (all string content): enableSupport, includedSeats, saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, saleDiscountSeatPriceOverride, planStartMonth, referralCode, referrerName, advertisementId, publisherId, shopperId, promoCode, groupMemberId, idType, and industry + Description string `json:"description,omitempty"` + // This is the sender-defined + // SKU, inventory number, or other item code + // for the line item. // - // ###### Note: saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, and saleDiscountSeatPriceOverride are reserved for DoucSign use only. + ItemCode string `json:"itemCode,omitempty"` + // This is a sender-defined + // product name, service name, + // or other designation for the line item. // - ReferralInformation *ReferralInformation `json:"referralInformation,omitempty"` - // Contains properties that map a DocuSign user to a social account (Facebook, Yahoo, etc.) - SocialAccountInformation *SocialAccountInformation `json:"socialAccountInformation,omitempty"` + Name string `json:"name,omitempty"` } -type NewAccountSummary struct { - // The account ID associated with the envelope. - AccountID string `json:"accountId,omitempty"` - // The GUID associated with the account ID. - AccountIDGUID string `json:"accountIdGuid,omitempty"` - // The account name for the new account. - AccountName string `json:"accountName,omitempty"` - // Contains a token that can be used for authentication in API calls instead of using the user name and password. - APIPassword string `json:"apiPassword,omitempty"` - // The URL that should be used for successive calls to this account. It includes the protocal (https), the DocuSign server where the account is located, and the account number. Use this Url to make API calls against this account. Many of the API calls provide Uri's that are relative to this baseUrl. - BaseURL string `json:"baseUrl,omitempty"` +// PaymentMethodWithOptions this object contains information about a payment method that the gateway accepts and the payment options that are compatible with it. +type PaymentMethodWithOptions struct { + // The payment options that are compatible with the payment method in the `type` property. // - BillingPlanPreview *BillingPlanPreview `json:"billingPlanPreview,omitempty"` - // Specifies the user ID of the new user. - UserID string `json:"userId,omitempty"` + // Possible values are: + // + // - `save` + // - `save_and_authorize` + // - `authorize` + SupportedOptions []string `json:"supportedOptions,omitempty"` + // The name of a payment method that the gateway accepts. + // + // Possible values are: + // + // - `CreditCard` + // - `ApplePay` + // - `AndroidPay` + // - `BankAccount` + // - `PayPal` + Type string `json:"type,omitempty"` } -// NewUser object representing a new user. -type NewUser struct { - // Contains a token that can be used for authentication in API calls instead of using the user name and password. - APIPassword string `json:"apiPassword,omitempty"` - // The date and time the item was created. - CreatedDateTime *time.Time `json:"createdDateTime,omitempty"` - // Filters returned user records by the specified email address. +type PaymentProcessorInformation struct { + // The mailing address associated with the payment processor. + Address *AddressInformation `json:"address,omitempty"` + // The id of the billing agreement. + BillingAgreementID string `json:"billingAgreementId,omitempty"` + // The email address associated with the payment processor. Email string `json:"email,omitempty"` - // This object describes errors that occur. It is only valid for responses and ignored in requests. - ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` +} + +type PaymentSignerValues struct { + // This property specifies how the signer's collected payment details will be used. + // + // Possible values: + // + // - `authorize`: The payment details will be used to collect payment. This is the default value. + // - `save`: The signer's payment method (credit card or bank account) will be saved to the sender's payment gateway. + // - `save_and_authorize`: The signer's payment method (credit card or bank account) will be saved to the sender's payment gateway and will also be used to collect payment. + PaymentOption string `json:"paymentOption,omitempty"` +} + +// PermissionProfile is the AccountPermissionProfiles resource provides methods that allow you to manage permission profiles for groups of account users. +type PermissionProfile struct { + // The username of the user who last modified the permission profile. + ModifiedByUsername string `json:"modifiedByUsername,omitempty"` + // The date and time when the permission profile was last modified. + ModifiedDateTime *time.Time `json:"modifiedDateTime,omitempty"` // The ID of the permission profile. Possible values include: // // - `2301416` (for the `DocuSign Viewer` profile) @@ -9258,66 +15044,110 @@ type NewUser struct { // // Example: `Account Administrator` PermissionProfileName string `json:"permissionProfileName,omitempty"` - // URI containing the user ID. - URI string `json:"uri,omitempty"` - // Specifies the user ID for the new user. - UserID string `json:"userId,omitempty"` - // The name of the user. - UserName string `json:"userName,omitempty"` - // Status of the user's account. One of: - // - // - `ActivationRequired` - // - `ActivationSent` - // - `Active` - // - `Closed` - // - `Disabled` - // - UserStatus string `json:"userStatus,omitempty"` -} - -type NewUsersDefinition struct { - // A list of one or more new users. - NewUsers []UserInformation `json:"newUsers,omitempty"` + // This object specifies the permissions that are associated with the account permission profile. + Settings *AccountRoleSettings `json:"settings,omitempty"` + // The total number of users in the group associated with the account permission profile. + UserCount string `json:"userCount,omitempty"` + // A list of user objects containing information about the users who are associated with the account permission profile. + Users []UserInformation `json:"users,omitempty"` } -// NewUsersSummary object representing a summary of data for new users. -type NewUsersSummary struct { - // A list of one or more new users. - NewUsers []NewUser `json:"newUsers,omitempty"` +// PermissionProfileInformation contains details about the permission profiles associated with an account. +type PermissionProfileInformation struct { + // A complex type containing a collection of permission profiles. + PermissionProfiles []PermissionProfile `json:"permissionProfiles,omitempty"` } -// Notarize is a tab that alerts notary recipients that -// they must take action on the page. -// Only one notarize tab can appear on a page. -type Notarize struct { - TabBase - TabGuidedForm - // Reserved for DocuSign. - // +type PhoneNumber struct { + // + AnchorAllowWhiteSpaceInCharacters string `json:"anchorAllowWhiteSpaceInCharacters,omitempty"` + // + AnchorAllowWhiteSpaceInCharactersMetadata *PropertyMetadata `json:"anchorAllowWhiteSpaceInCharactersMetadata,omitempty"` + // This property controls how [anchor tabs][AnchorTabs] are placed. When **true**, the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false**. + // + // For example, when set to **true**, if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When set to **false**, `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. + // + // This functionality uses the following rules: + // + // - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: + // + // $~><|^+= + // + // For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` + // + // - Strings embedded in other strings are ignored during the matching process. + // + // - In words that have dashes, the parts separated by dashes are treated as distinct words. + // + // Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**. + // + // - Letters with accent marks are treated as distinct characters from their unaccented counterparts. + // + // - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. + // + // Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. + // + // - Unlike punctuation, numbers are not ignored when finding anchor words. + // + // Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). + // + // **Note**: You can only specify the value of this property in POST requests. + // + // [AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place AnchorCaseSensitive string `json:"anchorCaseSensitive,omitempty"` - // Reserved for DocuSign. + // Metadata that indicates whether the `anchorCaseSensitive` property is editable. AnchorCaseSensitiveMetadata *PropertyMetadata `json:"anchorCaseSensitiveMetadata,omitempty"` - // Reserved for DocuSign. - // + // This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are : + // + // - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. + // - `right`: Aligns the tab’s left side with the last character of the matching anchor word. + // + // **Note**: You can only specify the value of this property in POST requests. + // + // [AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place // AnchorHorizontalAlignment string `json:"anchorHorizontalAlignment,omitempty"` - // Reserved for DocuSign. + // Metadata that indicates whether the `anchorHorizontalAlignment` property is editable. AnchorHorizontalAlignmentMetadata *PropertyMetadata `json:"anchorHorizontalAlignmentMetadata,omitempty"` // When set to **true**, this tab is ignored if the `anchorString` is not found in the document. AnchorIgnoreIfNotPresent string `json:"anchorIgnoreIfNotPresent,omitempty"` // Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable. AnchorIgnoreIfNotPresentMetadata *PropertyMetadata `json:"anchorIgnoreIfNotPresentMetadata,omitempty"` - // Reserved for DocuSign. - // + // When set to **true**, the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false**. + // + // For example, when set to **true**, if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When set to **false**, if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. + // + // This functionality uses the following rules: + // + // - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: + // + // $~><|^+= + // + // For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` + // + // - Strings embedded in other strings are ignored during the matching process. + // + // - In words that have dashes, the parts separated by dashes are treated as distinct words. + // + // Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**. + // + // - Letters with accent marks are treated as distinct characters from their unaccented counterparts. + // + // - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. + // + // Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. + // + // - Unlike punctuation, numbers are not ignored when finding anchor words. + // + // Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). + // + // + // **Note**: You can only specify the value of this property in POST requests. + // + // [AnchorTab]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place // AnchorMatchWholeWord string `json:"anchorMatchWholeWord,omitempty"` - // Reserved for DocuSign. + // Metadata that indicates whether the `anchorMatchWholeWord` property is editable. AnchorMatchWholeWordMetadata *PropertyMetadata `json:"anchorMatchWholeWordMetadata,omitempty"` // Specifies the string to find in the document and use as the basis for tab placement. AnchorString string `json:"anchorString,omitempty"` @@ -9327,61 +15157,219 @@ type Notarize struct { AnchorTabProcessorVersion string `json:"anchorTabProcessorVersion,omitempty"` // Reserved for DocuSign. AnchorTabProcessorVersionMetadata *PropertyMetadata `json:"anchorTabProcessorVersionMetadata,omitempty"` - // Specifies the units of the X and Y offset. Units may be pixels, millimeters, centimeters, or inches. + // Specifies units of the + // `anchorXOffset` and + // `anchorYOffset`. + // Valid units are: + // + // - `pixels` + // - `inches` + // - `mms` + // - `cms` + // AnchorUnits string `json:"anchorUnits,omitempty"` // Metadata that indicates whether the `anchorUnits` property is editable. AnchorUnitsMetadata *PropertyMetadata `json:"anchorUnitsMetadata,omitempty"` // Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. + // AnchorXOffset string `json:"anchorXOffset,omitempty"` // Metadata that indicates whether the `anchorXOffset` property is editable. AnchorXOffsetMetadata *PropertyMetadata `json:"anchorXOffsetMetadata,omitempty"` // Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. + // AnchorYOffset string `json:"anchorYOffset,omitempty"` // Metadata that indicates whether the `anchorYOffset` property is editable. AnchorYOffsetMetadata *PropertyMetadata `json:"anchorYOffsetMetadata,omitempty"` - // The DocuSign-generated custom tab id for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. + // When set to **true**, the information in the tab is bold. + Bold string `json:"bold,omitempty"` + // Metadata that indicates whether the `bold` property is editable. + BoldMetadata *PropertyMetadata `json:"boldMetadata,omitempty"` + // When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. + // + // When an envelope is completed the information is only available to the sender through the Form Data link in the DocuSign Console. The information on the downloaded document remains masked by asterisks. + // + // This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. + ConcealValueOnDocument string `json:"concealValueOnDocument,omitempty"` + // Metadata that indicates whether the `concealValueOnDocument` property is editable. + ConcealValueOnDocumentMetadata *PropertyMetadata `json:"concealValueOnDocumentMetadata,omitempty"` + // For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility. + ConditionalParentLabel string `json:"conditionalParentLabel,omitempty"` + // Metadata that indicates whether the `conditionalParentLabel` property is editable. + ConditionalParentLabelMetadata *PropertyMetadata `json:"conditionalParentLabelMetadata,omitempty"` + // For conditional fields, this is the value of the parent tab that controls the tab's visibility. + // + // If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. + // + ConditionalParentValue string `json:"conditionalParentValue,omitempty"` + // Metadata that indicates whether the `conditionalParentValue` property is editable. + ConditionalParentValueMetadata *PropertyMetadata `json:"conditionalParentValueMetadata,omitempty"` + // The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. CustomTabID string `json:"customTabId,omitempty"` // Metadata that indicates whether the `customTabId` property is editable. CustomTabIDMetadata *PropertyMetadata `json:"customTabIdMetadata,omitempty"` + // When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. + DisableAutoSize string `json:"disableAutoSize,omitempty"` + // Metadata that indicates whether the `disableAutoSize` property is editable. + DisableAutoSizeMetadata *PropertyMetadata `json:"disableAutoSizeMetadata,omitempty"` + // Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. + DocumentID string `json:"documentId,omitempty"` + // Metadata that indicates whether the `documentId` property is editable. + DocumentIDMetadata *PropertyMetadata `json:"documentIdMetadata,omitempty"` // This object describes errors that occur. It is only valid for responses and ignored in requests. ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` + // The font to be used for the tab value. Supported fonts include: + // + // - Default + // - Arial + // - ArialNarrow + // - Calibri + // - CourierNew + // - Garamond + // - Georgia + // - Helvetica + // - LucidaConsole + // - MSGothic + // - MSMincho + // - OCR-A + // - Tahoma + // - TimesNewRoman + // - Trebuchet + // - Verdana + // + Font string `json:"font,omitempty"` + // The font color to use for the information in the tab. Possible values are: + // + // - Black + // - BrightBlue + // - BrightRed + // - DarkGreen + // - DarkRed + // - Gold + // - Green + // - NavyBlue + // - Purple + // - White + // + FontColor string `json:"fontColor,omitempty"` + // Metadata that indicates whether the `fontColor` property is editable. + FontColorMetadata *PropertyMetadata `json:"fontColorMetadata,omitempty"` + // Metadata that indicates whether the `font` property is editable. + FontMetadata *PropertyMetadata `json:"fontMetadata,omitempty"` + // The font size used for the information in the tab. Possible values are: + // + // - Size7 + // - Size8 + // - Size9 + // - Size10 + // - Size11 + // - Size12 + // - Size14 + // - Size16 + // - Size18 + // - Size20 + // - Size22 + // - Size24 + // - Size26 + // - Size28 + // - Size36 + // - Size48 + // - Size72 + FontSize string `json:"fontSize,omitempty"` + // Metadata that indicates whether the `fontSize` property is editable. + FontSizeMetadata *PropertyMetadata `json:"fontSizeMetadata,omitempty"` + // An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. + FormOrder string `json:"formOrder,omitempty"` + // Metadata that indicates whether the `formOrder` property is editable. + FormOrderMetadata *PropertyMetadata `json:"formOrderMetadata,omitempty"` + // A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. + FormPageLabel string `json:"formPageLabel,omitempty"` + // Metadata that indicates whether the `formPageLabel` property is editable. + FormPageLabelMetadata *PropertyMetadata `json:"formPageLabelMetadata,omitempty"` + // An integer specifying the order in which to present the guided form pages. + FormPageNumber string `json:"formPageNumber,omitempty"` + // Metadata that indicates whether the `fromPageNumber` property is editable. + FormPageNumberMetadata *PropertyMetadata `json:"formPageNumberMetadata,omitempty"` // The height of the tab in pixels. Height string `json:"height,omitempty"` // Metadata that indicates whether the `height` property is editable. HeightMetadata *PropertyMetadata `json:"heightMetadata,omitempty"` + // When set to **true**, the information in the tab is italic. + Italic string `json:"italic,omitempty"` + // Metadata that indicates whether the `italic` property is editable. + ItalicMetadata *PropertyMetadata `json:"italicMetadata,omitempty"` + // Reserved for DocuSign. + LocalePolicy *LocalePolicyTab `json:"localePolicy,omitempty"` // When set to **true**, the signer cannot change the data of the custom tab. - Locked DSBool `json:"locked,omitempty"` + Locked string `json:"locked,omitempty"` // Metadata that indicates whether the `locked` property is editable. LockedMetadata *PropertyMetadata `json:"lockedMetadata,omitempty"` + // An optional value that describes the maximum length of the property when the property is a string. + MaxLength string `json:"maxLength,omitempty"` + // Metadata that indicates whether the `maxLength` property is editable. + MaxLengthMetadata *PropertyMetadata `json:"maxLengthMetadata,omitempty"` // Contains the information necessary to map the tab to a field in SalesForce. MergeField *MergeField `json:"mergeField,omitempty"` - // The page number being accessed. + // + MergeFieldXML string `json:"mergeFieldXml,omitempty"` + // + Name string `json:"name,omitempty"` + // Metadata that indicates whether the `name` property is editable. Read only. + NameMetadata *PropertyMetadata `json:"nameMetadata,omitempty"` + // The initial value of the tab when it was sent to the recipient. + OriginalValue string `json:"originalValue,omitempty"` + // Metadata that indicates whether the `originalValue` property is editable. + OriginalValueMetadata *PropertyMetadata `json:"originalValueMetadata,omitempty"` + // Specifies the page number on which the tab is located. PageNumber string `json:"pageNumber,omitempty"` // Metadata that indicates whether the `pageNumber` property is editable. PageNumberMetadata *PropertyMetadata `json:"pageNumberMetadata,omitempty"` + // Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. + RecipientID string `json:"recipientId,omitempty"` + // The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only. + RecipientIDGUID string `json:"recipientIdGuid,omitempty"` + // Metadata that indicates whether the `recipientIdGuid` property is editable. + RecipientIDGUIDMetadata *PropertyMetadata `json:"recipientIdGuidMetadata,omitempty"` + // Metadata that indicates whether the `recipientId` property is editable. + RecipientIDMetadata *PropertyMetadata `json:"recipientIdMetadata,omitempty"` // When set to **true**, the signer is required to fill out this tab. - Required TabRequired `json:"required,omitempty"` + Required string `json:"required,omitempty"` // Metadata that indicates whether the `required` property is editable. RequiredMetadata *PropertyMetadata `json:"requiredMetadata,omitempty"` - // The status of the tab. Possible values are: // - // - `active`: The tab is active, but the recipient has not yet interacted with it. - // - `signed`: The recipient signed the tab. - // - `declined`: The recipient declined the envelope. - // - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). + SmartContractInformation *SmartContractInformation `json:"smartContractInformation,omitempty"` + // Indicates the envelope status. Valid values are: + // + // * sent - The envelope is sent to the recipients. + // * created - The envelope is saved as a draft and can be modified and sent later. Status string `json:"status,omitempty"` // Metadata that indicates whether the `status` property is editable. StatusMetadata *PropertyMetadata `json:"statusMetadata,omitempty"` + // An array of tab group labels that uniquely identify tab groups. To assign a tab to a `tabGroup`, you assign the `TabGroupLabel` to the `Tab.TabGroupLabels` array. + TabGroupLabels []string `json:"tabGroupLabels,omitempty"` + // Metadata that indicates whether the `tabGroupLabels` property is editable. + TabGroupLabelsMetadata *PropertyMetadata `json:"tabGroupLabelsMetadata,omitempty"` // The unique identifier for the tab. TabID string `json:"tabId,omitempty"` // Metadata that indicates whether the `tabId` property is editable. TabIDMetadata *PropertyMetadata `json:"tabIdMetadata,omitempty"` + // The label associated with the tab. This value may be an empty string. + // If no value is provided, the tab type is used as the value. + // + // Maximum Length: 500 characters. + // + TabLabel string `json:"tabLabel,omitempty"` + // Metadata that indicates whether the `tabLabel` property is editable. + TabLabelMetadata *PropertyMetadata `json:"tabLabelMetadata,omitempty"` // A positive integer that sets the order the tab is navigated to during signing. // // Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. TabOrder string `json:"tabOrder,omitempty"` // Metadata that indicates whether the `tabOrder` property is editable. TabOrderMetadata *PropertyMetadata `json:"tabOrderMetadata,omitempty"` + // Indicates the type of tab (for example, `signHere` or `initialHere`). + TabType string `json:"tabType,omitempty"` + // Metadata that indicates whether the `tabType` property is editable. + TabTypeMetadata *PropertyMetadata `json:"tabTypeMetadata,omitempty"` // When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. TemplateLocked string `json:"templateLocked,omitempty"` // Metadata that indicates whether the `templateLocked` property is editable. @@ -9394,880 +15382,687 @@ type Notarize struct { ToolTipMetadata *PropertyMetadata `json:"toolTipMetadata,omitempty"` // The text of a tooltip that appears when a user hovers over a form field or tab. Tooltip string `json:"tooltip,omitempty"` - // The width of the tab in pixels. - Width string `json:"width,omitempty"` - // Metadata that indicates whether the `width` property is editable. - WidthMetadata *PropertyMetadata `json:"widthMetadata,omitempty"` - // This property indicates the horizontal offset of the object on the page. - // DocuSign uses 72 DPI when determining position. - // Required. May be zero. - // - XPosition string `json:"xPosition,omitempty"` - // Metadata that indicates whether the `xPosition` property is editable. - XPositionMetadata *PropertyMetadata `json:"xPositionMetadata,omitempty"` - // This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. - YPosition string `json:"yPosition,omitempty"` - // Metadata that indicates whether the `yPosition` property is editable. - YPositionMetadata *PropertyMetadata `json:"yPositionMetadata,omitempty"` -} - -// NotaryHost this object is used only when `inPersonSigningType` in the `inPersonSigner` object is `notary`. -// -// It describes information about the notary host. -// The following information is required -// when using the eNotary in-person signing flow: -// -// * `name`: Specifies the notary's full legal name. -// * `email`: Specifies the notary's email address. -// * `recipientId`: A unique ID number for the notary signing host. -// -type NotaryHost struct { - // If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. - // - // Maximum Length: 50 characters and it must conform to the account's access code format setting. - // - // If blank, but the signer `accessCode` property is set in the envelope, then that value is used. - // - // If blank and the signer `accessCode` property is not set, then the access code is not required. - AccessCode string `json:"accessCode,omitempty"` - // Metadata that indicates if the sender can edit the `accessCode` property. - AccessCodeMetadata *PropertyMetadata `json:"accessCodeMetadata,omitempty"` - // This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient. - AddAccessCodeToEmail string `json:"addAccessCodeToEmail,omitempty"` - // Specifies whether the recipient is embedded or remote. - // - // If the `clientUserId` property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing. - // - // Note: if the `clientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true**, an error is generated on sending. - // - // Maximum length: 100 characters. - ClientUserID string `json:"clientUserId,omitempty"` - // Indicates the number of times that the recipient has been through a signing completion for the envelope. - // - // If this number is greater than 0 for a signing group, only the user who previously completed may sign again. - CompletedCount string `json:"completedCount,omitempty"` - // An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters. - CustomFields []string `json:"customFields,omitempty"` - // The date and time the recipient declined the document. - DeclinedDateTime *time.Time `json:"declinedDateTime,omitempty"` - // The reason the recipient declined the document. - DeclinedReason string `json:"declinedReason,omitempty"` - // The date and time that the envelope was delivered to the recipient. - DeliveredDateTime *time.Time `json:"deliveredDateTime,omitempty"` - // Reserved for DocuSign. - DeliveryMethod string `json:"deliveryMethod,omitempty"` - // Metadata that indicates whether the `deliveryMethod` property is editable. - // - DeliveryMethodMetadata *PropertyMetadata `json:"deliveryMethodMetadata,omitempty"` - // A list of documentVisibility objects, which define a recipient's read/write access to a document. - DocumentVisibility []DocumentVisibility `json:"documentVisibility,omitempty"` - // The notary's email address. - // - // Maximum Length: 100 characters. - // - Email string `json:"email,omitempty"` - // Metadata that indicates if the sender can edit the notary's email address. - EmailMetadata *PropertyMetadata `json:"emailMetadata,omitempty"` - // An optional complex type that sets a specific email subject and body for this recipient's notification email. - // - // **Note**: If you use this field to set a specific email notification for one recipient, you must also set the email notification for the other recipients. Using this field for one or more recipients negates the Envelope `Subject` and `EmailBlurb` property settings. - EmailNotification *RecipientEmailNotification `json:"emailNotification,omitempty"` - // Specifies a sender-provided valid URL string for redirecting an embedded recipient. When this option is used, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the recipient clicks the document link in the email, the recipient is redirected through DocuSign to the specified URL to complete the required actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. - // - // If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation launched by a partner. - // - // It is important to understand that in a typical embedded workflow, the authentication of an embedded recipient is the responsibility of the sending application. DocuSign expects that senders will follow their own processes for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process is initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process, bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. - // - // If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: `envelopeId`, `recipientId`, `recipientName`, `recipientEmail`, and `customFields`. The `customFields` property must be set for the recipient or envelope. The merge fields are enclosed in double brackets. + // When set to **true**, the information in the tab is underlined. + Underline string `json:"underline,omitempty"` + // Metadata that indicates whether the `underline` property is editable. + UnderlineMetadata *PropertyMetadata `json:"underlineMetadata,omitempty"` + // Specifies the value of the tab. + Value string `json:"value,omitempty"` + // Metadata that indicates whether the `value` property is editable. + ValueMetadata *PropertyMetadata `json:"valueMetadata,omitempty"` + // The width of the tab in pixels. + Width string `json:"width,omitempty"` + // Metadata that indicates whether the `width` property is editable. + WidthMetadata *PropertyMetadata `json:"widthMetadata,omitempty"` + // This property indicates the horizontal offset of the object on the page. + // DocuSign uses 72 DPI when determining position. + // Required. May be zero. // - // *Example*: + XPosition string `json:"xPosition,omitempty"` + // Metadata that indicates whether the `xPosition` property is editable. + XPositionMetadata *PropertyMetadata `json:"xPositionMetadata,omitempty"` + // This property indicates the vertical offset of the object on the page. + // DocuSign uses 72 DPI when determining position. + // Required. May be zero. // - // `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` - EmbeddedRecipientStartURL string `json:"embeddedRecipientStartURL,omitempty"` - // This object describes errors that occur. It is only valid for responses and ignored in requests. - ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` + YPosition string `json:"yPosition,omitempty"` + // Metadata that indicates whether the `yPosition` property is editable. + YPositionMetadata *PropertyMetadata `json:"yPositionMetadata,omitempty"` +} + +// PlanInformation is an object used to identify the features and attributes of the account being created. +type PlanInformation struct { // Reserved for DocuSign. - FaxNumber string `json:"faxNumber,omitempty"` + AddOns []AddOn `json:"addOns,omitempty"` + // Specifies the ISO currency code for the account. + CurrencyCode string `json:"currencyCode,omitempty"` // Reserved for DocuSign. - FaxNumberMetadata *PropertyMetadata `json:"faxNumberMetadata,omitempty"` - // - HostRecipientID string `json:"hostRecipientId,omitempty"` - // The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. + FreeTrialDaysOverride string `json:"freeTrialDaysOverride,omitempty"` + // Reserved for DocuSign. + PlanFeatureSets []FeatureSet `json:"planFeatureSets,omitempty"` + // DocuSign's id for the account plan. + PlanID string `json:"planId,omitempty"` // - // **Example**: Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node. - IDCheckConfigurationName string `json:"idCheckConfigurationName,omitempty"` - // Metadata that indicates whether the `idCheckConfigurationName` property is editable. + RecipientDomains []RecipientDomain `json:"recipientDomains,omitempty"` +} + +type PolyLine struct { // - IDCheckConfigurationNameMetadata *PropertyMetadata `json:"idCheckConfigurationNameMetadata,omitempty"` - // An object that contains input information related to a recipient ID check. - IDCheckInformationInput *IDCheckInformationInput `json:"idCheckInformationInput,omitempty"` - // When set to **true** and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account. - InheritEmailNotificationConfiguration DSBool `json:"inheritEmailNotificationConfiguration,omitempty"` - // Reserved for DocuSign. - LockedRecipientPhoneAuthEditable string `json:"lockedRecipientPhoneAuthEditable,omitempty"` - // Reserved for DocuSign. - LockedRecipientSmsEditable string `json:"lockedRecipientSmsEditable,omitempty"` - // The notary's full legal name. + X1 string `json:"x1,omitempty"` // - // Maximum Length: 100 characters. + X2 string `json:"x2,omitempty"` // - Name string `json:"name,omitempty"` - // Metadata that indicates if the sender can edit the notary's full legal name. - NameMetadata *PropertyMetadata `json:"nameMetadata,omitempty"` - // A note sent to the notary in the signing email. - // This note is visible only to this notary. + Y1 string `json:"y1,omitempty"` // - // Maximum Length: 1000 characters. + Y2 string `json:"y2,omitempty"` +} + +// PolyLineOverlay this tab enables users to strike through the text of a document. The tab is implemented as a line represented as a pair of x and y coordinates. +type PolyLineOverlay struct { + TabBase + TabGuidedForm // - Note string `json:"note,omitempty"` - // Metadata that indicates if the sender can edit the note sent to the notary in the signing email. - NoteMetadata *PropertyMetadata `json:"noteMetadata,omitempty"` - // A complex type that contains the following elements: + AnchorAllowWhiteSpaceInCharacters string `json:"anchorAllowWhiteSpaceInCharacters,omitempty"` // - // * `recipMayProvideNumber` - Boolean. When set to **true**, the recipient can use whatever phone number they choose. - // * `senderProvidedNumbers` - ArrayOfString. A list of phone numbers the recipient can use. - // * `recordVoicePrint` - Reserved. - // * `validateRecipProvidedNumber` - Reserved. - PhoneAuthentication DSBool `json:"phoneAuthentication,omitempty"` - // Reserved for DocuSign. - RecipientAttachments []RecipientAttachment `json:"recipientAttachments,omitempty"` - // Information about the recipient's authentication status. - RecipientAuthenticationStatus *AuthenticationStatus `json:"recipientAuthenticationStatus,omitempty"` - // Metadata about the features that are supported for the recipient type. - RecipientFeatureMetadata []FeatureAvailableMetadata `json:"recipientFeatureMetadata,omitempty"` - // A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`. - RecipientID string `json:"recipientId,omitempty"` - // The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. - RecipientIDGUID string `json:"recipientIdGuid,omitempty"` - // The recipient type, as specified by the following values: - // - `agents`: Agent recipients can add name and email information for recipients that appear after the agent in routing order. - // - `carbonCopies`: Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date, or add information to any of the documents. This type of recipient can be used in any routing order. - // - `certifiedDeliveries`: Certified delivery recipients must receive the completed documents for the envelope to be completed. They don't need to sign, initial, date, or add information to any of the documents. - // - `editors`: Editors have the same management and access rights for the envelope as the sender. Editors can add name and email information, add or change the routing order, set authentication options, and can edit signature/initial tabs and data fields for the remaining recipients. - // - `inPersonSigners`: In-person recipients are DocuSign users who act as signing hosts in the same physical location as the signer. - // - `intermediaries`: Intermediary recipients can optionally add name and email information for recipients at the same or subsequent level in the routing order. - // - `seals`: Electronic seal recipients represent legal entities. - // - `signers`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope. - // - `witnesses`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope. - RecipientType string `json:"recipientType,omitempty"` - // Metadata that indicates whether the `recipientType` property is editable. + AnchorAllowWhiteSpaceInCharactersMetadata *PropertyMetadata `json:"anchorAllowWhiteSpaceInCharactersMetadata,omitempty"` + // This property controls how [anchor tabs][AnchorTabs] are placed. When **true**, the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false**. // - RecipientTypeMetadata *PropertyMetadata `json:"recipientTypeMetadata,omitempty"` - // When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. - RequireIDLookup DSBool `json:"requireIdLookup,omitempty"` - // Metadata that indicates whether the `requireIdLookup` property is editable. + // For example, when set to **true**, if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When set to **false**, `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. // - RequireIDLookupMetadata *PropertyMetadata `json:"requireIdLookupMetadata,omitempty"` - // Optional element. Specifies the role name associated with the recipient.

This is required when working with template recipients. - RoleName string `json:"roleName,omitempty"` - // Specifies the routing order of the recipient in the envelope. - RoutingOrder string `json:"routingOrder,omitempty"` - // Metadata that indicates whether the `routingOrder` property is editable. + // This functionality uses the following rules: // - RoutingOrderMetadata *PropertyMetadata `json:"routingOrderMetadata,omitempty"` - // The date and time the envelope was sent. - SentDateTime *time.Time `json:"sentDateTime,omitempty"` - // Reserved for DocuSign. - SignedDateTime *time.Time `json:"signedDateTime,omitempty"` - // The ID of the signing group of which the notary is a member, if applicable. - SigningGroupID string `json:"signingGroupId,omitempty"` - // Metadata that indicates whether the `signingGroupId` property is editable. + // - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: // - SigningGroupIDMetadata *PropertyMetadata `json:"signingGroupIdMetadata,omitempty"` - // The display name for the signing group. + // $~><|^+= // - // Maximum Length: 100 characters. - SigningGroupName string `json:"signingGroupName,omitempty"` - // A complex type that contains information about users in the signing group. - SigningGroupUsers []UserInfo `json:"signingGroupUsers,omitempty"` - // Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication. + // For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` // - SmsAuthentication *RecipientSMSAuthentication `json:"smsAuthentication,omitempty"` - // Lists the social ID type that can be used for recipient authentication. - SocialAuthentications []SocialAuthentication `json:"socialAuthentications,omitempty"` - // Indicates the envelope status. Valid values are: + // - Strings embedded in other strings are ignored during the matching process. // - // * sent - The envelope is sent to the recipients. - // * created - The envelope is saved as a draft and can be modified and sent later. - Status string `json:"status,omitempty"` - // Reserved for DocuSign. - StatusCode string `json:"statusCode,omitempty"` - // A list of `signHere` tabs, which can be used to add a visual representation for an electronic seal in a document. - Tabs *Tabs `json:"tabs,omitempty"` - // When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. - TemplateLocked DSBool `json:"templateLocked,omitempty"` - // When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. - TemplateRequired DSBool `json:"templateRequired,omitempty"` - // The total number of tabs in the documents. - TotalTabCount string `json:"totalTabCount,omitempty"` - // The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing. + // - In words that have dashes, the parts separated by dashes are treated as distinct words. // - UserID string `json:"userId,omitempty"` -} - -type NotaryJournal struct { - // The creation date of the account in UTC timedate format. - CreatedDate string `json:"createdDate,omitempty"` + // Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**. // - DocumentName string `json:"documentName,omitempty"` + // - Letters with accent marks are treated as distinct characters from their unaccented counterparts. // - Jurisdiction *Jurisdiction `json:"jurisdiction,omitempty"` + // - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. // - NotaryJournalID string `json:"notaryJournalId,omitempty"` + // Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. // - NotaryJournalMetaData *NotaryJournalMetaData `json:"notaryJournalMetaData,omitempty"` - // The in-person signer's full legal name. + // - Unlike punctuation, numbers are not ignored when finding anchor words. // - // Required when `inPersonSigningType` is `inPersonSigner`. - // For eNotary flow, use `name` instead. + // Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). // - // Maximum Length: 100 characters. + // **Note**: You can only specify the value of this property in POST requests. // - SignerName string `json:"signerName,omitempty"` -} - -type NotaryJournalCredibleWitness struct { - // The user's address. - Address string `json:"address,omitempty"` + // [AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place + AnchorCaseSensitive string `json:"anchorCaseSensitive,omitempty"` + // Metadata that indicates whether the `anchorCaseSensitive` property is editable. + AnchorCaseSensitiveMetadata *PropertyMetadata `json:"anchorCaseSensitiveMetadata,omitempty"` + // This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are : // - Name string `json:"name,omitempty"` + // - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. + // - `right`: Aligns the tab’s left side with the last character of the matching anchor word. // - SignatureImage string `json:"signatureImage,omitempty"` -} - -type NotaryJournalList struct { - // The last position in the result set. - EndPosition string `json:"endPosition,omitempty"` - // The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. - NextURI string `json:"nextUri,omitempty"` + // **Note**: You can only specify the value of this property in POST requests. // - NotaryJournals []NotaryJournal `json:"notaryJournals,omitempty"` - // The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. - PreviousURI string `json:"previousUri,omitempty"` - // The number of results returned in this response. Because you can filter which entries are included in the response, this value is always less than or equal to `totalSetSize`. - ResultSetSize string `json:"resultSetSize,omitempty"` - // The starting position of the current result set. - StartPosition string `json:"startPosition,omitempty"` - // The total number of items in the search's result set. This value is always greater than or equal to the value of `resultSetSize`. - TotalSetSize string `json:"totalSetSize,omitempty"` -} - -type NotaryJournalMetaData struct { + // [AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place // - Comment string `json:"comment,omitempty"` + AnchorHorizontalAlignment string `json:"anchorHorizontalAlignment,omitempty"` + // Metadata that indicates whether the `anchorHorizontalAlignment` property is editable. + AnchorHorizontalAlignmentMetadata *PropertyMetadata `json:"anchorHorizontalAlignmentMetadata,omitempty"` + // When set to **true**, this tab is ignored if the `anchorString` is not found in the document. + AnchorIgnoreIfNotPresent string `json:"anchorIgnoreIfNotPresent,omitempty"` + // Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable. + AnchorIgnoreIfNotPresentMetadata *PropertyMetadata `json:"anchorIgnoreIfNotPresentMetadata,omitempty"` + // When set to **true**, the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false**. // - CredibleWitnesses []NotaryJournalCredibleWitness `json:"credibleWitnesses,omitempty"` + // For example, when set to **true**, if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When set to **false**, if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. // - SignatureImage string `json:"signatureImage,omitempty"` + // This functionality uses the following rules: // - SignerIDType string `json:"signerIdType,omitempty"` -} - -// Note is a tab that displays additional information, in the form of a -// note, for the recipient. -// -type Note struct { - TabBase - TabGuidedForm - TabPosition - TabStyle - TabValue - // The height of the tab in pixels. - Height string `json:"height,omitempty"` - // Metadata that indicates whether the `height` property is editable. - HeightMetadata *PropertyMetadata `json:"heightMetadata,omitempty"` - // Reserved for DocuSign. - LocalePolicy *LocalePolicyTab `json:"localePolicy,omitempty"` - // When set to **true**, this custom tab is shared. - Shared DSBool `json:"shared,omitempty"` - // Metadata that indicates whether the `shared` property is editable. - SharedMetadata *PropertyMetadata `json:"sharedMetadata,omitempty"` - // Metadata that indicates whether the `toolTip` property is editable. - ToolTipMetadata *PropertyMetadata `json:"toolTipMetadata,omitempty"` - // The text of a tooltip that appears when a user hovers over a form field or tab. - Tooltip string `json:"tooltip,omitempty"` - // The width of the tab in pixels. - Width string `json:"width,omitempty"` - // Metadata that indicates whether the `width` property is editable. - WidthMetadata *PropertyMetadata `json:"widthMetadata,omitempty"` -} - -// Notification is a complex element that specifies the notification settings for the envelope. -type Notification struct { - // A complex element that specifies the expiration settings for the envelope. - Expirations *Expirations `json:"expirations,omitempty"` - // A complex element that specifies reminder settings for the envelope - Reminders *Reminders `json:"reminders,omitempty"` - // When set to **true**, the account default notification settings are used for the envelope, overriding the reminders and expirations settings. When set to **false**, the reminders and expirations settings specified in this request are used. - UseAccountDefaults DSBool `json:"useAccountDefaults,omitempty"` -} - -type NotificationDefaultSettings struct { + // - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: // - // An array of email notifications that sets the email the user receives when they are a sender. When the specific email notification is set to true, the user will receive those types of email notifications from DocuSign. + // $~><|^+= // - // The user inherits the default account sender email notification settings when the user is created. The email notifications are: + // For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` // - // * envelopeComplete - // * changedSigner - // * senderEnvelopeDeclined - // * withdrawnConsent - // * recipientViewed - // * deliveryFailed + // - Strings embedded in other strings are ignored during the matching process. // - SenderEmailNotifications *SenderEmailNotifications `json:"senderEmailNotifications,omitempty"` - // An array of email notifications that specifies the email the user receives when they are a sender. When the specific email notification is set to true, the user receives those types of email notifications from DocuSign. The user inherits the default account sender email notification settings when the user is created. - SignerEmailNotifications *SignerEmailNotifications `json:"signerEmailNotifications,omitempty"` -} - -type NotificationDefaults struct { + // - In words that have dashes, the parts separated by dashes are treated as distinct words. // - APIEmailNotifications *NotificationDefaultSettings `json:"apiEmailNotifications,omitempty"` + // Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**. // - EmailNotifications *NotificationDefaultSettings `json:"emailNotifications,omitempty"` -} - -// Number is a tab that allows the recipient to enter numbers and decimal -// (.) points. -// -type Number struct { - TabBase - TabGuidedForm - TabPosition - TabStyle - TabValue - // When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. + // - Letters with accent marks are treated as distinct characters from their unaccented counterparts. // - // When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. + // - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. // - // This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. - ConcealValueOnDocument DSBool `json:"concealValueOnDocument,omitempty"` - // Metadata that indicates whether the `concealValueOnDocument` property is editable. - ConcealValueOnDocumentMetadata *PropertyMetadata `json:"concealValueOnDocumentMetadata,omitempty"` - // When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. - DisableAutoSize DSBool `json:"disableAutoSize,omitempty"` - // Metadata that indicates whether the `disableAutoSize` property is editable. - DisableAutoSizeMetadata *PropertyMetadata `json:"disableAutoSizeMetadata,omitempty"` - // Contains the formula - // for calculating the value of - // this tab. + // Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. // - // Use a tab's `tabLabel`, - // enclosed in brackets, - // to refer to it. + // - Unlike punctuation, numbers are not ignored when finding anchor words. // - // For example, - // you want to present the total cost - // of two items, tax included. + // Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). // - // The cost of each item is stored - // in number tabs labeled Item1 and Item2. - // The tax rate is in a number tab - // labeled TaxRate. // - // The formula string for this property - // would be: - // `([Item1] + [Item2]) * (1 + [TaxRate])` + // **Note**: You can only specify the value of this property in POST requests. // - // See [Calculated Fields][calculatedfields] - // in the DocuSign Support Center - // to learn more about formulas. + // [AnchorTab]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place // - // Maximum Length: 2000 characters + AnchorMatchWholeWord string `json:"anchorMatchWholeWord,omitempty"` + // Metadata that indicates whether the `anchorMatchWholeWord` property is editable. + AnchorMatchWholeWordMetadata *PropertyMetadata `json:"anchorMatchWholeWordMetadata,omitempty"` + // Specifies the string to find in the document and use as the basis for tab placement. + AnchorString string `json:"anchorString,omitempty"` + // Metadata that indicates whether the `anchorString` property is editable. + AnchorStringMetadata *PropertyMetadata `json:"anchorStringMetadata,omitempty"` + // Reserved for DocuSign. + AnchorTabProcessorVersion string `json:"anchorTabProcessorVersion,omitempty"` + // Reserved for DocuSign. + AnchorTabProcessorVersionMetadata *PropertyMetadata `json:"anchorTabProcessorVersionMetadata,omitempty"` + // Specifies units of the + // `anchorXOffset` and + // `anchorYOffset`. + // Valid units are: // - // [calculatedfields]: https://support.docusign.com/en/guides/ndse-user-guide-calculated-fields + // - `pixels` + // - `inches` + // - `mms` + // - `cms` // - Formula string `json:"formula,omitempty"` - // Metadata indicating if the sender can edit the `formula` property. - FormulaMetadata *PropertyMetadata `json:"formulaMetadata,omitempty"` + AnchorUnits string `json:"anchorUnits,omitempty"` + // Metadata that indicates whether the `anchorUnits` property is editable. + AnchorUnitsMetadata *PropertyMetadata `json:"anchorUnitsMetadata,omitempty"` + // Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. + // + AnchorXOffset string `json:"anchorXOffset,omitempty"` + // Metadata that indicates whether the `anchorXOffset` property is editable. + AnchorXOffsetMetadata *PropertyMetadata `json:"anchorXOffsetMetadata,omitempty"` + // Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. + // + AnchorYOffset string `json:"anchorYOffset,omitempty"` + // Metadata that indicates whether the `anchorYOffset` property is editable. + AnchorYOffsetMetadata *PropertyMetadata `json:"anchorYOffsetMetadata,omitempty"` + // The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. + CustomTabID string `json:"customTabId,omitempty"` + // Metadata that indicates whether the `customTabId` property is editable. + CustomTabIDMetadata *PropertyMetadata `json:"customTabIdMetadata,omitempty"` + // This object describes errors that occur. It is only valid for responses and ignored in requests. + ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` + // Contains details about the style used for the strike through graphic. + GraphicsContext *GraphicsContext `json:"graphicsContext,omitempty"` // The height of the tab in pixels. Height string `json:"height,omitempty"` // Metadata that indicates whether the `height` property is editable. HeightMetadata *PropertyMetadata `json:"heightMetadata,omitempty"` - // When set to **true**, sets this as a payment tab. Can only be used with Text, Number, Formula, or List tabs. The value of the tab must be a number. - IsPaymentAmount DSBool `json:"isPaymentAmount,omitempty"` - // Metadata that indicates whether the `isPaymentAmount` property is editable. - IsPaymentAmountMetadata *PropertyMetadata `json:"isPaymentAmountMetadata,omitempty"` - // Reserved for DocuSign. - LocalePolicy *LocalePolicyTab `json:"localePolicy,omitempty"` // When set to **true**, the signer cannot change the data of the custom tab. - Locked DSBool `json:"locked,omitempty"` + Locked string `json:"locked,omitempty"` // Metadata that indicates whether the `locked` property is editable. LockedMetadata *PropertyMetadata `json:"lockedMetadata,omitempty"` - // An optional value that describes the maximum length of the property when the property is a string. - MaxLength string `json:"maxLength,omitempty"` - // Metadata that indicates whether the `maxLength` property is editable. - MaxLengthMetadata *PropertyMetadata `json:"maxLengthMetadata,omitempty"` - // The initial value of the tab when it was sent to the recipient. - OriginalValue string `json:"originalValue,omitempty"` - // Metadata that indicates whether the `originalValue` property is editable. - OriginalValueMetadata *PropertyMetadata `json:"originalValueMetadata,omitempty"` - // When set to **true** and shared is true, information must be entered in this field to complete the envelope. - RequireAll DSBool `json:"requireAll,omitempty"` - // Metadata that indicates whether the `requireAll` property is editable. - RequireAllMetadata *PropertyMetadata `json:"requireAllMetadata,omitempty"` - // Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field. - RequireInitialOnSharedChange DSBool `json:"requireInitialOnSharedChange,omitempty"` - // Metadata that indicates whether the `requireInitialOnSharedChange` property is editable. - RequireInitialOnSharedChangeMetadata *PropertyMetadata `json:"requireInitialOnSharedChangeMetadata,omitempty"` - // When set to **true**, the signer is required to fill out this tab. - Required TabRequired `json:"required,omitempty"` - // Metadata that indicates whether the `required` property is editable. - RequiredMetadata *PropertyMetadata `json:"requiredMetadata,omitempty"` - // When set to **true**, the sender must populate the tab before an envelope can be sent using the template. + // Contains the information necessary to map the tab to a field in SalesForce. + MergeField *MergeField `json:"mergeField,omitempty"` // - // This value tab can only be changed by modifying (PUT) the template. + MergeFieldXML string `json:"mergeFieldXml,omitempty"` + // The type of overlay to use. The API currently supports only the `outline` overlay type. + OverlayType string `json:"overlayType,omitempty"` + // Metadata that indicates whether the `overlayType` property is editable. // - // Tabs with a `senderRequired` value of true cannot be deleted from an envelope. - SenderRequired DSBool `json:"senderRequired,omitempty"` - // Metadata that indicates whether the `senderRequired` property is editable. - SenderRequiredMetadata *PropertyMetadata `json:"senderRequiredMetadata,omitempty"` - // When set to **true**, this custom tab is shared. - Shared DSBool `json:"shared,omitempty"` + OverlayTypeMetadata *PropertyMetadata `json:"overlayTypeMetadata,omitempty"` + // Specifies the page number on which the tab is located. + PageNumber string `json:"pageNumber,omitempty"` + // Metadata that indicates whether the `pageNumber` property is editable. + PageNumberMetadata *PropertyMetadata `json:"pageNumberMetadata,omitempty"` + // An array of `polyLine` objects that contain x- and y-coordinates representing the locations of the lines. + PolyLines []PolyLine `json:"polyLines,omitempty"` + // When set to **true**, indicates that the tab is shared. + Shared string `json:"shared,omitempty"` // Metadata that indicates whether the `shared` property is editable. SharedMetadata *PropertyMetadata `json:"sharedMetadata,omitempty"` + // + SmartContractInformation *SmartContractInformation `json:"smartContractInformation,omitempty"` + // The status of the tab. Possible values are: + // + // - `active`: The tab is active, but the recipient has not yet interacted with it. + // - `signed`: The recipient signed the tab. + // - `declined`: The recipient declined the envelope. + // - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). + Status string `json:"status,omitempty"` + // Metadata that indicates whether the `status` property is editable. + StatusMetadata *PropertyMetadata `json:"statusMetadata,omitempty"` + // The unique identifier for the tab. + TabID string `json:"tabId,omitempty"` + // Metadata that indicates whether the `tabId` property is editable. + TabIDMetadata *PropertyMetadata `json:"tabIdMetadata,omitempty"` + // The label associated with the tab. This value may be an empty string. + // If no value is provided, the tab type is used as the value. + // + // Maximum Length: 500 characters. + // + TabLabel string `json:"tabLabel,omitempty"` + // A positive integer that sets the order the tab is navigated to during signing. + // + // Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. + TabOrder string `json:"tabOrder,omitempty"` + // Metadata that indicates whether the `tabOrder` property is editable. + TabOrderMetadata *PropertyMetadata `json:"tabOrderMetadata,omitempty"` + // When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. + TemplateLocked string `json:"templateLocked,omitempty"` + // Metadata that indicates whether the `templateLocked` property is editable. + TemplateLockedMetadata *PropertyMetadata `json:"templateLockedMetadata,omitempty"` + // When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. + TemplateRequired string `json:"templateRequired,omitempty"` + // Metadata that indicates whether the `templateRequired` property is editable. + TemplateRequiredMetadata *PropertyMetadata `json:"templateRequiredMetadata,omitempty"` // Metadata that indicates whether the `toolTip` property is editable. ToolTipMetadata *PropertyMetadata `json:"toolTipMetadata,omitempty"` // The text of a tooltip that appears when a user hovers over a form field or tab. Tooltip string `json:"tooltip,omitempty"` - // The message displayed if the custom tab fails input validation (either custom of embedded). - ValidationMessage string `json:"validationMessage,omitempty"` - // Metadata that indicates whether the `validationMessage` property is editable. - ValidationMessageMetadata *PropertyMetadata `json:"validationMessageMetadata,omitempty"` - // A regular expression used to validate input for the tab. - ValidationPattern string `json:"validationPattern,omitempty"` - // Metadata that indicates whether the `validationPattern` property is editable. - ValidationPatternMetadata *PropertyMetadata `json:"validationPatternMetadata,omitempty"` // The width of the tab in pixels. Width string `json:"width,omitempty"` // Metadata that indicates whether the `width` property is editable. WidthMetadata *PropertyMetadata `json:"widthMetadata,omitempty"` -} - -type OauthAccess struct { - // Access token information. - AccessToken string `json:"access_token,omitempty"` - // A Base64-encoded representation of the attachment that is used to upload and download the file. File attachments may be up to 50 MB in size. - Data []NameValue `json:"data,omitempty"` - // - ExpiresIn string `json:"expires_in,omitempty"` - // - RefreshToken string `json:"refresh_token,omitempty"` - // Must be set to "api". - Scope string `json:"scope,omitempty"` - // - TokenType string `json:"token_type,omitempty"` -} - -// Page description of a page of a document. -type Page struct { - // The number of dots per inch used for the page image. - Dpi string `json:"dpi,omitempty"` - // If an error occurs, this property describes the error. - ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` - // The height of the page in pixels. - Height string `json:"height,omitempty"` - // The number of image bytes. - ImageBytes string `json:"imageBytes,omitempty"` - // The MIME type. - MimeType string `json:"mimeType,omitempty"` - // The unique ID of the page. - PageID string `json:"pageId,omitempty"` - // The sequence of the page in the document, or page number. - Sequence string `json:"sequence,omitempty"` - // The width of the page in pixels. - Width string `json:"width,omitempty"` -} - -type PageImages struct { - // The last position in the result set. - EndPosition string `json:"endPosition,omitempty"` - // The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. - NextURI string `json:"nextUri,omitempty"` - // An array of page objects. - Pages []Page `json:"pages,omitempty"` - // The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. - PreviousURI string `json:"previousUri,omitempty"` - // The number of results returned in this response. Because you can filter which entries are included in the response, this value is always less than or equal to `totalSetSize`. - ResultSetSize string `json:"resultSetSize,omitempty"` - // The starting position of the current result set. - StartPosition string `json:"startPosition,omitempty"` - // The total number of items in the search's result set. This value is always greater than or equal to the value of `resultSetSize`. - TotalSetSize string `json:"totalSetSize,omitempty"` -} - -type PageRequest struct { - // The user's encrypted password hash. - Password string `json:"password,omitempty"` - // Sets the direction the page image is rotated. The possible settings are: left or right - Rotate string `json:"rotate,omitempty"` -} - -type PageSize struct { - // - PageHeight string `json:"pageHeight,omitempty"` - // - PageWidth string `json:"pageWidth,omitempty"` -} - -type PathExtendedElement struct { - // - Name string `json:"name,omitempty"` - // Type of user: - // - `type_owner` - // - `type_participant` - Type string `json:"type,omitempty"` - // - TypeName string `json:"typeName,omitempty"` -} - -type PayPalLegacySettings struct { - // The three-letter - // [ISO 4217][ISO4217] currency code for the payment. - // - // For example: - // - // * AUD Australian dollar - // * CAD Canadian dollar - // * EUR Euro - // * GBP Great Britain pound - // * USD United States dollar - // - // This is a read-only property. - // - // [ISO4217]: https://en.wikipedia.org/wiki/ISO_4217 - // - Currency string `json:"currency,omitempty"` + // This property indicates the horizontal offset of the object on the page. + // DocuSign uses 72 DPI when determining position. + // Required. May be zero. // - Partner string `json:"partner,omitempty"` - // The user's encrypted password hash. - Password string `json:"password,omitempty"` - // The name of the user. - UserName string `json:"userName,omitempty"` + XPosition string `json:"xPosition,omitempty"` + // Metadata that indicates whether the `xPosition` property is editable. + XPositionMetadata *PropertyMetadata `json:"xPositionMetadata,omitempty"` + // This property indicates the vertical offset of the object on the page. + // DocuSign uses 72 DPI when determining position. + // Required. May be zero. // - Vendor string `json:"vendor,omitempty"` + YPosition string `json:"yPosition,omitempty"` + // Metadata that indicates whether the `yPosition` property is editable. + YPositionMetadata *PropertyMetadata `json:"yPositionMetadata,omitempty"` } -// PaymentDetails when a formula tab -// has a `paymentDetails` property, -// the formula tab -// is a payment item. -// See [Requesting Payments Along with Signatures][paymentguide] -// in the DocuSign Support Center -// to learn more about payments. -// -// [paymentguide]: https://support.docusign.com/en/guides/requesting-payments-along-with-signatures -// -type PaymentDetails struct { - // An array of accepted payment methods: - // - // * `CreditCard` - // * `ApplePay` - // * `AndroidPay` - // * `BankAccount` - // - // For example, if you only accept credit cards and ACH transfers, you would set this property to: - // - // `'["BankAccount", "CreditCard"]'` +// PowerForm is the PowerForms resource enables you to create fillable forms that you can email or make available for self service on the web. +type PowerForm struct { + // The id of the user who created the PowerForm. This property is returned in a response only when you set the `include_created_by` query parameter to **true**. + CreatedBy string `json:"createdBy,omitempty"` + // The date and time that the PowerForm was created. + CreatedDateTime *time.Time `json:"createdDateTime,omitempty"` + // For a PowerForm that is sent by email, this is the body of the email message sent to the recipients. // - // Do not specify `BankAccount` (ACH) if you are also using in-person signing. + // Maximum length: 10000 characters. + EmailBody string `json:"emailBody,omitempty"` + // Sets the envelope name for the envelopes that the PowerForm generates. One option is to make this property the same as the subject from the template. // - AllowedPaymentMethods []string `json:"allowedPaymentMethods,omitempty"` - // The GUID set by the payment gateway (such as Stripe) that identifies a transaction. The `chargeId` is created when authorizing a payment and must be referenced when completing a payment. - ChargeID string `json:"chargeId,omitempty"` - // Specifies the three-letter - // [ISO 4217][ISO4217] currency code for the payment. + // You can customize the subject line to include a recipient's name or email address by using merge fields. For information about adding merge fields to the email subject, see [Template Email Subject Merge Fields](https://developers.docusign.com/docs/esign-rest-api/reference/templates/templates/create/). // - // Supported currencies are: + EmailSubject string `json:"emailSubject,omitempty"` + // An array of envelope objects that contain information about the envelopes that are associated with the PowerForm. + Envelopes []Envelope `json:"envelopes,omitempty"` + // This object describes errors that occur. It is only valid for responses and ignored in requests. + ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` + // The instructions that display on the landing page for the first recipient. These instructions are important if the recipient accesses the PowerForm by a method other than email. When you include instructions, they display as an introduction after the recipient accesses the PowerForm. + Instructions string `json:"instructions,omitempty"` + // When **true**, indicates that the PowerForm is active and can be sent to recipients. This is the default value. // - // * AUD Australian dollar - // * CAD Canadian dollar - // * EUR Euro - // * GBP Great Britain pound - // * USD United States dollar // - // Specifying any other ISO 4217 code for payments is an error. + // When **false**, the PowerForm cannot be emailed or accessed by a recipient, even if they arrive at the PowerForm URL. // - // [ISO4217]: https://en.wikipedia.org/wiki/ISO_4217 + // If a recipient attempts to sign an inactive PowerForm, an error message informs the recipient that the document is not active and suggests that they contact the sender. + IsActive DSBool `json:"isActive,omitempty"` + // The date and time that the PowerForm was last used. + LastUsed string `json:"lastUsed,omitempty"` + // The length of time before the same recipient can sign the same PowerForm again. This property is used in combination with the `limitUseIntervalUnits` property. + LimitUseInterval string `json:"limitUseInterval,omitempty"` + // When **true**, the `limitUseInterval` is enabled. + LimitUseIntervalEnabled string `json:"limitUseIntervalEnabled,omitempty"` + // The units associated with the `limitUseInterval`. Valid values are: // - CurrencyCode string `json:"currencyCode,omitempty"` + // - `minutes` + // - `hours` + // - `days` + // - `weeks` + // - `months` // - CurrencyCodeMetadata *PropertyMetadata `json:"currencyCodeMetadata,omitempty"` - // A GUID that identifies the payment gateway - // connected to the sender's DocuSign account. + // For example, to limit a recipient to signing once per year, set the `limitUseInterval` to 365 and the `limitUseIntervalUnits` to `days`. // - // There is no public API - // for connecting payment gateway accounts - // You must connect and manage payment gateway accounts - // through the DocuSign Admin console - // and through your chosen payment gateway. + LimitUseIntervalUnits string `json:"limitUseIntervalUnits,omitempty"` + // When set to **true**, you can set a maximum number of uses for the PowerForm. + MaxUseEnabled string `json:"maxUseEnabled,omitempty"` + // The name of the PowerForm. + Name string `json:"name,omitempty"` + // The id of the PowerForm. + PowerFormID string `json:"powerFormId,omitempty"` + // The URL for the PowerForm. + PowerFormURL string `json:"powerFormUrl,omitempty"` + // An array of `powerFormRecipient` objects. // - // You can get the gateway account ID - // in the Payments section - // of the DocuSign Admin console. + // **Note**: For self-service documents where you do not know who the recipients are in advance, you can enter generic information for the `role` property and leave other details (such as `name` and `email`) blank. + Recipients []PowerFormRecipient `json:"recipients,omitempty"` + // The name of the sender. // + // **Note**: The default sender for a PowerForm is the PowerForm Administrator who created it. + SenderName string `json:"senderName,omitempty"` + // The id of the sender. + SenderUserID string `json:"senderUserId,omitempty"` + // The signing method to use. Valid values are: // - // [paymentgateways]: https://support.docusign.com/en/guides/managing-payment-gateways + // - `email`: This mode verifies the recipient's identity by using email authentication before the recipient can sign a document. // - GatewayAccountID string `json:"gatewayAccountId,omitempty"` + // - `direct`: This mode does not require any verification. We recommend that you use this signing method only when another form of authentication is in use. // - GatewayAccountIDMetadata *PropertyMetadata `json:"gatewayAccountIdMetadata,omitempty"` - // Display name of the gateway connected to sender's Docusign account. + // **Note**: In the account settings, `enablePowerFormDirect` must be **true** to use `direct` as the `signingMode`. // - // Possible values are: Stripe, Braintree, Authorize.Net. - GatewayDisplayName string `json:"gatewayDisplayName,omitempty"` - // Name of the gateway connected to sender's DocuSign account. + // For more information about signing modes, see the [overview of the Create method](https://developers.docusign.com/docs/esign-rest-api/reference/PowerForms/PowerForms/create). + SigningMode string `json:"signingMode,omitempty"` + // The id of the template used to create the PowerForm. + TemplateID string `json:"templateId,omitempty"` + // The name of the template used to create the PowerForm. + TemplateName string `json:"templateName,omitempty"` + // The number of times the PowerForm has been used. + TimesUsed string `json:"timesUsed,omitempty"` + // The URI for the PowerForm. + URI string `json:"uri,omitempty"` + // The number of times that the PowerForm can still be used. If no use limit is set, the value is `Unlimited`. + UsesRemaining string `json:"usesRemaining,omitempty"` +} + +type PowerFormFormDataEnvelope struct { + // The envelope ID of the envelope status that failed to post. + EnvelopeID string `json:"envelopeId,omitempty"` + // An array of recipient objects that provides details about the recipients of the envelope. + Recipients []PowerFormFormDataRecipient `json:"recipients,omitempty"` +} + +type PowerFormFormDataRecipient struct { // - // Possible values are: + Email string `json:"email,omitempty"` // - // * `Stripe` - // * `Braintree` - // * `AuthorizeDotNet` - GatewayName string `json:"gatewayName,omitempty"` - // A payment formula can have - // one or more line items - // that provide detail about - // individual items in a payment request. + FormData []NameValue `json:"formData,omitempty"` + // The name of the recipient. + Name string `json:"name,omitempty"` + // The unique id for the recipient. It is used by the tab element to indicate which recipient is to sign the document. + RecipientID string `json:"recipientId,omitempty"` +} + +// PowerFormRecipient **Note**: For a self-service PowerForm on a website, you can specify the intended recipients generically (for example, use `Member` as the `Name`), and omit personal details such as `email`. +type PowerFormRecipient struct { + // (Optional) The access code that the recipient must enter to access the PowerForm. // - // The list of line items - // are returned as metadata - // to the payment gateway. + // Maximum Length: 50 characters. The code must also conform to the account's access code format setting. // - LineItems []PaymentLineItem `json:"lineItems,omitempty"` + // If blank but the signer accessCode property is set in the envelope, then that value is used. // - PaymentOption string `json:"paymentOption,omitempty"` - // This read-only property describes the status of a payment. + // If blank and the signer accessCode property is not set, then the access code is not required. + AccessCode string `json:"accessCode,omitempty"` + // When **true**, the `accessCode` property is locked and cannot be edited. + AccessCodeLocked string `json:"accessCodeLocked,omitempty"` + // When **true**, the recipient must enter the `accessCode` to access the PowerForm. + AccessCodeRequired string `json:"accessCodeRequired,omitempty"` + // The email address of the recipient. // - // * `new`
- // This is a new payment request. - // The envelope has been created, - // but no payment authorizations have been made. + // **Note**: For self-service documents where you do not know who the recipients are in advance, you can leave this property blank. + Email string `json:"email,omitempty"` + // When **true**, the recipient's email address is locked and cannot be edited. + EmailLocked string `json:"emailLocked,omitempty"` + // The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are: // - // * `auth_complete`
- // A recipient has entered their credit card information, - // but the envelope has not been completed. - // The card has not been charged. + // - `Phone Auth $`: The recipient must authenticate by using two-factor authentication (2FA). You provide the phone number to use for 2FA in the `phoneAuthentication` object. + // - `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object. + // - `ID Check $`: The recipient must answer detailed security questions. // - // * `payment_complete`
- // The recipient's card has been charged. + // **Example**: Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node. + IDCheckConfigurationName string `json:"idCheckConfigurationName,omitempty"` + // Indicates if authentication is configured for the account. Valid values are: // - // * `payment_capture_failed`
- // Final charge failed. - // This can happen when too much time - // passes between authorizing the payment - // and completing the document. + // - `always`: Authentication checks are performed on every envelope. + // - `never`: Authentication checks are not performed on any envelopes. + // - `optional:` Authentication is configurable per envelope. + IDCheckRequired string `json:"idCheckRequired,omitempty"` + // The name of the PowerForm recipient. // - Status string `json:"status,omitempty"` - // This read-only property - // is a currency-formatted string - // that represents the total - // of all the line items. - // The total is available - // only after the document is completed, - // which is when all recipients have paid and - // have completed all required fields. + // **Note**: For self-service documents where you do not know who the recipients are in advance, you can leave this property blank. + Name string `json:"name,omitempty"` + // The recipient type, as specified by the following values: + // - `agent`: Agent recipients can add name and email information for recipients that appear after the agent in routing order. + // - `carbonCopy`: Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date, or add information to any of the documents. This type of recipient can be used in any routing order. + // - `certifiedDelivery`: Certified delivery recipients must receive the completed documents for the envelope to be completed. They don't need to sign, initial, date, or add information to any of the documents. + // - `editor`: Editors have the same management and access rights for the envelope as the sender. Editors can add name and email information, add or change the routing order, set authentication options, and can edit signature/initial tabs and data fields for the remaining recipients. + // - `inPersonSigner`: In-person recipients are DocuSign users who act as signing hosts in the same physical location as the signer. + // - `intermediaries`: Intermediary recipients can optionally add name and email information for recipients at the same or subsequent level in the routing order. + // - `seal`: Electronic seal recipients represent legal entities. + // - `signer`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope. + // - `witness`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope. + RecipientType string `json:"recipientType,omitempty"` + // The role associated with the recipient (for example, `Member`). // - Total *Money `json:"total,omitempty"` + // This property is required when you are working with template recipients and PowerForm recipients. + RoleName string `json:"roleName,omitempty"` + // Specifies the routing order of the recipient in the envelope. + RoutingOrder string `json:"routingOrder,omitempty"` + // When **true**, the template used to create the PowerForm requires ID lookup for the recipient. + TemplateRequiresIDLookup string `json:"templateRequiresIdLookup,omitempty"` + // When **true**, the `userName` property for the recipient is locked and cannot be edited. + UserNameLocked string `json:"userNameLocked,omitempty"` } -// PaymentGatewayAccount information about a connected payment gateway account. -type PaymentGatewayAccount struct { +// PowerFormSendersResponse this object includes information about the users who have sent PowerForms. +type PowerFormSendersResponse struct { + // The last index position in the result set. + EndPosition int32 `json:"endPosition,omitempty"` + // The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. + NextURI string `json:"nextUri,omitempty"` + // An array of `userInfo` objects containing information about users who have sent PowerForms. + PowerFormSenders []UserInfo `json:"powerFormSenders,omitempty"` + // The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. + PreviousURI string `json:"previousUri,omitempty"` + // The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`. + ResultSetSize int32 `json:"resultSetSize,omitempty"` + // The starting index position of the current result set. + StartPosition int32 `json:"startPosition,omitempty"` + // The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`. + TotalSetSize int32 `json:"totalSetSize,omitempty"` +} + +type PowerFormsFormDataResponse struct { + // An array containing PowerForm data. + Envelopes []PowerFormFormDataEnvelope `json:"envelopes,omitempty"` +} + +type PowerFormsRequest struct { + // An array of PowerForm objects. + PowerForms []PowerForm `json:"powerForms,omitempty"` +} + +// PowerFormsResponse is a list of PowerForms. +type PowerFormsResponse struct { + // The last index position in the result set. + EndPosition int32 `json:"endPosition,omitempty"` + // The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. + NextURI string `json:"nextUri,omitempty"` + // An array of PowerForm objects. + PowerForms []PowerForm `json:"powerForms,omitempty"` + // The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. + PreviousURI string `json:"previousUri,omitempty"` + // The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`. + ResultSetSize int32 `json:"resultSetSize,omitempty"` + // The starting index position of the current result set. + StartPosition int32 `json:"startPosition,omitempty"` + // The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`. + TotalSetSize int32 `json:"totalSetSize,omitempty"` +} + +type PrefillTabs struct { + // A list of + // [Checkbox tabs][checkbox]. // - Config *PaymentGatewayAccountSetting `json:"config,omitempty"` - // A user-defined name for a connected gateway account. // - // This name is used in the Admin panel in the list of connected accounts and in Tagger in the payment gateway selector. + // A Checkbox tab enables the recipient to select a yes/no (on/off) option. This value can be set. // - // The human-readable version of `paymentGatewayAccountId`. - DisplayName string `json:"displayName,omitempty"` // - IsEnabled string `json:"isEnabled,omitempty"` + // [checkbox]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/ // - IsLegacy string `json:"isLegacy,omitempty"` - // Utc date and time the comment was last updated (can only be done by creator.) - LastModified string `json:"lastModified,omitempty"` + CheckboxTabs []Checkbox `json:"checkboxTabs,omitempty"` + // A list of [Radio Group tabs][radioGroup]. // - PayPalLegacySettings *PayPalLegacySettings `json:"payPalLegacySettings,omitempty"` - // Payment gateway used by the connected gateway account. - // This is the name used by the API. - // For a human-readable version use `paymentGatewayDisplayName`. + // A Radio Group tab places a group of radio buttons on a document. The `radios` property is used to add and place the radio + // buttons associated with the group. Only one radio button can be selected in a group. This value can be set. // - // Possible values are: // - // * `Stripe` - // * `Braintree` - // * `AuthorizeDotNet` - PaymentGateway string `json:"paymentGateway,omitempty"` - // A GUID that identifies the payment gateway account. For a human-readable version use `displayName`. - PaymentGatewayAccountID string `json:"paymentGatewayAccountId,omitempty"` - // Display name of the payment gateway used by the connected gateway account. - // This is the human-readable version of `paymentGateway`. + // [radioGroup]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/ // - // Possible values are: + RadioGroupTabs []RadioGroup `json:"radioGroupTabs,omitempty"` + // An array of `tabGroup` items that contain information about tab groups. To assign a tab to a `tabGroup`, you assign the `tabGroupLabel` to the `Tab.TabGroupLabels` array. + TabGroups []TabGroup `json:"tabGroups,omitempty"` + // A list of + // Text tabs. // - // * Stripe - // * Braintree - // * Authorize.Net - PaymentGatewayDisplayName string `json:"paymentGatewayDisplayName,omitempty"` + // A text tab enables the recipient to enter free text. This value can be set. // - SupportedCurrencies []string `json:"supportedCurrencies,omitempty"` + // Find descriptions of all tab types in + // the [EnvelopeRecipientTabs Resource][ert]. // - SupportedPaymentMethods []string `json:"supportedPaymentMethods,omitempty"` + // [ert]: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ + // + TextTabs []Text `json:"textTabs,omitempty"` +} + +type ProofServiceResourceToken struct { + // Returns the available base URIs to request the [ID Evidence API](https://developers.docusign.com/docs/idevidence-api/). + ProofBaseURI string `json:"proofBaseURI,omitempty"` + // Token that can be used to access [ID Evidence API](https://developers.docusign.com/docs/idevidence-api/) endpoints. + ResourceToken string `json:"resourceToken,omitempty"` +} + +type ProofServiceViewLink struct { + // + ViewLink string `json:"ViewLink,omitempty"` +} + +// PropertyMetadata metadata about a property. +type PropertyMetadata struct { + // An array of option strings supported by this setting. + Options []string `json:"options,omitempty"` + // Indicates whether the property is editable. Valid values are: + // + // - `editable` + // - `read_only` + Rights string `json:"rights,omitempty"` +} + +type Province struct { + // + IsoCode string `json:"isoCode,omitempty"` // - SupportedPaymentMethodsWithOptions []PaymentMethodWithOptions `json:"supportedPaymentMethodsWithOptions,omitempty"` + Name string `json:"name,omitempty"` } -type PaymentGatewayAccountSetting struct { +type ProvisioningInformation struct { // - APIFields string `json:"apiFields,omitempty"` + DefaultConnectionID string `json:"defaultConnectionId,omitempty"` // - AuthorizationCode string `json:"authorizationCode,omitempty"` + DefaultPlanID string `json:"defaultPlanId,omitempty"` + // The code that identifies the billing plan groups and plans for the new account. + DistributorCode string `json:"distributorCode,omitempty"` + // The password for the `distributorCode`. + DistributorPassword string `json:"distributorPassword,omitempty"` // - CredentialStatus string `json:"credentialStatus,omitempty"` + PasswordRuleText string `json:"passwordRuleText,omitempty"` // - MerchantID string `json:"merchantId,omitempty"` + PlanPromotionText string `json:"planPromotionText,omitempty"` + // + PurchaseOrderOrPromAllowed string `json:"purchaseOrderOrPromAllowed,omitempty"` } -// PaymentGatewayAccountsInfo holds information about connected payment accounts. -type PaymentGatewayAccountsInfo struct { - // A list of payment gateway accounts. - PaymentGatewayAccounts []PaymentGatewayAccount `json:"paymentGatewayAccounts,omitempty"` +type PurchasedEnvelopesInformation struct { + // The total amount of the purchase. + Amount string `json:"amount,omitempty"` + // The AppName of the client application. + AppName string `json:"appName,omitempty"` + // Specifies the ISO currency code of the purchase. This is based on the ISO 4217 currency code information. + CurrencyCode string `json:"currencyCode,omitempty"` + // The Platform of the client application + Platform string `json:"platform,omitempty"` + // The Product ID from the AppStore. + ProductID string `json:"productId,omitempty"` + // The quantity of envelopes to add to the account. + Quantity string `json:"quantity,omitempty"` + // The encrypted Base64 encoded receipt data. + ReceiptData []byte `json:"receiptData,omitempty"` + // The name of the AppStore. + StoreName string `json:"storeName,omitempty"` + // Specifies the Transaction ID from the AppStore. + TransactionID string `json:"transactionId,omitempty"` } -// PaymentLineItem is a line item describes details -// about an individual line item -// in a payment request. -// +// Radio one of the selectable radio buttons +// in the `radios` property +// of a [`radioGroup`](https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/) tab. // -type PaymentLineItem struct { - // This is a the `tabLabel` - // that specifies the amount paid - // for the line items. +type Radio struct { // + AnchorAllowWhiteSpaceInCharacters string `json:"anchorAllowWhiteSpaceInCharacters,omitempty"` // - AmountReference string `json:"amountReference,omitempty"` - // A sender-defined description of the line item. + AnchorAllowWhiteSpaceInCharactersMetadata *PropertyMetadata `json:"anchorAllowWhiteSpaceInCharactersMetadata,omitempty"` + // This property controls how [anchor tabs][AnchorTabs] are placed. When **true**, the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false**. // - Description string `json:"description,omitempty"` - // This is the sender-defined - // SKU, inventory number, or other item code - // for the line item. + // For example, when set to **true**, if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When set to **false**, `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. // - ItemCode string `json:"itemCode,omitempty"` - // This is a sender-defined - // product name, service name, - // or other designation for the line item. + // This functionality uses the following rules: // - Name string `json:"name,omitempty"` -} - -type PaymentMethodWithOptions struct { + // - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: // - SupportedOptions []string `json:"supportedOptions,omitempty"` - // Type of user: - // - `type_owner` - // - `type_participant` - Type string `json:"type,omitempty"` -} - -type PaymentProcessorInformation struct { - // The user's address. - Address *AddressInformation `json:"address,omitempty"` + // $~><|^+= // - BillingAgreementID string `json:"billingAgreementId,omitempty"` - // Filters returned user records by the specified email address. - Email string `json:"email,omitempty"` -} - -// PermissionProfile this object defines the account permissions for a profile that you can apply to a group of users. -type PermissionProfile struct { - // The username of the user who last modified the permission profile. - ModifiedByUsername string `json:"modifiedByUsername,omitempty"` - // The date and time when the permission profile was last modified. - ModifiedDateTime *time.Time `json:"modifiedDateTime,omitempty"` - // The ID of the permission profile. Possible values include: + // For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` // - // - `2301416` (for the `DocuSign Viewer` profile) - // - `2301415` (for the `DocuSign Sender` profile) - // - `2301414` (for the `Account Administrator` profile) + // - Strings embedded in other strings are ignored during the matching process. // - // In addition, any custom permission profiles associated with your account will have an automatically generated `permissionProfileId`. - PermissionProfileID string `json:"permissionProfileId,omitempty"` - // The name of the account permission profile. + // - In words that have dashes, the parts separated by dashes are treated as distinct words. // - // Example: `Account Administrator` - PermissionProfileName string `json:"permissionProfileName,omitempty"` - // This object specifies the permissions that are associated with the account permission profile. - Settings *AccountRoleSettings `json:"settings,omitempty"` - // The total number of users in the group associated with the account permission profile. - UserCount string `json:"userCount,omitempty"` - // A list of user objects containing information about the users who are associated with the account permission profile. - Users []UserInformation `json:"users,omitempty"` -} - -// PermissionProfileInformation contains details about the permission profiles associated with an account. -type PermissionProfileInformation struct { - // A complex type containing a collection of permission profiles. - PermissionProfiles []PermissionProfile `json:"permissionProfiles,omitempty"` -} - -// PlanInformation is an object used to identify the features and attributes of the account being created. -type PlanInformation struct { - // Reserved for DocuSign. - AddOns []AddOn `json:"addOns,omitempty"` - // Specifies the ISO currency code for the account. - CurrencyCode string `json:"currencyCode,omitempty"` - // Reserved for DocuSign use only. - FreeTrialDaysOverride string `json:"freeTrialDaysOverride,omitempty"` - // Reserved for DocuSign. - PlanFeatureSets []FeatureSet `json:"planFeatureSets,omitempty"` - // The DocuSign plan id for the account. - PlanID string `json:"planId,omitempty"` + // Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**. // - RecipientDomains []RecipientDomain `json:"recipientDomains,omitempty"` -} - -type PolyLine struct { + // - Letters with accent marks are treated as distinct characters from their unaccented counterparts. // - X1 string `json:"x1,omitempty"` + // - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. // - X2 string `json:"x2,omitempty"` + // Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. // - Y1 string `json:"y1,omitempty"` + // - Unlike punctuation, numbers are not ignored when finding anchor words. // - Y2 string `json:"y2,omitempty"` -} - -// PolyLineOverlay this tab enables users to strike through the text of a document. The tab is implemented as a line represented as a pair of x and y coordinates. -type PolyLineOverlay struct { - TabBase - TabGuidedForm - // Reserved for DocuSign. - // - AnchorCaseSensitive string `json:"anchorCaseSensitive,omitempty"` - // Reserved for DocuSign. + // Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). + // + // **Note**: You can only specify the value of this property in POST requests. + // + // [AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place + AnchorCaseSensitive DSBool `json:"anchorCaseSensitive,omitempty"` + // Metadata that indicates whether the `anchorCaseSensitive` property is editable. AnchorCaseSensitiveMetadata *PropertyMetadata `json:"anchorCaseSensitiveMetadata,omitempty"` - // Reserved for DocuSign. - // + // This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are : + // + // - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. + // - `right`: Aligns the tab’s left side with the last character of the matching anchor word. + // + // **Note**: You can only specify the value of this property in POST requests. + // + // [AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place // AnchorHorizontalAlignment string `json:"anchorHorizontalAlignment,omitempty"` - // Reserved for DocuSign. + // Metadata that indicates whether the `anchorHorizontalAlignment` property is editable. AnchorHorizontalAlignmentMetadata *PropertyMetadata `json:"anchorHorizontalAlignmentMetadata,omitempty"` // When set to **true**, this tab is ignored if the `anchorString` is not found in the document. - AnchorIgnoreIfNotPresent string `json:"anchorIgnoreIfNotPresent,omitempty"` + AnchorIgnoreIfNotPresent DSBool `json:"anchorIgnoreIfNotPresent,omitempty"` // Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable. AnchorIgnoreIfNotPresentMetadata *PropertyMetadata `json:"anchorIgnoreIfNotPresentMetadata,omitempty"` - // Reserved for DocuSign. - // + // When set to **true**, the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false**. // - AnchorMatchWholeWord string `json:"anchorMatchWholeWord,omitempty"` - // Reserved for DocuSign. + // For example, when set to **true**, if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When set to **false**, if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. + // + // This functionality uses the following rules: + // + // - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: + // + // $~><|^+= + // + // For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` + // + // - Strings embedded in other strings are ignored during the matching process. + // + // - In words that have dashes, the parts separated by dashes are treated as distinct words. + // + // Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**. + // + // - Letters with accent marks are treated as distinct characters from their unaccented counterparts. + // + // - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. + // + // Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. + // + // - Unlike punctuation, numbers are not ignored when finding anchor words. + // + // Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). + // + // + // **Note**: You can only specify the value of this property in POST requests. + // + // [AnchorTab]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place + // + AnchorMatchWholeWord DSBool `json:"anchorMatchWholeWord,omitempty"` + // Metadata that indicates whether the `anchorMatchWholeWord` property is editable. AnchorMatchWholeWordMetadata *PropertyMetadata `json:"anchorMatchWholeWordMetadata,omitempty"` // Specifies the string to find in the document and use as the basis for tab placement. AnchorString string `json:"anchorString,omitempty"` @@ -10277,57 +16072,121 @@ type PolyLineOverlay struct { AnchorTabProcessorVersion string `json:"anchorTabProcessorVersion,omitempty"` // Reserved for DocuSign. AnchorTabProcessorVersionMetadata *PropertyMetadata `json:"anchorTabProcessorVersionMetadata,omitempty"` - // Specifies the units of the X and Y offset. Units may be pixels, millimeters, centimeters, or inches. + // Specifies units of the + // `anchorXOffset` and + // `anchorYOffset`. + // Valid units are: + // + // - `pixels` + // - `inches` + // - `mms` + // - `cms` + // AnchorUnits string `json:"anchorUnits,omitempty"` // Metadata that indicates whether the `anchorUnits` property is editable. AnchorUnitsMetadata *PropertyMetadata `json:"anchorUnitsMetadata,omitempty"` // Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. + // AnchorXOffset string `json:"anchorXOffset,omitempty"` // Metadata that indicates whether the `anchorXOffset` property is editable. AnchorXOffsetMetadata *PropertyMetadata `json:"anchorXOffsetMetadata,omitempty"` // Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. + // AnchorYOffset string `json:"anchorYOffset,omitempty"` // Metadata that indicates whether the `anchorYOffset` property is editable. AnchorYOffsetMetadata *PropertyMetadata `json:"anchorYOffsetMetadata,omitempty"` - // The DocuSign-generated custom tab id for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - CustomTabID string `json:"customTabId,omitempty"` - // Metadata that indicates whether the `customTabId` property is editable. - CustomTabIDMetadata *PropertyMetadata `json:"customTabIdMetadata,omitempty"` + // When set to **true**, the information in the tab is bold. + Bold string `json:"bold,omitempty"` + // Metadata that indicates whether the `bold` property is editable. + BoldMetadata *PropertyMetadata `json:"boldMetadata,omitempty"` // This object describes errors that occur. It is only valid for responses and ignored in requests. ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` - // Contains details about the style used for the strike through graphic. - GraphicsContext *GraphicsContext `json:"graphicsContext,omitempty"` - // The height of the tab in pixels. - Height string `json:"height,omitempty"` - // Metadata that indicates whether the `height` property is editable. - HeightMetadata *PropertyMetadata `json:"heightMetadata,omitempty"` + // The font to be used for the tab value. Supported fonts include: + // + // - Default + // - Arial + // - ArialNarrow + // - Calibri + // - CourierNew + // - Garamond + // - Georgia + // - Helvetica + // - LucidaConsole + // - MSGothic + // - MSMincho + // - OCR-A + // - Tahoma + // - TimesNewRoman + // - Trebuchet + // - Verdana + // + Font string `json:"font,omitempty"` + // The font color to use for the information in the tab. Possible values are: + // + // - Black + // - BrightBlue + // - BrightRed + // - DarkGreen + // - DarkRed + // - Gold + // - Green + // - NavyBlue + // - Purple + // - White + // + FontColor string `json:"fontColor,omitempty"` + // Metadata that indicates whether the `fontColor` property is editable. + FontColorMetadata *PropertyMetadata `json:"fontColorMetadata,omitempty"` + // Metadata that indicates whether the `font` property is editable. + FontMetadata *PropertyMetadata `json:"fontMetadata,omitempty"` + // The font size used for the information in the tab. Possible values are: + // + // - Size7 + // - Size8 + // - Size9 + // - Size10 + // - Size11 + // - Size12 + // - Size14 + // - Size16 + // - Size18 + // - Size20 + // - Size22 + // - Size24 + // - Size26 + // - Size28 + // - Size36 + // - Size48 + // - Size72 + FontSize string `json:"fontSize,omitempty"` + // Metadata that indicates whether the `fontSize` property is editable. + FontSizeMetadata *PropertyMetadata `json:"fontSizeMetadata,omitempty"` + // When set to **true**, the information in the tab is italic. + Italic string `json:"italic,omitempty"` + // Metadata that indicates whether the `italic` property is editable. + ItalicMetadata *PropertyMetadata `json:"italicMetadata,omitempty"` // When set to **true**, the signer cannot change the data of the custom tab. - Locked string `json:"locked,omitempty"` - // Metadata that indicates whether the `locked` property is editable. - LockedMetadata *PropertyMetadata `json:"lockedMetadata,omitempty"` - // Contains the information necessary to map the tab to a field in SalesForce. - MergeField *MergeField `json:"mergeField,omitempty"` - // The type of overlay to use. The API currently supports only the `outline` overlay type. - OverlayType string `json:"overlayType,omitempty"` - // Metadata that indicates whether the `overlayType` property is editable. + Locked DSBool `json:"locked,omitempty"` + // Metadata that indicates whether the `locked` property is editable. + LockedMetadata *PropertyMetadata `json:"lockedMetadata,omitempty"` + // Specifies the page number on which the tab is located. + // Must be 1 for supplemental documents. // - OverlayTypeMetadata *PropertyMetadata `json:"overlayTypeMetadata,omitempty"` - // The page number being accessed. PageNumber string `json:"pageNumber,omitempty"` // Metadata that indicates whether the `pageNumber` property is editable. PageNumberMetadata *PropertyMetadata `json:"pageNumberMetadata,omitempty"` - // An array of `polyLine` objects that contain x- and y-coordinates representing the locations of the lines. - PolyLines []PolyLine `json:"polyLines,omitempty"` - // When set to **true**, indicates that the tab is shared. - Shared string `json:"shared,omitempty"` - // Metadata that indicates whether the `shared` property is editable. - SharedMetadata *PropertyMetadata `json:"sharedMetadata,omitempty"` - // The status of the tab. Possible values are: + // When set to **true**, the signer is required to fill out this tab. + Required TabRequired `json:"required,omitempty"` + // Metadata that indicates whether the `required` property is editable. + RequiredMetadata *PropertyMetadata `json:"requiredMetadata,omitempty"` + // When set to **true**, the radio button is selected. + Selected DSBool `json:"selected,omitempty"` + // Metadata that indicates whether the `selected` property is editable. + SelectedMetadata *PropertyMetadata `json:"selectedMetadata,omitempty"` + // Indicates the envelope status. Valid values are: // - // - `active`: The tab is active, but the recipient has not yet interacted with it. - // - `signed`: The recipient signed the tab. - // - `declined`: The recipient declined the envelope. - // - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). + // * sent - The envelope is sent to the recipients. + // * created - The envelope is saved as a draft and can be modified and sent later. Status string `json:"status,omitempty"` // Metadata that indicates whether the `status` property is editable. StatusMetadata *PropertyMetadata `json:"statusMetadata,omitempty"` @@ -10335,19 +16194,63 @@ type PolyLineOverlay struct { TabID string `json:"tabId,omitempty"` // Metadata that indicates whether the `tabId` property is editable. TabIDMetadata *PropertyMetadata `json:"tabIdMetadata,omitempty"` - // The label string associated with the tab. - // The string may be the empty string. - // If no value is provided, the tab type is used as the value. - // - // Maximum of 500 characters. - // - TabLabel string `json:"tabLabel,omitempty"` // A positive integer that sets the order the tab is navigated to during signing. // // Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. TabOrder string `json:"tabOrder,omitempty"` // Metadata that indicates whether the `tabOrder` property is editable. TabOrderMetadata *PropertyMetadata `json:"tabOrderMetadata,omitempty"` + // When set to **true**, the information in the tab is underlined. + Underline string `json:"underline,omitempty"` + // Metadata that indicates whether the `underline` property is editable. + UnderlineMetadata *PropertyMetadata `json:"underlineMetadata,omitempty"` + // Specifies the value of the tab. + Value string `json:"value,omitempty"` + // Metadata that indicates whether the `value` property is editable. + ValueMetadata *PropertyMetadata `json:"valueMetadata,omitempty"` + // This property indicates the horizontal offset of the object on the page. + // DocuSign uses 72 DPI when determining position. + // Required. May be zero. + // + XPosition string `json:"xPosition,omitempty"` + // Metadata that indicates whether the `xPosition` property is editable. + XPositionMetadata *PropertyMetadata `json:"xPositionMetadata,omitempty"` + // This property indicates the vertical offset of the object on the page. + // DocuSign uses 72 DPI when determining position. + // Required. May be zero. + // + YPosition string `json:"yPosition,omitempty"` + // Metadata that indicates whether the `yPosition` property is editable. + YPositionMetadata *PropertyMetadata `json:"yPositionMetadata,omitempty"` +} + +// RadioGroup this group tab is used to place radio buttons on a document. +// The `radios` property +// contains a list of +// [`radio`](https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/) +// objects associated with the group. Only one radio button can +// be selected in a group. +// +type RadioGroup struct { + TabBase + // The name of the group. The search_text provided in the call automatically performs a wild card search on group_name. + GroupName string `json:"groupName,omitempty"` + // Metadata that indicates whether the `groupName` property is editable. + GroupNameMetadata *PropertyMetadata `json:"groupNameMetadata,omitempty"` + // Specifies the locations and status for radio buttons that are grouped together. + Radios []Radio `json:"radios,omitempty"` + // When set to **true** and shared is true, information must be entered in this field to complete the envelope. + RequireAll DSBool `json:"requireAll,omitempty"` + // Metadata that indicates whether the `requireAll` property is editable. + RequireAllMetadata *PropertyMetadata `json:"requireAllMetadata,omitempty"` + // Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field. + RequireInitialOnSharedChange DSBool `json:"requireInitialOnSharedChange,omitempty"` + // Metadata that indicates whether the `requireInitialOnSharedChange` property is editable. + RequireInitialOnSharedChangeMetadata *PropertyMetadata `json:"requireInitialOnSharedChangeMetadata,omitempty"` + // When set to **true**, this custom tab is shared. + Shared DSBool `json:"shared,omitempty"` + // Metadata that indicates whether the `shared` property is editable. + SharedMetadata *PropertyMetadata `json:"sharedMetadata,omitempty"` // When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. TemplateLocked string `json:"templateLocked,omitempty"` // Metadata that indicates whether the `templateLocked` property is editable. @@ -10356,900 +16259,1083 @@ type PolyLineOverlay struct { TemplateRequired string `json:"templateRequired,omitempty"` // Metadata that indicates whether the `templateRequired` property is editable. TemplateRequiredMetadata *PropertyMetadata `json:"templateRequiredMetadata,omitempty"` - // Metadata that indicates whether the `toolTip` property is editable. - ToolTipMetadata *PropertyMetadata `json:"toolTipMetadata,omitempty"` // The text of a tooltip that appears when a user hovers over a form field or tab. Tooltip string `json:"tooltip,omitempty"` - // The width of the tab in pixels. - Width string `json:"width,omitempty"` - // Metadata that indicates whether the `width` property is editable. - WidthMetadata *PropertyMetadata `json:"widthMetadata,omitempty"` - // This property indicates the horizontal offset of the object on the page. - // DocuSign uses 72 DPI when determining position. - // Required. May be zero. + // Metadata that indicates whether the `tooltip` property is editable. + TooltipMetadata *PropertyMetadata `json:"tooltipMetadata,omitempty"` +} + +// RecipientAdditionalNotification describes an additional notification method. +type RecipientAdditionalNotification struct { + // The phone number to receive the additional notifcation. + PhoneNumber *RecipientPhoneNumber `json:"phoneNumber,omitempty"` + // The secondary delivery method. One of: // - XPosition string `json:"xPosition,omitempty"` - // Metadata that indicates whether the `xPosition` property is editable. - XPositionMetadata *PropertyMetadata `json:"xPositionMetadata,omitempty"` - // This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. - YPosition string `json:"yPosition,omitempty"` - // Metadata that indicates whether the `yPosition` property is editable. - YPositionMetadata *PropertyMetadata `json:"yPositionMetadata,omitempty"` + // - `email` + // - `fax` + // - `SMS` + // - `offline` + // + SecondaryDeliveryMethod string `json:"secondaryDeliveryMethod,omitempty"` + // Metadata about the delivery method. + SecondaryDeliveryMethodMetadata *PropertyMetadata `json:"secondaryDeliveryMethodMetadata,omitempty"` + // (Read-only) The status of the delivery. + // + // One of: + // + // - `autoresponded` + // - `optedout` + // - `limitreached` + // + SecondaryDeliveryStatus string `json:"secondaryDeliveryStatus,omitempty"` } -type PowerForm struct { +type RecipientAttachment struct { + // The unique identifier for the attachment. + AttachmentID string `json:"attachmentId,omitempty"` + // Specifies the type of the attachment for the recipient. Possible values are: // - CreatedBy string `json:"createdBy,omitempty"` - // The date and time the item was created. - CreatedDateTime *time.Time `json:"createdDateTime,omitempty"` - // The body of the email message sent to the recipients. + // - `.htm` + // - `.xml` + AttachmentType string `json:"attachmentType,omitempty"` + // A Base64-encoded representation of the attachment that is used to upload and download the file. File attachments may be up to 50 MB in size. + Data []byte `json:"data,omitempty"` + // An optional label for the attachment. + Label string `json:"label,omitempty"` + // The name of the attachment. + Name string `json:"name,omitempty"` + // The URL of a previously staged chunked upload. Using a chunked upload enables you to stage a large, chunkable temp file. You then use the `remoteUrl` property to reference the chunked upload as the content in attachment and document-related requests. The `remoteUrl` property cannot be used for downloads. + RemoteURL string `json:"remoteUrl,omitempty"` +} + +type RecipientDomain struct { // - // Maximum length: 10000 characters. - EmailBody string `json:"emailBody,omitempty"` - // The subject line of the email message that is sent to all recipients. + Active string `json:"active,omitempty"` + // + DomainCode string `json:"domainCode,omitempty"` // - // For information about adding merge field information to the email subject, see [Template Email Subject Merge Fields](https://developers.docusign.com/esign-rest-api/reference/Templates/Templates/create#template-email-subject-merge-fields). + DomainName string `json:"domainName,omitempty"` // + RecipientDomainID string `json:"recipientDomainId,omitempty"` +} + +type RecipientEmailNotification struct { + // The body of the email message. + EmailBody string `json:"emailBody,omitempty"` + // Metadata that indicates whether the `emailBody` property can be edited. + EmailBodyMetadata *PropertyMetadata `json:"emailBodyMetadata,omitempty"` + // The subject line for the email notification. EmailSubject string `json:"emailSubject,omitempty"` - // An array containing PowerForm data. - Envelopes []Envelope `json:"envelopes,omitempty"` - // This object describes errors that occur. It is only valid for responses and ignored in requests. - ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` + // Metadata that indicates whether the `emailSubject` property can be edited. + EmailSubjectMetadata *PropertyMetadata `json:"emailSubjectMetadata,omitempty"` + // The language to use for the standard email format and signing view for a recipient. // - Instructions string `json:"instructions,omitempty"` + // For example, in the recipient's email notification, this setting affects elements such as the standard introductory text describing the request to sign. It also determines the language used for buttons and tabs in both the email notification and the signing experience. // - IsActive DSBool `json:"isActive,omitempty"` + // **Note**: This setting affects only DocuSign standard text. Any custom text that you enter for the `emailBody` and `emailSubject` of the notification is not translated, and appears exactly as you enter it. + // + // To retrieve the possible values, use the [Accounts::listSupportedLanguages][ListLang] method. + // + // [ListLang]: https://developers.docusign.com/docs/esign-rest-api/reference/Accounts/Accounts/listSupportedLanguages/ + // + SupportedLanguage string `json:"supportedLanguage,omitempty"` + // Metadata that indicates whether the `supportedLanguage` property can be edited. + SupportedLanguageMetadata *PropertyMetadata `json:"supportedLanguageMetadata,omitempty"` +} + +type RecipientEvent struct { + // When set to **true**, the PDF documents are included in the message along with the updated XML. + IncludeDocuments string `json:"includeDocuments,omitempty"` + // Send a webhook notification for the following recipient statuses: Sent, Delivered, Completed, Declined, AuthenticationFailed, and AutoResponded. + RecipientEventStatusCode string `json:"recipientEventStatusCode,omitempty"` +} + +type RecipientFormData struct { + // The date and time the recipient declined the envelope. + DeclinedTime string `json:"DeclinedTime,omitempty"` + // The date and time the recipient viewed the documents in the envelope in the DocuSign signing UI. + DeliveredTime string `json:"DeliveredTime,omitempty"` + // The date and time the envelope was sent to the recipient. + SentTime string `json:"SentTime,omitempty"` + // The date and time the recipient signed the documents. + SignedTime string `json:"SignedTime,omitempty"` + // The recipient's email address. + Email string `json:"email,omitempty"` + // An array of form data objects. + FormData []FormDataItem `json:"formData,omitempty"` + // The name of the recipient. + Name string `json:"name,omitempty"` + // Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. + RecipientID string `json:"recipientId,omitempty"` +} + +// RecipientGroup describes a group of recipients. +type RecipientGroup struct { + // The group message, typically a description of the group. + GroupMessage string `json:"groupMessage,omitempty"` + // The name of the group + GroupName string `json:"groupName,omitempty"` + // An array of recipient objects that provides details about the recipients of the envelope. + Recipients []RecipientOption `json:"recipients,omitempty"` +} + +type RecipientIdentityInputOption struct { + // + Name string `json:"name,omitempty"` + // + PhoneNumberList []RecipientIdentityPhoneNumber `json:"phoneNumberList,omitempty"` + // + ValueType string `json:"valueType,omitempty"` +} + +type RecipientIdentityPhoneNumber struct { + // + Extension string `json:"extension,omitempty"` + // + Number string `json:"number,omitempty"` +} + +// RecipientIdentityVerification specifies ID Verification applied on an envelope by workflow ID. +// See the [list](https://developers.docusign.com/docs/esign-rest-api/reference/Accounts/IdentityVerifications/list) +// method in the [IdentityVerifications](https://developers.docusign.com/docs/esign-rest-api/reference/Accounts/IdentityVerifications) resource +// for more information on how to retrieve workflow IDs available for an account. +// This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods. +type RecipientIdentityVerification struct { + // + InputOptions []RecipientIdentityInputOption `json:"inputOptions,omitempty"` + // ID of the Identity Verification worklow used to verify recipients' identity. + // + // This ID must match one of the [workflowId](https://developers.docusign.com/docs/esign-rest-api/reference/accounts/identityverifications/list/) available to your account. + WorkflowID string `json:"workflowId,omitempty"` +} + +// RecipientNamesResponse this response object contains a list of recipients. +type RecipientNamesResponse struct { + // When set to **true**, the email address is used by more than one user. + MultipleUsers string `json:"multipleUsers,omitempty"` + // The names of the recipients associated with the email address. + RecipientNames []string `json:"recipientNames,omitempty"` + // When set to **true**, new names cannot be added to the email address. + ReservedRecipientEmail string `json:"reservedRecipientEmail,omitempty"` +} + +type RecipientOption struct { + // + Email string `json:"email,omitempty"` + // + Name string `json:"name,omitempty"` + // + RecipientLabel string `json:"recipientLabel,omitempty"` + // Optional element. Specifies the role name associated with the recipient.

This property is required when you are working with template recipients. + RoleName string `json:"roleName,omitempty"` + // When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once). + SigningGroupID string `json:"signingGroupId,omitempty"` +} + +// RecipientPhoneAuthentication is a complex type that contains the elements: +// +// * `recipMayProvideNumber`: A Boolean value that specifies whether the recipient can use the phone number of their choice. +// * `senderProvidedNumbers`: A list of phone numbers that the recipient can use. +// * `recordVoicePrint`: Reserved for DocuSign. +// * `validateRecipProvidedNumber`: Reserved for DocuSign. +type RecipientPhoneAuthentication struct { + // Boolean. When set to **true**, the recipient can supply a phone number their choice. + RecipMayProvideNumber DSBool `json:"recipMayProvideNumber,omitempty"` + // Metadata that indicates whether the `recipMayProvideNumber` property can be edited. + RecipMayProvideNumberMetadata *PropertyMetadata `json:"recipMayProvideNumberMetadata,omitempty"` + // Reserved for DocuSign. + RecordVoicePrint string `json:"recordVoicePrint,omitempty"` + // Reserved for DocuSign. + RecordVoicePrintMetadata *PropertyMetadata `json:"recordVoicePrintMetadata,omitempty"` + // An array containing a list of phone numbers that the recipient can use for SMS text authentication. + SenderProvidedNumbers []string `json:"senderProvidedNumbers,omitempty"` + // Metadata that indicates whether the `senderProvidedNumbers` property can be edited. + SenderProvidedNumbersMetadata *PropertyMetadata `json:"senderProvidedNumbersMetadata,omitempty"` + // Reserved for DocuSign. + ValidateRecipProvidedNumber string `json:"validateRecipProvidedNumber,omitempty"` + // Reserved for DocuSign. + ValidateRecipProvidedNumberMetadata *PropertyMetadata `json:"validateRecipProvidedNumberMetadata,omitempty"` +} + +// RecipientPhoneNumber describes the recipient phone number. +type RecipientPhoneNumber struct { + // The numeric country calling code for `number`. For example, the country calling code for the US and Canada is `1`, for the UK: `44`, + // + // Do not include the `+` symbol. + CountryCode string `json:"countryCode,omitempty"` + // Metadata that indicates if the `countryCode` property is editable. + CountryCodeMetadata *PropertyMetadata `json:"countryCodeMetadata,omitempty"` + // The telephone number. Use only the digits `0`-`9`. Remove any non-numeric characters. + // + // Do not include the `countryCode`. For US, Canada, and other + // [North American Numbering Plan](https://en.wikipedia.org/wiki/North_American_Numbering_Plan) countries, do not include a leading `1` or `0`. + Number string `json:"number,omitempty"` + // Metadata that indicates if the `number` property is editable. + NumberMetadata *PropertyMetadata `json:"numberMetadata,omitempty"` +} + +// RecipientPreviewRequest this request object contains the information necessary to create a recipient preview. +type RecipientPreviewRequest struct { + // A unique identifier of the authentication event executed by the client application. + AssertionID string `json:"assertionId,omitempty"` + // A sender-generated value that indicates the date and time that the signer was authenticated. + AuthenticationInstant string `json:"authenticationInstant,omitempty"` + // Required. Choose a value that most closely matches the technique your application used to authenticate the recipient / signer. + // + // Choose a value from this list: + // * Biometric + // * Email + // * HTTPBasicAuth + // * Kerberos + // * KnowledgeBasedAuth + // * None + // * PaperDocuments + // * Password + // * RSASecureID + // * SingleSignOn_CASiteminder + // * SingleSignOn_InfoCard + // * SingleSignOn_MicrosoftActiveDirectory + // * SingleSignOn_Other + // * SingleSignOn_Passport + // * SingleSignOn_SAML + // * Smartcard + // * SSLMutualAuth + // * X509Certificate // - LastUsed string `json:"lastUsed,omitempty"` + // This information is included in the Certificate of Completion. + AuthenticationMethod string `json:"authenticationMethod,omitempty"` + // Only used if `pingUrl` is specified. This is the interval, in seconds, between pings on the `pingUrl`. The default is `300` seconds. Valid values are 60-1200 seconds. + PingFrequency string `json:"pingFrequency,omitempty"` + // The client URL that the DocuSign Signing experience should ping to indicate to the client that Signing is active. An HTTP GET call is executed against the client. The response from the client is ignored. The intent is for the client to reset its session timer when the request is received. + PingURL string `json:"pingUrl,omitempty"` + // Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. + RecipientID string `json:"recipientId,omitempty"` + // The URL to which the sender should be redirected after viewing the preview. + ReturnURL string `json:"returnUrl,omitempty"` + // The domain in which the user authenticated. + SecurityDomain string `json:"securityDomain,omitempty"` + // Specifies whether a browser should be allowed to render a page in a frame or IFrame. Setting this property ensures that your content is not embedded into unauthorized pages or frames. // - LimitUseInterval string `json:"limitUseInterval,omitempty"` - // When **true**, the `limitUseInterval` is enabled. - LimitUseIntervalEnabled string `json:"limitUseIntervalEnabled,omitempty"` + // Valid values are: // - LimitUseIntervalUnits string `json:"limitUseIntervalUnits,omitempty"` - // The maximum number of times that the PowerForm can be used. Setting this property can limit your account's exposure to excessive envelope usage. Each time a recipient clicks **Begin Signing** for a document, the number of uses remaining is reduced by one. If a recipient attempts to sign a PowerForm that has reached the maximum number of uses, an error message informs the recipient that the document is not available for signing. + // - `deny`: The page cannot be displayed in a frame. + // - `same_origin`: The page can only be displayed in a frame on the same origin as the page itself. + // - `allow_from`: The page can only be displayed in a frame on the origin specified by the `xFrameOptionsAllowFromUrl` property. + XFrameOptions string `json:"xFrameOptions,omitempty"` + // When the value of `xFrameOptions` is `allow_from`, this property specifies the origin on which the page is allowed to display in a frame. If the value of `xFrameOptions` is `allow_from`, you must include a value for this property. + XFrameOptionsAllowFromURL string `json:"xFrameOptionsAllowFromUrl,omitempty"` +} + +// RecipientProofFile is the proof file of the recipient. [ID Evidence](https://developers.docusign.com/idevidence-api) uses proof files to store the identification data that recipients submit when verifying their ID with [ID Verification](https://developers.docusign.com/docs/esign-rest-api/reference/Accounts/IdentityVerifications) +type RecipientProofFile struct { + // Indicates whether a proof file is available for this recipient. + IsInProofFile string `json:"isInProofFile,omitempty"` +} + +// RecipientRouting describes the recipient routing rules. +type RecipientRouting struct { + // The recipient routing rules. + Rules *RecipientRules `json:"rules,omitempty"` +} + +type RecipientRules struct { // - // **Note**: A PowerForm Administrator can edit this number at any time after the PowerForm is created, even if it has reached a previous use limit. - MaxUseEnabled string `json:"maxUseEnabled,omitempty"` + ConditionalRecipients []ConditionalRecipientRule `json:"conditionalRecipients,omitempty"` +} + +// RecipientSMSAuthentication contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication. +type RecipientSMSAuthentication struct { + // An array containing a list of phone numbers that the recipient can use for SMS text authentication. + SenderProvidedNumbers []string `json:"senderProvidedNumbers,omitempty"` + // Metadata that indicates whether the `senderProvidedNumbers` property can be edited. + SenderProvidedNumbersMetadata *PropertyMetadata `json:"senderProvidedNumbersMetadata,omitempty"` +} + +// RecipientSignatureInformation allows the sender to pre-specify the signature name, signature initials and signature font used in the signature stamp for the recipient. +// +// Used only with recipient types In Person Signers and Signers. +type RecipientSignatureInformation struct { + // The font type to use for the signature if the signature is not drawn. The following font styles are supported. The quotes are to indicate that these values are strings, not `enums`. + // + // - `"1_DocuSign"` + // - `"2_DocuSign"` + // - `"3_DocuSign"` + // - `"4_DocuSign"` + // - `"5_DocuSign"` + // - `"6_DocuSign"` + // - `"7_DocuSign"` + // - `"8_DocuSign"` + // - `"Mistral"` + // - `"Rage Italic"` // - Name string `json:"name,omitempty"` - // The id of the PowerForm. - PowerFormID string `json:"powerFormId,omitempty"` - // The URL for the PowerForm. - PowerFormURL string `json:"powerFormUrl,omitempty"` - // An array of recipient objects that provides details about the recipients of the envelope. - Recipients []PowerFormRecipient `json:"recipients,omitempty"` + FontStyle string `json:"fontStyle,omitempty"` + // Specifies the user's signature in initials format. + SignatureInitials string `json:"signatureInitials,omitempty"` + // Specifies the user's signature name. + SignatureName string `json:"signatureName,omitempty"` +} + +// RecipientSignatureProvider is an Electronic or Standards Based Signature (digital signature) provider for the signer to use. [More information](https://developers.docusign.com/esign-rest-api/guides/standards-based-signatures). +// +type RecipientSignatureProvider struct { + // By default, electronic seals apply on all documents in an envelope. If any of the documents has a `signHere` tab, then a visual representation of the electronic seal will show up in the final document. If not, the electronic seal will be visible in the metadata but not in the content of the document. // - SenderName string `json:"senderName,omitempty"` + // To apply electronic seals on specific documents only, you must enable the `sealDocumentsWithTabsOnly` parameter. In this case, Electronic Seal applies only on documents that have `signHere` tabs set for the Electronic Seal recipient. Other documents won't be sealed. + SealDocumentsWithTabsOnly DSBool `json:"sealDocumentsWithTabsOnly,omitempty"` + // Indicates the name of the electronic seal to apply on documents. // - SenderUserID string `json:"senderUserId,omitempty"` + SealName string `json:"sealName,omitempty"` + // The name of an Electronic or Standards Based Signature (digital signature) provider for the signer to use. For details, see [the current provider list](https://developers.docusign.com/esign-rest-api/guides/standards-based-signatures). You can also retrieve the list by using the [AccountSignatureProviders::List](https://developers.docusign.com/esign-rest-api/reference/Accounts/AccountSignatureProviders/list/) method. // - SigningMode string `json:"signingMode,omitempty"` - // The ID of the template. - TemplateID string `json:"templateId,omitempty"` + // Example: `universalsignaturepen_default` // - TemplateName string `json:"templateName,omitempty"` // - TimesUsed string `json:"timesUsed,omitempty"` - // URI containing the user ID. - URI string `json:"uri,omitempty"` + SignatureProviderName string `json:"signatureProviderName,omitempty"` + // Metadata that indicates whether the `signatureProviderName` property is editable. // - UsesRemaining string `json:"usesRemaining,omitempty"` + SignatureProviderNameMetadata *PropertyMetadata `json:"signatureProviderNameMetadata,omitempty"` + // Not applicable for this object. + SignatureProviderOptions *RecipientSignatureProviderOptions `json:"signatureProviderOptions,omitempty"` } -type PowerFormFormDataEnvelope struct { - // The envelope's GUID. - // - // Example: `93be49ab-afa0-4adf-933c-f752070d71ec` - EnvelopeID string `json:"envelopeId,omitempty"` - // An array of recipient objects that provides details about the recipients of the envelope. - Recipients []PowerFormFormDataRecipient `json:"recipients,omitempty"` +// RecipientSignatureProviderOptions option settings for the signature provider. Different providers require or use different options. [The current provider list and the options they require.](https://developers.docusign.com/esign-rest-api/guides/standards-based-signatures) +type RecipientSignatureProviderOptions struct { + // Reserved for DocuSign. + CpfNumber string `json:"cpfNumber,omitempty"` + // Reserved for DocuSign. + CpfNumberMetadata *PropertyMetadata `json:"cpfNumberMetadata,omitempty"` + // A pre-shared secret that the signer must enter to complete the signing process. Eg last six digits of the signer's government ID or Social Security number. Or a newly created pre-shared secret for the transaction. Note: some signature providers may require an exact (case-sensitive) match if alphabetic characters are included in the field. + OneTimePassword string `json:"oneTimePassword,omitempty"` + // Metadata that indicates whether the `oneTimePassword` property is editable. + OneTimePasswordMetadata *PropertyMetadata `json:"oneTimePasswordMetadata,omitempty"` + // The role or capacity of the signing recipient. Examples: Manager, Approver, etc. + SignerRole string `json:"signerRole,omitempty"` + // Metadata that indicates whether the `signerRole` property is editable. + SignerRoleMetadata *PropertyMetadata `json:"signerRoleMetadata,omitempty"` + // The mobile phone number used to send the recipient an access code for the signing ceremony. Format: a string starting with +, then the country code followed by the full mobile phone number without any spaces or special characters. Omit leading zeroes before a city code. Examples: +14155551234, +97235551234, +33505551234. + Sms string `json:"sms,omitempty"` + // Metadata that indicates whether the `sms` property is editable. + SmsMetadata *PropertyMetadata `json:"smsMetadata,omitempty"` } -type PowerFormFormDataRecipient struct { - // Filters returned user records by the specified email address. - Email string `json:"email,omitempty"` - // - FormData []NameValue `json:"formData,omitempty"` - // The name of the recipient. - Name string `json:"name,omitempty"` - // The unique id for the recipient. It is used by the tab element to indicate which recipient is to sign the document. +// RecipientUpdateResponse is the recipient details that are returned after you update the recipient. +type RecipientUpdateResponse struct { + // When you use the query parameter `combine_same_order_recipients` on the PUT Recipients call, the `recipientUpdateResponse` returns this property. When set to **true**, it indicates that the recipient has been combined or merged with a matching recipient. Recipient matching occurs as part of template matching, and is based on Recipient Role and Routing Order. + Combined string `json:"combined,omitempty"` + // This object describes errors that occur. It is only valid for responses and ignored in requests. + ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` + // Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. RecipientID string `json:"recipientId,omitempty"` + // The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only. + RecipientIDGUID string `json:"recipientIdGuid,omitempty"` + // All of the tabs associated with the recipient. + Tabs *Tabs `json:"tabs,omitempty"` } -// PowerFormRecipient **Note**: For a self-service PowerForm on a website, you can specify the intended recipients generically (for example, use `Member` as the `Name`), and omit personal details such as `email`. -type PowerFormRecipient struct { - // (Optional) The access code that the recipient must enter to access the PowerForm. +// RecipientViewRequest is the request body for the EnvelopeViews::createRecipient and EnvelopeViews::createSharedRecipient methods. +type RecipientViewRequest struct { + // A unique identifier of the authentication event executed by the client application. + AssertionID string `json:"assertionId,omitempty"` + // A sender-generated value that indicates the date and time that the signer was authenticated. + AuthenticationInstant string `json:"authenticationInstant,omitempty"` + // Required. Choose a value that most closely matches the technique your application used to authenticate the recipient / signer. // - // Maximum Length: 50 characters. The code must also conform to the account's access code format setting. + // Choose a value from this list: + // * Biometric + // * Email + // * HTTPBasicAuth + // * Kerberos + // * KnowledgeBasedAuth + // * None + // * PaperDocuments + // * Password + // * RSASecureID + // * SingleSignOn_CASiteminder + // * SingleSignOn_InfoCard + // * SingleSignOn_MicrosoftActiveDirectory + // * SingleSignOn_Other + // * SingleSignOn_Passport + // * SingleSignOn_SAML + // * Smartcard + // * SSLMutualAuth + // * X509Certificate // - // If blank but the signer accessCode property is set in the envelope, then that value is used. + // This information is included in the Certificate of Completion. + AuthenticationMethod string `json:"authenticationMethod,omitempty"` + // A sender-created value. If provided, the recipient is treated as an embedded (captive) recipient or signer. // - // If blank and the signer accessCode property is not set, then the access code is not required. - AccessCode string `json:"accessCode,omitempty"` - // When **true**, the `accessCode` property is locked and cannot be edited. - AccessCodeLocked string `json:"accessCodeLocked,omitempty"` - // When **true**, the recipient must enter the `accessCode` to access the PowerForm. - AccessCodeRequired string `json:"accessCodeRequired,omitempty"` - // The email address of the recipient. + // Use your application's client ID (user ID) for the recipient. Doing so enables the details of your application's authentication of the recipient to be connected to the recipient's signature if the signature is disputed or repudiated. // - // **Note**: For self-service documents where you do not know who the recipients are in advance, you can leave this property blank. + // Maximum length: 100 characters. + ClientUserID string `json:"clientUserId,omitempty"` + // (Required) Specifies the email of the recipient. You can use either `email` and `userName` or `userId` to identify the recipient. Email string `json:"email,omitempty"` - // When **true**, the recipient's email address is locked and cannot be edited. - EmailLocked string `json:"emailLocked,omitempty"` - // The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. // - // **Example**: Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node. - IDCheckConfigurationName string `json:"idCheckConfigurationName,omitempty"` - // Determines how authentication is configured for the account. Valid values are: + FrameAncestors []string `json:"frameAncestors,omitempty"` // - // - `always`: Authentication checks are performed on every envelope. - // - `never`: Authentication checks are not performed on any envelopes. - // - `optional:` Authentication is configurable per envelope. - IDCheckRequired string `json:"idCheckRequired,omitempty"` - // The name of the PowerForm recipient. + MessageOrigins []string `json:"messageOrigins,omitempty"` + // Only used if `pingUrl` is specified. This is the interval, in seconds, between pings on the `pingUrl`. The default is `300` seconds. Valid values are 60-1200 seconds. + PingFrequency string `json:"pingFrequency,omitempty"` + // The client URL that the DocuSign Signing experience should ping to indicate to the client that Signing is active. An HTTP GET call is executed against the client. The response from the client is ignored. The intent is for the client to reset its session timer when the request is received. + PingURL string `json:"pingUrl,omitempty"` + // Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. + RecipientID string `json:"recipientId,omitempty"` + // (Required) The URL to which the user should be redirected + // after the signing session has ended. + // DocuSign redirects to the URL + // and includes an `event` query parameter + // that can be used by your application. // - // **Note**: For self-service documents where you do not know who the recipients are in advance, you can leave this property blank. - Name string `json:"name,omitempty"` - // The recipient type, as specified by the following values: - // - `agents`: Agent recipients can add name and email information for recipients that appear after the agent in routing order. - // - `carbonCopies`: Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date, or add information to any of the documents. This type of recipient can be used in any routing order. - // - `certifiedDeliveries`: Certified delivery recipients must receive the completed documents for the envelope to be completed. They don't need to sign, initial, date, or add information to any of the documents. - // - `editors`: Editors have the same management and access rights for the envelope as the sender. Editors can add name and email information, add or change the routing order, set authentication options, and can edit signature/initial tabs and data fields for the remaining recipients. - // - `inPersonSigners`: In-person recipients are DocuSign users who act as signing hosts in the same physical location as the signer. - // - `intermediaries`: Intermediary recipients can optionally add name and email information for recipients at the same or subsequent level in the routing order. - // - `seals`: Electronic seal recipients represent legal entities. - // - `signers`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope. - // - `witnesses`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope. - RecipientType string `json:"recipientType,omitempty"` - // The role associated with the recipient (for example, `Member`). + // Maximum Length: 500 characters. If the `returnUrl` exceeds this limit, the user is redirected to a truncated URL. // - // This property is required when you are working with template recipients and PowerForm recipients. - RoleName string `json:"roleName,omitempty"` - // Specifies the routing order of the recipient in the envelope. - RoutingOrder string `json:"routingOrder,omitempty"` - // When **true**, the template used to create the PowerForm requires ID lookup for the recipient. - TemplateRequiresIDLookup string `json:"templateRequiresIdLookup,omitempty"` - // When **true**, the `userName` property for the recipient is locked and cannot be edited. - UserNameLocked string `json:"userNameLocked,omitempty"` -} - -// PowerFormSendersResponse this object includes information about the users who have sent PowerForms. -type PowerFormSendersResponse struct { - // The last position in the result set. - EndPosition int32 `json:"endPosition,omitempty"` - // The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. - NextURI string `json:"nextUri,omitempty"` - // An array of `userInfo` objects containing information about users who have sent PowerForms. - PowerFormSenders []UserInfo `json:"powerFormSenders,omitempty"` - // The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. - PreviousURI string `json:"previousUri,omitempty"` - // The number of results returned in this response. Because you can filter which entries are included in the response, this value is always less than or equal to `totalSetSize`. - ResultSetSize int32 `json:"resultSetSize,omitempty"` - // The starting position of the current result set. - StartPosition int32 `json:"startPosition,omitempty"` - // The total number of items in the search's result set. This value is always greater than or equal to the value of `resultSetSize`. - TotalSetSize int32 `json:"totalSetSize,omitempty"` -} - -type PowerFormsFormDataResponse struct { - // An array containing PowerForm data. - Envelopes []PowerFormFormDataEnvelope `json:"envelopes,omitempty"` + // Possible `event` parameter values include: + // + // * `access_code_failed`: Recipient used incorrect access code. + // * `cancel`: Recipient canceled the signing operation, + // possibly by using the **Finish Later** option. + // * `decline`: Recipient declined to sign. + // * `exception`: A system error occurred during the signing process. + // * `fax_pending`: Recipient has a fax pending. + // * `id_check_failed`: Recipient failed an ID check. + // * `session_timeout`: The session timed out. An account can control this timeout by using the **Signer Session Timeout** option. + // * `signing_complete`: The recipient completed the signing ceremony. + // * `ttl_expired`: The Time To Live token for the envelope has expired. + // After being successfully invoked, these tokens expire + // after 5 minutes or if the envelope is voided. + // * `viewing_complete`: The recipient completed viewing an envelope + // that is in a read-only/terminal state, + // such as completed, declined, or voided. + // + // Ensure that you include `https://` in the URL to prevent the redirect from failing on certain browsers. + // + ReturnURL string `json:"returnUrl,omitempty"` + // The domain in which the user authenticated. + SecurityDomain string `json:"securityDomain,omitempty"` + // The user ID of the recipient. You can use either the user ID or email and user name to identify the recipient. + // + // If `userId` is used and a `clientUserId` is provided, the value in the `userId` property must match a `recipientId` (which you can retrieve with a GET recipients call) for the envelope. + // + // If a `userId` is used and a `clientUserId` is not provided, the `userId` must match the user ID of the authenticating user. + UserID string `json:"userId,omitempty"` + // The username of the recipient. You can use either `email` and `userName` or `userId` to identify the recipient. + UserName string `json:"userName,omitempty"` + // Specifies whether a browser should be allowed to render a page in a frame or IFrame. Setting this property ensures that your content is not embedded into unauthorized pages or frames. + // + // Valid values are: + // + // - `deny`: The page cannot be displayed in a frame. + // - `same_origin`: The page can only be displayed in a frame on the same origin as the page itself. + // - `allow_from`: The page can only be displayed in a frame on the origin specified by the `xFrameOptionsAllowFromUrl` property. + XFrameOptions string `json:"xFrameOptions,omitempty"` + // When the value of `xFrameOptions` is `allow_from`, this property specifies the origin on which the page is allowed to display in a frame. If the value of `xFrameOptions` is `allow_from`, you must include a value for this property. + XFrameOptionsAllowFromURL string `json:"xFrameOptionsAllowFromUrl,omitempty"` } -type PowerFormsRequest struct { - // An array of PowerForm objects. - PowerForms []PowerForm `json:"powerForms,omitempty"` +// Recipients envelope recipients +type Recipients struct { + // A list of agent recipients assigned to the documents. + Agents []Agent `json:"agents,omitempty"` + // A list of carbon copy recipients assigned to the documents. + CarbonCopies []CarbonCopy `json:"carbonCopies,omitempty"` + // A complex type containing information on a recipient the must receive the completed documents for the envelope to be completed, but the recipient does not need to sign, initial, date, or add information to any of the documents. + CertifiedDeliveries []CertifiedDelivery `json:"certifiedDeliveries,omitempty"` + // The routing order of the current recipient. If this value equals a particular signer's routing order, it indicates that the envelope has been sent to that recipient, but he or she has not completed the required actions. + CurrentRoutingOrder string `json:"currentRoutingOrder,omitempty"` + // A list of users who can edit the envelope. + Editors []Editor `json:"editors,omitempty"` + // This object describes errors that occur. It is only valid for responses and ignored in requests. + ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` + // Specifies a signer that is in the same physical location as a DocuSign user who will act as a Signing Host for the transaction. The recipient added is the Signing Host and new separate Signer Name field appears after Sign in person is selected. + InPersonSigners []InPersonSigner `json:"inPersonSigners,omitempty"` + // Identifies a recipient that can, but is not required to, add name and email information for recipients at the same or subsequent level in the routing order (until subsequent Agents, Editors or Intermediaries recipient types are added). + Intermediaries []Intermediary `json:"intermediaries,omitempty"` + // + Notaries []NotaryRecipient `json:"notaries,omitempty"` + // The number of recipients in the envelope. + RecipientCount string `json:"recipientCount,omitempty"` + // A list of electronic seals to apply to documents. + Seals []SealSign `json:"seals,omitempty"` + // A list of signers on the envelope. + Signers []Signer `json:"signers,omitempty"` + // A list of signers who act as witnesses on the envelope. + Witnesses []Witness `json:"witnesses,omitempty"` } -type PowerFormsResponse struct { - // The last position in the result set. - EndPosition int32 `json:"endPosition,omitempty"` - // The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. - NextURI string `json:"nextUri,omitempty"` - // An array of PowerForm objects. - PowerForms []PowerForm `json:"powerForms,omitempty"` - // The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. - PreviousURI string `json:"previousUri,omitempty"` - // The number of results returned in this response. Because you can filter which entries are included in the response, this value is always less than or equal to `totalSetSize`. - ResultSetSize int32 `json:"resultSetSize,omitempty"` - // The starting position of the current result set. - StartPosition int32 `json:"startPosition,omitempty"` - // The total number of items in the search's result set. This value is always greater than or equal to the value of `resultSetSize`. - TotalSetSize int32 `json:"totalSetSize,omitempty"` +// RecipientsUpdateSummary this is the response that the API returns after you update recipients. +type RecipientsUpdateSummary struct { + // An array of `recipientUpdateResults` objects that contain details about the recipients. + RecipientUpdateResults []RecipientUpdateResponse `json:"recipientUpdateResults,omitempty"` } -// PropertyMetadata metadata about a property. -type PropertyMetadata struct { - // An array of option strings supported by this setting. - Options []string `json:"options,omitempty"` - // Indicates whether the property is editable. Valid values are: +// ReferralInformation is a complex type that contains the following information for entering referral and discount information. The following items are included in the referral information (all string content): enableSupport, includedSeats, saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, saleDiscountSeatPriceOverride, planStartMonth, referralCode, referrerName, advertisementId, publisherId, shopperId, promoCode, groupMemberId, idType, and industry +// +// **Note**: saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, and saleDiscountSeatPriceOverride are reserved for DoucSign use only. +type ReferralInformation struct { + // A complex type that contains the following information for entering referral and discount information. The following items are included in the referral information (all string content): enableSupport, includedSeats, saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, saleDiscountSeatPriceOverride, planStartMonth, referralCode, referrerName, advertisementId, publisherId, shopperId, promoCode, groupMemberId, idType, and industry. // - // - `editable` - // - `read_only` - Rights string `json:"rights,omitempty"` -} - -type Province struct { + // **Note**: saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, and saleDiscountSeatPriceOverride are reserved for DoucSign use only. // - IsoCode string `json:"isoCode,omitempty"` + AdvertisementID string `json:"advertisementId,omitempty"` + // When set to **true**, customer support is provided as part of the account plan. + EnableSupport DSBool `json:"enableSupport,omitempty"` + // An optional external id for the referral. + ExternalOrgID string `json:"externalOrgId,omitempty"` // - Name string `json:"name,omitempty"` -} - -type ProvisioningInformation struct { + GroupMemberID string `json:"groupMemberId,omitempty"` // - DefaultConnectionID string `json:"defaultConnectionId,omitempty"` + IDType string `json:"idType,omitempty"` + // The number of seats (users) included in the plan. + IncludedSeats string `json:"includedSeats,omitempty"` + // The name of the industry associated with the referral. // - DefaultPlanID string `json:"defaultPlanId,omitempty"` - // The code that identifies the billing plan groups and plans for the new account. - DistributorCode string `json:"distributorCode,omitempty"` - // The password for the distributorCode. - DistributorPassword string `json:"distributorPassword,omitempty"` + // Example: `Accounting` + Industry string `json:"industry,omitempty"` // - PasswordRuleText string `json:"passwordRuleText,omitempty"` + PlanStartMonth string `json:"planStartMonth,omitempty"` // - PlanPromotionText string `json:"planPromotionText,omitempty"` + PromoCode string `json:"promoCode,omitempty"` // - PurchaseOrderOrPromAllowed string `json:"purchaseOrderOrPromAllowed,omitempty"` -} - -type PurchasedEnvelopesInformation struct { - // The total amount of the purchase. - Amount string `json:"amount,omitempty"` - // The AppName of the client application. - AppName string `json:"appName,omitempty"` - // The currency code for the account, based on the [ISO 4217 currency code](https://www.iso.org/iso-4217-currency-codes.html). - CurrencyCode string `json:"currencyCode,omitempty"` - // The Platform of the client application - Platform string `json:"platform,omitempty"` - // The Product ID from the AppStore. - ProductID string `json:"productId,omitempty"` - // The quantity of envelopes to add to the account. - Quantity string `json:"quantity,omitempty"` - // The encrypted Base64 encoded receipt data. - ReceiptData []byte `json:"receiptData,omitempty"` - // The name of the AppStore. - StoreName string `json:"storeName,omitempty"` - // Specifies the Transaction ID from the AppStore. - TransactionID string `json:"transactionId,omitempty"` -} - -// Radio one of the selectable radio buttons -// in the `radios` property -// of a [`radioGroup`](https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/radioGroup) tab. -// -type Radio struct { - // Reserved for DocuSign. - // - AnchorCaseSensitive DSBool `json:"anchorCaseSensitive,omitempty"` - // Reserved for DocuSign. - AnchorCaseSensitiveMetadata *PropertyMetadata `json:"anchorCaseSensitiveMetadata,omitempty"` - // Reserved for DocuSign. - // + PublisherID string `json:"publisherId,omitempty"` // - AnchorHorizontalAlignment string `json:"anchorHorizontalAlignment,omitempty"` + ReferralCode string `json:"referralCode,omitempty"` + // The name of the referrer. + ReferrerName string `json:"referrerName,omitempty"` // Reserved for DocuSign. - AnchorHorizontalAlignmentMetadata *PropertyMetadata `json:"anchorHorizontalAlignmentMetadata,omitempty"` - // When set to **true**, this tab is ignored if the `anchorString` is not found in the document. - AnchorIgnoreIfNotPresent DSBool `json:"anchorIgnoreIfNotPresent,omitempty"` - // Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable. - AnchorIgnoreIfNotPresentMetadata *PropertyMetadata `json:"anchorIgnoreIfNotPresentMetadata,omitempty"` + SaleDiscountAmount string `json:"saleDiscountAmount,omitempty"` // Reserved for DocuSign. - // - // - AnchorMatchWholeWord DSBool `json:"anchorMatchWholeWord,omitempty"` + SaleDiscountFixedAmount string `json:"saleDiscountFixedAmount,omitempty"` // Reserved for DocuSign. - AnchorMatchWholeWordMetadata *PropertyMetadata `json:"anchorMatchWholeWordMetadata,omitempty"` - // Specifies the string to find in the document and use as the basis for tab placement. - AnchorString string `json:"anchorString,omitempty"` - // Metadata that indicates whether the `anchorString` property is editable. - AnchorStringMetadata *PropertyMetadata `json:"anchorStringMetadata,omitempty"` + SaleDiscountPercent string `json:"saleDiscountPercent,omitempty"` // Reserved for DocuSign. - AnchorTabProcessorVersion string `json:"anchorTabProcessorVersion,omitempty"` + SaleDiscountPeriods string `json:"saleDiscountPeriods,omitempty"` // Reserved for DocuSign. - AnchorTabProcessorVersionMetadata *PropertyMetadata `json:"anchorTabProcessorVersionMetadata,omitempty"` - // Specifies the units of the X and Y offset. Units may be pixels, millimeters, centimeters, or inches. - AnchorUnits string `json:"anchorUnits,omitempty"` - // Metadata that indicates whether the `anchorUnits` property is editable. - AnchorUnitsMetadata *PropertyMetadata `json:"anchorUnitsMetadata,omitempty"` - // Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. - AnchorXOffset string `json:"anchorXOffset,omitempty"` - // Metadata that indicates whether the `anchorXOffset` property is editable. - AnchorXOffsetMetadata *PropertyMetadata `json:"anchorXOffsetMetadata,omitempty"` - // Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. - AnchorYOffset string `json:"anchorYOffset,omitempty"` - // Metadata that indicates whether the `anchorYOffset` property is editable. - AnchorYOffsetMetadata *PropertyMetadata `json:"anchorYOffsetMetadata,omitempty"` - // When set to **true**, the information in the tab is bold. - Bold string `json:"bold,omitempty"` - // Metadata that indicates whether the `bold` property is editable. - BoldMetadata *PropertyMetadata `json:"boldMetadata,omitempty"` - // This object describes errors that occur. It is only valid for responses and ignored in requests. - ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` - // The font to be used for the tab value. Supported fonts include: + SaleDiscountSeatPriceOverride string `json:"saleDiscountSeatPriceOverride,omitempty"` // - // - Default - // - Arial - // - ArialNarrow - // - Calibri - // - CourierNew - // - Garamond - // - Georgia - // - Helvetica - // - LucidaConsole - // - MSGothic - // - MSMincho - // - OCR-A - // - Tahoma - // - TimesNewRoman - // - Trebuchet - // - Verdana + ShopperID string `json:"shopperId,omitempty"` +} + +// Reminders is a complex element that specifies reminder settings for the envelope. +type Reminders struct { + // An integer specifying the number of days after the recipient receives the envelope that reminder emails are sent to the recipient. + ReminderDelay string `json:"reminderDelay,omitempty"` + // When set to **true**, reminders are enabled. + ReminderEnabled DSBool `json:"reminderEnabled,omitempty"` + // An integer specifying the interval in days between reminder emails. + ReminderFrequency string `json:"reminderFrequency,omitempty"` +} + +type ReportInProductCsvRunRequest struct { // - Font string `json:"font,omitempty"` - // The font color to use for the information in the tab. Possible values are: + CustomFieldFilter string `json:"customFieldFilter,omitempty"` // - // - Black - // - BrightBlue - // - BrightRed - // - DarkGreen - // - DarkRed - // - Gold - // - Green - // - NavyBlue - // - Purple - // - White + DateRangeCustomFromDate string `json:"dateRangeCustomFromDate,omitempty"` // - FontColor string `json:"fontColor,omitempty"` - // Metadata that indicates whether the `fontColor` property is editable. - FontColorMetadata *PropertyMetadata `json:"fontColorMetadata,omitempty"` - // Metadata that indicates whether the `font` property is editable. - FontMetadata *PropertyMetadata `json:"fontMetadata,omitempty"` - // The font size used for the information in the tab. Possible values are: + DateRangeCustomToDate string `json:"dateRangeCustomToDate,omitempty"` // - // - Size7 - // - Size8 - // - Size9 - // - Size10 - // - Size11 - // - Size12 - // - Size14 - // - Size16 - // - Size18 - // - Size20 - // - Size22 - // - Size24 - // - Size26 - // - Size28 - // - Size36 - // - Size48 - // - Size72 - FontSize string `json:"fontSize,omitempty"` - // Metadata that indicates whether the `fontSize` property is editable. - FontSizeMetadata *PropertyMetadata `json:"fontSizeMetadata,omitempty"` - // When set to **true**, the information in the tab is italic. - Italic string `json:"italic,omitempty"` - // Metadata that indicates whether the `italic` property is editable. - ItalicMetadata *PropertyMetadata `json:"italicMetadata,omitempty"` - // When set to **true**, the signer cannot change the data of the custom tab. - Locked DSBool `json:"locked,omitempty"` - // Metadata that indicates whether the `locked` property is editable. - LockedMetadata *PropertyMetadata `json:"lockedMetadata,omitempty"` - // Specifies the page number on which the tab is located. - // Must be 1 for supplemental documents. + DateRangeFilter string `json:"dateRangeFilter,omitempty"` // - PageNumber string `json:"pageNumber,omitempty"` - // Metadata that indicates whether the `pageNumber` property is editable. - PageNumberMetadata *PropertyMetadata `json:"pageNumberMetadata,omitempty"` - // When set to **true**, the signer is required to fill out this tab. - Required TabRequired `json:"required,omitempty"` - // Metadata that indicates whether the `required` property is editable. - RequiredMetadata *PropertyMetadata `json:"requiredMetadata,omitempty"` - // When set to **true**, the radio button is selected. - Selected DSBool `json:"selected,omitempty"` - // Metadata that indicates whether the `selected` property is editable. - SelectedMetadata *PropertyMetadata `json:"selectedMetadata,omitempty"` - // The status of the item. - Status string `json:"status,omitempty"` - // Metadata that indicates whether the `status` property is editable. - StatusMetadata *PropertyMetadata `json:"statusMetadata,omitempty"` - // The unique identifier for the tab. - TabID string `json:"tabId,omitempty"` - // Metadata that indicates whether the `tabId` property is editable. - TabIDMetadata *PropertyMetadata `json:"tabIdMetadata,omitempty"` - // A positive integer that sets the order the tab is navigated to during signing. + EnvelopeDateTypeFilter string `json:"envelopeDateTypeFilter,omitempty"` // - // Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - TabOrder string `json:"tabOrder,omitempty"` - // Metadata that indicates whether the `tabOrder` property is editable. - TabOrderMetadata *PropertyMetadata `json:"tabOrderMetadata,omitempty"` - // When set to **true**, the information in the tab is underlined. - Underline string `json:"underline,omitempty"` - // Metadata that indicates whether the `underline` property is editable. - UnderlineMetadata *PropertyMetadata `json:"underlineMetadata,omitempty"` - // Specifies the value of the tab. - Value string `json:"value,omitempty"` - // Metadata that indicates whether the `value` property is editable. - ValueMetadata *PropertyMetadata `json:"valueMetadata,omitempty"` - // This property indicates the horizontal offset of the object on the page. - // DocuSign uses 72 DPI when determining position. - // Required. May be zero. + EnvelopeRecipientNameContainsFilter string `json:"envelopeRecipientNameContainsFilter,omitempty"` + // + EnvelopeStatusFilter string `json:"envelopeStatusFilter,omitempty"` + // + EnvelopeSubjectContainsFilter string `json:"envelopeSubjectContainsFilter,omitempty"` + // + Fields []ReportInProductField `json:"fields,omitempty"` + // + ForDownload string `json:"forDownload,omitempty"` + // + IsDashboard string `json:"isDashboard,omitempty"` + // + NewLine string `json:"newLine,omitempty"` // - XPosition string `json:"xPosition,omitempty"` - // Metadata that indicates whether the `xPosition` property is editable. - XPositionMetadata *PropertyMetadata `json:"xPositionMetadata,omitempty"` - // This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. - YPosition string `json:"yPosition,omitempty"` - // Metadata that indicates whether the `yPosition` property is editable. - YPositionMetadata *PropertyMetadata `json:"yPositionMetadata,omitempty"` -} - -// RadioGroup this group tab is used to place radio buttons on a document. -// The `radios` property -// contains a list of -// [`radio`](https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/radio) -// objects associated with the group. Only one radio button can -// be selected in a group. -// -type RadioGroup struct { - TabBase - // The name of the group. The search_text provided in the call automatically performs a wild card search on group_name. - GroupName string `json:"groupName,omitempty"` - // Metadata that indicates whether the `groupName` property is editable. - GroupNameMetadata *PropertyMetadata `json:"groupNameMetadata,omitempty"` - // Specifies the locations and status for radio buttons that are grouped together. - Radios []Radio `json:"radios,omitempty"` - // When set to **true** and shared is true, information must be entered in this field to complete the envelope. - RequireAll DSBool `json:"requireAll,omitempty"` - // Metadata that indicates whether the `requireAll` property is editable. - RequireAllMetadata *PropertyMetadata `json:"requireAllMetadata,omitempty"` - // Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field. - RequireInitialOnSharedChange DSBool `json:"requireInitialOnSharedChange,omitempty"` - // Metadata that indicates whether the `requireInitialOnSharedChange` property is editable. - RequireInitialOnSharedChangeMetadata *PropertyMetadata `json:"requireInitialOnSharedChangeMetadata,omitempty"` - // When set to **true**, this custom tab is shared. - Shared DSBool `json:"shared,omitempty"` - // Metadata that indicates whether the `shared` property is editable. - SharedMetadata *PropertyMetadata `json:"sharedMetadata,omitempty"` - // When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. - TemplateLocked string `json:"templateLocked,omitempty"` - // Metadata that indicates whether the `templateLocked` property is editable. - TemplateLockedMetadata *PropertyMetadata `json:"templateLockedMetadata,omitempty"` - // When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. - TemplateRequired string `json:"templateRequired,omitempty"` - // Metadata that indicates whether the `templateRequired` property is editable. - TemplateRequiredMetadata *PropertyMetadata `json:"templateRequiredMetadata,omitempty"` - // The text of a tooltip that appears when a user hovers over a form field or tab. - Tooltip string `json:"tooltip,omitempty"` - // Metadata that indicates whether the `tooltip` property is editable. - TooltipMetadata *PropertyMetadata `json:"tooltipMetadata,omitempty"` + OverrideTimezoneKey string `json:"overrideTimezoneKey,omitempty"` + // + PeriodLengthFilter string `json:"periodLengthFilter,omitempty"` + // + Quote string `json:"quote,omitempty"` + // + ReportCustomizedID string `json:"reportCustomizedId,omitempty"` + // + ReportDescription string `json:"reportDescription,omitempty"` + // + ReportID string `json:"reportId,omitempty"` + // + ReportInvocationType string `json:"reportInvocationType,omitempty"` + // + ReportName string `json:"reportName,omitempty"` + // + SentByFilter string `json:"sentByFilter,omitempty"` + // + SentByIds string `json:"sentByIds,omitempty"` + // + Separator string `json:"separator,omitempty"` + // + SortDirection string `json:"sortDirection,omitempty"` + // + SortField string `json:"sortField,omitempty"` + // The starting index position of the current result set. + StartPosition string `json:"startPosition,omitempty"` } -type RecipientAttachment struct { - // The unique identifier for the attachment. - AttachmentID string `json:"attachmentId,omitempty"` - // Specifies the type of the attachment for the recipient. Possible values are: +type ReportInProductField struct { + // The position on the page where the display section appears. + DisplayOrder string `json:"displayOrder,omitempty"` + // + FieldVersion string `json:"fieldVersion,omitempty"` // - // - `.htm` - // - `.xml` - AttachmentType string `json:"attachmentType,omitempty"` - // A Base64-encoded representation of the attachment that is used to upload and download the file. File attachments may be up to 50 MB in size. - Data []byte `json:"data,omitempty"` - // An optional label for the attachment. - Label string `json:"label,omitempty"` - // The name of the attachment. Name string `json:"name,omitempty"` - // The URL of a previously staged chunked upload. Using a chunked upload enables you to stage a large, chunkable temp file. You then use the `remoteUrl` property to reference the chunked upload as the content in attachment and document-related requests. The `remoteUrl` property cannot be used for downloads. - RemoteURL string `json:"remoteUrl,omitempty"` + // When set to **true**, the radio button is selected. + Selected string `json:"selected,omitempty"` } -type RecipientDomain struct { +type ReportInProductGet struct { // - Active string `json:"active,omitempty"` + CustomFieldFilter string `json:"customFieldFilter,omitempty"` // - DomainCode string `json:"domainCode,omitempty"` + DateRangeCustomFromDate string `json:"dateRangeCustomFromDate,omitempty"` // - DomainName string `json:"domainName,omitempty"` + DateRangeCustomToDate string `json:"dateRangeCustomToDate,omitempty"` // - RecipientDomainID string `json:"recipientDomainId,omitempty"` + DateRangeFilter string `json:"dateRangeFilter,omitempty"` + // The position on the page where the display section appears. + DisplayOrder string `json:"displayOrder,omitempty"` + // + EnvelopeDateTypeFilter string `json:"envelopeDateTypeFilter,omitempty"` + // + EnvelopeRecipientNameContainsFilter string `json:"envelopeRecipientNameContainsFilter,omitempty"` + // + EnvelopeStatusFilter string `json:"envelopeStatusFilter,omitempty"` + // + EnvelopeSubjectContainsFilter string `json:"envelopeSubjectContainsFilter,omitempty"` + // + Fields []ReportInProductField `json:"fields,omitempty"` + // + LastScheduledExecutionDate string `json:"lastScheduledExecutionDate,omitempty"` + // + LastScheduledExecutionSuccessDate string `json:"lastScheduledExecutionSuccessDate,omitempty"` + // + MaxDownloadRows string `json:"maxDownloadRows,omitempty"` + // + MaxGridRows string `json:"maxGridRows,omitempty"` + // + MaxScheduledRows string `json:"maxScheduledRows,omitempty"` + // + PeriodLengthFilter string `json:"periodLengthFilter,omitempty"` + // + ReportCustomizedID string `json:"reportCustomizedId,omitempty"` + // + ReportDescription string `json:"reportDescription,omitempty"` + // + ReportID string `json:"reportId,omitempty"` + // + ReportName string `json:"reportName,omitempty"` + // + ReportType string `json:"reportType,omitempty"` + // + RunURI string `json:"runUri,omitempty"` + // + SaveURI string `json:"saveUri,omitempty"` + // + ScheduleID string `json:"scheduleId,omitempty"` + // + SentByDetails *ReportInProductSentByDetails `json:"sentByDetails,omitempty"` + // + SentByFilter string `json:"sentByFilter,omitempty"` + // + SentByIds string `json:"sentByIds,omitempty"` + // + SortFieldDirection string `json:"sortFieldDirection,omitempty"` + // + SortFieldName string `json:"sortFieldName,omitempty"` } -type RecipientEmailNotification struct { - // Not applicable for this object. - EmailBody string `json:"emailBody,omitempty"` - // Metadata that indicates whether the `emailBody` property can be edited. - EmailBodyMetadata *PropertyMetadata `json:"emailBodyMetadata,omitempty"` - // Not applicable for this object. - EmailSubject string `json:"emailSubject,omitempty"` - // Metadata that indicates whether the `emailSubject` property can be edited. - EmailSubjectMetadata *PropertyMetadata `json:"emailSubjectMetadata,omitempty"` - // Specifies the language used to localize Electronic Seals UI texts such as "Sealed by", etc. +type ReportInProductList struct { // - // The supported languages, with the language value shown in parenthesis, are: Arabic (ar), Bahasa Indonesia (id), Bahasa Melayu (ms) Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro),Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk), and Vietnamese (vi). + Reports []ReportInProductListItem `json:"reports,omitempty"` +} + +type ReportInProductListItem struct { // - // This parameter is optional. If not set, it defaults to the sender's language settings at the time of sealing. - SupportedLanguage string `json:"supportedLanguage,omitempty"` - // Metadata that indicates whether the `supportedLanguage` property can be edited. - SupportedLanguageMetadata *PropertyMetadata `json:"supportedLanguageMetadata,omitempty"` + GetURI string `json:"getUri,omitempty"` + // + LastScheduledExecutionDate string `json:"lastScheduledExecutionDate,omitempty"` + // + LastScheduledExecutionSuccessDate string `json:"lastScheduledExecutionSuccessDate,omitempty"` + // + ReportCustomizedID string `json:"reportCustomizedId,omitempty"` + // + ReportDescription string `json:"reportDescription,omitempty"` + // + ReportID string `json:"reportId,omitempty"` + // + ReportName string `json:"reportName,omitempty"` + // + ReportType string `json:"reportType,omitempty"` + // + RunURI string `json:"runUri,omitempty"` + // + SaveURI string `json:"saveUri,omitempty"` + // + ScheduleCreateDate string `json:"scheduleCreateDate,omitempty"` + // + ScheduleEndDate string `json:"scheduleEndDate,omitempty"` + // + ScheduleID string `json:"scheduleId,omitempty"` + // + ScheduleRenewDurationDays string `json:"scheduleRenewDurationDays,omitempty"` } -type RecipientEvent struct { - // reserved - IncludeDocuments string `json:"includeDocuments,omitempty"` - // Send a webhook notification for the following recipient statuses: Sent, Delivered, Completed, Declined, AuthenticationFailed, and AutoResponded. - RecipientEventStatusCode string `json:"recipientEventStatusCode,omitempty"` +type ReportInProductRunRequest struct { + // + CustomFieldFilter string `json:"customFieldFilter,omitempty"` + // + DateRangeCustomFromDate string `json:"dateRangeCustomFromDate,omitempty"` + // + DateRangeCustomToDate string `json:"dateRangeCustomToDate,omitempty"` + // + DateRangeFilter string `json:"dateRangeFilter,omitempty"` + // + EnvelopeDateTypeFilter string `json:"envelopeDateTypeFilter,omitempty"` + // + EnvelopeRecipientNameContainsFilter string `json:"envelopeRecipientNameContainsFilter,omitempty"` + // + EnvelopeStatusFilter string `json:"envelopeStatusFilter,omitempty"` + // + EnvelopeSubjectContainsFilter string `json:"envelopeSubjectContainsFilter,omitempty"` + // + Fields []ReportInProductField `json:"fields,omitempty"` + // + ForDownload string `json:"forDownload,omitempty"` + // + IsDashboard string `json:"isDashboard,omitempty"` + // + PeriodLengthFilter string `json:"periodLengthFilter,omitempty"` + // + ReportCustomizedID string `json:"reportCustomizedId,omitempty"` + // + ReportDescription string `json:"reportDescription,omitempty"` + // + ReportID string `json:"reportId,omitempty"` + // + ReportInvocationType string `json:"reportInvocationType,omitempty"` + // + ReportName string `json:"reportName,omitempty"` + // + SentByFilter string `json:"sentByFilter,omitempty"` + // + SentByIds string `json:"sentByIds,omitempty"` + // + SortDirection string `json:"sortDirection,omitempty"` + // + SortField string `json:"sortField,omitempty"` + // The starting index position of the current result set. + StartPosition string `json:"startPosition,omitempty"` } -type RecipientFormData struct { - // The date and time the recipient declined the envelope. - DeclinedTime string `json:"DeclinedTime,omitempty"` - // The date and time the recipient viewed the documents in the envelope in the DocuSign signing UI. - DeliveredTime string `json:"DeliveredTime,omitempty"` - // The date and time the envelope was sent to the recipient. - SentTime string `json:"SentTime,omitempty"` - // The date and time the recipient signed the documents. - SignedTime string `json:"SignedTime,omitempty"` - // The recipient's email address. - Email string `json:"email,omitempty"` - // An array of form data objects. - FormData []FormDataItem `json:"formData,omitempty"` - // The name of the recipient. - Name string `json:"name,omitempty"` - // A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`. - RecipientID string `json:"recipientId,omitempty"` +type ReportInProductRunResponse struct { + // The last index position in the result set. + EndPosition string `json:"endPosition,omitempty"` + // + ExceededMaxResults string `json:"exceededMaxResults,omitempty"` + // + LastWarehouseRefreshDateTime string `json:"lastWarehouseRefreshDateTime,omitempty"` + // The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`. + ResultSetSize string `json:"resultSetSize,omitempty"` + // + Rows []ReportInProductRunResponseRow `json:"rows,omitempty"` + // The starting index position of the current result set. + StartPosition string `json:"startPosition,omitempty"` + // The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`. + TotalSetSize string `json:"totalSetSize,omitempty"` } -// RecipientIdentityVerification specifies ID Verification applied on an envelope by workflow ID. See the [list](https://developers.docusign.com/esign-rest-api/reference/Accounts/IdentityVerifications/list) method in the [IdentityVerifications](https://developers.docusign.com/esign-rest-api/reference/Accounts/IdentityVerifications) resource for more information on how to retrieve workflow IDs available for an account. This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods. -type RecipientIdentityVerification struct { - // ID of the Identity Verification worklow used to verify recipients' identity.
This ID must match one of the [workflowId](https://developers.docusign.com/esign-rest-api/reference/Accounts/IdentityVerifications/list#accountIdentityVerificationWorkflow) available to your account. - WorkflowID string `json:"workflowId,omitempty"` +type ReportInProductRunResponseRow struct { + // The envelope ID of the envelope status that failed to post. + EnvelopeID string `json:"envelopeId,omitempty"` + // + Fields *ReportInProductRunResponseRowFields `json:"fields,omitempty"` } -type RecipientNamesResponse struct { - // Indicates whether email address is used by more than one user. - MultipleUsers string `json:"multipleUsers,omitempty"` +type ReportInProductRunResponseRowFields struct { + // + AccessCodeRequired string `json:"accessCodeRequired,omitempty"` + // + AccessCodesAttempted string `json:"accessCodesAttempted,omitempty"` + // + AccessCodesFailed string `json:"accessCodesFailed,omitempty"` + // The account ID associated with the envelope. + AccountID string `json:"accountId,omitempty"` + // + AuthenticationCategory string `json:"authenticationCategory,omitempty"` + // + AuthenticationSuccess string `json:"authenticationSuccess,omitempty"` + // Indicates the type of authentication. Valid values are: + // + // - `PhoneAuth` + // - `STAN` + // - `ISCheck` + // - `OFAC` + // - `AccessCode` + // - `AgeVerify` + // - `SSOAuth` + AuthenticationType string `json:"authenticationType,omitempty"` + // + AverageTimeToCompleteSeconds string `json:"averageTimeToCompleteSeconds,omitempty"` + // + AvgCompleteSeconds string `json:"avgCompleteSeconds,omitempty"` + // + Completed string `json:"completed,omitempty"` + // + CompletedTs string `json:"completedTs,omitempty"` + // The creation date of the account in UTC timedate format. + CreatedDate string `json:"createdDate,omitempty"` + // + CustomField string `json:"customField,omitempty"` + // + DeclinedDate string `json:"declinedDate,omitempty"` + // The reason the recipient declined the document. Read only. + DeclinedReason string `json:"declinedReason,omitempty"` + // + DeliveredDate string `json:"deliveredDate,omitempty"` + // + EnvelopeCount string `json:"envelopeCount,omitempty"` + // + EnvelopeCreator string `json:"envelopeCreator,omitempty"` + // The envelope ID of the envelope status that failed to post. + EnvelopeID string `json:"envelopeId,omitempty"` + // + EnvelopeInitialSendTs string `json:"envelopeInitialSendTs,omitempty"` + // + EnvelopeVoidedReason string `json:"envelopeVoidedReason,omitempty"` + // + EnvelopesBilled string `json:"envelopesBilled,omitempty"` + // + EnvelopesCompleted string `json:"envelopesCompleted,omitempty"` + // + EnvelopesCompletedCount string `json:"envelopesCompletedCount,omitempty"` + // + EnvelopesDeclined string `json:"envelopesDeclined,omitempty"` + // + EnvelopesSent string `json:"envelopesSent,omitempty"` + // + EnvelopesSentCount string `json:"envelopesSentCount,omitempty"` + // + EnvelopesVoided string `json:"envelopesVoided,omitempty"` + // + EodDocumentDescription string `json:"eodDocumentDescription,omitempty"` + // + EodDocumentName string `json:"eodDocumentName,omitempty"` + // + EodDocumentProfileID string `json:"eodDocumentProfileId,omitempty"` + // + EodTransactionID string `json:"eodTransactionId,omitempty"` + // + EodTransactionName string `json:"eodTransactionName,omitempty"` + // + EventDate string `json:"eventDate,omitempty"` + // + ExpirationDate string `json:"expirationDate,omitempty"` + // + ExpiredTs string `json:"expiredTs,omitempty"` + // + FailureVendorCode string `json:"failureVendorCode,omitempty"` + // + FailureVendorReason string `json:"failureVendorReason,omitempty"` + // A list of Connect failure logs. + Failures string `json:"failures,omitempty"` + // + FirstSendTs string `json:"firstSendTs,omitempty"` + // The ID of the group being accessed. + GroupID string `json:"groupId,omitempty"` + // The name of the group. The search_text provided in the call automatically performs a wild card search on group_name. + GroupName string `json:"groupName,omitempty"` + // + HoursToCompleteEnd string `json:"hoursToCompleteEnd,omitempty"` + // + HoursToCompleteStart string `json:"hoursToCompleteStart,omitempty"` + // + IDChecksAttempted string `json:"idChecksAttempted,omitempty"` + // + IDChecksFailed string `json:"idChecksFailed,omitempty"` + // + InitialSendTs string `json:"initialSendTs,omitempty"` + // + IPAddress string `json:"ipAddress,omitempty"` + // + LastActivity string `json:"lastActivity,omitempty"` // - RecipientNames []string `json:"recipientNames,omitempty"` + LastActivityDate string `json:"lastActivityDate,omitempty"` // - ReservedRecipientEmail string `json:"reservedRecipientEmail,omitempty"` -} - -// RecipientPhoneAuthentication is a complex type that contains the elements: -// -// * `recipMayProvideNumber` - A Boolean value that specifies whether the recipient can use the phone number of their choice. -// * `senderProvidedNumbers` - A list of phone numbers that the recipient can use. -// * `recordVoicePrint` - Reserved for DocuSign. -// * `validateRecipProvidedNumber` - Reserved for DocuSign. -type RecipientPhoneAuthentication struct { - // Boolean. When set to **true**, the recipient can supply a phone number their choice. - RecipMayProvideNumber DSBool `json:"recipMayProvideNumber,omitempty"` - // Metadata that indicates whether the `recipMayProvideNumber` property can be edited. - RecipMayProvideNumberMetadata *PropertyMetadata `json:"recipMayProvideNumberMetadata,omitempty"` - // Reserved for DocuSign. - RecordVoicePrint string `json:"recordVoicePrint,omitempty"` - // Metadata that indicates whether the `recordVoicePrint` property can be edited. - RecordVoicePrintMetadata *PropertyMetadata `json:"recordVoicePrintMetadata,omitempty"` - // An array containing a list of phone numbers that the recipient can use for SMS text authentication. - SenderProvidedNumbers []string `json:"senderProvidedNumbers,omitempty"` - // Metadata that indicates whether the `senderProvidedNumbers` property can be edited. - SenderProvidedNumbersMetadata *PropertyMetadata `json:"senderProvidedNumbersMetadata,omitempty"` - // Reserved for DocuSign. - ValidateRecipProvidedNumber string `json:"validateRecipProvidedNumber,omitempty"` - // Metadata that indicates whether the `validateRecipProvidedNumber` property can be edited. - ValidateRecipProvidedNumberMetadata *PropertyMetadata `json:"validateRecipProvidedNumberMetadata,omitempty"` -} - -type RecipientPreviewRequest struct { - // A unique identifier of the authentication event executed by the client application. - AssertionID string `json:"assertionId,omitempty"` - // A sender generated value that indicates the date/time that the signer was authenticated. - AuthenticationInstant string `json:"authenticationInstant,omitempty"` - // Required. Choose a value that most closely matches the technique your application used to authenticate the recipient / signer. + LastSentDate string `json:"lastSentDate,omitempty"` // - // Choose a value from this list: - // * Biometric - // * Email - // * HTTPBasicAuth - // * Kerberos - // * KnowledgeBasedAuth - // * None - // * PaperDocuments - // * Password - // * RSASecureID - // * SingleSignOn_CASiteminder - // * SingleSignOn_InfoCard - // * SingleSignOn_MicrosoftActiveDirectory - // * SingleSignOn_Other - // * SingleSignOn_Passport - // * SingleSignOn_SAML - // * Smartcard - // * SSLMutualAuth - // * X509Certificate + NotSigned string `json:"notSigned,omitempty"` // - // This information is included in the Certificate of Completion. - AuthenticationMethod string `json:"authenticationMethod,omitempty"` - // Only used if pingUrl is specified. This is the interval, in seconds, between pings on the pingUrl. The default is 300 seconds. Valid values are 60-1200 seconds. - PingFrequency string `json:"pingFrequency,omitempty"` - // A client Url to be pinged by the DocuSign Signing experience to indicate to the client that Signing is active. An HTTP Get is executed against the client. The response from the client is ignored. The intent is for the client to reset it's session timer when the request is received. - PingURL string `json:"pingUrl,omitempty"` - // A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`. - RecipientID string `json:"recipientId,omitempty"` + NumberOfAuthenticatedRecipients string `json:"numberOfAuthenticatedRecipients,omitempty"` // - ReturnURL string `json:"returnUrl,omitempty"` - // The domain in which the user authenticated. - SecurityDomain string `json:"securityDomain,omitempty"` + NumberOfCompletedSignatures string `json:"numberOfCompletedSignatures,omitempty"` // - XFrameOptions string `json:"xFrameOptions,omitempty"` + NumberOfDocuments string `json:"numberOfDocuments,omitempty"` // - XFrameOptionsAllowFromURL string `json:"xFrameOptionsAllowFromUrl,omitempty"` -} - -// RecipientSMSAuthentication contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication. -type RecipientSMSAuthentication struct { - // An array containing a list of phone numbers that the recipient can use for SMS text authentication. - SenderProvidedNumbers []string `json:"senderProvidedNumbers,omitempty"` - // Metadata that indicates whether the `senderProvidedNumbers` property can be edited. - SenderProvidedNumbersMetadata *PropertyMetadata `json:"senderProvidedNumbersMetadata,omitempty"` -} - -// RecipientSignatureInformation allows the sender to pre-specify the signature name, signature initials and signature font used in the signature stamp for the recipient. -// -// Used only with recipient types In Person Signers and Signers. -type RecipientSignatureInformation struct { - // Specifies the font style for the user's signature. - FontStyle string `json:"fontStyle,omitempty"` - // Specifies the user's signature in initials format. - SignatureInitials string `json:"signatureInitials,omitempty"` - // Specifies the user's signature name. - SignatureName string `json:"signatureName,omitempty"` -} - -// RecipientSignatureProvider is an Electronic or Standards Based Signature (digital signature) provider for the signer to use. [More information](https://developers.docusign.com/esign-rest-api/guides/standards-based-signatures). -// -type RecipientSignatureProvider struct { - // By default, electronic seals apply on all documents in an envelope. If any of the documents has a `signHere` tab, then a visual representation of the electronic seal will show up in the final document. If not, the electronic seal will be visible in the metadata but not in the content of the document. + NumberOfPages string `json:"numberOfPages,omitempty"` // - // To apply electronic seals on specific documents only, you must enable the `sealDocumentsWithTabsOnly` parameter. In this case, Electronic Seal applies only on documents that have `signHere` tabs set for the Electronic Seal recipient. Other documents won't be sealed. - SealDocumentsWithTabsOnly DSBool `json:"sealDocumentsWithTabsOnly,omitempty"` - // Indicates the name of the electronic seal to apply on documents. + NumberOfRecipients string `json:"numberOfRecipients,omitempty"` // - SealName string `json:"sealName,omitempty"` - // The name of an Electronic or Standards Based Signature (digital signature) provider for the signer to use. [The current provider list.](https://developers.docusign.com/esign-rest-api/guides/standards-based-signatures) - SignatureProviderName string `json:"signatureProviderName,omitempty"` - // Metadata that indicates whether the `signatureProviderName` property is editable. + NumberOfSends string `json:"numberOfSends,omitempty"` // - SignatureProviderNameMetadata *PropertyMetadata `json:"signatureProviderNameMetadata,omitempty"` - // Not applicable for this object. - SignatureProviderOptions *RecipientSignatureProviderOptions `json:"signatureProviderOptions,omitempty"` -} - -// RecipientSignatureProviderOptions option settings for the signature provider. Different providers require or use different options. [The current provider list and the options they require.](https://developers.docusign.com/esign-rest-api/guides/standards-based-signatures) -type RecipientSignatureProviderOptions struct { - // Reserved for DocuSign - CpfNumber string `json:"cpfNumber,omitempty"` + NumberOfSigners string `json:"numberOfSigners,omitempty"` // - CpfNumberMetadata *PropertyMetadata `json:"cpfNumberMetadata,omitempty"` - // A pre-shared secret that the signer must enter to complete the signing process. Eg last six digits of the signer's government ID or Social Security number. Or a newly created pre-shared secret for the transaction. Note: some signature providers may require an exact (case-sensitive) match if alphabetic characters are included in the field. - OneTimePassword string `json:"oneTimePassword,omitempty"` + NumberOfTotalDocuments string `json:"numberOfTotalDocuments,omitempty"` // - OneTimePasswordMetadata *PropertyMetadata `json:"oneTimePasswordMetadata,omitempty"` - // The role or capacity of the signing recipient. Examples: Manager, Approver, etc. - SignerRole string `json:"signerRole,omitempty"` + NumberOfTotalPages string `json:"numberOfTotalPages,omitempty"` // - SignerRoleMetadata *PropertyMetadata `json:"signerRoleMetadata,omitempty"` - // The mobile phone number used to send the recipient an access code for the signing ceremony. Format: a string starting with +, then the country code followed by the full mobile phone number without any spaces or special characters. Omit leading zeroes before a city code. Examples: +14155551234, +97235551234, +33505551234. - Sms string `json:"sms,omitempty"` + NumberOfTotalSigners string `json:"numberOfTotalSigners,omitempty"` // - SmsMetadata *PropertyMetadata `json:"smsMetadata,omitempty"` -} - -// RecipientUpdateResponse is the recipient details that are returned after you update the recipient. -type RecipientUpdateResponse struct { - // When you use the query parameter `combine_same_order_recipients` on the PUT Recipients call, the `recipientUpdateResponse` returns this property. When set to **true**, it indicates that the recipient has been combined or merged with a matching recipient. Recipient matching occurs as part of template matching, and is based on Recipient Role and Routing Order. - Combined string `json:"combined,omitempty"` - // This object describes errors that occur. It is only valid for responses and ignored in requests. - ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` - // A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`. - RecipientID string `json:"recipientId,omitempty"` - // The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. - RecipientIDGUID string `json:"recipientIdGuid,omitempty"` - // All of the tabs associated with the recipient. - Tabs *Tabs `json:"tabs,omitempty"` -} - -type RecipientViewRequest struct { - // A unique identifier of the authentication event executed by the client application. - AssertionID string `json:"assertionId,omitempty"` - // A sender generated value that indicates the date/time that the signer was authenticated. - AuthenticationInstant string `json:"authenticationInstant,omitempty"` - // Required. Choose a value that most closely matches the technique your application used to authenticate the recipient / signer. + NumberOfUniqueSenders string `json:"numberOfUniqueSenders,omitempty"` // - // Choose a value from this list: - // * Biometric - // * Email - // * HTTPBasicAuth - // * Kerberos - // * KnowledgeBasedAuth - // * None - // * PaperDocuments - // * Password - // * RSASecureID - // * SingleSignOn_CASiteminder - // * SingleSignOn_InfoCard - // * SingleSignOn_MicrosoftActiveDirectory - // * SingleSignOn_Other - // * SingleSignOn_Passport - // * SingleSignOn_SAML - // * Smartcard - // * SSLMutualAuth - // * X509Certificate + NumberTotalRecipients string `json:"numberTotalRecipients,omitempty"` // - // This information is included in the Certificate of Completion. - AuthenticationMethod string `json:"authenticationMethod,omitempty"` - // A sender created value. If provided, the recipient is treated as an embedded (captive) recipient or signer. + PeriodEnd string `json:"periodEnd,omitempty"` // - // Use your application's client ID (user ID) for the recipient. Doing so enables the details of your application's authentication of the recipient to be connected to the recipient's signature if the signature is disputed or repudiated. + PeriodStart string `json:"periodStart,omitempty"` // - // Maximum length: 100 characters. - ClientUserID string `json:"clientUserId,omitempty"` - // Specifies the email of the recipient. You can use either email and userName or userId to identify the recipient. - Email string `json:"email,omitempty"` - // Only used if pingUrl is specified. This is the interval, in seconds, between pings on the pingUrl. The default is 300 seconds. Valid values are 60-1200 seconds. - PingFrequency string `json:"pingFrequency,omitempty"` - // A client Url to be pinged by the DocuSign Signing experience to indicate to the client that Signing is active. An HTTP Get is executed against the client. The response from the client is ignored. The intent is for the client to reset it's session timer when the request is received. - PingURL string `json:"pingUrl,omitempty"` - // A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`. + PhoneCallsAttempted string `json:"phoneCallsAttempted,omitempty"` + // + PhoneCallsFailed string `json:"phoneCallsFailed,omitempty"` + // + ReasonForDeclining string `json:"reasonForDeclining,omitempty"` + // + ReasonForVoiding string `json:"reasonForVoiding,omitempty"` + // + ReassignReason string `json:"reassignReason,omitempty"` + // + Received string `json:"received,omitempty"` + // + Recipient string `json:"recipient,omitempty"` + // + RecipientAction string `json:"recipientAction,omitempty"` + // + RecipientCompanyName string `json:"recipientCompanyName,omitempty"` + // + RecipientCountry string `json:"recipientCountry,omitempty"` + // + RecipientEmail string `json:"recipientEmail,omitempty"` + // Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. RecipientID string `json:"recipientId,omitempty"` - // The URL that the recipient is redirected to - // after the signing session has ended. - // DocuSign redirects to the URL - // and includes an `event` query parameter - // that can be used by your application. // - // Possible `event` parameter values include: + RecipientName string `json:"recipientName,omitempty"` // - // * `access_code_failed`
- // Recipient used incorrect access code. - // * `cancel`
- // Recipient canceled the signing operation, - // possibly by using the **Finish Later** option. - // * `decline`
- // Recipient declined to sign. - // * `exception`
- // A system error occurred during the signing process. - // * `fax_pending`
- // Recipient has a fax pending. - // * `id_check_failed`
- // Recipient failed an ID check. - // * `session_timeout`
- // The session timed out. - // An account can control this timeout using the **Signer Session Timeout** option. - // * `signing_complete`
- // Recipient completed the signing ceremony. - // * `ttl_expired`
- // The Time To Live token for the envelope has expired. - // After being successfully invoked, these tokens expire - // after 5 minutes or if the envelope is voided. - // * `viewing_complete`
- // The recipient completed viewing an envelope - // that is in a read-only/terminal state - // such as completed, declined, or voided. + RecipientTemplateRoleName string `json:"recipientTemplateRoleName,omitempty"` // - // Be sure to include `https://` in the URL or the redirect may fail on certain browsers. + RecipientTitle string `json:"recipientTitle,omitempty"` + // The recipient type, as specified by the following values: + // - `agent`: Agent recipients can add name and email information for recipients that appear after the agent in routing order. + // - `carbonCopy`: Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date, or add information to any of the documents. This type of recipient can be used in any routing order. + // - `certifiedDelivery`: Certified delivery recipients must receive the completed documents for the envelope to be completed. They don't need to sign, initial, date, or add information to any of the documents. + // - `editor`: Editors have the same management and access rights for the envelope as the sender. Editors can add name and email information, add or change the routing order, set authentication options, and can edit signature/initial tabs and data fields for the remaining recipients. + // - `inPersonSigner`: In-person recipients are DocuSign users who act as signing hosts in the same physical location as the signer. + // - `intermediaries`: Intermediary recipients can optionally add name and email information for recipients at the same or subsequent level in the routing order. + // - `seal`: Electronic seal recipients represent legal entities. + // - `signer`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope. + // - `witness`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope. + RecipientType string `json:"recipientType,omitempty"` // - ReturnURL string `json:"returnUrl,omitempty"` - // The domain in which the user authenticated. - SecurityDomain string `json:"securityDomain,omitempty"` - // Specifies the user ID of the recipient. You can use with user ID or email and user name to identify the recipient. + RecipientUserID string `json:"recipientUserId,omitempty"` + // The number of remaining signatures that need to be applied to this document. + RemainingSignatures string `json:"remainingSignatures,omitempty"` + // Specifies the routing order of the recipient in the envelope. + RoutingOrder string `json:"routingOrder,omitempty"` // - // If userId is used and a clientUserId is provided, the value in the `userId` property must match a recipientId (which can be retrieved with a GET recipients call) for the envelope. + SenderAccountID string `json:"senderAccountId,omitempty"` // - // If a userId is used and a clientUserId is not provided, the userId must match the user ID of the authenticating user. - UserID string `json:"userId,omitempty"` - // Specifies the username of the recipient. You can use either email and userName or userId to identify the recipient. - UserName string `json:"userName,omitempty"` + SenderCompanyName string `json:"senderCompanyName,omitempty"` // - XFrameOptions string `json:"xFrameOptions,omitempty"` + SenderCountry string `json:"senderCountry,omitempty"` + // The sender's email address. + SenderEmail string `json:"senderEmail,omitempty"` // - XFrameOptionsAllowFromURL string `json:"xFrameOptionsAllowFromUrl,omitempty"` -} - -// Recipients envelope recipients -type Recipients struct { - // A list of agent recipients assigned to the documents. - Agents []Agent `json:"agents,omitempty"` - // A list of carbon copy recipients assigned to the documents. - CarbonCopies []CarbonCopy `json:"carbonCopies,omitempty"` - // A complex type containing information on a recipient the must receive the completed documents for the envelope to be completed, but the recipient does not need to sign, initial, date, or add information to any of the documents. - CertifiedDeliveries []CertifiedDelivery `json:"certifiedDeliveries,omitempty"` - // The routing order of the current recipient. If this value equals a particular signer's routing order, it indicates that the envelope has been sent to that recipient, but he or she has not completed the required actions. - CurrentRoutingOrder string `json:"currentRoutingOrder,omitempty"` - // A list of editors on the document. - Editors []Editor `json:"editors,omitempty"` - // This object describes errors that occur. It is only valid for responses and ignored in requests. - ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` - // Specifies a signer that is in the same physical location as a DocuSign user who will act as a Signing Host for the transaction. The recipient added is the Signing Host and new separate Signer Name field appears after Sign in person is selected. - InPersonSigners []InPersonSigner `json:"inPersonSigners,omitempty"` - // Identifies a recipient that can, but is not required to, add name and email information for recipients at the same or subsequent level in the routing order (until subsequent Agents, Editors or Intermediaries recipient types are added). - Intermediaries []Intermediary `json:"intermediaries,omitempty"` - // The list of recipient event statuses that will trigger Connect to send updates to the url. It can be a two-part list with: + SenderIPAddress string `json:"senderIPAddress,omitempty"` // - // * recipientEventStatusCode - The recipient status, this can be Sent, Delivered, Completed, Declined, AuthenticationFailed, and AutoResponded. - // * includeDocuments - When set to **true**, the envelope time zone information is included in the message. - RecipientCount string `json:"recipientCount,omitempty"` - // A list of electronic seals to apply to documents. - Seals []SealSign `json:"seals,omitempty"` - // A list of signers on the envelope. - Signers []Signer `json:"signers,omitempty"` - // A list of signers who act as witnesses on the envelope. - Witnesses []Witness `json:"witnesses,omitempty"` -} - -// RecipientsUpdateSummary this is the response that the API returns after you update recipients. -type RecipientsUpdateSummary struct { - // An array of `recipientUpdateResults` objects that contain details about the recipients. - RecipientUpdateResults []RecipientUpdateResponse `json:"recipientUpdateResults,omitempty"` -} - -// ReferralInformation is a complex type that contains the following information for entering referral and discount information. The following items are included in the referral information (all string content): enableSupport, includedSeats, saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, saleDiscountSeatPriceOverride, planStartMonth, referralCode, referrerName, advertisementId, publisherId, shopperId, promoCode, groupMemberId, idType, and industry -// -// ###### Note: saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, and saleDiscountSeatPriceOverride are reserved for DoucSign use only. -type ReferralInformation struct { - // A complex type that contains the following information for entering referral and discount information. The following items are included in the referral information (all string content): enableSupport, includedSeats, saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, saleDiscountSeatPriceOverride, planStartMonth, referralCode, referrerName, advertisementId, publisherId, shopperId, promoCode, groupMemberId, idType, and industry. + SenderJobTitle string `json:"senderJobTitle,omitempty"` + // The sender's name. + SenderName string `json:"senderName,omitempty"` + // The id of the sender. + SenderUserID string `json:"senderUserId,omitempty"` // - // ###### Note: saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, and saleDiscountSeatPriceOverride are reserved for DoucSign use only. + SignDate string `json:"signDate,omitempty"` // - AdvertisementID string `json:"advertisementId,omitempty"` - // When set to **true**, then customer support is provided as part of the account plan. - EnableSupport DSBool `json:"enableSupport,omitempty"` + Signed string `json:"signed,omitempty"` + // + SignedDate string `json:"signedDate,omitempty"` + // + SignedOnMobile string `json:"signedOnMobile,omitempty"` + // + SignedOnPaper string `json:"signedOnPaper,omitempty"` + // + SignerList string `json:"signerList,omitempty"` + // Indicates the envelope status. Valid values are: + // + // * sent - The envelope is sent to the recipients. + // * created - The envelope is saved as a draft and can be modified and sent later. + Status string `json:"status,omitempty"` + // + StatusChangedDate string `json:"statusChangedDate,omitempty"` + // + StatusChangedTs string `json:"statusChangedTs,omitempty"` + // + Subject string `json:"subject,omitempty"` + // + Successes string `json:"successes,omitempty"` + // + TemplatesCreated string `json:"templatesCreated,omitempty"` + // + TemplatesCreatedCount string `json:"templatesCreatedCount,omitempty"` + // + TerminalStatusDate string `json:"terminalStatusDate,omitempty"` + // + TimeToCompleteSeconds string `json:"timeToCompleteSeconds,omitempty"` + // + TimeToDeliver string `json:"timeToDeliver,omitempty"` + // + TotalDocuments string `json:"totalDocuments,omitempty"` + // + TotalEnvelopes string `json:"totalEnvelopes,omitempty"` + // + TotalPages string `json:"totalPages,omitempty"` + // + TotalRecipients string `json:"totalRecipients,omitempty"` // - ExternalOrgID string `json:"externalOrgId,omitempty"` + TotalSigners string `json:"totalSigners,omitempty"` // - GroupMemberID string `json:"groupMemberId,omitempty"` + UniqueSenders string `json:"uniqueSenders,omitempty"` // - IDType string `json:"idType,omitempty"` - // The number of seats (users) included. - IncludedSeats string `json:"includedSeats,omitempty"` + UserAccountEmail string `json:"userAccountEmail,omitempty"` // - Industry string `json:"industry,omitempty"` + UserAccountName string `json:"userAccountName,omitempty"` // - PlanStartMonth string `json:"planStartMonth,omitempty"` + UserAccountStatus string `json:"userAccountStatus,omitempty"` // - PromoCode string `json:"promoCode,omitempty"` + UserCount string `json:"userCount,omitempty"` + // The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing. // - PublisherID string `json:"publisherId,omitempty"` + UserID string `json:"userId,omitempty"` // - ReferralCode string `json:"referralCode,omitempty"` + ViewDate string `json:"viewDate,omitempty"` // - ReferrerName string `json:"referrerName,omitempty"` - // Reserved for DocuSign use only. - SaleDiscountAmount string `json:"saleDiscountAmount,omitempty"` - // Reserved for DocuSign use only. - SaleDiscountFixedAmount string `json:"saleDiscountFixedAmount,omitempty"` - // Reserved for DocuSign use only. - SaleDiscountPercent string `json:"saleDiscountPercent,omitempty"` - // Reserved for DocuSign use only. - SaleDiscountPeriods string `json:"saleDiscountPeriods,omitempty"` - // Reserved for DocuSign use only. - SaleDiscountSeatPriceOverride string `json:"saleDiscountSeatPriceOverride,omitempty"` + VoidedTs string `json:"voidedTs,omitempty"` +} + +type ReportInProductSaveResponse struct { // - ShopperID string `json:"shopperId,omitempty"` + ReportCustomizedID string `json:"reportCustomizedId,omitempty"` } -// Reminders is a complex element that specifies reminder settings for the envelope. -type Reminders struct { - // An integer specifying the number of days after the recipient receives the envelope that reminder emails are sent to the recipient. - ReminderDelay string `json:"reminderDelay,omitempty"` - // When set to **true**, the envelope expires and is no longer available for signing after the specified number of days. When **false**, the account default setting is used. If the account does not have an expiration setting, the DocuSign default value of 120 days is used. - ReminderEnabled DSBool `json:"reminderEnabled,omitempty"` - // An integer specifying the interval in days between reminder emails. - ReminderFrequency string `json:"reminderFrequency,omitempty"` +type ReportInProductSentByDetails struct { + // A collection group objects containing information about the groups. + Groups []Group `json:"groups,omitempty"` + // User management information. + Users []UserInfo `json:"users,omitempty"` } type ResourceInformation struct { @@ -11257,15 +17343,11 @@ type ResourceInformation struct { Resources []NameValue `json:"resources,omitempty"` } -// ReturnURLRequest is the request body for the EnvelopeViews: createSender method. +// ReturnURLRequest is the request body for the EnvelopeViews::createSender method. type ReturnURLRequest struct { - // Your app's return url that the user will be redirected to after sending the envelope or completing the sending/tagging view. Query parameters `envelopeId` and `event` will be added to the URL. The event parameter values: + // (Optional) The URL to which the user should be redirected after the sending session is complete. // - // * `Send` (the user sent the envelope) - // * `Save` (the user saved the envelope, it is still a draft) - // * `Cancel` (the user canceled the sending transaction) - // * `Error` (there was an error during the send operation) - // * `SessionEnd` (the sending session ended before the user completed a different action) + // Maximum Length: 500 characters. If the `returnUrl` exceeds this limit, the user is redirected to a truncated URL. ReturnURL string `json:"returnUrl,omitempty"` } @@ -11293,13 +17375,15 @@ type Seal struct { } type SealIdentifier struct { - // + // The user-friendly display name for a seal. SealDisplayName string `json:"sealDisplayName,omitempty"` - // + // The name of a seal. SealName string `json:"sealName,omitempty"` } -// SealSign specifies one or more electronic seals to apply on documents. +// SealSign specifies one or more electronic seals to apply on documents. An electronic seal recipient is a legal entity rather than an actual person. Electronic Seals can be used by organizations and governments to show evidence of origin and integrity of documents. Even though electronic seals can be represented by a tab in a document, they do not require user interaction and apply automatically in the order specified by the sender. The sender is therefore the person authorizing usage of the electronic seal in the flow. +// +// Example: // // ```json // "recipients": { @@ -11309,121 +17393,113 @@ type SealIdentifier struct { // "routingOrder" : 1, // "recipientSignatureProviders": [ // { -// "sealName": "52e9d968-13be-42ca-a6fe-4682bc45c106" +// "sealName": "52e9d968-xxxx-xxxx-xxxx-4682bc45c106" // } // ] // } // ] // }, +// . +// . +// . // ``` -// For more information on Electronic Seals , see https://support.docusign.com/en/guides/ndse-user-guide-apply-electronic-seals +// For more information about Electronic Seals, see [Apply Electronic Seals to Your Documents](https://support.docusign.com/en/guides/ndse-user-guide-apply-electronic-seals). +// type SealSign struct { - // Not applicable + // Not applicable. AccessCode string `json:"accessCode,omitempty"` // Not applicable. AccessCodeMetadata *PropertyMetadata `json:"accessCodeMetadata,omitempty"` - // Not applicable + // Not applicable. AddAccessCodeToEmail string `json:"addAccessCodeToEmail,omitempty"` - // Not applicable - ClientUserID string `json:"clientUserId,omitempty"` - // Indicates the number of times that the recipient has been through a signing completion for the envelope. // - // If this number is greater than 0 for a signing group, only the user who previously completed may sign again. + AllowSystemOverrideForLockedRecipient string `json:"allowSystemOverrideForLockedRecipient,omitempty"` + // Not applicable. + ClientUserID string `json:"clientUserId,omitempty"` + // Not applicable. CompletedCount string `json:"completedCount,omitempty"` - // An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters. + // Not applicable. CustomFields []string `json:"customFields,omitempty"` - // Not applicable + // Not applicable. DeclinedDateTime string `json:"declinedDateTime,omitempty"` - // Not applicable + // Not applicable. DeclinedReason string `json:"declinedReason,omitempty"` - // Not applicable + // Not applicable. DeliveredDateTime string `json:"deliveredDateTime,omitempty"` // Reserved for DocuSign. DeliveryMethod string `json:"deliveryMethod,omitempty"` // Reserved for DocuSign. DeliveryMethodMetadata *PropertyMetadata `json:"deliveryMethodMetadata,omitempty"` - // Not applicable - DocumentVisibility []DocumentVisibility `json:"documentVisibility,omitempty"` - // Sets the language for electronic seals. - EmailNotification *RecipientEmailNotification `json:"emailNotification,omitempty"` - // Specifies a sender-provided valid URL string for redirecting an embedded recipient. When this option is used, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the recipient clicks the document link in the email, the recipient is redirected through DocuSign to the specified URL to complete the required actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. - // - // If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation launched by a partner. - // - // It is important to understand that in a typical embedded workflow, the authentication of an embedded recipient is the responsibility of the sending application. DocuSign expects that senders will follow their own processes for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process is initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process, bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. - // - // If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: `envelopeId`, `recipientId`, `recipientName`, `recipientEmail`, and `customFields`. The `customFields` property must be set for the recipient or envelope. The merge fields are enclosed in double brackets. // - // *Example*: + DesignatorID string `json:"designatorId,omitempty"` // - // `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` + DesignatorIDGUID string `json:"designatorIdGuid,omitempty"` + // Not applicable. + DocumentVisibility []DocumentVisibility `json:"documentVisibility,omitempty"` + // Not applicable. + EmailNotification *RecipientEmailNotification `json:"emailNotification,omitempty"` + // Not applicable. EmbeddedRecipientStartURL string `json:"embeddedRecipientStartURL,omitempty"` // This object describes errors that occur. It is only valid for responses and ignored in requests. ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` // Reserved for DocuSign. FaxNumber string `json:"faxNumber,omitempty"` - // Metadata that indicates whether the `faxNumber` property is editable. - // + // Reserved for DocuSign. FaxNumberMetadata *PropertyMetadata `json:"faxNumberMetadata,omitempty"` - // The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. - // - // **Example**: Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node. + // Not applicable. IDCheckConfigurationName string `json:"idCheckConfigurationName,omitempty"` - // Metadata that indicates if the sender can edit the `idCheckConfigurationName` property. + // Not applicable. IDCheckConfigurationNameMetadata *PropertyMetadata `json:"idCheckConfigurationNameMetadata,omitempty"` - // Not applicable + // Not applicable. IDCheckInformationInput *IDCheckInformationInput `json:"idCheckInformationInput,omitempty"` - // When set to **true** and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account. + // Specifies the ID Verification workflow applied on an envelope by workflow ID.
See the [list](https://developers.docusign.com/docs/esign-rest-api/reference/Accounts/IdentityVerifications/list) method in the [IdentityVerifications](https://developers.docusign.com/docs/esign-rest-api/reference/Accounts/IdentityVerifications) resource for more information on how to retrieve workflow IDs available for an account.
This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods.
Note that ID Verification and ID Check are two distinct methods. ID Verification checks recipients' identity by verifying their ID while ID Check relies on data available on public records (such as current and former address). + IdentityVerification *RecipientIdentityVerification `json:"identityVerification,omitempty"` + // Not applicable. InheritEmailNotificationConfiguration string `json:"inheritEmailNotificationConfiguration,omitempty"` // Reserved for DocuSign. LockedRecipientPhoneAuthEditable string `json:"lockedRecipientPhoneAuthEditable,omitempty"` // Reserved for DocuSign. LockedRecipientSmsEditable string `json:"lockedRecipientSmsEditable,omitempty"` - // The name of the recipient. + // Not applicable. Name string `json:"name,omitempty"` - // Not applicable + // Not applicable. Note string `json:"note,omitempty"` - // Not applicable + // Not applicable. NoteMetadata *PropertyMetadata `json:"noteMetadata,omitempty"` - // A complex type that contains the following elements: - // - // * `recipMayProvideNumber` - Boolean. When set to **true**, the recipient can use whatever phone number they choose. - // * `senderProvidedNumbers` - ArrayOfString. A list of phone numbers the recipient can use. - // * `recordVoicePrint` - Reserved. - // * `validateRecipProvidedNumber` - Reserved. + // Not applicable. PhoneAuthentication *RecipientPhoneAuthentication `json:"phoneAuthentication,omitempty"` - // Not applicable + // Not applicable. RecipientAttachments []RecipientAttachment `json:"recipientAttachments,omitempty"` - // Not applicable + // Not applicable. RecipientAuthenticationStatus *AuthenticationStatus `json:"recipientAuthenticationStatus,omitempty"` - // Metadata about the features that are supported for the recipient type. + // Metadata about the features that are supported for the recipient type. Read only. RecipientFeatureMetadata []FeatureAvailableMetadata `json:"recipientFeatureMetadata,omitempty"` // (Required) The `recipientId` used when the envelope or template was created. // // This is a local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`. RecipientID string `json:"recipientId,omitempty"` - // The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. + // The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only. RecipientIDGUID string `json:"recipientIdGuid,omitempty"` // (Required) Indicates which electronic seal to apply on documents when creating an envelope. RecipientSignatureProviders []RecipientSignatureProvider `json:"recipientSignatureProviders,omitempty"` // The recipient type, as specified by the following values: - // - `agents`: Agent recipients can add name and email information for recipients that appear after the agent in routing order. - // - `carbonCopies`: Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date, or add information to any of the documents. This type of recipient can be used in any routing order. - // - `certifiedDeliveries`: Certified delivery recipients must receive the completed documents for the envelope to be completed. They don't need to sign, initial, date, or add information to any of the documents. - // - `editors`: Editors have the same management and access rights for the envelope as the sender. Editors can add name and email information, add or change the routing order, set authentication options, and can edit signature/initial tabs and data fields for the remaining recipients. - // - `inPersonSigners`: In-person recipients are DocuSign users who act as signing hosts in the same physical location as the signer. + // - `agent`: Agent recipients can add name and email information for recipients that appear after the agent in routing order. + // - `carbonCopy`: Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date, or add information to any of the documents. This type of recipient can be used in any routing order. + // - `certifiedDelivery`: Certified delivery recipients must receive the completed documents for the envelope to be completed. They don't need to sign, initial, date, or add information to any of the documents. + // - `editor`: Editors have the same management and access rights for the envelope as the sender. Editors can add name and email information, add or change the routing order, set authentication options, and can edit signature/initial tabs and data fields for the remaining recipients. + // - `inPersonSigner`: In-person recipients are DocuSign users who act as signing hosts in the same physical location as the signer. // - `intermediaries`: Intermediary recipients can optionally add name and email information for recipients at the same or subsequent level in the routing order. - // - `seals`: Electronic seal recipients represent legal entities. - // - `signers`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope. - // - `witnesses`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope. + // - `seal`: Electronic seal recipients represent legal entities. + // - `signer`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope. + // - `witness`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope. RecipientType string `json:"recipientType,omitempty"` - // Metadata that indicates if the sender can edit the recipient type. + // Metadata that indicates whether the `recipientType` property is editable. Read only. RecipientTypeMetadata *PropertyMetadata `json:"recipientTypeMetadata,omitempty"` - // Not applicable + // Not applicable. RequireIDLookup string `json:"requireIdLookup,omitempty"` - // Not applicable + // Not applicable. RequireIDLookupMetadata *PropertyMetadata `json:"requireIdLookupMetadata,omitempty"` - // Optional element. Specifies the role name associated with the recipient.

This is required when working with template recipients. + // Optional element. Specifies the role name associated with the recipient.

This property is required when you are working with template recipients. RoleName string `json:"roleName,omitempty"` // (Optional, default: 1) // Specifies the routing order of the electronic seal in the envelope. @@ -11431,68 +17507,80 @@ type SealSign struct { // It is recommended that you set a routing order for your electronic seals. // RoutingOrder string `json:"routingOrder,omitempty"` - // Metadata that indicates if the sender can edit the routing order for the recipient. + // Metadata that indicates whether the `routingOrder` property is editable. Read only. RoutingOrderMetadata *PropertyMetadata `json:"routingOrderMetadata,omitempty"` - // Not applicable + // Not applicable. SentDateTime string `json:"sentDateTime,omitempty"` - // Not applicable + // Not applicable. SignedDateTime string `json:"signedDateTime,omitempty"` - // Not applicable + // Not applicable. SmsAuthentication *RecipientSMSAuthentication `json:"smsAuthentication,omitempty"` - // Lists the social ID type that can be used for recipient authentication. + // Deprecated. SocialAuthentications []SocialAuthentication `json:"socialAuthentications,omitempty"` - // The status of the item. + // The recipient's status. Read only. + // + // Possible values: + // + // - `autoresponded`: The recipient's email system auto-responded to the email from DocuSign. This status is used in the web console to inform senders about the bounced-back email. This recipient status is only used if **Send-on-behalf-of** is turned off for the account. + // - `completed`: The recipient has completed their actions (signing or other required actions if not a signer) for an envelope. + // - `created`: The recipient is in a draft state. This value is only associated with draft envelopes (envelopes that have a status of `created`). + // - `declined`: The recipient declined to sign the document(s) in the envelope. + // - `delivered`: The recipient has viewed the document(s) in an envelope through the DocuSign signing website. This is not an email delivery of the documents in an envelope. + // - `faxPending`: The recipient has finished signing and the system is waiting for a fax attachment from the recipient before completing their signing step. + // - `sent`: The recipient has been sent an email notification that it is their turn to sign an envelope. + // - `signed`: The recipient has completed (signed) all required tags in an envelope. This is a temporary state during processing, after which the recipient's status automatically switches to `completed`. Status string `json:"status,omitempty"` - // Reserved for DocuSign. + // The code associated with the recipient's status. Read only. StatusCode string `json:"statusCode,omitempty"` - // A list of `signHere` tabs, which can be used to add a visual representation for an electronic seal in a document. + // Not applicable. + SuppressEmails string `json:"suppressEmails,omitempty"` + // A list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients. Tabs *Tabs `json:"tabs,omitempty"` // When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. TemplateLocked string `json:"templateLocked,omitempty"` // When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. TemplateRequired string `json:"templateRequired,omitempty"` - // Not applicable + // Not applicable. TotalTabCount string `json:"totalTabCount,omitempty"` - // Not applicable + // Not applicable. UserID string `json:"userId,omitempty"` } +// SeatDiscount this object contains information about a seat discount. type SeatDiscount struct { - // Reserved: TBD + // Reserved for DocuSign. BeginSeatCount string `json:"beginSeatCount,omitempty"` + // The percent of the discount. // + // Example: `"0.00"` DiscountPercent string `json:"discountPercent,omitempty"` - // Reserved: TBD + // Reserved for DocuSign. EndSeatCount string `json:"endSeatCount,omitempty"` } -type Sender struct { - // The GUID associated with the account ID. - AccountIDGUID string `json:"accountIdGuid,omitempty"` - // The name of the user's company. - CompanyName string `json:"companyName,omitempty"` -} - +// SenderEmailNotifications contains the settings for the email notifications that senders receive about the envelopes that they send. type SenderEmailNotifications struct { - // When set to **true**, the sender receives notification if the signer changes. + // When set to **true**, the sender receives an email notification if the signer changes. ChangedSigner DSBool `json:"changedSigner,omitempty"` - // When set to **true**, the user receives only comments in which that user name is mentioned. + // When set to **true**, the user receives only comments that mention their own user name. CommentsOnlyPrivateAndMention string `json:"commentsOnlyPrivateAndMention,omitempty"` // When set to **true**, the user receives all comments. CommentsReceiveAll string `json:"commentsReceiveAll,omitempty"` - // When set to **true**, the sender receives notification if the delivery of the envelope fails. + // When set to **true**, the sender receives an email notification if envelope delivery fails. DeliveryFailed DSBool `json:"deliveryFailed,omitempty"` - // When set to **true**, the user receives notification that the envelope has been completed. + // When set to **true**, the user receives an email notification when the envelope has been completed. EnvelopeComplete DSBool `json:"envelopeComplete,omitempty"` - // When set to **true**, the user receives notification if the offline signing failed. + // When set to **true**, the user receives an email notification if offline signing failed. OfflineSigningFailed DSBool `json:"offlineSigningFailed,omitempty"` - // When set to **true**, the user receives notification of document purges. + // + PowerformResponsesLimitNotificationEmail string `json:"powerformResponsesLimitNotificationEmail,omitempty"` + // When set to **true**, the user receives an email notification when a document purge occurs. PurgeDocuments string `json:"purgeDocuments,omitempty"` - // When set to **true**, the sender receives notification that the recipient viewed the enveloper. + // When set to **true**, the sender receives notification that a recipient viewed the envelope. RecipientViewed DSBool `json:"recipientViewed,omitempty"` // When set to **true**, the sender receives notification that the envelope was declined. SenderEnvelopeDeclined string `json:"senderEnvelopeDeclined,omitempty"` - // When set to **true**, the user receives notification if consent is withdrawn. + // When set to **true**, the user receives an email notification if consent is withdrawn. WithdrawnConsent DSBool `json:"withdrawnConsent,omitempty"` } @@ -11579,27 +17667,6 @@ type SignHashDocument struct { SignatureType string `json:"signatureType,omitempty"` } -type SignHashSessionInfoResponse struct { - // Complex element contains the details on the documents in the envelope. - Documents []SignHashDocument `json:"documents,omitempty"` - // The envelope's GUID. - // - // Example: `93be49ab-afa0-4adf-933c-f752070d71ec` - EnvelopeID string `json:"envelopeId,omitempty"` - // Specifies the language for the Certificate of Completion in the response. The supported languages are: Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Dutch (nl), English US (en), French (fr), German (de), Italian (it), Japanese (ja), Korean (ko), Portuguese (pt), Portuguese (Brazil) (pt_BR), Russian (ru), Spanish (es). - Language string `json:"language,omitempty"` - // - RedirectionURL string `json:"redirectionUrl,omitempty"` - // - RemainingSignatureRequests int64 `json:"remainingSignatureRequests,omitempty"` - // Set of information related to the electronic seal used by the Trust Service Provider (TSP) - Seal *Seal `json:"seal,omitempty"` - // Information about the sender of the envelope. - Sender *Sender `json:"sender,omitempty"` - // - User *User `json:"user,omitempty"` -} - // SignHere is a tab that allows the recipient to sign a document. May be // optional. // @@ -11607,25 +17674,39 @@ type SignHere struct { TabBase TabGuidedForm TabPosition - // The height of the tab in pixels. + // + AnchorAllowWhiteSpaceInCharacters string `json:"anchorAllowWhiteSpaceInCharacters,omitempty"` + // + AnchorAllowWhiteSpaceInCharactersMetadata *PropertyMetadata `json:"anchorAllowWhiteSpaceInCharactersMetadata,omitempty"` + // Not applicable to Sign Here tab. Height string `json:"height,omitempty"` // Metadata that indicates whether the `height` property is editable. HeightMetadata *PropertyMetadata `json:"heightMetadata,omitempty"` // When set to **true**, the tab contains a visual representation for an electronic seal in a document. IsSealSignTab string `json:"isSealSignTab,omitempty"` + // + MergeFieldXML string `json:"mergeFieldXml,omitempty"` // The name of the tab. For example, `Sign Here` or `Initial Here`. Name string `json:"name,omitempty"` - // Metadata that indicates whether the `name` property is editable. + // Metadata that indicates whether the `name` property is editable. Read only. NameMetadata *PropertyMetadata `json:"nameMetadata,omitempty"` // When set to **true**, the recipient does not need to complete this tab to complete the signing process. Optional DSBool `json:"optional,omitempty"` // Metadata that indicates whether the `optional` property is editable. OptionalMetadata *PropertyMetadata `json:"optionalMetadata,omitempty"` - // Sets the size of the tab. This field accepts values from `0.5` to `1.0`, where `1.0` represents full size and `0.5` is 50% of full size. + // Scales the size of the tab. This field accepts values from 0.5 to 2.0, where 0.5 is half the normal size, 1.0 is normal size, and 2.0 is twice the normal size. ScaleValue string `json:"scaleValue,omitempty"` // Metadata that indicates whether the `scaleValue` property is editable. ScaleValueMetadata *PropertyMetadata `json:"scaleValueMetadata,omitempty"` - // If the recipient signs by using a personal stamp that is representative of their signature, this property specifies the stamp type. + // + SmartContractInformation *SmartContractInformation `json:"smartContractInformation,omitempty"` + // + Stamp *Stamp `json:"stamp,omitempty"` + // The type of stamp. Valid values are: + // + // - `signature`: A signature image. This is the default value. + // - `stamp`: A stamp image. + // - null StampType string `json:"stampType,omitempty"` // Metadata that indicates whether the `stampType` property is editable. StampTypeMetadata *PropertyMetadata `json:"stampTypeMetadata,omitempty"` @@ -11633,56 +17714,91 @@ type SignHere struct { ToolTipMetadata *PropertyMetadata `json:"toolTipMetadata,omitempty"` // The text of a tooltip that appears when a user hovers over a form field or tab. Tooltip string `json:"tooltip,omitempty"` - // The width of the tab in pixels. + // Not applicable to Sign Here tab. Width string `json:"width,omitempty"` // Metadata that indicates whether the `width` property is editable. WidthMetadata *PropertyMetadata `json:"widthMetadata,omitempty"` } -type SignSessionInfoRequest struct { - // When set to **false**, the envelope signing certificate is removed from the download. - Certificate string `json:"certificate,omitempty"` - // - MaxSignatureLength string `json:"maxSignatureLength,omitempty"` +type SignatureGroup struct { + // The ID of the group being accessed. + GroupID string `json:"groupId,omitempty"` + // The name of the group. The search_text provided in the call automatically performs a wild card search on group_name. + GroupName string `json:"groupName,omitempty"` + // Indicates whether the property is editable. Valid values are: // - ReturnFormat string `json:"returnFormat,omitempty"` - // Specifies the physical location where the signing takes place. It can have two enumeration values; `inPerson` and `online`. The default value is `online`. - SigningLocation string `json:"signingLocation,omitempty"` + // - `editable` + // - `read_only` + Rights string `json:"rights,omitempty"` } -type SignatureDataInfo struct { - // - DocumentSecurityStore *DocumentSecurityStore `json:"documentSecurityStore,omitempty"` - // - SignatureData string `json:"signatureData,omitempty"` +type SignatureGroupDef struct { + // The ID of the group being accessed. + GroupID string `json:"groupId,omitempty"` + // Indicates whether the property is editable. Valid values are: // - SignatureFieldName string `json:"signatureFieldName,omitempty"` + // - `editable` + // - `read_only` + Rights string `json:"rights,omitempty"` } type SignatureProperties struct { - // + // Specifies the preferred handler that should be used to validate the signature. Filter string `json:"filter,omitempty"` - // + // Indicates the format of the data that the stream contains. SubFilter string `json:"subFilter,omitempty"` } +// SignatureProviderRequiredOption contains additional information that a specific signature provider requires. type SignatureProviderRequiredOption struct { - // + // Reserved for DocuSign. RequiredSignatureProviderOptionIds []string `json:"requiredSignatureProviderOptionIds,omitempty"` - // + // Reserved for DocuSign. SignerType string `json:"signerType,omitempty"` } +// SignatureType this object contains information about the type of signature. type SignatureType struct { - // Indicates if the signature type is the default type. + // When **true**, the signature type is the default type. IsDefault DSBool `json:"isDefault,omitempty"` - // Type of user: - // - `type_owner` - // - `type_participant` + // The type of signature. Valid values are: + // + // - `electronic`: Indicates an **electronic** signature that is used by common law countries such as the United States, United Kingdom, and Australia. This is the default signature type that DocuSign uses. + // - `universal`: Indicates a **digital** signature that is accepted by both common law and civil law countries. To use digital signatures, you must use the [DocuSign Signature Appliance](https://developers.docusign.com/dsa-api). + // + // For more information, see [Standards Based Signatures](https://developers.docusign.com/esign-rest-api/guides/standards-based-signatures). Type string `json:"type,omitempty"` } -// Signer is a complex type containing information about the signer recipient. +type SignatureUser struct { + // Boolean that specifies whether the signature is the default signature for the user. + IsDefault string `json:"isDefault,omitempty"` + // Indicates whether the property is editable. Valid values are: + // + // - `editable` + // - `read_only` + Rights string `json:"rights,omitempty"` + // The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing. + // + UserID string `json:"userId,omitempty"` + // The name of the user. + UserName string `json:"userName,omitempty"` +} + +type SignatureUserDef struct { + // Boolean that specifies whether the signature is the default signature for the user. + IsDefault string `json:"isDefault,omitempty"` + // Indicates whether the property is editable. Valid values are: + // + // - `editable` + // - `read_only` + Rights string `json:"rights,omitempty"` + // The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing. + // + UserID string `json:"userId,omitempty"` +} + +// Signer is a complex type containing information about a signer recipient. A signer is a recipient who must take action on a document, such as sign, initial, date, or add data to form fields on a document. type Signer struct { // If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. // @@ -11692,18 +17808,22 @@ type Signer struct { // // If blank and the signer `accessCode` property is not set, then the access code is not required. AccessCode string `json:"accessCode,omitempty"` - // Metadata that indicates if the sender can edit the `accessCode` property. + // Metadata that indicates whether the `accessCode` property is editable. Read only. AccessCodeMetadata *PropertyMetadata `json:"accessCodeMetadata,omitempty"` - // This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient. + // Optional. When set to **true**, the access code will be added to the email sent to the recipient. This nullifies the security measure of `accessCode` on the recipient. AddAccessCodeToEmail string `json:"addAccessCodeToEmail,omitempty"` - // Optional element. When set to true, the agents recipient associated with this recipient can change the recipient's pre-populated email address. This element is only active if enabled for the account. + // An array of additional notification objects. + AdditionalNotifications []RecipientAdditionalNotification `json:"additionalNotifications,omitempty"` + // Optional element. When set to **true**, the agent recipient associated with this recipient can change the recipient's pre-populated email address. This element is only active if enabled for the account. AgentCanEditEmail DSBool `json:"agentCanEditEmail,omitempty"` - // Optional element. When set to **true**, the agents recipient associated with this recipient can change the recipient's pre-populated name. This element is only active if enabled for the account. + // Optional. When set to **true**, the agent recipient associated with this recipient can change the recipient's pre-populated name. This element is only active if enabled for the account. AgentCanEditName DSBool `json:"agentCanEditName,omitempty"` - // When **true**, auto navigation is set for the recipient. + // + AllowSystemOverrideForLockedRecipient string `json:"allowSystemOverrideForLockedRecipient,omitempty"` + // When set to **true**, autonavigation is set for the recipient. // AutoNavigation string `json:"autoNavigation,omitempty"` - // Contains a URI for an endpoint that allows you to easily retrieve bulk recipient information. + // Reserved for DocuSign. BulkRecipientsURI string `json:"bulkRecipientsUri,omitempty"` // When set to **true**, specifies that the signer can perform the signing ceremony offline. CanSignOffline DSBool `json:"canSignOffline,omitempty"` @@ -11715,37 +17835,39 @@ type Signer struct { // // Maximum length: 100 characters. ClientUserID string `json:"clientUserId,omitempty"` - // Indicates the number of times that the recipient has been through a signing completion for the envelope. - // - // If this number is greater than 0 for a signing group, only the user who previously completed may sign again. + // Indicates the number of times that the recipient has been through a signing completion for the envelope. If this number is greater than 0 for a signing group, only the user who previously completed may sign again. Read only. CompletedCount string `json:"completedCount,omitempty"` - // Payment status for payment services. + // The reason why the item was created. CreationReason string `json:"creationReason,omitempty"` // An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters. CustomFields []string `json:"customFields,omitempty"` - // The date and time the recipient declined the document. + // The date and time the recipient declined the document. Read only. DeclinedDateTime *time.Time `json:"declinedDateTime,omitempty"` - // The reason the recipient declined the document. + // The reason the recipient declined the document. Read only. DeclinedReason string `json:"declinedReason,omitempty"` // When set to **true**, this recipient is the default recipient and any tabs generated by the transformPdfFields option are mapped to this recipient. DefaultRecipient DSBool `json:"defaultRecipient,omitempty"` - // The date and time that the envelope was delivered to the recipient. + // The date and time that the envelope was delivered to the recipient. Read only. DeliveredDateTime *time.Time `json:"deliveredDateTime,omitempty"` // Reserved for DocuSign. DeliveryMethod string `json:"deliveryMethod,omitempty"` // Reserved for DocuSign. DeliveryMethodMetadata *PropertyMetadata `json:"deliveryMethodMetadata,omitempty"` - // A list of documentVisibility objects, which define a recipient's read/write access to a document. + // + DesignatorID string `json:"designatorId,omitempty"` + // + DesignatorIDGUID string `json:"designatorIdGuid,omitempty"` + // A list of `documentVisibility` objects. Each object in the list specifies whether a document in the envelope is visible to this recipient. For the envelope to use this functionality, Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true**. DocumentVisibility []DocumentVisibility `json:"documentVisibility,omitempty"` - // Recipient email ID to which notifications of the document to sign are sent. Maximum length: 100 characters. + // The recipient's email address. The system sends notifications about the documents to sign to this address. Maximum length: 100 characters. Email string `json:"email,omitempty"` - // Metadata that indicates whether the signer can edit the recipient's email ID. + // Metadata that indicates whether the `email` property is editable. Read only. EmailMetadata *PropertyMetadata `json:"emailMetadata,omitempty"` // An optional complex type that sets a specific email subject and body for this recipient's notification email. // - // **Note**: If you use this field to set a specific email notification for one recipient, you must also set the email notification for the other recipients. Using this field for one or more recipients negates the Envelope `Subject` and `EmailBlurb` property settings. + // **Note**: You can set the `emailNotification` property separately for each recipient. If you set the value only for certain recipients, the other recipients will inherit the this value from the top-level `emailSubject` and `emailBlurb`. EmailNotification *RecipientEmailNotification `json:"emailNotification,omitempty"` - // Specifies a sender-provided valid URL string for redirecting an embedded recipient. When this option is used, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the recipient clicks the document link in the email, the recipient is redirected through DocuSign to the specified URL to complete the required actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. + // Specifies a sender-provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. // // If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation launched by a partner. // @@ -11765,26 +17887,29 @@ type Signer struct { ExcludedDocuments DSBool `json:"excludedDocuments,omitempty"` // Reserved for DocuSign. FaxNumber string `json:"faxNumber,omitempty"` - // Metadata that indicates whether the `faxNumber` property is editable. - // + // Reserved for DocuSign. FaxNumberMetadata *PropertyMetadata `json:"faxNumberMetadata,omitempty"` // The recipient's first name. Maximum Length: 50 characters. FirstName string `json:"firstName,omitempty"` - // Metadata that indicates if the sender can edit the recipient's first name. + // Metadata that indicates whether the `firstame` property is editable. Read only. FirstNameMetadata *PropertyMetadata `json:"firstNameMetadata,omitempty"` // Reserved for DocuSign. FullName string `json:"fullName,omitempty"` // Reserved for DocuSign. FullNameMetadata *PropertyMetadata `json:"fullNameMetadata,omitempty"` - // The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. + // The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are: + // + // - `Phone Auth $`: The recipient must authenticate by using two-factor authentication (2FA). You provide the phone number to use for 2FA in the `phoneAuthentication` object. + // - `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object. + // - `ID Check $`: The recipient must answer detailed security questions. // // **Example**: Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node. IDCheckConfigurationName string `json:"idCheckConfigurationName,omitempty"` - // Metadata that indicates if the sender can edit the `idCheckConfigurationName` property. + // Metadata that indicates whether the `idCheckConfigurationName` property is editable. Read only. IDCheckConfigurationNameMetadata *PropertyMetadata `json:"idCheckConfigurationNameMetadata,omitempty"` // An object that contains input information related to a recipient ID check. IDCheckInformationInput *IDCheckInformationInput `json:"idCheckInformationInput,omitempty"` - // Specifies ID Verification applied on an envelope by workflow ID.
See the [list](https://developers.docusign.com/esign-rest-api/reference/Accounts/IdentityVerifications/list) method in the [IdentityVerifications](https://developers.docusign.com/esign-rest-api/reference/Accounts/IdentityVerifications) resource for more information on how to retrieve workflow IDs available for an account.
This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods.
Note that ID Verification and ID Check are two distinct methods. ID Verification checks recipients' identity by verifying their ID while ID Check relies on data available on public records (such as current and former address). + // Specifies the ID Verification workflow applied on an envelope by workflow ID.
See the [list](https://developers.docusign.com/docs/esign-rest-api/reference/Accounts/IdentityVerifications/list) method in the [IdentityVerifications](https://developers.docusign.com/docs/esign-rest-api/reference/Accounts/IdentityVerifications) resource for more information on how to retrieve workflow IDs available for an account.
This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods.
Note that ID Verification and ID Check are two distinct methods. ID Verification checks recipients' identity by verifying their ID while ID Check relies on data available on public records (such as current and former address). IdentityVerification *RecipientIdentityVerification `json:"identityVerification,omitempty"` // When set to **true** and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account. InheritEmailNotificationConfiguration DSBool `json:"inheritEmailNotificationConfiguration,omitempty"` @@ -11793,20 +17918,24 @@ type Signer struct { // Note that when this is true the email and name for the recipient becomes bulk@recipient.com and "Bulk Recipient". These fields can not be changed for the bulk recipient. // IsBulkRecipient DSBool `json:"isBulkRecipient,omitempty"` - // Metadata that indicates if the sender can edit the `isBulkRecipient` property. + // Reserved for DocuSign. IsBulkRecipientMetadata *PropertyMetadata `json:"isBulkRecipientMetadata,omitempty"` // The recipient's last name. LastName string `json:"lastName,omitempty"` - // Metadata that indicates if the sender can edit the recipient's last name. + // Metadata that indicates whether the `lastName` property is editable. Read only. LastNameMetadata *PropertyMetadata `json:"lastNameMetadata,omitempty"` // Reserved for DocuSign. LockedRecipientPhoneAuthEditable string `json:"lockedRecipientPhoneAuthEditable,omitempty"` // Reserved for DocuSign. LockedRecipientSmsEditable string `json:"lockedRecipientSmsEditable,omitempty"` - // The full legal name of the recipient. + // The full legal name of the recipient. Maximum Length: 100 characters. + // + // **Note**: You must always set a value for this property in requests, even if `firstName` and `lastName` are set. Name string `json:"name,omitempty"` - // Metadata that indicates if the sender can edit the full legal name of the recipient. + // Metadata that indicates whether the `name` property is editable. Read only. NameMetadata *PropertyMetadata `json:"nameMetadata,omitempty"` + // + NotaryID string `json:"notaryId,omitempty"` // A note sent to the recipient in the signing email. // This note is unique to this recipient. // In the user interface, @@ -11817,105 +17946,121 @@ type Signer struct { // Maximum Length: 1000 characters. // Note string `json:"note,omitempty"` - // Metdata that indicates if the sender can edit the note sent to the recipient in the signing email. + // Metadata that indicates whether the `note` property is editable. Read only. NoteMetadata *PropertyMetadata `json:"noteMetadata,omitempty"` - // A complex type that contains the following elements: + // When `idCheckConfigurationName` is set to `Phone Auth $`, you use this complex type to provide the recipient authentication method details. It contains the following elements: + // + // * `recipMayProvideNumber`: Boolean. When set to **true**, the recipient can use whatever phone number they choose. + // * `senderProvidedNumbers`: ArrayOfStrings. A list of phone numbers the recipient can use. + // * `recordVoicePrint`: Reserved for DocuSign. + // * `validateRecipProvidedNumber`: Reserved for DocuSign. + // // - // * `recipMayProvideNumber` - Boolean. When set to **true**, the recipient can use whatever phone number they choose. - // * `senderProvidedNumbers` - ArrayOfString. A list of phone numbers the recipient can use. - // * `recordVoicePrint` - Reserved. - // * `validateRecipProvidedNumber` - Reserved. PhoneAuthentication DSBool `json:"phoneAuthentication,omitempty"` + // The proof file of the recipient. + ProofFile *RecipientProofFile `json:"proofFile,omitempty"` // Reserved for DocuSign. RecipientAttachments []RecipientAttachment `json:"recipientAttachments,omitempty"` - // Information about the recipient's authentication status. + // Information about the recipient's authentication status. Read only. RecipientAuthenticationStatus *AuthenticationStatus `json:"recipientAuthenticationStatus,omitempty"` - // Metadata about the features that are supported for the recipient type. + // Metadata about the features that are supported for the recipient type. Read only. RecipientFeatureMetadata []FeatureAvailableMetadata `json:"recipientFeatureMetadata,omitempty"` - // A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`. + // Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. RecipientID string `json:"recipientId,omitempty"` - // The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. + // The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only. RecipientIDGUID string `json:"recipientIdGuid,omitempty"` // The default signature provider is the DocuSign Electronic signature system. This parameter is used to specify one or more Standards Based Signature (digital signature) providers for the signer to use. [More information.](https://developers.docusign.com/esign-rest-api/guides/standards-based-signatures) RecipientSignatureProviders []RecipientSignatureProvider `json:"recipientSignatureProviders,omitempty"` - // Specifies whether the recipient creates the tabs. + // When set to **true**, specifies that the recipient creates the tabs. RecipientSuppliesTabs string `json:"recipientSuppliesTabs,omitempty"` // The recipient type, as specified by the following values: - // - `agents`: Agent recipients can add name and email information for recipients that appear after the agent in routing order. - // - `carbonCopies`: Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date, or add information to any of the documents. This type of recipient can be used in any routing order. - // - `certifiedDeliveries`: Certified delivery recipients must receive the completed documents for the envelope to be completed. They don't need to sign, initial, date, or add information to any of the documents. - // - `editors`: Editors have the same management and access rights for the envelope as the sender. Editors can add name and email information, add or change the routing order, set authentication options, and can edit signature/initial tabs and data fields for the remaining recipients. - // - `inPersonSigners`: In-person recipients are DocuSign users who act as signing hosts in the same physical location as the signer. + // - `agent`: Agent recipients can add name and email information for recipients that appear after the agent in routing order. + // - `carbonCopy`: Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date, or add information to any of the documents. This type of recipient can be used in any routing order. + // - `certifiedDelivery`: Certified delivery recipients must receive the completed documents for the envelope to be completed. They don't need to sign, initial, date, or add information to any of the documents. + // - `editor`: Editors have the same management and access rights for the envelope as the sender. Editors can add name and email information, add or change the routing order, set authentication options, and can edit signature/initial tabs and data fields for the remaining recipients. + // - `inPersonSigner`: In-person recipients are DocuSign users who act as signing hosts in the same physical location as the signer. // - `intermediaries`: Intermediary recipients can optionally add name and email information for recipients at the same or subsequent level in the routing order. - // - `seals`: Electronic seal recipients represent legal entities. - // - `signers`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope. - // - `witnesses`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope. + // - `seal`: Electronic seal recipients represent legal entities. + // - `signer`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope. + // - `witness`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope. RecipientType string `json:"recipientType,omitempty"` - // Metadata that indicates if the sender can edit the recipient type. + // Metadata that indicates whether the `recipientType` property is editable. Read only. RecipientTypeMetadata *PropertyMetadata `json:"recipientTypeMetadata,omitempty"` // When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. RequireIDLookup DSBool `json:"requireIdLookup,omitempty"` - // Metadata that indicates whether the `requireIdLookup` property is editable. - // + // Metadata that indicates whether the `requireIdLookup` property is editable. Read only. RequireIDLookupMetadata *PropertyMetadata `json:"requireIdLookupMetadata,omitempty"` // When set to **true**, the signer must print, sign, and upload or fax the signed documents to DocuSign. RequireSignOnPaper DSBool `json:"requireSignOnPaper,omitempty"` - // By default, DocuSign signers create electronic signatures. This field can be used to require the signer to use a SAFE-BioPharma digital certificate for signing. + // Sets the type of signer certificate required for signing. If left blank, no certificate is required. Only one type of certificate can be set for a signer. The possible values are: // - // This parameter should only be used to select a SAFE-BioPharma certificate. New integrations should use the `recipientSignatureProviders` parameter for other types of digital certificates. + // * docusign_express – Requires a DocuSign Express certificate. + // * safe – Requires a SAFE-BioPharma certificate. + // * open_trust – Requires an OpenTrust certificate. // - // Set this parameter to `safe` to use a SAFE-BioPharma certificate. + // **Important**: There are certain rules and restrictions that must be followed when requiring OpenTrust digital signatures. See [ML:OpenTrust Rules and Restrictions] for more information. // - // The signer must be enrolled in the SAFE program to sign with a SAFE certificate. RequireSignerCertificate string `json:"requireSignerCertificate,omitempty"` - // Optional element. Specifies the role name associated with the recipient.

This is required when working with template recipients. + // When set to **true**, the signer is required to upload a new signature, even if they have a pre-adopted signature in their personal DocuSign account. + RequireUploadSignature string `json:"requireUploadSignature,omitempty"` + // Optional element. Specifies the role name associated with the recipient.

This property is required when you are working with template recipients. RoleName string `json:"roleName,omitempty"` // Specifies the routing order of the recipient in the envelope. RoutingOrder string `json:"routingOrder,omitempty"` - // Metadata that indicates if the sender can edit the routing order for the recipient. + // Metadata that indicates whether the `routingOrder` property is editable. Read only. RoutingOrderMetadata *PropertyMetadata `json:"routingOrderMetadata,omitempty"` - // The date and time the envelope was sent. + // The UTC DateTime when the envelope was sent. Read only. SentDateTime *time.Time `json:"sentDateTime,omitempty"` // When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab (instead of adopting a signature/initial style or only drawing a signature/initial once). SignInEachLocation DSBool `json:"signInEachLocation,omitempty"` - // Metadata that indicates whether the `signInEachLocation` property is editable. - // + // Metadata that indicates whether the `signInEachLocation` property is editable. Read only. SignInEachLocationMetadata *PropertyMetadata `json:"signInEachLocationMetadata,omitempty"` // Allows the sender to pre-specify the signature name, signature initials and signature font used in the signature stamp for the recipient. // // Used only with recipient types In Person Signers and Signers. - // SignatureInfo *RecipientSignatureInformation `json:"signatureInfo,omitempty"` // Reserved for DocuSign. SignedDateTime *time.Time `json:"signedDateTime,omitempty"` - // The id of the signing group of which the recipient is a member, if applicable. + // When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once). SigningGroupID string `json:"signingGroupId,omitempty"` - // Metadata that indicates if the sender can edit the signing group id. + // Metadata that indicates whether the `signingGroupId` property is editable. Read only. SigningGroupIDMetadata *PropertyMetadata `json:"signingGroupIdMetadata,omitempty"` - // The display name for the signing group. + // Optional. The name of the signing group. // // Maximum Length: 100 characters. SigningGroupName string `json:"signingGroupName,omitempty"` // A complex type that contains information about users in the signing group. SigningGroupUsers []UserInfo `json:"signingGroupUsers,omitempty"` - // Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication. + // When `idCheckConfigurationName` is set to `SMS Auth $`, you use this complex type to provide the recipient authentication method details. It contains the element `senderProvidedNumbers`, which is an array of phone numbers that the recipient can use for SMS text authentication. + // // SmsAuthentication *RecipientSMSAuthentication `json:"smsAuthentication,omitempty"` - // Lists the social ID type that can be used for recipient authentication. + // Deprecated. SocialAuthentications []SocialAuthentication `json:"socialAuthentications,omitempty"` - // Recipient status. - // + // Specifies the status of the recipient at the time of the request. Read only. Possible values are: + // + // - `created`: The recipient is in a draft state. This is only associated with draft envelopes (envelopes with a created status). + // - `sent`: The recipient has been sent an email notification that it is their turn to sign an envelope. + // - `delivered`: The recipient has viewed the documents in an envelope through the DocuSign signing web site. This is not an email delivery of the documents in an envelope. + // - `signed`; The recipient has completed (performed all required interactions, such as signing or entering data) all required tags in an envelope. This is a temporary state during processing, after which the recipient is automatically moved to completed. + // - `declined`: The recipient declined to sign the documents in the envelope. + // - `completed`: The recipient has completed their actions (signing or other required actions if not a signer) for an envelope. + // - `faxpending`: The recipient has finished signing and the system is waiting a fax attachment by the recipient before completing their signing step. + // - `autoresponded`: The recipient's email system auto-responded to the email from DocuSign. This status is used by the DocuSign webapp (also known as the DocuSign console) to inform senders about the auto-responded email. // Status string `json:"status,omitempty"` // Reserved for DocuSign. StatusCode string `json:"statusCode,omitempty"` + // When set to **true**, email notifications are suppressed for the recipient, and they must access envelopes and documents from their DocuSign inbox. + SuppressEmails string `json:"suppressEmails,omitempty"` // The tabs to assign to the recipient. + // [More information](https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/). Tabs *Tabs `json:"tabs,omitempty"` // When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. TemplateLocked DSBool `json:"templateLocked,omitempty"` // When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. TemplateRequired DSBool `json:"templateRequired,omitempty"` - // The total number of tabs in the documents. + // The total number of tabs in the documents. Read only. TotalTabCount string `json:"totalTabCount,omitempty"` // The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing. // @@ -11929,13 +18074,19 @@ type SignerAttachment struct { TabBase TabGuidedForm TabPosition + // + AnchorAllowWhiteSpaceInCharacters string `json:"anchorAllowWhiteSpaceInCharacters,omitempty"` + // + AnchorAllowWhiteSpaceInCharactersMetadata *PropertyMetadata `json:"anchorAllowWhiteSpaceInCharactersMetadata,omitempty"` // The height of the tab in pixels. Height string `json:"height,omitempty"` // Metadata that indicates whether the `height` property is editable. HeightMetadata *PropertyMetadata `json:"heightMetadata,omitempty"` + // + MergeFieldXML string `json:"mergeFieldXml,omitempty"` // The name of the tab. For example, `Sign Here` or `Initial Here`. Name string `json:"name,omitempty"` - // Metadata that indicates whether the `name` property is editable. + // Metadata that indicates whether the `name` property is editable. Read only. NameMetadata *PropertyMetadata `json:"nameMetadata,omitempty"` // When set to **true**, the recipient does not need to complete this tab to complete the signing process. Optional DSBool `json:"optional,omitempty"` @@ -11945,6 +18096,8 @@ type SignerAttachment struct { ScaleValue string `json:"scaleValue,omitempty"` // Metadata that indicates whether the `scaleValue` property is editable. ScaleValueMetadata *PropertyMetadata `json:"scaleValueMetadata,omitempty"` + // + SmartContractInformation *SmartContractInformation `json:"smartContractInformation,omitempty"` // Metadata that indicates whether the `toolTip` property is editable. ToolTipMetadata *PropertyMetadata `json:"toolTipMetadata,omitempty"` // The text of a tooltip that appears when a user hovers over a form field or tab. @@ -11963,7 +18116,7 @@ type SignerEmailNotifications struct { CarbonCopyNotification DSBool `json:"carbonCopyNotification,omitempty"` // When set to **true**, the user receives notifications of certified deliveries. CertifiedDeliveryNotification DSBool `json:"certifiedDeliveryNotification,omitempty"` - // When set to **true**, the user receives only comments in which that user name is mentioned. + // When set to **true**, the user receives only comments that mention their own user name. CommentsOnlyPrivateAndMention string `json:"commentsOnlyPrivateAndMention,omitempty"` // When set to **true**, the user receives all comments. CommentsReceiveAll string `json:"commentsReceiveAll,omitempty"` @@ -11971,7 +18124,7 @@ type SignerEmailNotifications struct { DocumentMarkupActivation DSBool `json:"documentMarkupActivation,omitempty"` // When set to **true**, the user receives notification that the envelope has been activated. EnvelopeActivation DSBool `json:"envelopeActivation,omitempty"` - // When set to **true**, the user receives notification that the envelope has been completed. + // When set to **true**, the user receives an email notification when the envelope has been completed. EnvelopeComplete DSBool `json:"envelopeComplete,omitempty"` // When set to **true**, the user receives notification that the envelope has been corrected. EnvelopeCorrected DSBool `json:"envelopeCorrected,omitempty"` @@ -11981,9 +18134,9 @@ type SignerEmailNotifications struct { EnvelopeVoided DSBool `json:"envelopeVoided,omitempty"` // Reserved for DocuSign. FaxReceived string `json:"faxReceived,omitempty"` - // When set to **true**, the user receives notification if the offline signing failed. + // When set to **true**, the user receives an email notification if offline signing failed. OfflineSigningFailed DSBool `json:"offlineSigningFailed,omitempty"` - // When set to **true**, the user receives notification of document purges. + // When set to **true**, the user receives an email notification when a document purge occurs. PurgeDocuments DSBool `json:"purgeDocuments,omitempty"` // When set to **true**, the user receives notification that the envelope has been reassigned. ReassignedSigner DSBool `json:"reassignedSigner,omitempty"` @@ -11991,29 +18144,30 @@ type SignerEmailNotifications struct { WhenSigningGroupMember string `json:"whenSigningGroupMember,omitempty"` } -// SigningGroup signing groups +// SigningGroup contains details about a signing group. Signing groups enable you to send an envelope to a predefined group of recipients and have any one member of the group sign your documents. When you send an envelope to a signing group, anyone in the group can open it and sign it with their own signature. type SigningGroup struct { - // The UTC DateTime when the workspace user authorization was created. + // The UTC DateTime when the signing group was created. Read only. Created *time.Time `json:"created,omitempty"` - // + // The name of the user who created the signing group. CreatedBy string `json:"createdBy,omitempty"` // This object describes errors that occur. It is only valid for responses and ignored in requests. ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` - // + // The email address for the signing group. You can use a group email address to email all of the group members at the same time. GroupEmail string `json:"groupEmail,omitempty"` // The name of the group. The search_text provided in the call automatically performs a wild card search on group_name. GroupName string `json:"groupName,omitempty"` - // The group type. Potential values for POST and PUT requests include: + // The group type. Possible values include: // // - `adminstrators` // - `everyone` // - `customGroup` + // - `sharedSigningGroup` // // GroupType string `json:"groupType,omitempty"` - // + // The UTC DateTime when the signing group was last modified. Read only. Modified *time.Time `json:"modified,omitempty"` - // User ID (GUID) of the user who last modified this user record. + // The user id (GUID) of the user who last modified this user record. ModifiedBy string `json:"modifiedBy,omitempty"` // When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once). SigningGroupID string `json:"signingGroupId,omitempty"` @@ -12027,7 +18181,7 @@ type SigningGroupInformation struct { } type SigningGroupUser struct { - // Filters returned user records by the specified email address. + // Email string `json:"email,omitempty"` // This object describes errors that occur. It is only valid for responses and ignored in requests. ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` @@ -12037,41 +18191,110 @@ type SigningGroupUser struct { UserName string `json:"userName,omitempty"` } -// SigningGroupUsers signing groups' users type SigningGroupUsers struct { // User management information. Users []SigningGroupUser `json:"users,omitempty"` } +type SmartContractInformation struct { + // + Code string `json:"code,omitempty"` + // A URI containing the user ID. + URI string `json:"uri,omitempty"` +} + type SmartSection struct { TabBase TabGuidedForm - // Reserved for DocuSign. - // + // + AnchorAllowWhiteSpaceInCharacters string `json:"anchorAllowWhiteSpaceInCharacters,omitempty"` + // + AnchorAllowWhiteSpaceInCharactersMetadata *PropertyMetadata `json:"anchorAllowWhiteSpaceInCharactersMetadata,omitempty"` + // This property controls how [anchor tabs][AnchorTabs] are placed. When **true**, the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false**. + // + // For example, when set to **true**, if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When set to **false**, `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. + // + // This functionality uses the following rules: + // + // - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: + // + // $~><|^+= + // + // For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` + // + // - Strings embedded in other strings are ignored during the matching process. + // + // - In words that have dashes, the parts separated by dashes are treated as distinct words. + // + // Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**. + // + // - Letters with accent marks are treated as distinct characters from their unaccented counterparts. + // + // - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. + // + // Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. + // + // - Unlike punctuation, numbers are not ignored when finding anchor words. + // + // Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). + // + // **Note**: You can only specify the value of this property in POST requests. + // + // [AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place AnchorCaseSensitive string `json:"anchorCaseSensitive,omitempty"` - // Reserved for DocuSign. + // Metadata that indicates whether the `anchorCaseSensitive` property is editable. AnchorCaseSensitiveMetadata *PropertyMetadata `json:"anchorCaseSensitiveMetadata,omitempty"` - // Reserved for DocuSign. - // + // This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are : + // + // - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. + // - `right`: Aligns the tab’s left side with the last character of the matching anchor word. + // + // **Note**: You can only specify the value of this property in POST requests. + // + // [AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place // AnchorHorizontalAlignment string `json:"anchorHorizontalAlignment,omitempty"` - // Reserved for DocuSign. + // Metadata that indicates whether the `anchorHorizontalAlignment` property is editable. AnchorHorizontalAlignmentMetadata *PropertyMetadata `json:"anchorHorizontalAlignmentMetadata,omitempty"` // When set to **true**, this tab is ignored if the `anchorString` is not found in the document. AnchorIgnoreIfNotPresent string `json:"anchorIgnoreIfNotPresent,omitempty"` // Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable. AnchorIgnoreIfNotPresentMetadata *PropertyMetadata `json:"anchorIgnoreIfNotPresentMetadata,omitempty"` - // Reserved for DocuSign. - // + // When set to **true**, the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false**. + // + // For example, when set to **true**, if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When set to **false**, if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. + // + // This functionality uses the following rules: + // + // - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: + // + // $~><|^+= + // + // For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` + // + // - Strings embedded in other strings are ignored during the matching process. + // + // - In words that have dashes, the parts separated by dashes are treated as distinct words. + // + // Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**. + // + // - Letters with accent marks are treated as distinct characters from their unaccented counterparts. + // + // - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. + // + // Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. + // + // - Unlike punctuation, numbers are not ignored when finding anchor words. + // + // Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). + // + // + // **Note**: You can only specify the value of this property in POST requests. + // + // [AnchorTab]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place // AnchorMatchWholeWord string `json:"anchorMatchWholeWord,omitempty"` - // Reserved for DocuSign. + // Metadata that indicates whether the `anchorMatchWholeWord` property is editable. AnchorMatchWholeWordMetadata *PropertyMetadata `json:"anchorMatchWholeWordMetadata,omitempty"` // Specifies the string to find in the document and use as the basis for tab placement. AnchorString string `json:"anchorString,omitempty"` @@ -12081,21 +18304,32 @@ type SmartSection struct { AnchorTabProcessorVersion string `json:"anchorTabProcessorVersion,omitempty"` // Reserved for DocuSign. AnchorTabProcessorVersionMetadata *PropertyMetadata `json:"anchorTabProcessorVersionMetadata,omitempty"` - // Specifies the units of the X and Y offset. Units may be pixels, millimeters, centimeters, or inches. + // Specifies units of the + // `anchorXOffset` and + // `anchorYOffset`. + // Valid units are: + // + // - `pixels` + // - `inches` + // - `mms` + // - `cms` + // AnchorUnits string `json:"anchorUnits,omitempty"` // Metadata that indicates whether the `anchorUnits` property is editable. AnchorUnitsMetadata *PropertyMetadata `json:"anchorUnitsMetadata,omitempty"` // Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. + // AnchorXOffset string `json:"anchorXOffset,omitempty"` // Metadata that indicates whether the `anchorXOffset` property is editable. AnchorXOffsetMetadata *PropertyMetadata `json:"anchorXOffsetMetadata,omitempty"` // Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. + // AnchorYOffset string `json:"anchorYOffset,omitempty"` // Metadata that indicates whether the `anchorYOffset` property is editable. AnchorYOffsetMetadata *PropertyMetadata `json:"anchorYOffsetMetadata,omitempty"` // When **true**, the `startAnchor` and `endAnchor` for the Smart Section must match both the case and the content of the strings in the HTML. CaseSensitive bool `json:"caseSensitive,omitempty"` - // The DocuSign-generated custom tab id for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. + // The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. CustomTabID string `json:"customTabId,omitempty"` // Metadata that indicates whether the `customTabId` property is editable. CustomTabIDMetadata *PropertyMetadata `json:"customTabIdMetadata,omitempty"` @@ -12105,7 +18339,7 @@ type SmartSection struct { // // **Note**: A start anchor, an end anchor, or both are required. EndAnchor string `json:"endAnchor,omitempty"` - // The last position in the result set. + // The last index position in the result set. EndPosition *SmartSectionAnchorPosition `json:"endPosition,omitempty"` // This object describes errors that occur. It is only valid for responses and ignored in requests. ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` @@ -12119,6 +18353,8 @@ type SmartSection struct { LockedMetadata *PropertyMetadata `json:"lockedMetadata,omitempty"` // Contains the information necessary to map the tab to a field in SalesForce. MergeField *MergeField `json:"mergeField,omitempty"` + // + MergeFieldXML string `json:"mergeFieldXml,omitempty"` // The type of overlay to draw on the document. The following overlay types are supported: // // - `line` @@ -12127,7 +18363,7 @@ type SmartSection struct { OverlayType string `json:"overlayType,omitempty"` // Metadata that indicates whether the `overlayType` property is editable. OverlayTypeMetadata *PropertyMetadata `json:"overlayTypeMetadata,omitempty"` - // The page number being accessed. + // Specifies the page number on which the tab is located. PageNumber string `json:"pageNumber,omitempty"` // Metadata that indicates whether the `pageNumber` property is editable. PageNumberMetadata *PropertyMetadata `json:"pageNumberMetadata,omitempty"` @@ -12135,15 +18371,17 @@ type SmartSection struct { RemoveEndAnchor bool `json:"removeEndAnchor,omitempty"` // When **true**, removes the start anchor string for the Smart Section from the HTML, preventing it from displaying. RemoveStartAnchor bool `json:"removeStartAnchor,omitempty"` - // When **true**, the tab is shared. + // When set to **true**, this custom tab is shared. Shared string `json:"shared,omitempty"` // Metadata that indicates whether the `shared` property is editable. SharedMetadata *PropertyMetadata `json:"sharedMetadata,omitempty"` + // + SmartContractInformation *SmartContractInformation `json:"smartContractInformation,omitempty"` // Specifies the beginning of the area in the HTML where the display settings will be applied. If you do not specify a start anchor, the beginning of the document will be used by default. // // **Note**: A start anchor, an end anchor, or both are required. StartAnchor string `json:"startAnchor,omitempty"` - // The starting position of the current result set. + // The starting index position of the current result set. StartPosition *SmartSectionAnchorPosition `json:"startPosition,omitempty"` // The status of the tab. Possible values are: // @@ -12158,11 +18396,10 @@ type SmartSection struct { TabID string `json:"tabId,omitempty"` // Metadata that indicates whether the `tabId` property is editable. TabIDMetadata *PropertyMetadata `json:"tabIdMetadata,omitempty"` - // The label string associated with the tab. - // The string may be the empty string. + // The label associated with the tab. This value may be an empty string. // If no value is provided, the tab type is used as the value. // - // Maximum of 500 characters. + // Maximum Length: 500 characters. // TabLabel string `json:"tabLabel,omitempty"` // A positive integer that sets the order the tab is navigated to during signing. @@ -12194,21 +18431,27 @@ type SmartSection struct { XPosition string `json:"xPosition,omitempty"` // Metadata that indicates whether the `xPosition` property is editable. XPositionMetadata *PropertyMetadata `json:"xPositionMetadata,omitempty"` - // This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. + // This property indicates the vertical offset of the object on the page. + // DocuSign uses 72 DPI when determining position. + // Required. May be zero. + // YPosition string `json:"yPosition,omitempty"` // Metadata that indicates whether the `yPosition` property is editable. YPositionMetadata *PropertyMetadata `json:"yPositionMetadata,omitempty"` } type SmartSectionAnchorPosition struct { - // The page number being accessed. + // Specifies the page number on which the tab is located. PageNumber int32 `json:"pageNumber,omitempty"` // This property indicates the horizontal offset of the object on the page. // DocuSign uses 72 DPI when determining position. // Required. May be zero. // XPosition float64 `json:"xPosition,omitempty"` - // This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. + // This property indicates the vertical offset of the object on the page. + // DocuSign uses 72 DPI when determining position. + // Required. May be zero. + // YPosition float64 `json:"yPosition,omitempty"` } @@ -12262,6 +18505,8 @@ type SmartSectionDisplaySettings struct { InlineOuterStyle string `json:"inlineOuterStyle,omitempty"` // The label for the display section when it is expanded from a collapsed state. This label displays only on the first opening and is only valid with the value of the `display` property is `collapsed`. LabelWhenOpened string `json:"labelWhenOpened,omitempty"` + // Enables you to add descriptive text that appears before a collapsed section or continue button. + PreLabel string `json:"preLabel,omitempty"` // When **true** and the section is expanded, the position of the section close is scrolled to the top of the screen. This property is only valid when the value of the `display` property is `collapsed`. ScrollToTopWhenOpened bool `json:"scrollToTopWhenOpened,omitempty"` // Specifies the valid CSS-formatted styles to use on responsive tables. This property is valid only when the value of the `display` property is `responsive_table` or `responsive_table_single_column`. @@ -12269,7 +18514,7 @@ type SmartSectionDisplaySettings struct { } type SocialAccountInformation struct { - // Filters returned user records by the specified email address. + // The users email address. Email string `json:"email,omitempty"` // This object describes errors that occur. It is only valid for responses and ignored in requests. ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` @@ -12277,7 +18522,7 @@ type SocialAccountInformation struct { Provider string `json:"provider,omitempty"` // The ID provided by the Socal Account. SocialID string `json:"socialId,omitempty"` - // The name of the user. + // The full user name for the account. UserName string `json:"userName,omitempty"` } @@ -12297,9 +18542,13 @@ type SSN struct { TabPosition TabStyle TabValue + // + AnchorAllowWhiteSpaceInCharacters string `json:"anchorAllowWhiteSpaceInCharacters,omitempty"` + // + AnchorAllowWhiteSpaceInCharactersMetadata *PropertyMetadata `json:"anchorAllowWhiteSpaceInCharactersMetadata,omitempty"` // When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. // - // When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. + // When an envelope is completed the information is only available to the sender through the Form Data link in the DocuSign Console. The information on the downloaded document remains masked by asterisks. // // This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. ConcealValueOnDocument DSBool `json:"concealValueOnDocument,omitempty"` @@ -12323,6 +18572,8 @@ type SSN struct { MaxLength string `json:"maxLength,omitempty"` // Metadata that indicates whether the `maxLength` property is editable. MaxLengthMetadata *PropertyMetadata `json:"maxLengthMetadata,omitempty"` + // + MergeFieldXML string `json:"mergeFieldXml,omitempty"` // The initial value of the tab when it was sent to the recipient. OriginalValue string `json:"originalValue,omitempty"` // Metadata that indicates whether the `originalValue` property is editable. @@ -12351,6 +18602,8 @@ type SSN struct { Shared DSBool `json:"shared,omitempty"` // Metadata that indicates whether the `shared` property is editable. SharedMetadata *PropertyMetadata `json:"sharedMetadata,omitempty"` + // + SmartContractInformation *SmartContractInformation `json:"smartContractInformation,omitempty"` // Metadata that indicates whether the `toolTip` property is editable. ToolTipMetadata *PropertyMetadata `json:"toolTipMetadata,omitempty"` // The text of a tooltip that appears when a user hovers over a form field or tab. @@ -12391,102 +18644,195 @@ type Ssn9InformationInput struct { Ssn9 string `json:"ssn9,omitempty"` } -type SupportedLanguages struct { +type Stamp struct { + // The UTC date and time when the user adopted the signature. + AdoptedDateTime string `json:"adoptedDateTime,omitempty"` + // The UTC DateTime when the item was created. + CreatedDateTime string `json:"createdDateTime,omitempty"` + // + CustomField string `json:"customField,omitempty"` + // Specifies the area in which a date stamp is placed. This parameter uses pixel positioning to draw a rectangle at the center of the stamp area. The stamp is superimposed on top of this central area. + // + // This property contains the following information about the central rectangle: + // + // - `DateAreaX`: The X axis position of the top-left corner. + // - `DateAreaY`: The Y axis position of the top-left corner. + // - `DateAreaWidth`: The width of the rectangle. + // - `DateAreaHeight`: The height of the rectangle. + DateStampProperties *DateStampProperties `json:"dateStampProperties,omitempty"` + // When set to **true**, users may not resize the stamp. + DisallowUserResizeStamp string `json:"disallowUserResizeStamp,omitempty"` + // This object describes errors that occur. It is only valid for responses and ignored in requests. + ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` + // Optionally specify an external identifier for the user's signature. + ExternalID string `json:"externalID,omitempty"` + // + ImageBase64 string `json:"imageBase64,omitempty"` + // Specificies the type of image. Valid values are: + // + // - `signature_image` + // - `initials_image` + ImageType string `json:"imageType,omitempty"` + // The date and time that the item was last modified. + LastModifiedDateTime string `json:"lastModifiedDateTime,omitempty"` + // The phonetic spelling of the `signatureName`. + PhoneticName string `json:"phoneticName,omitempty"` + // Specifies the user's signature name. + SignatureName string `json:"signatureName,omitempty"` + // The format of a stamp. Valid values are: + // + // - `NameHanko`: The stamp represents only the signer's name. + // - `NameDateHanko`: The stamp represents the signer's name and the date. + StampFormat string `json:"stampFormat,omitempty"` + // The URI for retrieving the image of the user's stamp. + StampImageURI string `json:"stampImageUri,omitempty"` + // The physical height of the stamp image (in millimeters) that the stamp vendor recommends for displaying the image in PDF documents. + StampSizeMM string `json:"stampSizeMM,omitempty"` + // Indicates the envelope status. Valid values are: // + // * sent - The envelope is sent to the recipients. + // * created - The envelope is saved as a draft and can be modified and sent later. + Status string `json:"status,omitempty"` +} + +// SupportedLanguages is a list of supported languages. +type SupportedLanguages struct { + // A list of languages that you can use for a recipient's language setting. These are the languages that you can set for the standard email format and signing view for each recipient. + // + // For example, in the recipient's email notification, this setting affects elements such as the standard introductory text describing the request to sign. It also determines the language used for buttons and tabs in both the email notification and the signing experience. + // + // **Note**: Setting a language for a recipient affects only the DocuSign standard text. Any custom text that you enter for the `emailBody` and `emailSubject` of the notification is not translated, and appears exactly as you enter it. + // + // Example: + // + // ``` + // { + // "languages": [ + // { + // "name": "Arabic (ar)", + // "value": "ar" + // }, + // { + // "name": "Bulgarian (bg)", + // "value": "bg" + // }, + // . + // . + // . + // } + // ``` Languages []NameValue `json:"languages,omitempty"` } type TabAccountSettings struct { - // Boolean that specifies whether the order for tabs used in signing can be set for the account. + // When set to **true**, account users can set a tab order for the signing process. + // + // **Note**: Only Admin users can change this setting. AllowTabOrder DSBool `json:"allowTabOrder,omitempty"` // Metadata that indicates whether the `allowTabOrder` property is editable. // AllowTabOrderMetadata *SettingsMetadata `json:"allowTabOrderMetadata,omitempty"` - // Boolean that specifies whether the approve and decline fields for use in the tagger and when sending envelopes are enabled. + // When **true**, approve and decline tabs are enabled. ApproveDeclineTabsEnabled DSBool `json:"approveDeclineTabsEnabled,omitempty"` // Metadata that indicates whether the `approveDeclineTabs` property is editable. // ApproveDeclineTabsMetadata *SettingsMetadata `json:"approveDeclineTabsMetadata,omitempty"` - // Boolean that specifies whether calculated fields are enabled for the account. + // When **true**, [calculated fields](https://support.docusign.com/en/guides/ndse-user-guide-calculated-fields) are enabled for tabs. CalculatedFieldsEnabled DSBool `json:"calculatedFieldsEnabled,omitempty"` // Metadata that indicates whether the `calculatedFields` property is editable. // CalculatedFieldsMetadata *SettingsMetadata `json:"calculatedFieldsMetadata,omitempty"` - // Metadata that indicates whether the `checkboxTabsEnabled` property is editable. + // Metadata that indicates whether the `checkBoxTabs` property is editable. CheckBoxTabsMetadata *SettingsMetadata `json:"checkBoxTabsMetadata,omitempty"` - // Boolean that specifies whether the checkbox field can be used in the tagger and for sending envelopes. + // When **true**, checkbox tabs are enabled. CheckboxTabsEnabled DSBool `json:"checkboxTabsEnabled,omitempty"` - // Boolean that specifies whether the account can add regular expression (RegEx) field validation to a text field during sending, which will constrict what data the signer can enter. + // When **true**, regular expressions are enabled for tabs that contain data fields. DataFieldRegexEnabled DSBool `json:"dataFieldRegexEnabled,omitempty"` // Metadata that indicates whether the `dataFieldRegex` property is editable. // DataFieldRegexMetadata *SettingsMetadata `json:"dataFieldRegexMetadata,omitempty"` - // Boolean that specifies whether the account enables a sender to change the data field size during sending. + // When **true**, setting character limits for input fields is enabled. DataFieldSizeEnabled DSBool `json:"dataFieldSizeEnabled,omitempty"` // Metadata that indicates whether the `dataFieldSize` property is editable. // DataFieldSizeMetadata *SettingsMetadata `json:"dataFieldSizeMetadata,omitempty"` - // Boolean that specifies whether an account can use the first, last, and email tags when sending an envelope. - FirstLastEmailTabsEnabled DSBool `json:"firstLastEmailTabsEnabled,omitempty"` - // Metadata that indicates whether the `firstLastEmailTabs` property is editable. // + DrawTabsEnabled string `json:"drawTabsEnabled,omitempty"` + // + DrawTabsMetadata *SettingsMetadata `json:"drawTabsMetadata,omitempty"` + // Reserved for DocuSign. + FirstLastEmailTabsEnabled DSBool `json:"firstLastEmailTabsEnabled,omitempty"` + // Reserved for DocuSign. FirstLastEmailTabsMetadata *SettingsMetadata `json:"firstLastEmailTabsMetadata,omitempty"` - // Boolean that specifies whether the account can use the list field in the tagger and when sending envelopes. + // When **true**, list tabs are enabled. ListTabsEnabled DSBool `json:"listTabsEnabled,omitempty"` // Metadata that indicates whether the `listTabs` property is editable. // ListTabsMetadata *SettingsMetadata `json:"listTabsMetadata,omitempty"` - // Boolean that specifies whether the account can use the note field in the tagger and when sending envelopes. + // When **true**, note tabs are enabled. NoteTabsEnabled DSBool `json:"noteTabsEnabled,omitempty"` // Metadata that indicates whether the `noteTabs` property is editable. // NoteTabsMetadata *SettingsMetadata `json:"noteTabsMetadata,omitempty"` - // Boolean that specifies whether the account can use the radio button field in the tagger and when sending envelopes. + // + PrefillTabsEnabled string `json:"prefillTabsEnabled,omitempty"` + // + PrefillTabsMetadata *SettingsMetadata `json:"prefillTabsMetadata,omitempty"` + // When **true**, radio button tabs are enabled. RadioTabsEnabled DSBool `json:"radioTabsEnabled,omitempty"` // Metadata that indicates whether the `radioTabs` property is editable. // RadioTabsMetadata *SettingsMetadata `json:"radioTabsMetadata,omitempty"` - // Boolean that specifies whether an account can create and save custom tabs. + // When **true**, saving custom tabs is enabled. SavingCustomTabsEnabled DSBool `json:"savingCustomTabsEnabled,omitempty"` // Metadata that indicates whether the `savingCustomTabs` property is editable. // SavingCustomTabsMetadata *SettingsMetadata `json:"savingCustomTabsMetadata,omitempty"` - // Boolean that specifies whether a sender can change the recipient to which an existing tag is assigned. + // Reserved for DocuSign. SenderToChangeTabAssignmentsEnabled DSBool `json:"senderToChangeTabAssignmentsEnabled,omitempty"` - // Metadata that indicates whether the `senderToChangeTabAssignments` property is editable. - // + // Reserved for DocuSign. SenderToChangeTabAssignmentsMetadata *SettingsMetadata `json:"senderToChangeTabAssignmentsMetadata,omitempty"` - // Boolean that specifies whether an account member can share custom tabs to other members of the account. + // When **true**, shared custom tabs are enabled. SharedCustomTabsEnabled DSBool `json:"sharedCustomTabsEnabled,omitempty"` // Metadata that indicates whether the `sharedCustomTabs` property is editable. // SharedCustomTabsMetadata *SettingsMetadata `json:"sharedCustomTabsMetadata,omitempty"` - // Boolean that specifies whether an account admin can change the default (generated) name for a field. + // When set to **true**, [data + // labels](https://support.docusign.com/en/videos/Data-Labels) are enabled. + // + // **Note**: Only Admin users can change this setting. + // TabDataLabelEnabled DSBool `json:"tabDataLabelEnabled,omitempty"` // Metadata that indicates whether the `tabDataLabel` property is editable. // TabDataLabelMetadata *SettingsMetadata `json:"tabDataLabelMetadata,omitempty"` - // Boolean that specifies whether an account admin can change the location of a tab by editing x,y props for a field. + // Reserved for DocuSign. TabLocationEnabled DSBool `json:"tabLocationEnabled,omitempty"` - // Metadata that indicates whether the `tabLocation` property is editable. - // + // Reserved for DocuSign. TabLocationMetadata *SettingsMetadata `json:"tabLocationMetadata,omitempty"` - // Boolean that specifies whether an account admin can lock the properties of a field. + // When set to **true**, tab locking is enabled. + // + // **Note**: Only Admin users can change this setting. + // TabLockingEnabled DSBool `json:"tabLockingEnabled,omitempty"` // Metadata that indicates whether the `tabLocking` property is editable. // TabLockingMetadata *SettingsMetadata `json:"tabLockingMetadata,omitempty"` - // Boolean that specifies whether an account admin can scale the size of a field. + // Reserved for DocuSign. TabScaleEnabled DSBool `json:"tabScaleEnabled,omitempty"` - // Metadata that indicates whether the `tabScale` property is editable. - // + // Reserved for DocuSign. TabScaleMetadata *SettingsMetadata `json:"tabScaleMetadata,omitempty"` - // Boolean that specifies whether an account admin can change the text formatting (font, font size, bold, etc) of a field. + // When set to **true**, text formatting (such as font type, font size, + // font color, bold, italic, and underline) is enabled for tabs that + // support formatting. + // + // **Note**: Only Admin users can change this setting. + // TabTextFormattingEnabled DSBool `json:"tabTextFormattingEnabled,omitempty"` // Metadata that indicates whether the `tabTextFormatting` property is editable. // TabTextFormattingMetadata *SettingsMetadata `json:"tabTextFormattingMetadata,omitempty"` - // Boolean that specifies whether the text field can be used in the tagger and for sending envelopes. + // When **true**, text tabs are enabled. TextTabsEnabled DSBool `json:"textTabsEnabled,omitempty"` // Metadata that indicates whether the `textTabs` property is editable. // @@ -12496,32 +18842,95 @@ type TabAccountSettings struct { type TabGroup struct { TabBase TabGuidedForm - // Reserved for DocuSign. - // + // + AnchorAllowWhiteSpaceInCharacters string `json:"anchorAllowWhiteSpaceInCharacters,omitempty"` + // + AnchorAllowWhiteSpaceInCharactersMetadata *PropertyMetadata `json:"anchorAllowWhiteSpaceInCharactersMetadata,omitempty"` + // This property controls how [anchor tabs][AnchorTabs] are placed. When **true**, the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false**. + // + // For example, when set to **true**, if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When set to **false**, `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. + // + // This functionality uses the following rules: + // + // - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: + // + // $~><|^+= + // + // For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` + // + // - Strings embedded in other strings are ignored during the matching process. + // + // - In words that have dashes, the parts separated by dashes are treated as distinct words. + // + // Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**. + // + // - Letters with accent marks are treated as distinct characters from their unaccented counterparts. + // + // - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. + // + // Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. + // + // - Unlike punctuation, numbers are not ignored when finding anchor words. + // + // Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). + // + // **Note**: You can only specify the value of this property in POST requests. + // + // [AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place AnchorCaseSensitive string `json:"anchorCaseSensitive,omitempty"` - // Reserved for DocuSign. + // Metadata that indicates whether the `anchorCaseSensitive` property is editable. AnchorCaseSensitiveMetadata *PropertyMetadata `json:"anchorCaseSensitiveMetadata,omitempty"` - // Reserved for DocuSign. - // + // This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are : + // + // - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. + // - `right`: Aligns the tab’s left side with the last character of the matching anchor word. + // + // **Note**: You can only specify the value of this property in POST requests. + // + // [AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place // AnchorHorizontalAlignment string `json:"anchorHorizontalAlignment,omitempty"` - // Reserved for DocuSign. + // Metadata that indicates whether the `anchorHorizontalAlignment` property is editable. AnchorHorizontalAlignmentMetadata *PropertyMetadata `json:"anchorHorizontalAlignmentMetadata,omitempty"` // When set to **true**, this tab is ignored if the `anchorString` is not found in the document. AnchorIgnoreIfNotPresent string `json:"anchorIgnoreIfNotPresent,omitempty"` // Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable. AnchorIgnoreIfNotPresentMetadata *PropertyMetadata `json:"anchorIgnoreIfNotPresentMetadata,omitempty"` - // Reserved for DocuSign. - // + // When set to **true**, the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false**. + // + // For example, when set to **true**, if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When set to **false**, if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. + // + // This functionality uses the following rules: + // + // - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: + // + // $~><|^+= + // + // For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` + // + // - Strings embedded in other strings are ignored during the matching process. + // + // - In words that have dashes, the parts separated by dashes are treated as distinct words. + // + // Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**. + // + // - Letters with accent marks are treated as distinct characters from their unaccented counterparts. + // + // - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. + // + // Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. + // + // - Unlike punctuation, numbers are not ignored when finding anchor words. + // + // Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). + // + // + // **Note**: You can only specify the value of this property in POST requests. + // + // [AnchorTab]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place // AnchorMatchWholeWord string `json:"anchorMatchWholeWord,omitempty"` - // Reserved for DocuSign. + // Metadata that indicates whether the `anchorMatchWholeWord` property is editable. AnchorMatchWholeWordMetadata *PropertyMetadata `json:"anchorMatchWholeWordMetadata,omitempty"` // Specifies the string to find in the document and use as the basis for tab placement. AnchorString string `json:"anchorString,omitempty"` @@ -12531,19 +18940,30 @@ type TabGroup struct { AnchorTabProcessorVersion string `json:"anchorTabProcessorVersion,omitempty"` // Reserved for DocuSign. AnchorTabProcessorVersionMetadata *PropertyMetadata `json:"anchorTabProcessorVersionMetadata,omitempty"` - // Specifies the units of the X and Y offset. Units may be pixels, millimeters, centimeters, or inches. + // Specifies units of the + // `anchorXOffset` and + // `anchorYOffset`. + // Valid units are: + // + // - `pixels` + // - `inches` + // - `mms` + // - `cms` + // AnchorUnits string `json:"anchorUnits,omitempty"` // Metadata that indicates whether the `anchorUnits` property is editable. AnchorUnitsMetadata *PropertyMetadata `json:"anchorUnitsMetadata,omitempty"` // Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. + // AnchorXOffset string `json:"anchorXOffset,omitempty"` // Metadata that indicates whether the `anchorXOffset` property is editable. AnchorXOffsetMetadata *PropertyMetadata `json:"anchorXOffsetMetadata,omitempty"` // Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. + // AnchorYOffset string `json:"anchorYOffset,omitempty"` // Metadata that indicates whether the `anchorYOffset` property is editable. AnchorYOffsetMetadata *PropertyMetadata `json:"anchorYOffsetMetadata,omitempty"` - // The DocuSign-generated custom tab id for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. + // The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. CustomTabID string `json:"customTabId,omitempty"` // Metadata that indicates whether the `customTabId` property is editable. CustomTabIDMetadata *PropertyMetadata `json:"customTabIdMetadata,omitempty"` @@ -12553,7 +18973,17 @@ type TabGroup struct { GroupLabel string `json:"groupLabel,omitempty"` // Metadata that indicates whether the `groupLabel` property is editable. GroupLabelMetadata *PropertyMetadata `json:"groupLabelMetadata,omitempty"` - // The rule that is selected by default when a user is adding validation for a tab group in the UI. + // Specifies how `maximumAllowed` and `minimumRequired` + // are interpreted when selecting tabs in a `tabGroup`. + // + // Possible values are: + // + // - `SelectAtLeast` + // - `SelectAtMost` + // - `SelectExactly` + // - `SelectARange` + // + // GroupRule string `json:"groupRule,omitempty"` // Metadata that indicates whether the `groupRule` property is editable. GroupRuleMetadata *PropertyMetadata `json:"groupRuleMetadata,omitempty"` @@ -12567,14 +18997,18 @@ type TabGroup struct { MaximumAllowedMetadata *PropertyMetadata `json:"maximumAllowedMetadata,omitempty"` // Contains the information necessary to map the tab to a field in SalesForce. MergeField *MergeField `json:"mergeField,omitempty"` + // + MergeFieldXML string `json:"mergeFieldXml,omitempty"` // The minimum number of of tabs within the `tabGroup` that should be checked, populated, or signed. This property is used for validation. MinimumRequired string `json:"minimumRequired,omitempty"` // Metadata that indicates whether the `minimumRequired` property is editable. MinimumRequiredMetadata *PropertyMetadata `json:"minimumRequiredMetadata,omitempty"` - // The page number being accessed. + // Specifies the page number on which the tab is located. PageNumber string `json:"pageNumber,omitempty"` // Metadata that indicates whether the `pageNumber` property is editable. PageNumberMetadata *PropertyMetadata `json:"pageNumberMetadata,omitempty"` + // + SmartContractInformation *SmartContractInformation `json:"smartContractInformation,omitempty"` // The status of the tab. Possible values are: // // - `active`: The tab is active, but the recipient has not yet interacted with it. @@ -12628,7 +19062,10 @@ type TabGroup struct { XPosition string `json:"xPosition,omitempty"` // Metadata that indicates whether the `xPosition` property is editable. XPositionMetadata *PropertyMetadata `json:"xPositionMetadata,omitempty"` - // This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. + // This property indicates the vertical offset of the object on the page. + // DocuSign uses 72 DPI when determining position. + // Required. May be zero. + // YPosition string `json:"yPosition,omitempty"` // Metadata that indicates whether the `yPosition` property is editable. YPositionMetadata *PropertyMetadata `json:"yPositionMetadata,omitempty"` @@ -12637,36 +19074,108 @@ type TabGroup struct { type TabMetadata struct { // An optional string that is used to auto-match tabs to strings located in the documents of an envelope. Anchor string `json:"anchor,omitempty"` - // Reserved for DocuSign. - // + // This property controls how [anchor tabs][AnchorTabs] are placed. When **true**, the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false**. + // + // For example, when set to **true**, if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When set to **false**, `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. + // + // This functionality uses the following rules: + // + // - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: + // + // $~><|^+= + // + // For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` + // + // - Strings embedded in other strings are ignored during the matching process. + // + // - In words that have dashes, the parts separated by dashes are treated as distinct words. + // + // Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**. + // + // - Letters with accent marks are treated as distinct characters from their unaccented counterparts. + // + // - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. + // + // Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. + // + // - Unlike punctuation, numbers are not ignored when finding anchor words. + // + // Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). + // + // **Note**: You can only specify the value of this property in POST requests. + // + // [AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place AnchorCaseSensitive DSBool `json:"anchorCaseSensitive,omitempty"` - // Reserved for DocuSign. - // + // This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are : + // + // - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. + // - `right`: Aligns the tab’s left side with the last character of the matching anchor word. + // + // **Note**: You can only specify the value of this property in POST requests. + // + // [AnchorTabs]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place // AnchorHorizontalAlignment string `json:"anchorHorizontalAlignment,omitempty"` // When set to **true**, this tab is ignored if the `anchorString` is not found in the document. AnchorIgnoreIfNotPresent DSBool `json:"anchorIgnoreIfNotPresent,omitempty"` - // Reserved for DocuSign. - // + // When set to **true**, the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false**. + // + // For example, when set to **true**, if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When set to **false**, if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. + // + // This functionality uses the following rules: + // + // - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: + // + // $~><|^+= + // + // For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` + // + // - Strings embedded in other strings are ignored during the matching process. + // + // - In words that have dashes, the parts separated by dashes are treated as distinct words. + // + // Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**. + // + // - Letters with accent marks are treated as distinct characters from their unaccented counterparts. + // + // - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. + // + // Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. + // + // - Unlike punctuation, numbers are not ignored when finding anchor words. + // + // Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). + // + // + // **Note**: You can only specify the value of this property in POST requests. + // + // [AnchorTab]: https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place // AnchorMatchWholeWord DSBool `json:"anchorMatchWholeWord,omitempty"` - // Specifies the units of the X and Y offset. Units may be pixels, millimeters, centimeters, or inches. + // Specifies units of the + // `anchorXOffset` and + // `anchorYOffset`. + // Valid units are: + // + // - `pixels` + // - `inches` + // - `mms` + // - `cms` + // AnchorUnits string `json:"anchorUnits,omitempty"` // Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. + // AnchorXOffset string `json:"anchorXOffset,omitempty"` // Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. + // AnchorYOffset string `json:"anchorYOffset,omitempty"` // When set to **true**, the information in the tab is bold. Bold DSBool `json:"bold,omitempty"` + // + Collaborative string `json:"collaborative,omitempty"` // When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. // - // When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. + // When an envelope is completed the information is only available to the sender through the Form Data link in the DocuSign Console. The information on the downloaded document remains masked by asterisks. // // This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. ConcealValueOnDocument DSBool `json:"concealValueOnDocument,omitempty"` @@ -12674,7 +19183,7 @@ type TabMetadata struct { CreatedByDisplayName string `json:"createdByDisplayName,omitempty"` // The userId of the DocuSign user who created this object. CreatedByUserID string `json:"createdByUserId,omitempty"` - // The DocuSign-generated custom tab id for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. + // The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. CustomTabID string `json:"customTabId,omitempty"` // When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. DisableAutoSize DSBool `json:"disableAutoSize,omitempty"` @@ -12742,9 +19251,9 @@ type TabMetadata struct { InitialValue string `json:"initialValue,omitempty"` // When set to **true**, the information in the tab is italic. Italic DSBool `json:"italic,omitempty"` - // + // If the tab is a list, this represents the values that are possible for the tab. Items []string `json:"items,omitempty"` - // Utc date and time the comment was last updated (can only be done by creator.) + // The UTC DateTime this object was last modified. This is in ISO8601 format. LastModified *time.Time `json:"lastModified,omitempty"` // The User Name of the DocuSign user who last modified this object. LastModifiedByDisplayName string `json:"lastModifiedByDisplayName,omitempty"` @@ -12752,40 +19261,57 @@ type TabMetadata struct { LastModifiedByUserID string `json:"lastModifiedByUserId,omitempty"` // When set to **true**, the signer cannot change the data of the custom tab. Locked DSBool `json:"locked,omitempty"` - // + // The maximum number of entry characters supported by the custom tab. MaximumLength string `json:"maximumLength,omitempty"` // Contains the information necessary to map the tab to a field in SalesForce. MergeField *MergeField `json:"mergeField,omitempty"` // Name string `json:"name,omitempty"` + // If the custom tab is for a payment request, this is the external code for the item associated with the charge. For example, this might be your product id. + // + // Example: `SHAK1` // + // Maximum Length: 100 characters. PaymentItemCode string `json:"paymentItemCode,omitempty"` + // If the custom tab is for a payment request, this is the description of the item associated with the charge. + // + // Example: `The Danish play by Shakespeare` // + // Maximum Length: 100 characters. PaymentItemDescription string `json:"paymentItemDescription,omitempty"` + // If the custom tab is for a payment request, this is the name of the item associated with the charge. + // + // Maximum Length: 100 characters. // + // Example: `Hamlet` PaymentItemName string `json:"paymentItemName,omitempty"` + // When set to **true** and shared is true, information must be entered in this field to complete the envelope. + RequireAll string `json:"requireAll,omitempty"` + // Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field. + RequireInitialOnSharedChange string `json:"requireInitialOnSharedChange,omitempty"` // When set to **true**, the signer is required to fill out this tab. Required TabRequired `json:"required,omitempty"` // Sets the size of the tab. This field accepts values from `0.5` to `1.0`, where `1.0` represents full size and `0.5` is 50% of full size. ScaleValue string `json:"scaleValue,omitempty"` // When set to **true**, the radio button is selected. Selected string `json:"selected,omitempty"` - // When **true**, the tab is shared. + // When set to **true**, this custom tab is shared. Shared DSBool `json:"shared,omitempty"` - // If the recipient signs by using a personal stamp that is representative of their signature, this property specifies the stamp type. + // The type of stamp. Valid values are: + // + // - `signature`: A signature image. This is the default value. + // - `stamp`: A stamp image. + // - null StampType string `json:"stampType,omitempty"` // Metadata that indicates whether the `stampType` property is editable. StampTypeMetadata *PropertyMetadata `json:"stampTypeMetadata,omitempty"` - // The label string associated with the tab. - // The string may be the empty string. + // The label associated with the tab. This value may be an empty string. // If no value is provided, the tab type is used as the value. // - // Maximum of 500 characters. + // Maximum Length: 500 characters. // TabLabel string `json:"tabLabel,omitempty"` - // Type of user: - // - `type_owner` - // - `type_participant` + // The type of this tab. Values are: Approve, CheckBox, Company, Date, DateSigned, Decline, Email, EmailAddress, EnvelopeId, FirstName, Formula, FullName, InitialHere, InitialHereOptional, LastName, List, Note, Number, Radio, SignerAttachment, SignHere, SignHereOptional, Ssn, Text, Title, Zip5, or Zip5Dash4. Type string `json:"type,omitempty"` // When set to **true**, the information in the tab is underlined. Underline DSBool `json:"underline,omitempty"` @@ -12798,10 +19324,12 @@ type TabMetadata struct { } type TabMetadataList struct { - // A list of `signHere` tabs, which can be used to add a visual representation for an electronic seal in a document. + // A list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients. Tabs []TabMetadata `json:"tabs,omitempty"` } +// Tabs all of the tabs associated with a recipient. Each property is a list of a type of tab. +// type Tabs struct { // A list of // [Approve tabs][approve]. @@ -12815,7 +19343,7 @@ type Tabs struct { // is recorded as a signature in the envelope history. // The value of an approve tab can't be set. // - // [approve]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/approve + // [approve]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/ // ApproveTabs []Approve `json:"approveTabs,omitempty"` // A list of @@ -12825,11 +19353,19 @@ type Tabs struct { // A Checkbox tab enables the recipient to select a yes/no (on/off) option. This value can be set. // // - // [checkbox]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/checkbox + // [checkbox]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/ // CheckboxTabs []Checkbox `json:"checkboxTabs,omitempty"` // An array of tabs that represents a collection of comments in a comment thread. For example, if a recipient has questions about the content of a document, they can add a comment to the document and control who else can see the comment. This value can't be set. CommentThreadTabs []CommentThread `json:"commentThreadTabs,omitempty"` + // + CommissionCountyTabs []CommissionCounty `json:"commissionCountyTabs,omitempty"` + // + CommissionExpirationTabs []CommissionExpiration `json:"commissionExpirationTabs,omitempty"` + // + CommissionNumberTabs []CommissionNumber `json:"commissionNumberTabs,omitempty"` + // + CommissionStateTabs []CommissionState `json:"commissionStateTabs,omitempty"` // A list of // [Company tabs][company]. // @@ -12838,16 +19374,18 @@ type Tabs struct { // // // - // [company]: https://developers.docusign.com/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/company + // [company]: https://developers.docusign.com/docs/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/company // CompanyTabs []Company `json:"companyTabs,omitempty"` + // + CurrencyTabs []Currency `json:"currencyTabs,omitempty"` // A list of // [Date Signed tabs][dateSigned]. // // // A Date Signed tab displays the date that the recipient signed the document. This value can't be set. // - // [dateSigned]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/dateSigned + // [dateSigned]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/ // DateSignedTabs []DateSigned `json:"dateSignedTabs,omitempty"` // A list of @@ -12858,7 +19396,7 @@ type Tabs struct { // **Note**: If you need to enforce a specific date format, we recommend that you use a Text tab with a validation pattern and validation message. // // - // [date]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/date + // [date]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/ // DateTabs []Date `json:"dateTabs,omitempty"` // A list of @@ -12867,16 +19405,18 @@ type Tabs struct { // A Decline tab enables the recipient to decline the envelope. If the recipient clicks the tab during the signing process, the envelope is voided. The value of this tab can't be set. // // - // [decline]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/decline + // [decline]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/ // DeclineTabs []Decline `json:"declineTabs,omitempty"` + // + DrawTabs []Draw `json:"drawTabs,omitempty"` // A list of // [Email Address tabs][emailAddress]. // // An Email Address tab displays the recipient's email as entered in the recipient information. This value can't be set. // // - // [emailAddress]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/emailAddress + // [emailAddress]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/ // EmailAddressTabs []EmailAddress `json:"emailAddressTabs,omitempty"` // A list of @@ -12892,7 +19432,7 @@ type Tabs struct { // this tab type, the original value of the tab when the // associated envelope was sent is included in the response. // - // [email]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/email + // [email]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/ // EmailTabs []Email `json:"emailTabs,omitempty"` // A list of @@ -12901,7 +19441,7 @@ type Tabs struct { // An Envelope ID tab displays the envelope ID. Recipients cannot enter or change the information in this tab. This value can't be set. // // - // [envelopeId]: https://developers.docusign.com/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/envelopeId + // [envelopeId]: https://developers.docusign.com/docs/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/envelopeId // EnvelopeIDTabs []EnvelopeID `json:"envelopeIdTabs,omitempty"` // A list of @@ -12910,7 +19450,7 @@ type Tabs struct { // A First Name tab displays the recipient's first name. The system automatically populates this field by splitting the name in the recipient information on spaces. This value can't be set. // // - // [firstName]: https://developers.docusign.com/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/firstName + // [firstName]: https://developers.docusign.com/docs/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/firstName // FirstNameTabs []FirstName `json:"firstNameTabs,omitempty"` // A list of [Formula tabs][formulaTab]. @@ -12923,7 +19463,7 @@ type Tabs struct { // // [calculatedfields]: https://support.docusign.com/en/guides/ndse-user-guide-calculated-fields // [paymentguide]: https://support.docusign.com/en/guides/requesting-payments-along-with-signatures - // [formulaTab]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/formulaTab + // [formulaTab]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/ // FormulaTabs []FormulaTab `json:"formulaTabs,omitempty"` // A list of @@ -12932,7 +19472,7 @@ type Tabs struct { // A Full Name tab displays the recipient's full name. This value can't be set. // // - // [fullName]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/fullName + // [fullName]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/ // FullNameTabs []FullName `json:"fullNameTabs,omitempty"` // A list of @@ -12940,7 +19480,7 @@ type Tabs struct { // // This type of tab enables the recipient to initial the document. May be optional. This value can't be set. // - // [initialHere]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/initialHere + // [initialHere]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/ // InitialHereTabs []InitialHere `json:"initialHereTabs,omitempty"` // A list of @@ -12949,16 +19489,17 @@ type Tabs struct { // A Last Name tab displays the recipient's last name. The system automatically populates this field by splitting the name in the recipient information on spaces. This value can't be set. // // - // [lastName]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/lastName + // [lastName]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/ // LastNameTabs []LastName `json:"lastNameTabs,omitempty"` - // A list of [List tabs][list]. + // An array of List tabs. // // A List tab enables the recipient to choose from a list of options. You specify the options in the `listItems` property. This value can't be set. // + // Find descriptions of all tab types in + // the [EnvelopeRecipientTabs Resource][ert]. // - // - // [list]: https://developers.docusign.com/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/list + // [ert]: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ // ListTabs []List `json:"listTabs,omitempty"` // A list of [Notarize tabs][notarize]. @@ -12967,15 +19508,17 @@ type Tabs struct { // // **Note**: Only one notarize tab can appear on a page. // - // [notarize]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/notarize + // [notarize]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/ // NotarizeTabs []Notarize `json:"notarizeTabs,omitempty"` + // + NotarySealTabs []NotarySeal `json:"notarySealTabs,omitempty"` // A list of // [Note tabs][note]. // // A Note tab displays additional information to the recipient in the form of a note. This value can be set. // - // [note]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/note + // [note]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/ // NoteTabs []Note `json:"noteTabs,omitempty"` // A list of @@ -12985,18 +19528,22 @@ type Tabs struct { // // // - // [number]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/number + // [number]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/ // NumberTabs []Number `json:"numberTabs,omitempty"` + // + PhoneNumberTabs []PhoneNumber `json:"phoneNumberTabs,omitempty"` // This type of tab enables the recipient to strike through document text. This value can't be set. PolyLineOverlayTabs []PolyLineOverlay `json:"polyLineOverlayTabs,omitempty"` + // + PrefillTabs *PrefillTabs `json:"prefillTabs,omitempty"` // A list of [Radio Group tabs][radioGroup]. // // A Radio Group tab places a group of radio buttons on a document. The `radios` property is used to add and place the radio // buttons associated with the group. Only one radio button can be selected in a group. This value can be set. // // - // [radioGroup]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/radioGroup + // [radioGroup]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/ // RadioGroupTabs []RadioGroup `json:"radioGroupTabs,omitempty"` // A list of @@ -13004,7 +19551,7 @@ type Tabs struct { // // This type of tab enables the recipient to sign a document. May be optional. This value can't be set. // - // [signHere]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/signHere + // [signHere]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/ // SignHereTabs []SignHere `json:"signHereTabs,omitempty"` // A list of @@ -13013,7 +19560,7 @@ type Tabs struct { // This type of tab enables the recipient to attach supporting documents to an envelope. This value can't be set. // // - // [signerAttachment]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/signerAttachment + // [signerAttachment]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/ // SignerAttachmentTabs []SignerAttachment `json:"signerAttachmentTabs,omitempty"` // A list of [Smart Section](https://www.docusign.com/blog/dsdev-deep-dive-responsive-smart-sections/) tabs. @@ -13029,17 +19576,20 @@ type Tabs struct { // dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for SSN information. This value can be set. // // - // [ssn]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/ssn + // [ssn]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/ // SSNTabs []SSN `json:"ssnTabs,omitempty"` // An array of `tabGroup` items that contain information about tab groups. To assign a tab to a `tabGroup`, you assign the `tabGroupLabel` to the `Tab.TabGroupLabels` array. TabGroups []TabGroup `json:"tabGroups,omitempty"` // A list of - // [Text tabs][text]. + // Text tabs. // // A text tab enables the recipient to enter free text. This value can be set. // - // [text]: https://developers.docusign.com/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/text + // Find descriptions of all tab types in + // the [EnvelopeRecipientTabs Resource][ert]. + // + // [ert]: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ // TextTabs []Text `json:"textTabs,omitempty"` // A list of @@ -13048,7 +19598,7 @@ type Tabs struct { // A Title tab displays the recipient's title. This value can't be set. // // - // [title]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/title + // [title]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/ // TitleTabs []Title `json:"titleTabs,omitempty"` // A list of @@ -13056,7 +19606,7 @@ type Tabs struct { // // A View tab is used with an Approve tab to handle supplemental documents. This value can be set. // - // [view]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/view + // [view]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/ // ViewTabs []View `json:"viewTabs,omitempty"` // A list of @@ -13065,7 +19615,7 @@ type Tabs struct { // A Zip tab enables the recipient to enter a ZIP code. The ZIP code can be five digits or nine digits ( in ZIP+4 format), and can be entered with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for ZIP code information. This value can be set. // // - // [zip]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/zip + // [zip]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/ // ZipTabs []Zip `json:"zipTabs,omitempty"` } @@ -13077,22 +19627,12 @@ type TemplateCustomFields struct { TextCustomFields []TextCustomField `json:"textCustomFields,omitempty"` } -// TemplateDocumentVisibilityList document Visibility enables senders to control the visibility of the documents in an envelope at the recipient level. For example, if the parties associated with a legal proceeding should have access to different documents, the Document Visibility feature enables you to keep all of the documents in the same envelope and set view permissions for the documents by recipient. This functionality is enabled for envelopes and templates. It is not available for PowerForms. -// -// **Note**: Before you use Document Visibility, you should be aware of the following information: -// -// - Document Visibility must be enabled for your account by your DocuSign administrator. -// - A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. -// - When the Document Visibility setting hides a document from a recipient, the document also does not appear in the recipient's list of envelopes, documents, or page images. -// - Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all of the documents associated with the envelope or template. -// -// The Document Visibility feature has multiple settings that specify the options that senders have when sending documents. For more information, see [Use Document Visibility to Control Recipient Access](https://support.docusign.com/en/guides/ndse-user-guide-document-visibility). +// TemplateDocumentVisibilityList is a list of `documentVisibility` objects that specify whether the documents associated with a template are visible to recipients. type TemplateDocumentVisibilityList struct { // An array of `documentVisibility` objects that specifies which documents are visible to which recipients. DocumentVisibility []DocumentVisibility `json:"documentVisibility,omitempty"` } -// TemplateDocumentsResult template documents type TemplateDocumentsResult struct { // An array of document objects that contain information about the documents associated with the template. TemplateDocuments []EnvelopeDocument `json:"templateDocuments,omitempty"` @@ -13134,7 +19674,7 @@ type TemplateRecipients struct { CertifiedDeliveries []CertifiedDelivery `json:"certifiedDeliveries,omitempty"` // The routing order of the current recipient. If this value equals a particular signer's routing order, it indicates that the envelope has been sent to that recipient, but he or she has not completed the required actions. CurrentRoutingOrder string `json:"currentRoutingOrder,omitempty"` - // A list of editors on the document. + // A list of users who can edit the envelope. Editors []Editor `json:"editors,omitempty"` // This object describes errors that occur. It is only valid for responses and ignored in requests. ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` @@ -13142,6 +19682,8 @@ type TemplateRecipients struct { InPersonSigners []InPersonSigner `json:"inPersonSigners,omitempty"` // Identifies a recipient that can, but is not required to, add name and email information for recipients at the same or subsequent level in the routing order (until subsequent Agents, Editors or Intermediaries recipient types are added). Intermediaries []Intermediary `json:"intermediaries,omitempty"` + // + Notaries []NotaryRecipient `json:"notaries,omitempty"` // The list of recipient event statuses that will trigger Connect to send updates to the url. It can be a two-part list with: // // * recipientEventStatusCode - The recipient status, this can be Sent, Delivered, Completed, Declined, AuthenticationFailed, and AutoResponded. @@ -13178,9 +19720,9 @@ type TemplateRole struct { Email string `json:"email,omitempty"` // An optional complex type that sets a specific email subject and body for this recipient's notification email. // - // **Note**: If you use this field to set a specific email notification for one recipient, you must also set the email notification for the other recipients. Using this field for one or more recipients negates the Envelope `Subject` and `EmailBlurb` property settings. + // **Note**: You can set the `emailNotification` property separately for each recipient. If you set the value only for certain recipients, the other recipients will inherit the this value from the top-level `emailSubject` and `emailBlurb`. EmailNotification *RecipientEmailNotification `json:"emailNotification,omitempty"` - // Specifies a sender-provided valid URL string for redirecting an embedded recipient. When this option is used, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the recipient clicks the document link in the email, the recipient is redirected through DocuSign to the specified URL to complete the required actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. + // Specifies a sender-provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. // // If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation launched by a partner. // @@ -13200,13 +19742,13 @@ type TemplateRole struct { Name string `json:"name,omitempty"` // The default signature provider is the DocuSign Electronic signature system. This parameter is used to specify one or more Standards Based Signature (digital signature) providers for the signer to use. [More information.](https://developers.docusign.com/esign-rest-api/guides/standards-based-signatures) RecipientSignatureProviders []RecipientSignatureProvider `json:"recipientSignatureProviders,omitempty"` - // Optional element. Specifies the role name associated with the recipient.

This is required when working with template recipients. + // Optional element. Specifies the role name associated with the recipient.

This property is required when you are working with template recipients. RoleName string `json:"roleName,omitempty"` // Specifies the routing order of the recipient in the envelope. RoutingOrder string `json:"routingOrder,omitempty"` - // The id of the signing group of which the recipient is a member, if applicable. + // When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once). SigningGroupID string `json:"signingGroupId,omitempty"` - // A list of `signHere` tabs, which can be used to add a visual representation for an electronic seal in a document. + // A list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients. Tabs *Tabs `json:"tabs,omitempty"` } @@ -13222,8 +19764,6 @@ type TemplateSharedItem struct { // // - `not_shared` // - `shared_to` - // - `shared_from` - // - `shared_to_and_from` // Shared DSBool `json:"shared,omitempty"` // List of groups that share the template. @@ -13252,7 +19792,7 @@ type TemplateSummary struct { TemplateID string `json:"templateId,omitempty"` // TemplateMatch *TemplateMatch `json:"templateMatch,omitempty"` - // URI containing the user ID. + // A URI containing the user ID. URI string `json:"uri,omitempty"` } @@ -13269,7 +19809,7 @@ type TemplateTabs struct { // is recorded as a signature in the envelope history. // The value of an approve tab can't be set. // - // [approve]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/approve + // [approve]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/ // ApproveTabs []Approve `json:"approveTabs,omitempty"` // A list of @@ -13279,11 +19819,19 @@ type TemplateTabs struct { // A Checkbox tab enables the recipient to select a yes/no (on/off) option. This value can be set. // // - // [checkbox]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/checkbox + // [checkbox]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/ // CheckboxTabs []Checkbox `json:"checkboxTabs,omitempty"` // An array of tabs that represents a collection of comments in a comment thread. For example, if a recipient has questions about the content of a document, they can add a comment to the document and control who else can see the comment. This value can't be set. CommentThreadTabs []CommentThread `json:"commentThreadTabs,omitempty"` + // + CommissionCountyTabs []CommissionCounty `json:"commissionCountyTabs,omitempty"` + // + CommissionExpirationTabs []CommissionExpiration `json:"commissionExpirationTabs,omitempty"` + // + CommissionNumberTabs []CommissionNumber `json:"commissionNumberTabs,omitempty"` + // + CommissionStateTabs []CommissionState `json:"commissionStateTabs,omitempty"` // A list of // [Company tabs][company]. // @@ -13292,16 +19840,18 @@ type TemplateTabs struct { // // // - // [company]: https://developers.docusign.com/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/company + // [company]: https://developers.docusign.com/docs/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/company // CompanyTabs []Company `json:"companyTabs,omitempty"` + // + CurrencyTabs []Currency `json:"currencyTabs,omitempty"` // A list of // [Date Signed tabs][dateSigned]. // // // A Date Signed tab displays the date that the recipient signed the document. This value can't be set. // - // [dateSigned]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/dateSigned + // [dateSigned]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/ // DateSignedTabs []DateSigned `json:"dateSignedTabs,omitempty"` // A list of @@ -13312,7 +19862,7 @@ type TemplateTabs struct { // **Note**: If you need to enforce a specific date format, we recommend that you use a Text tab with a validation pattern and validation message. // // - // [date]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/date + // [date]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/ // DateTabs []Date `json:"dateTabs,omitempty"` // A list of @@ -13321,16 +19871,18 @@ type TemplateTabs struct { // A Decline tab enables the recipient to decline the envelope. If the recipient clicks the tab during the signing process, the envelope is voided. The value of this tab can't be set. // // - // [decline]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/decline + // [decline]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/ // DeclineTabs []Decline `json:"declineTabs,omitempty"` + // + DrawTabs []Draw `json:"drawTabs,omitempty"` // A list of // [Email Address tabs][emailAddress]. // // An Email Address tab displays the recipient's email as entered in the recipient information. This value can't be set. // // - // [emailAddress]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/emailAddress + // [emailAddress]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/ // EmailAddressTabs []EmailAddress `json:"emailAddressTabs,omitempty"` // A list of @@ -13346,7 +19898,7 @@ type TemplateTabs struct { // this tab type, the original value of the tab when the // associated envelope was sent is included in the response. // - // [email]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/email + // [email]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/ // EmailTabs []Email `json:"emailTabs,omitempty"` // A list of @@ -13355,7 +19907,7 @@ type TemplateTabs struct { // An Envelope ID tab displays the envelope ID. Recipients cannot enter or change the information in this tab. This value can't be set. // // - // [envelopeId]: https://developers.docusign.com/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/envelopeId + // [envelopeId]: https://developers.docusign.com/docs/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/envelopeId // EnvelopeIDTabs []EnvelopeID `json:"envelopeIdTabs,omitempty"` // A list of @@ -13364,7 +19916,7 @@ type TemplateTabs struct { // A First Name tab displays the recipient's first name. The system automatically populates this field by splitting the name in the recipient information on spaces. This value can't be set. // // - // [firstName]: https://developers.docusign.com/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/firstName + // [firstName]: https://developers.docusign.com/docs/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/firstName // FirstNameTabs []FirstName `json:"firstNameTabs,omitempty"` // A list of [Formula tabs][formulaTab]. @@ -13377,7 +19929,7 @@ type TemplateTabs struct { // // [calculatedfields]: https://support.docusign.com/en/guides/ndse-user-guide-calculated-fields // [paymentguide]: https://support.docusign.com/en/guides/requesting-payments-along-with-signatures - // [formulaTab]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/formulaTab + // [formulaTab]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/ // FormulaTabs []FormulaTab `json:"formulaTabs,omitempty"` // A list of @@ -13386,7 +19938,7 @@ type TemplateTabs struct { // A Full Name tab displays the recipient's full name. This value can't be set. // // - // [fullName]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/fullName + // [fullName]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/ // FullNameTabs []FullName `json:"fullNameTabs,omitempty"` // A list of @@ -13394,7 +19946,7 @@ type TemplateTabs struct { // // This type of tab enables the recipient to initial the document. May be optional. This value can't be set. // - // [initialHere]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/initialHere + // [initialHere]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/ // InitialHereTabs []InitialHere `json:"initialHereTabs,omitempty"` // A list of @@ -13403,16 +19955,17 @@ type TemplateTabs struct { // A Last Name tab displays the recipient's last name. The system automatically populates this field by splitting the name in the recipient information on spaces. This value can't be set. // // - // [lastName]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/lastName + // [lastName]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/ // LastNameTabs []LastName `json:"lastNameTabs,omitempty"` - // A list of [List tabs][list]. + // An array of List tabs. // // A List tab enables the recipient to choose from a list of options. You specify the options in the `listItems` property. This value can't be set. // + // Find descriptions of all tab types in + // the [EnvelopeRecipientTabs Resource][ert]. // - // - // [list]: https://developers.docusign.com/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/list + // [ert]: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ // ListTabs []List `json:"listTabs,omitempty"` // A list of [Notarize tabs][notarize]. @@ -13421,15 +19974,17 @@ type TemplateTabs struct { // // **Note**: Only one notarize tab can appear on a page. // - // [notarize]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/notarize + // [notarize]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/ // NotarizeTabs []Notarize `json:"notarizeTabs,omitempty"` + // + NotarySealTabs []NotarySeal `json:"notarySealTabs,omitempty"` // A list of // [Note tabs][note]. // // A Note tab displays additional information to the recipient in the form of a note. This value can be set. // - // [note]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/note + // [note]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/ // NoteTabs []Note `json:"noteTabs,omitempty"` // A list of @@ -13439,18 +19994,22 @@ type TemplateTabs struct { // // // - // [number]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/number + // [number]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/ // NumberTabs []Number `json:"numberTabs,omitempty"` + // + PhoneNumberTabs []PhoneNumber `json:"phoneNumberTabs,omitempty"` // This type of tab enables the recipient to strike through document text. This value can't be set. PolyLineOverlayTabs []PolyLineOverlay `json:"polyLineOverlayTabs,omitempty"` + // + PrefillTabs *PrefillTabs `json:"prefillTabs,omitempty"` // A list of [Radio Group tabs][radioGroup]. // // A Radio Group tab places a group of radio buttons on a document. The `radios` property is used to add and place the radio // buttons associated with the group. Only one radio button can be selected in a group. This value can be set. // // - // [radioGroup]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/radioGroup + // [radioGroup]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/ // RadioGroupTabs []RadioGroup `json:"radioGroupTabs,omitempty"` // A list of @@ -13458,7 +20017,7 @@ type TemplateTabs struct { // // This type of tab enables the recipient to sign a document. May be optional. This value can't be set. // - // [signHere]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/signHere + // [signHere]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/ // SignHereTabs []SignHere `json:"signHereTabs,omitempty"` // A list of @@ -13467,7 +20026,7 @@ type TemplateTabs struct { // This type of tab enables the recipient to attach supporting documents to an envelope. This value can't be set. // // - // [signerAttachment]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/signerAttachment + // [signerAttachment]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/ // SignerAttachmentTabs []SignerAttachment `json:"signerAttachmentTabs,omitempty"` // A list of [Smart Section](https://www.docusign.com/blog/dsdev-deep-dive-responsive-smart-sections/) tabs. @@ -13483,17 +20042,20 @@ type TemplateTabs struct { // dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for SSN information. This value can be set. // // - // [ssn]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/ssn + // [ssn]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/ // SSNTabs []SSN `json:"ssnTabs,omitempty"` // An array of `tabGroup` items that contain information about tab groups. To assign a tab to a `tabGroup`, you assign the `tabGroupLabel` to the `Tab.TabGroupLabels` array. TabGroups []TabGroup `json:"tabGroups,omitempty"` // A list of - // [Text tabs][text]. + // Text tabs. // // A text tab enables the recipient to enter free text. This value can be set. // - // [text]: https://developers.docusign.com/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/text + // Find descriptions of all tab types in + // the [EnvelopeRecipientTabs Resource][ert]. + // + // [ert]: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ // TextTabs []Text `json:"textTabs,omitempty"` // A list of @@ -13502,7 +20064,7 @@ type TemplateTabs struct { // A Title tab displays the recipient's title. This value can't be set. // // - // [title]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/title + // [title]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/ // TitleTabs []Title `json:"titleTabs,omitempty"` // A list of @@ -13510,7 +20072,7 @@ type TemplateTabs struct { // // A View tab is used with an Approve tab to handle supplemental documents. This value can be set. // - // [view]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/view + // [view]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/ // ViewTabs []View `json:"viewTabs,omitempty"` // A list of @@ -13519,13 +20081,13 @@ type TemplateTabs struct { // A Zip tab enables the recipient to enter a ZIP code. The ZIP code can be five digits or nine digits ( in ZIP+4 format), and can be entered with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for ZIP code information. This value can be set. // // - // [zip]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/zip + // [zip]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/ // ZipTabs []Zip `json:"zipTabs,omitempty"` } type TemplateUpdateSummary struct { - // + // An object that describes the status of the bulk send envelopes. BulkEnvelopeStatus *BulkEnvelopeStatus `json:"bulkEnvelopeStatus,omitempty"` // The envelope ID of the envelope status that failed to post. EnvelopeID string `json:"envelopeId,omitempty"` @@ -13562,9 +20124,13 @@ type Text struct { TabPosition TabStyle TabValue + // + AnchorAllowWhiteSpaceInCharacters string `json:"anchorAllowWhiteSpaceInCharacters,omitempty"` + // + AnchorAllowWhiteSpaceInCharactersMetadata *PropertyMetadata `json:"anchorAllowWhiteSpaceInCharactersMetadata,omitempty"` // When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. // - // When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. + // When an envelope is completed the information is only available to the sender through the Form Data link in the DocuSign Console. The information on the downloaded document remains masked by asterisks. // // This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. ConcealValueOnDocument DSBool `json:"concealValueOnDocument,omitempty"` @@ -13610,10 +20176,6 @@ type Text struct { Height string `json:"height,omitempty"` // Metadata that indicates whether the `height` property is editable. HeightMetadata *PropertyMetadata `json:"heightMetadata,omitempty"` - // When set to **true**, sets this as a payment tab. Can only be used with Text, Number, Formula, or List tabs. The value of the tab must be a number. - IsPaymentAmount DSBool `json:"isPaymentAmount,omitempty"` - // Metadata that indicates whether the `isPaymentAmount` property is editable. - IsPaymentAmountMetadata *PropertyMetadata `json:"isPaymentAmountMetadata,omitempty"` // Reserved for DocuSign. LocalePolicy *LocalePolicyTab `json:"localePolicy,omitempty"` // When set to **true**, the signer cannot change the data of the custom tab. @@ -13624,6 +20186,8 @@ type Text struct { MaxLength string `json:"maxLength,omitempty"` // Metadata that indicates whether the `maxLength` property is editable. MaxLengthMetadata *PropertyMetadata `json:"maxLengthMetadata,omitempty"` + // + MergeFieldXML string `json:"mergeFieldXml,omitempty"` // The initial value of the tab when it was sent to the recipient. OriginalValue string `json:"originalValue,omitempty"` // Metadata that indicates whether the `originalValue` property is editable. @@ -13652,6 +20216,8 @@ type Text struct { Shared DSBool `json:"shared,omitempty"` // Metadata that indicates whether the `shared` property is editable. SharedMetadata *PropertyMetadata `json:"sharedMetadata,omitempty"` + // + SmartContractInformation *SmartContractInformation `json:"smartContractInformation,omitempty"` // Metadata that indicates whether the `toolTip` property is editable. ToolTipMetadata *PropertyMetadata `json:"toolTipMetadata,omitempty"` // The text of a tooltip that appears when a user hovers over a form field or tab. @@ -13670,32 +20236,24 @@ type Text struct { WidthMetadata *PropertyMetadata `json:"widthMetadata,omitempty"` } +// TextCustomField this object represents a free text custom field where envelope creators and senders can enter custom data. type TextCustomField struct { - // If merge fields are being used, specifies the type of the merge field. The only supported value is **salesforce**. + // If you are using merge fields, this property specifies the type of the merge field. The only supported value is `salesforce`. ConfigurationType string `json:"configurationType,omitempty"` // This object describes errors that occur. It is only valid for responses and ignored in requests. ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` - // An ID used to specify a custom field. + // The id of the custom field. FieldID string `json:"fieldId,omitempty"` // The name of the custom field. Name string `json:"name,omitempty"` - // When set to **true**, the signer is required to fill out this tab. + // When set to **true**, senders are required to enter or select information for the field before they can send the envelope. Required TabRequired `json:"required,omitempty"` - // A boolean indicating if the value should be displayed. If this value is set to **true**, the custom field is displayed at the top of the certificate of completion. If this value is left blank/ or set to **false**, then it does not appear in the certificate of completion. + // When set to **true**, the field displays in the **Envelope Custom Fields** section when a user creates or sends an envelope. Show DSBool `json:"show,omitempty"` - // The value of the custom field. + // The value of the custom field. The user who creates or sends the envelope provides this value. Maximum length: 100 characters. Value string `json:"value,omitempty"` } -type TimeStampField struct { - // - DocumentSecurityStore *DocumentSecurityStore `json:"documentSecurityStore,omitempty"` - // - MaxTimeStampSignatureLength string `json:"maxTimeStampSignatureLength,omitempty"` - // - TimeStampFieldName string `json:"timeStampFieldName,omitempty"` -} - // Title is a tab that displays the recipient's title. // type Title struct { @@ -13704,9 +20262,13 @@ type Title struct { TabPosition TabStyle TabValue + // + AnchorAllowWhiteSpaceInCharacters string `json:"anchorAllowWhiteSpaceInCharacters,omitempty"` + // + AnchorAllowWhiteSpaceInCharactersMetadata *PropertyMetadata `json:"anchorAllowWhiteSpaceInCharactersMetadata,omitempty"` // When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. // - // When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. + // When an envelope is completed the information is only available to the sender through the Form Data link in the DocuSign Console. The information on the downloaded document remains masked by asterisks. // // This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. ConcealValueOnDocument DSBool `json:"concealValueOnDocument,omitempty"` @@ -13730,6 +20292,8 @@ type Title struct { MaxLength string `json:"maxLength,omitempty"` // Metadata that indicates whether the `maxLength` property is editable. MaxLengthMetadata *PropertyMetadata `json:"maxLengthMetadata,omitempty"` + // + MergeFieldXML string `json:"mergeFieldXml,omitempty"` // The initial value of the tab when it was sent to the recipient. OriginalValue string `json:"originalValue,omitempty"` // Metadata that indicates whether the `originalValue` property is editable. @@ -13738,6 +20302,8 @@ type Title struct { Required TabRequired `json:"required,omitempty"` // Metadata that indicates whether the `required` property is editable. RequiredMetadata *PropertyMetadata `json:"requiredMetadata,omitempty"` + // + SmartContractInformation *SmartContractInformation `json:"smartContractInformation,omitempty"` // Metadata that indicates whether the `toolTip` property is editable. ToolTipMetadata *PropertyMetadata `json:"toolTipMetadata,omitempty"` // The text of a tooltip that appears when a user hovers over a form field or tab. @@ -13748,52 +20314,6 @@ type Title struct { WidthMetadata *PropertyMetadata `json:"widthMetadata,omitempty"` } -type TspHealthCheckRequest struct { - // - AppVersion string `json:"appVersion,omitempty"` - // A sender-defined description of the line item. - // - Description string `json:"description,omitempty"` - // Server error for the Connect post failure. - Error string `json:"error,omitempty"` - // The status of the item. - Status string `json:"status,omitempty"` - // - StatusDescription []TspHealthCheckStatusDescription `json:"statusDescription,omitempty"` -} - -type TspHealthCheckStatusDescription struct { - // A sender-defined description of the line item. - // - Description string `json:"description,omitempty"` - // Server error for the Connect post failure. - Error string `json:"error,omitempty"` - // - Hostname string `json:"hostname,omitempty"` - // - ResponseSeconds string `json:"responseSeconds,omitempty"` - // The status of the item. - Status string `json:"status,omitempty"` - // Type of user: - // - `type_owner` - // - `type_participant` - Type string `json:"type,omitempty"` -} - -type UpdateTransactionRequest struct { - // - Code string `json:"code,omitempty"` - // - Message string `json:"message,omitempty"` - // The state or province associated with the address. - State string `json:"state,omitempty"` -} - -type UpdateTransactionResponse struct { - // - RedirectionURL string `json:"redirectionUrl,omitempty"` -} - // UsageHistory is a complex element consisting of: // // * lastSentDateTime - the date and time the user last sent an envelope. @@ -13811,21 +20331,6 @@ type UsageHistory struct { SignedCount string `json:"signedCount,omitempty"` } -type User struct { - // - CellPhoneNumber string `json:"cellPhoneNumber,omitempty"` - // The three-letter code for the user's country. - CountryCode string `json:"countryCode,omitempty"` - // - Credentials []Credential `json:"credentials,omitempty"` - // - DisplayName string `json:"displayName,omitempty"` - // Filters returned user records by the specified email address. - Email string `json:"email,omitempty"` - // - ExternalClaims []ExternalClaim `json:"externalClaims,omitempty"` -} - // UserAccountManagementGranularInformation describes which account management capabilities a user has. type UserAccountManagementGranularInformation struct { // **True** if the user can manage account security settings. @@ -13841,6 +20346,10 @@ type UserAccountManagementGranularInformation struct { // Metadata that indicates whether the `canManageAdmins` property is editable. // CanManageAdminsMetadata *SettingsMetadata `json:"canManageAdminsMetadata,omitempty"` + // + CanManageEnvelopeTransfer string `json:"canManageEnvelopeTransfer,omitempty"` + // + CanManageEnvelopeTransferMetadata *SettingsMetadata `json:"canManageEnvelopeTransferMetadata,omitempty"` // **True** if the user can manage reporting. CanManageReporting DSBool `json:"canManageReporting,omitempty"` // @@ -13859,26 +20368,28 @@ type UserAccountManagementGranularInformation struct { // Metadata that indicates whether the `canManageUsers` property is editable. // CanManageUsersMetadata *SettingsMetadata `json:"canManageUsersMetadata,omitempty"` + // + CanViewUsers string `json:"canViewUsers,omitempty"` } type UserInfo struct { - // The external account number (int) or account ID GUID. + // The account ID associated with the envelope. AccountID string `json:"accountId,omitempty"` - // The name of the account associated with the current workspace user. + // The name on the account. AccountName string `json:"accountName,omitempty"` // Access code provided to the user to activate the account. ActivationAccessCode string `json:"activationAccessCode,omitempty"` - // Filters returned user records by the specified email address. + // The user's email address. Email string `json:"email,omitempty"` // This object describes errors that occur. It is only valid for responses and ignored in requests. ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` - // Boolean value that indicates whether the user is currently logged in or not. + // When set to **true**, indicates that the user is logged in. This is a read-only property. LoginStatus string `json:"loginStatus,omitempty"` // The user's membership ID. MembershipID string `json:"membershipId,omitempty"` - // When set to **true**, specifies that an activation email be sent to the user. + // When set to **true**, specifies that an activation email will be sent to the user. SendActivationEmail string `json:"sendActivationEmail,omitempty"` - // URI containing the user ID. + // A URI containing the user ID. URI string `json:"uri,omitempty"` // The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing. // @@ -13903,21 +20414,7 @@ type UserInfoList struct { Users []UserInfo `json:"users,omitempty"` } -type UserInfoResponse struct { - // The envelope's GUID. - // - // Example: `93be49ab-afa0-4adf-933c-f752070d71ec` - EnvelopeID string `json:"envelopeId,omitempty"` - // Specifies the language for the Certificate of Completion in the response. The supported languages are: Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Dutch (nl), English US (en), French (fr), German (de), Italian (it), Japanese (ja), Korean (ko), Portuguese (pt), Portuguese (Brazil) (pt_BR), Russian (ru), Spanish (es). - Language string `json:"language,omitempty"` - // Set of information related to the electronic seal used by the Trust Service Provider (TSP). - Seal *Seal `json:"seal,omitempty"` - // Information about the sender of the envelope. - Sender *Sender `json:"sender,omitempty"` - // - User *User `json:"user,omitempty"` -} - +// UserInformation user information. type UserInformation struct { // Access code provided to the user to activate the account. ActivationAccessCode string `json:"activationAccessCode,omitempty"` @@ -13927,13 +20424,13 @@ type UserInformation struct { ConnectConfigurations []ConnectUserObject `json:"connectConfigurations,omitempty"` // The three-letter code for the user's country. CountryCode string `json:"countryCode,omitempty"` - // The date and time the item was created. + // The UTC DateTime when the item was created. CreatedDateTime *time.Time `json:"createdDateTime,omitempty"` // The name/value pair information for the user custom setting. CustomSettings []NameValue `json:"customSettings,omitempty"` // The default account ID associated with the user. DefaultAccountID string `json:"defaultAccountId,omitempty"` - // Filters returned user records by the specified email address. + // The user's email address. Email string `json:"email,omitempty"` // Boolean value that specifies whether the user is enabled for updates from DocuSign Connect. EnableConnectForUser string `json:"enableConnectForUser,omitempty"` @@ -13945,25 +20442,28 @@ type UserInformation struct { // A complex element containing up to four Question/Answer pairs for forgotten password information. ForgottenPasswordInfo *ForgottenPasswordInformation `json:"forgottenPasswordInfo,omitempty"` // A list of the group information for groups to add the user to. - // Use [UserGroups::listGroups](https://developers.docusign.com/esign-rest-api/reference/UserGroups/Groups/list) to get information about groups. + // Use [UserGroups::listGroups](https://developers.docusign.com/docs/esign-rest-api/reference/UserGroups/Groups/list) to get information about groups. // // When setting a user's group, only the `groupId` is required. // GroupList []Group `json:"groupList,omitempty"` + // + HasRemoteNotary bool `json:"hasRemoteNotary,omitempty"` // Specifies the email for the signing host. It is a Required element for In Person Signers recipient Type. // Maximum Length: 100 characters. HomeAddress *AddressInformation `json:"homeAddress,omitempty"` - // Contains the URI for an endpoint that you can use to retrieve the initials image. + // The URI for retrieving the image of the user's initials. InitialsImageURI string `json:"initialsImageUri,omitempty"` // Determines if the feature set is actively set as part of the plan. IsAdmin string `json:"isAdmin,omitempty"` - // + // When set to **true**, National Association of Realtors (NAR) signature logos are enabled for the user. IsNAREnabled string `json:"isNAREnabled,omitempty"` // The user's job title. JobTitle string `json:"jobTitle,omitempty"` // The date and time when the user last logged in to the system. LastLogin string `json:"lastLogin,omitempty"` - // + // The user's last name. + // Maximum Length: 50 characters. LastName string `json:"lastName,omitempty"` // Boolean value that indicates whether the user is currently logged in or not. LoginStatus string `json:"loginStatus,omitempty"` @@ -13988,7 +20488,7 @@ type UserInformation struct { PermissionProfileName string `json:"permissionProfileName,omitempty"` // The URL for retrieving the user's profile image. ProfileImageURI string `json:"profileImageUri,omitempty"` - // When set to **true**, specifies that an activation email be sent to the user. + // When set to **true**, specifies that an activation email will be sent to the user. SendActivationEmail string `json:"sendActivationEmail,omitempty"` // When set to **true**, specifies that an additional activation email be sent if user's log on fails before the account is activated. SendActivationOnInvalidLogin DSBool `json:"sendActivationOnInvalidLogin,omitempty"` @@ -14002,7 +20502,7 @@ type UserInformation struct { SuffixName string `json:"suffixName,omitempty"` // The title of the user. Title string `json:"title,omitempty"` - // URI containing the user ID. + // A URI containing the user ID. URI string `json:"uri,omitempty"` // The date and time that the user was added to the account. UserAddedToAccountDateTime string `json:"userAddedToAccountDateTime,omitempty"` @@ -14013,7 +20513,7 @@ type UserInformation struct { UserName string `json:"userName,omitempty"` // The date and time that the user's profile was last modified. UserProfileLastModifiedDate string `json:"userProfileLastModifiedDate,omitempty"` - // The collection of settings representing the actions a user can perform. See [userSettingsInformation](https://developers.docusign.com/esign-rest-api/reference/Users/Users/get#userSettingsInformation) for available settings. + // The collection of settings representing the actions a user can perform. See [userSettingsInformation](https://developers.docusign.com/docs/esign-rest-api/reference/users/users/get/#userSettingsInformation) for available settings. UserSettings *UserSettingsInformation `json:"userSettings,omitempty"` // Status of the user's account. One of: // @@ -14030,18 +20530,19 @@ type UserInformation struct { WorkAddress *AddressInformation `json:"workAddress,omitempty"` } +// UserInformationList contains a list of account users. type UserInformationList struct { - // The last position in the result set. + // The last index position in the result set. EndPosition string `json:"endPosition,omitempty"` // The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. NextURI string `json:"nextUri,omitempty"` // The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. PreviousURI string `json:"previousUri,omitempty"` - // The number of results returned in this response. Because you can filter which entries are included in the response, this value is always less than or equal to `totalSetSize`. + // The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`. ResultSetSize string `json:"resultSetSize,omitempty"` - // The starting position of the current result set. + // The starting index position of the current result set. StartPosition string `json:"startPosition,omitempty"` - // The total number of items in the search's result set. This value is always greater than or equal to the value of `resultSetSize`. + // The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`. TotalSetSize string `json:"totalSetSize,omitempty"` // User management information. Users []UserInformation `json:"users,omitempty"` @@ -14058,14 +20559,16 @@ type UserPasswordInformation struct { NewPassword string `json:"newPassword,omitempty"` } +// UserPasswordRules contains details about the password rules for a user. type UserPasswordRules struct { - // + // Contains details about the password rules for the user. PasswordRules *AccountPasswordRules `json:"passwordRules,omitempty"` // The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing. // UserID string `json:"userId,omitempty"` } +// UserProfile users' profiles type UserProfile struct { // The user's address. Address *AddressInformation `json:"address,omitempty"` @@ -14083,7 +20586,9 @@ type UserProfile struct { DisplayUsageHistory DSBool `json:"displayUsageHistory,omitempty"` // The URL for retrieving the user's profile image. ProfileImageURI string `json:"profileImageUri,omitempty"` - // The title of the user. + // The user's job title. + // + // Limit: 100 characters. Title string `json:"title,omitempty"` // A complex element consisting of: // @@ -14093,13 +20598,13 @@ type UserProfile struct { // - `signedCount`: The number of envelopes the user has signed. // UsageHistory *UsageHistory `json:"usageHistory,omitempty"` - // + // Detailed information about the user. UserDetails *UserInformation `json:"userDetails,omitempty"` // The date and time that the user's profile was last modified. UserProfileLastModifiedDate string `json:"userProfileLastModifiedDate,omitempty"` } -// UserSettingsInformation data that describes settings for a user. Some elements of this object have a `metadata` property, which includes the following: +// UserSettingsInformation properties that configure the settings for a user. Some elements of this object have a `metadata` property, which includes the following: // - `rights`: The calling users permissions to edit this setting (can be `editable` or `read_only`) // - `uiHint`: Internally used to build UIs (can be `available` or `hidden`) // - `options`: The values supported for this setting (not all settings have this element) @@ -14110,23 +20615,27 @@ type UserSettingsInformation struct { AdminOnly string `json:"adminOnly,omitempty"` // Reserved for DocuSign. AdminOnlyMetadata *SettingsMetadata `json:"adminOnlyMetadata,omitempty"` - // Boolean value that indicates whether the user can participate in envelope transfers on the account. + // When set to **true**, the API returns suggested tabs for documents for this user. + AllowAutoTagging string `json:"allowAutoTagging,omitempty"` + // When set to **true**, this user can participate in envelope transfers on the account. AllowEnvelopeTransferTo string `json:"allowEnvelopeTransferTo,omitempty"` // Reserved for DocuSign. AllowEnvelopeTransferToMetadata *SettingsMetadata `json:"allowEnvelopeTransferToMetadata,omitempty"` + // When set to **true**, this user can create [electronic seal recipients][eseal]. // + // [eseal]: https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeRecipients/#seal-recipient AllowEsealRecipients string `json:"allowEsealRecipients,omitempty"` - // + // Metadata about the `allowEsealRecipientsMetadata` property. AllowEsealRecipientsMetadata *SettingsMetadata `json:"allowEsealRecipientsMetadata,omitempty"` - // + // When set to **true** and this user is an administrator, they can view all of the envelopes generated from PowerForms. The default value is **false**. AllowPowerFormsAdminToAccessAllPowerFormEnvelope string `json:"allowPowerFormsAdminToAccessAllPowerFormEnvelope,omitempty"` - // + // Metadata about the `allowPowerFormsAdminToAccessAllPowerFormEnvelopeMetadata` property. AllowPowerFormsAdminToAccessAllPowerFormEnvelopeMetadata *SettingsMetadata `json:"allowPowerFormsAdminToAccessAllPowerFormEnvelopeMetadata,omitempty"` - // When true, this user can set the language used in the standard email format for a recipient when creating an envelope. + // When set to **true**, this user can set the language used in the standard email format for a recipient when creating an envelope. AllowRecipientLanguageSelection string `json:"allowRecipientLanguageSelection,omitempty"` // Metadata for allowRecipientLanguageSelection. AllowRecipientLanguageSelectionMetadata *SettingsMetadata `json:"allowRecipientLanguageSelectionMetadata,omitempty"` - // When **true**, this user can send envelopes "on behalf of" other users through the API. + // When set to **true**, this user can send envelopes "on behalf of" other users through the API. AllowSendOnBehalfOf string `json:"allowSendOnBehalfOf,omitempty"` // Metadata for allowSendOnBehalfOf. AllowSendOnBehalfOfMetadata *SettingsMetadata `json:"allowSendOnBehalfOfMetadata,omitempty"` @@ -14134,11 +20643,7 @@ type UserSettingsInformation struct { AllowSupplementalDocuments string `json:"allowSupplementalDocuments,omitempty"` // Metadata that indicates whether the `allowSupplementalDocuments` property is editable. AllowSupplementalDocumentsMetadata *SettingsMetadata `json:"allowSupplementalDocumentsMetadata,omitempty"` - // Valid values are: - // - // - `system_default` - // - `off` - // - `on` + // Reserved for DocuSign. // AnchorTagVersionedPlacementEnabled string `json:"anchorTagVersionedPlacementEnabled,omitempty"` // When **true**, indicates that this user can send envelope-specific API requests on the account. @@ -14147,7 +20652,7 @@ type UserSettingsInformation struct { APIAccountWideAccessMetadata *SettingsMetadata `json:"apiAccountWideAccessMetadata,omitempty"` // When **true**, this user can export authoritative copy for the account. APICanExportAC string `json:"apiCanExportAC,omitempty"` - // + // Metadata about the `apiCanExportACMetadata` property. APICanExportACMetadata *SettingsMetadata `json:"apiCanExportACMetadata,omitempty"` // When **true**, this user can use the bulk send feature for the account. BulkSend string `json:"bulkSend,omitempty"` @@ -14160,40 +20665,44 @@ type UserSettingsInformation struct { CanChargeAccountMetadata *SettingsMetadata `json:"canChargeAccountMetadata,omitempty"` // When true, this user can edit the shared address book for the account. CanEditSharedAddressbook string `json:"canEditSharedAddressbook,omitempty"` - // + // Metadata about the `canEditSharedAddressbookMetadata` property. CanEditSharedAddressbookMetadata *SettingsMetadata `json:"canEditSharedAddressbookMetadata,omitempty"` - // + // When set to **true**, this user can lock envelopes. CanLockEnvelopes string `json:"canLockEnvelopes,omitempty"` - // + // Metadata about the `canLockEnvelopes` property. CanLockEnvelopesMetadata *SettingsMetadata `json:"canLockEnvelopesMetadata,omitempty"` // When **true**, this user is an administrator for the account. CanManageAccount string `json:"canManageAccount,omitempty"` - // + // Metadata about the `canManageAccountMetadata` property. CanManageAccountMetadata *SettingsMetadata `json:"canManageAccountMetadata,omitempty"` // Reserved for DocuSign. CanManageDistributor string `json:"canManageDistributor,omitempty"` - // + // Metadata about the `canManageDistributor` property. CanManageDistributorMetadata *SettingsMetadata `json:"canManageDistributorMetadata,omitempty"` // When **true**, this user can manage templates for the account. CanManageTemplates string `json:"canManageTemplates,omitempty"` - // + // Metadata about the `canManageTemplates` property. CanManageTemplatesMetadata *SettingsMetadata `json:"canManageTemplatesMetadata,omitempty"` // When **true**, this user can send API requests on the account. CanSendAPIRequests string `json:"canSendAPIRequests,omitempty"` - // + // Metadata about the `canSendAPIRequests` property. CanSendAPIRequestsMetadata *SettingsMetadata `json:"canSendAPIRequestsMetadata,omitempty"` // When **true**, this user can send envelopes on the account. CanSendEnvelope string `json:"canSendEnvelope,omitempty"` - // + // Metadata about the `canSendEnvelope` property. CanSendEnvelopeMetadata *SettingsMetadata `json:"canSendEnvelopeMetadata,omitempty"` // When **true**, this user can sign envelopes. CanSignEnvelope string `json:"canSignEnvelope,omitempty"` - // + // Metadata about the `canSignEnvelope` property. CanSignEnvelopeMetadata *SettingsMetadata `json:"canSignEnvelopeMetadata,omitempty"` - // + // When set to **true**, this user can use a scratchpad to edit information. CanUseScratchpad string `json:"canUseScratchpad,omitempty"` - // + // Metadata about the `canUseScratchpad` property. CanUseScratchpadMetadata *SettingsMetadata `json:"canUseScratchpadMetadata,omitempty"` + // Reserved for DocuSign. + CanUseSmartContracts string `json:"canUseSmartContracts,omitempty"` + // Reserved for DocuSign. + CanUseSmartContractsMetadata *SettingsMetadata `json:"canUseSmartContractsMetadata,omitempty"` // When **true**, this user is prohibited from uploading documents during sending. DisableDocumentUpload string `json:"disableDocumentUpload,omitempty"` // Metadata that indicates whether the `disableDocumentUpload` property is editable. @@ -14209,21 +20718,26 @@ type UserSettingsInformation struct { // Metadata that indicates whether the `enableDSPro` property is editable. // EnableDSProMetadata *SettingsMetadata `json:"enableDSProMetadata,omitempty"` - // When **true**, the account can define the routing - // order of recipients for envelopes sent using the DocuSign API. + // When set to **true**, the account can define the routing + // order of recipients for envelopes sent by using the eSignature API. // + // **Note**: Only SysAdmin users can change this setting. EnableSequentialSigningAPI string `json:"enableSequentialSigningAPI,omitempty"` // Metadata that indicates whether the `enableSequentialSigningAPI` property is editable. // EnableSequentialSigningAPIMetadata *SettingsMetadata `json:"enableSequentialSigningAPIMetadata,omitempty"` - // When **true**, the account can define the routing order - // of recipients for envelopes sent using the DocuSign application. + // When set to **true**, the account can define the routing order + // of recipients for envelopes sent by using the DocuSign application. + // + // **Note**: Only SysAdmin users can change this setting. // EnableSequentialSigningUI string `json:"enableSequentialSigningUI,omitempty"` // Metadata that indicates whether the `enableSequentialSigningUI` property is editable. // EnableSequentialSigningUIMetadata *SettingsMetadata `json:"enableSequentialSigningUIMetadata,omitempty"` - // When **true**, this user can override the Sign on Paper account setting, which specifies whether signers can sign documents on paper as an option to signing electronically. + // When set to **true**, a user can override the default default account setting for the Sign on Paper option, which specifies whether signers can sign documents on paper as an option to signing electronically. + // + // **Note**: Only Admin users can change this setting. EnableSignOnPaperOverride string `json:"enableSignOnPaperOverride,omitempty"` // Metadata that indicates whether the `enableSignOnPaperOverride` property is editable. // @@ -14235,17 +20749,16 @@ type UserSettingsInformation struct { EnableSignerAttachmentsMetadata *SettingsMetadata `json:"enableSignerAttachmentsMetadata,omitempty"` // Reserved for DocuSign. EnableTransactionPoint string `json:"enableTransactionPoint,omitempty"` - // Metadata that indicates whether the `enableTransactionPoint` property is editable. - // + // Reserved for DocuSign. EnableTransactionPointMetadata *SettingsMetadata `json:"enableTransactionPointMetadata,omitempty"` - // When true, Vaulting is enabled for the account. + // When set to **true**, Vaulting is enabled for the account. EnableVaulting string `json:"enableVaulting,omitempty"` // Metadata that indicates whether the `enableVaulting` property is editable. // EnableVaultingMetadata *SettingsMetadata `json:"enableVaultingMetadata,omitempty"` - // + // When set to **false**, this user can apply tabs to documents during the sending experience. ExpressSendOnly string `json:"expressSendOnly,omitempty"` - // The user's locale code: + // The user's locale code. Valid values are: // - `zh_CN` // - `zh_TW` // - `nl` @@ -14260,43 +20773,51 @@ type UserSettingsInformation struct { // - `ru` // - `es` Locale string `json:"locale,omitempty"` - // + // Metadata about the `locale` property. LocaleMetadata *SettingsMetadata `json:"localeMetadata,omitempty"` // Reserved for DocuSign. LocalePolicy *LocalePolicy `json:"localePolicy,omitempty"` - // User ID (GUID) of the user who last modified this user record. + // When set to **true**, this user can create and manage [Clickwraps](https://developers.docusign.com/click-api). + ManageClickwrapsMode string `json:"manageClickwrapsMode,omitempty"` + // Metadata about the `manageClickwrapsMode` property. + ManageClickwrapsModeMetadata *SettingsMetadata `json:"manageClickwrapsModeMetadata,omitempty"` + // The user id (GUID) of the user who last modified this user record. ModifiedBy string `json:"modifiedBy,omitempty"` - // + // Metadata about the `modifiedBy` property. ModifiedByMetadata *SettingsMetadata `json:"modifiedByMetadata,omitempty"` - // Most recent date on which this user record was modified. + // The date on which this user record was last modified. ModifiedDate string `json:"modifiedDate,omitempty"` - // + // Metadata about the `modifiedDate` property. ModifiedDateMetadata *SettingsMetadata `json:"modifiedDateMetadata,omitempty"` // Note referencing the page that modified this user record. ModifiedPage string `json:"modifiedPage,omitempty"` - // + // Metadata about the `modifiedPage` property. ModifiedPageMetadata *SettingsMetadata `json:"modifiedPageMetadata,omitempty"` // Reserved for DocuSign. NewSendUI string `json:"newSendUI,omitempty"` - // + // Metadata about the `newSendUI` property. NewSendUIMetadata *SettingsMetadata `json:"newSendUIMetadata,omitempty"` // Indicates the Power Form mode setting for the user: // - `none` // - `admin` // - `user` PowerFormMode string `json:"powerFormMode,omitempty"` - // + // Metadata about the `powerFormMode` property. PowerFormModeMetadata *SettingsMetadata `json:"powerFormModeMetadata,omitempty"` // When **true**, this user receives notifications when envelopes are viewed. RecipientViewedNotification string `json:"recipientViewedNotification,omitempty"` - // + // Metadata about the `recipientViewedNotification` property. RecipientViewedNotificationMetadata *SettingsMetadata `json:"recipientViewedNotificationMetadata,omitempty"` - // + // Information about the seals associated with this user. SealIdentifiers []SealIdentifier `json:"sealIdentifiers,omitempty"` + // Sets how self-signed documents are presented to the email recipients. // Valid values are: // - // - `include_pdf` - // - `include_link` + // - `include_pdf`: A PDF of the completed document is attached to the email. + // - `include_link`: A secure link to the self-signed documents is included + // in the email. + // + // **Note**: Only Admin users can change this setting. // SelfSignedRecipientEmailDocument string `json:"selfSignedRecipientEmailDocument,omitempty"` // Metadata that indicates whether the `selfSignedRecipientEmailDocument` property is editable. @@ -14324,7 +20845,7 @@ type UserSettingsInformation struct { // Metadata that indicates whether the `supplementalDocumentsMustAccept` property is editable. // SupplementalDocumentsMustAcceptMetadata *SettingsMetadata `json:"supplementalDocumentsMustAcceptMetadata,omitempty"` - // When **true**, this user must read supplemental documents. + // When **true**, this user must both view and accept supplemental documents. SupplementalDocumentsMustRead string `json:"supplementalDocumentsMustRead,omitempty"` // Metadata that indicates whether the `supplementalDocumentsMustRead` property is editable. // @@ -14334,33 +20855,33 @@ type UserSettingsInformation struct { // Metadata that indicates whether the `supplementalDocumentsMustView` property is editable. // SupplementalDocumentsMustViewMetadata *SettingsMetadata `json:"supplementalDocumentsMustViewMetadata,omitempty"` - // + // When set to **true**, a new template is created each time the user sends an envelope. TemplateActiveCreation string `json:"templateActiveCreation,omitempty"` - // + // Metadata about the `templateActiveCreation` property. TemplateActiveCreationMetadata *SettingsMetadata `json:"templateActiveCreationMetadata,omitempty"` - // + // When set to **true**, the system notifies this user before applying a matching template. TemplateApplyNotify string `json:"templateApplyNotify,omitempty"` - // + // Metadata about the `templateApplyNotify` property. TemplateApplyNotifyMetadata *SettingsMetadata `json:"templateApplyNotifyMetadata,omitempty"` - // + // When set to **true**, the system automatically applies a matching template to a document if only one template matches. If there are multiple matches, it displays a list of matches to select from. TemplateAutoMatching string `json:"templateAutoMatching,omitempty"` - // + // Metadata about the `templateAutoMatching` property. TemplateAutoMatchingMetadata *SettingsMetadata `json:"templateAutoMatchingMetadata,omitempty"` // Percentage used when matching templates. TemplateMatchingSensitivity string `json:"templateMatchingSensitivity,omitempty"` - // + // Metadata about the `tempalteMatchingSensitivity` property. TemplateMatchingSensitivityMetadata *SettingsMetadata `json:"templateMatchingSensitivityMetadata,omitempty"` // When **true**, users see template matching functionality. TemplatePageLevelMatching string `json:"templatePageLevelMatching,omitempty"` - // + // Metadata about the `templatePageLevelMatching` property. TemplatePageLevelMatchingMetadata *SettingsMetadata `json:"templatePageLevelMatchingMetadata,omitempty"` // When true, daylight savings time is in effect for this user's time zone. TimezoneDST string `json:"timezoneDST,omitempty"` - // + // Metadata about the `timezoneDST` property. TimezoneDSTMetadata *SettingsMetadata `json:"timezoneDSTMetadata,omitempty"` - // + // The custom DateTime format setting for this user. TimezoneMask string `json:"timezoneMask,omitempty"` - // + // Metadata about the `timezoneMask` property. TimezoneMaskMetadata *SettingsMetadata `json:"timezoneMaskMetadata,omitempty"` // The timezone offset for the user. Valid values: // - `tz_01_afghanistan` @@ -14460,31 +20981,30 @@ type UserSettingsInformation struct { // - `tz_95_west_pacific` // - `tz_96_yakutsk` TimezoneOffset string `json:"timezoneOffset,omitempty"` - // + // Metadata about the `timezoneOffset` property. TimezoneOffsetMetadata *SettingsMetadata `json:"timezoneOffsetMetadata,omitempty"` // Reserved for DocuSign. TimezoneSendingPref string `json:"timezoneSendingPref,omitempty"` - // + // Reserved for DocuSign. TimezoneSendingPrefMetadata *SettingsMetadata `json:"timezoneSendingPrefMetadata,omitempty"` // Reserved for DocuSign. TimezoneSigningPref string `json:"timezoneSigningPref,omitempty"` - // + // Reserved for DocuSign. TimezoneSigningPrefMetadata *SettingsMetadata `json:"timezoneSigningPrefMetadata,omitempty"` // Reserved for DocuSign. TransactionPointSiteNameURL string `json:"transactionPointSiteNameURL,omitempty"` - // + // Reserved for DocuSign. TransactionPointSiteNameURLMetadata *SettingsMetadata `json:"transactionPointSiteNameURLMetadata,omitempty"` // Reserved for DocuSign. TransactionPointUserName string `json:"transactionPointUserName,omitempty"` - // + // Reserved for DocuSign. TransactionPointUserNameMetadata *SettingsMetadata `json:"transactionPointUserNameMetadata,omitempty"` // Indicates the specified Vaulting mode: // - `none` // - `estored` // - `electronic_original` VaultingMode string `json:"vaultingMode,omitempty"` - // Metadata that indicates whether the `vaultingMode` property is editable. - // + // Metadata about the `vaultingMode` property. VaultingModeMetadata *SettingsMetadata `json:"vaultingModeMetadata,omitempty"` } @@ -14504,13 +21024,12 @@ type UserSharedItem struct { User *UserInfo `json:"user,omitempty"` } -// UserSignature users' signatures type UserSignature struct { - // The date and time on which the user adopted the signature. + // The date and time the user adopted their signature. AdoptedDateTime *time.Time `json:"adoptedDateTime,omitempty"` - // The date and time on which the user created the signature. + // The UTC DateTime when the item was created. CreatedDateTime *time.Time `json:"createdDateTime,omitempty"` - // Serialized information about custom eHanko stamps that have been ordered, including the order status, purchase order ID, time created, and time modified. + // CustomField string `json:"customField,omitempty"` // Specifies the area in which a date stamp is placed. This parameter uses pixel positioning to draw a rectangle at the center of the stamp area. The stamp is superimposed on top of this central area. // @@ -14521,26 +21040,26 @@ type UserSignature struct { // - `DateAreaWidth`: The width of the rectangle. // - `DateAreaHeight`: The height of the rectangle. DateStampProperties *DateStampProperties `json:"dateStampProperties,omitempty"` - // When set to **true**, the user cannot resize the stamp. + // When set to **true**, users may not resize the stamp. DisallowUserResizeStamp string `json:"disallowUserResizeStamp,omitempty"` // This object describes errors that occur. It is only valid for responses and ignored in requests. ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` // Optionally specify an external identifier for the user's signature. ExternalID string `json:"externalID,omitempty"` - // The base64-encoded bytes of the signature image. + // A Base64-encoded representation of the signature image. ImageBase64 string `json:"imageBase64,omitempty"` - // The type of image. Valid values are: + // Specificies the type of image. Valid values are: // // - `signature_image` // - `initials_image` ImageType string `json:"imageType,omitempty"` // The ID of the user's initials image. Initials150ImageID string `json:"initials150ImageId,omitempty"` - // Contains the URI for an endpoint that you can use to retrieve the initials image. + // The URI for retrieving the image of the user's initials. InitialsImageURI string `json:"initialsImageUri,omitempty"` // Boolean that specifies whether the signature is the default signature for the user. IsDefault string `json:"isDefault,omitempty"` - // The date and time on which the signature was last modified. + // The date and time that the item was last modified. LastModifiedDateTime string `json:"lastModifiedDateTime,omitempty"` // The National Association of Realtors (NAR) membership ID for a user who is a realtor. NrdsID string `json:"nrdsId,omitempty"` @@ -14560,23 +21079,12 @@ type UserSignature struct { PhoneticName string `json:"phoneticName,omitempty"` // The ID of the user's signature image. Signature150ImageID string `json:"signature150ImageId,omitempty"` - // The font type for the signature if the signature is not drawn. The supported font types are: - // - // - `7_DocuSign` - // - `1_DocuSign` - // - `6_DocuSign` - // - `8_DocuSign` - // - `3_DocuSign` - // - `Mistral` - // - `4_DocuSign` - // - `2_DocuSign` - // - `5_DocuSign` - // - `Rage Italic` + // The font type for the signature, if the signature is not drawn. The supported font types are: // - SignatureFont string `json:"signatureFont,omitempty"` - // The ID associated with the signature name. You can use this property in the URI in place of the signature name. This enables the use of special characters (such as "&", "<", and ">") in a signature name. + // "7_DocuSign", "1_DocuSign", "6_DocuSign", "8_DocuSign", "3_DocuSign", "Mistral", "4_DocuSign", "2_DocuSign", "5_DocuSign", "Rage Italic" // - // **Note**: When you update a signature, its signature ID might change. In that case you need to use `signatureName` to get the new `signatureId`. + SignatureFont string `json:"signatureFont,omitempty"` + // Specifies the signature ID associated with the signature name. You can use the signature ID in the URI in place of the signature name, and the value stored in the `signatureName` property in the body is used. This allows the use of special characters (such as "&", "<", ">") in a the signature name. Note that with each update to signatures, the returned signature ID might change, so the caller will need to trigger off the signature name to get the new signature ID. SignatureID string `json:"signatureId,omitempty"` // An endpoint URI that you can use to retrieve the user's signature image. SignatureImageURI string `json:"signatureImageUri,omitempty"` @@ -14592,17 +21100,26 @@ type UserSignature struct { SignatureRights string `json:"signatureRights,omitempty"` // Specifies the type of signature. SignatureType string `json:"signatureType,omitempty"` - // The format of the stamp. Valid values are: + // The format of a stamp. Valid values are: // // - `NameHanko`: The stamp represents only the signer's name. // - `NameDateHanko`: The stamp represents the signer's name and the date. StampFormat string `json:"stampFormat,omitempty"` - // The URL for retrieving the image of the user's stamp. + // The URI for retrieving the image of the user's stamp. StampImageURI string `json:"stampImageUri,omitempty"` // The physical height of the stamp image (in millimeters) that the stamp vendor recommends for displaying the image in PDF documents. StampSizeMM string `json:"stampSizeMM,omitempty"` - // If the recipient signs by using a personal stamp that is representative of their signature, this property specifies the stamp type. + // The type of stamp. Valid values are: + // + // - `signature`: A signature image. This is the default value. + // - `stamp`: A stamp image. + // - null StampType string `json:"stampType,omitempty"` + // Indicates the envelope status. Valid values are: + // + // * sent - The envelope is sent to the recipients. + // * created - The envelope is saved as a draft and can be modified and sent later. + Status string `json:"status,omitempty"` } type UserSignatureDefinition struct { @@ -14615,11 +21132,11 @@ type UserSignatureDefinition struct { // - `DateAreaWidth`: The width of the rectangle. // - `DateAreaHeight`: The height of the rectangle. DateStampProperties *DateStampProperties `json:"dateStampProperties,omitempty"` - // When set to **true**, the user cannot resize the stamp. + // When set to **true**, users may not resize the stamp. DisallowUserResizeStamp string `json:"disallowUserResizeStamp,omitempty"` // Optionally specify an external identifier for the user's signature. ExternalID string `json:"externalID,omitempty"` - // The type of image. Valid values are: + // Specificies the type of image. Valid values are: // // - `signature_image` // - `initials_image` @@ -14632,6 +21149,18 @@ type UserSignatureDefinition struct { NrdsLastName string `json:"nrdsLastName,omitempty"` // The phonetic spelling of the `signatureName`. PhoneticName string `json:"phoneticName,omitempty"` + // The font type to use for the signature if the signature is not drawn. The following font styles are supported. The quotes are to indicate that these values are strings, not `enums`. + // + // - `"1_DocuSign"` + // - `"2_DocuSign"` + // - `"3_DocuSign"` + // - `"4_DocuSign"` + // - `"5_DocuSign"` + // - `"6_DocuSign"` + // - `"7_DocuSign"` + // - `"8_DocuSign"` + // - `"Mistral"` + // - `"Rage Italic"` // SignatureFont string `json:"signatureFont,omitempty"` // Specifies the signature ID associated with the signature name. You can use the signature ID in the URI in place of the signature name, and the value stored in the `signatureName` property in the body is used. This allows the use of special characters (such as "&", "<", ">") in a the signature name. Note that with each update to signatures, the returned signature ID might change, so the caller will need to trigger off the signature name to get the new signature ID. @@ -14640,7 +21169,7 @@ type UserSignatureDefinition struct { SignatureInitials string `json:"signatureInitials,omitempty"` // Specifies the user's signature name. SignatureName string `json:"signatureName,omitempty"` - // The format of the stamp. Valid values are: + // The format of a stamp. Valid values are: // // - `NameHanko`: The stamp represents only the signer's name. // - `NameDateHanko`: The stamp represents the signer's name and the date. @@ -14650,12 +21179,12 @@ type UserSignatureDefinition struct { } type UserSignaturesInformation struct { - // A list of `UserSignatures` objects, each of which defines a user's digital signature. + // An array of `userSignature` objects. UserSignatures []UserSignature `json:"userSignatures,omitempty"` } type UserSocialIDResult struct { - // Contains properties that map a DocuSign user to a social account (Facebook, Yahoo, etc.) + // Contains properties that map a DocuSign user to a social account such as Facebook or Yahoo. SocialAccountInformation []SocialAccountInformation `json:"socialAccountInformation,omitempty"` // The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing. // @@ -14663,17 +21192,17 @@ type UserSocialIDResult struct { } type UsersResponse struct { - // The last position in the result set. + // The last index position in the result set. EndPosition string `json:"endPosition,omitempty"` // The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. NextURI string `json:"nextUri,omitempty"` // The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. PreviousURI string `json:"previousUri,omitempty"` - // The number of results returned in this response. Because you can filter which entries are included in the response, this value is always less than or equal to `totalSetSize`. + // The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`. ResultSetSize string `json:"resultSetSize,omitempty"` - // The starting position of the current result set. + // The starting index position of the current result set. StartPosition string `json:"startPosition,omitempty"` - // The total number of items in the search's result set. This value is always greater than or equal to the value of `resultSetSize`. + // The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`. TotalSetSize string `json:"totalSetSize,omitempty"` // User management information. Users []UserInfo `json:"users,omitempty"` @@ -14684,6 +21213,10 @@ type View struct { TabBase TabGuidedForm TabPosition + // + AnchorAllowWhiteSpaceInCharacters string `json:"anchorAllowWhiteSpaceInCharacters,omitempty"` + // + AnchorAllowWhiteSpaceInCharactersMetadata *PropertyMetadata `json:"anchorAllowWhiteSpaceInCharactersMetadata,omitempty"` // When set to **true**, the information in the tab is bold. Bold string `json:"bold,omitempty"` // Metadata that indicates whether the `bold` property is editable. @@ -14762,12 +21295,16 @@ type View struct { ItalicMetadata *PropertyMetadata `json:"italicMetadata,omitempty"` // Reserved for DocuSign. LocalePolicy *LocalePolicyTab `json:"localePolicy,omitempty"` + // + MergeFieldXML string `json:"mergeFieldXml,omitempty"` // When set to **true**, the recipient must click the **View** button for the supporting document prior to completing the signing process. Required TabRequired `json:"required,omitempty"` // Metadata that indicates whether the `required` property is editable. RequiredMetadata *PropertyMetadata `json:"requiredMetadata,omitempty"` // When set to **true**, the recipient must read through the document. RequiredRead DSBool `json:"requiredRead,omitempty"` + // + SmartContractInformation *SmartContractInformation `json:"smartContractInformation,omitempty"` // Metadata that indicates whether the `toolTip` property is editable. ToolTipMetadata *PropertyMetadata `json:"toolTipMetadata,omitempty"` // The text of a tooltip that appears when a user hovers over a form field or tab. @@ -14782,7 +21319,7 @@ type View struct { WidthMetadata *PropertyMetadata `json:"widthMetadata,omitempty"` } -// ViewURL embedding template views +// ViewURL embedding Envelope views type ViewURL struct { // The view URL to be navigated to. URL string `json:"url,omitempty"` @@ -14857,7 +21394,7 @@ type Watermark struct { WatermarkText string `json:"watermarkText,omitempty"` } -// Witness is a complex type containing information about a witness signer recipient. +// Witness is a complex type containing information about a witness recipient. Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope. type Witness struct { // If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. // @@ -14867,18 +21404,22 @@ type Witness struct { // // If blank and the signer `accessCode` property is not set, then the access code is not required. AccessCode string `json:"accessCode,omitempty"` - // Metadata that indicates if the sender can edit the `accessCode` property. + // Metadata that indicates whether the `accessCode` property is editable. Read only. AccessCodeMetadata *PropertyMetadata `json:"accessCodeMetadata,omitempty"` - // This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient. + // Optional. When set to **true**, the access code will be added to the email sent to the recipient. This nullifies the security measure of `accessCode` on the recipient. AddAccessCodeToEmail string `json:"addAccessCodeToEmail,omitempty"` - // When set to **true**, the agent can edit the email address of the recipient. + // An array of additional notification objects. + AdditionalNotifications []RecipientAdditionalNotification `json:"additionalNotifications,omitempty"` + // Optional element. When set to **true**, the agents recipient associated with this recipient can change the recipient's pre-populated email address. This element is only active if enabled for the account. AgentCanEditEmail string `json:"agentCanEditEmail,omitempty"` - // When set to **true**, the agent can edit the name of the recipient. + // Optional element. When set to **true**, the agents recipient associated with this recipient can change the recipient's pre-populated name. This element is only active if enabled for the account. AgentCanEditName string `json:"agentCanEditName,omitempty"` - // When **true**, auto navigation is set for the recipient. + // + AllowSystemOverrideForLockedRecipient string `json:"allowSystemOverrideForLockedRecipient,omitempty"` + // When set to **true**, autonavigation is set for the recipient. // AutoNavigation string `json:"autoNavigation,omitempty"` - // Contains a URI for an endpoint that allows you to easily retrieve bulk recipient information. + // Reserved for DocuSign. BulkRecipientsURI string `json:"bulkRecipientsUri,omitempty"` // When set to **true**, specifies that the signer can perform the signing ceremony offline. CanSignOffline string `json:"canSignOffline,omitempty"` @@ -14890,37 +21431,39 @@ type Witness struct { // // Maximum length: 100 characters. ClientUserID string `json:"clientUserId,omitempty"` - // Indicates the number of times that the recipient has been through a signing completion for the envelope. - // - // If this number is greater than 0 for a signing group, only the user who previously completed may sign again. + // Indicates the number of times that the recipient has been through a signing completion for the envelope. If this number is greater than 0 for a signing group, only the user who previously completed may sign again. Read only. CompletedCount string `json:"completedCount,omitempty"` - // Payment status for payment services. + // The reason why the recipient was created (for example, `sender`). Read only. CreationReason string `json:"creationReason,omitempty"` // An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters. CustomFields []string `json:"customFields,omitempty"` - // The date and time the recipient declined the document. + // The date and time the recipient declined the document. Read only. DeclinedDateTime string `json:"declinedDateTime,omitempty"` - // The reason the recipient declined the document. + // The reason the recipient declined the document. Read only. DeclinedReason string `json:"declinedReason,omitempty"` // When set to **true**, this recipient is the default recipient and any tabs generated by the transformPdfFields option are mapped to this recipient. DefaultRecipient string `json:"defaultRecipient,omitempty"` - // The date and time that the envelope was delivered to the recipient. + // The date and time that the envelope was delivered to the recipient. Read only. DeliveredDateTime string `json:"deliveredDateTime,omitempty"` // Reserved for DocuSign. DeliveryMethod string `json:"deliveryMethod,omitempty"` // Reserved for DocuSign. DeliveryMethodMetadata *PropertyMetadata `json:"deliveryMethodMetadata,omitempty"` - // A list of documentVisibility objects, which define a recipient's read/write access to a document. + // + DesignatorID string `json:"designatorId,omitempty"` + // + DesignatorIDGUID string `json:"designatorIdGuid,omitempty"` + // A list of `documentVisibility` objects. Each object in the list specifies whether a document in the envelope is visible to this recipient. For the envelope to use this functionality, Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true**. DocumentVisibility []DocumentVisibility `json:"documentVisibility,omitempty"` - // The email id of the recipient. + // The recipient's email address. Email string `json:"email,omitempty"` - // Metadata that indicates if the sender can edit the email address of the witness. + // Metadata that indicates whether the `email` property is editable. Read only. EmailMetadata *PropertyMetadata `json:"emailMetadata,omitempty"` // An optional complex type that sets a specific email subject and body for this recipient's notification email. // - // **Note**: If you use this field to set a specific email notification for one recipient, you must also set the email notification for the other recipients. Using this field for one or more recipients negates the Envelope `Subject` and `EmailBlurb` property settings. + // **Note**: You can set the `emailNotification` property separately for each recipient. If you set the value only for certain recipients, the other recipients will inherit the this value from the top-level `emailSubject` and `emailBlurb`. EmailNotification *RecipientEmailNotification `json:"emailNotification,omitempty"` - // Specifies a sender-provided valid URL string for redirecting an embedded recipient. When this option is used, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the recipient clicks the document link in the email, the recipient is redirected through DocuSign to the specified URL to complete the required actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. + // Specifies a sender-provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. // // If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation launched by a partner. // @@ -14942,46 +21485,51 @@ type Witness struct { FaxNumber string `json:"faxNumber,omitempty"` // Reserved for DocuSign. FaxNumberMetadata *PropertyMetadata `json:"faxNumberMetadata,omitempty"` - // The witness's first name. Maximum Length: 50 characters. + // The recipient's first name. Maximum Length: 50 characters. FirstName string `json:"firstName,omitempty"` - // Metadata that indicates if the sender can edit the witness's first name. - // + // Metadata that indicates whether the `firstame` property is editable. Read only. FirstNameMetadata *PropertyMetadata `json:"firstNameMetadata,omitempty"` // Reserved for DocuSign. FullName string `json:"fullName,omitempty"` // Reserved for DocuSign. FullNameMetadata *PropertyMetadata `json:"fullNameMetadata,omitempty"` - // The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. + // The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are: + // + // - `Phone Auth $`: The recipient must authenticate by using two-factor authentication (2FA). You provide the phone number to use for 2FA in the `phoneAuthentication` object. + // - `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object. + // - `ID Check $`: The recipient must answer detailed security questions. // // **Example**: Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node. IDCheckConfigurationName string `json:"idCheckConfigurationName,omitempty"` - // Metadata that indicates if the sender can edit the `idCheckConfigurationName` property. + // Metadata that indicates whether the `idCheckConfigurationName` property is editable. Read only. IDCheckConfigurationNameMetadata *PropertyMetadata `json:"idCheckConfigurationNameMetadata,omitempty"` // An object that contains input information related to a recipient ID check. IDCheckInformationInput *IDCheckInformationInput `json:"idCheckInformationInput,omitempty"` - // Specifies ID Verification applied on an envelope by workflow ID.
See the [list](https://developers.docusign.com/esign-rest-api/reference/Accounts/IdentityVerifications/list) method in the [IdentityVerifications](https://developers.docusign.com/esign-rest-api/reference/Accounts/IdentityVerifications) resource for more information on how to retrieve workflow IDs available for an account.
This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods.
Note that ID Verification and ID Check are two distinct methods. ID Verification checks recipients' identity by verifying their ID while ID Check relies on data available on public records (such as current and former address). + // Specifies the ID Verification workflow applied on an envelope by workflow ID.
See the [list](https://developers.docusign.com/docs/esign-rest-api/reference/Accounts/IdentityVerifications/list) method in the [IdentityVerifications](https://developers.docusign.com/docs/esign-rest-api/reference/Accounts/IdentityVerifications) resource for more information on how to retrieve workflow IDs available for an account.
This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods.
Note that ID Verification and ID Check are two distinct methods. ID Verification checks recipients' identity by verifying their ID while ID Check relies on data available on public records (such as current and former address). IdentityVerification *RecipientIdentityVerification `json:"identityVerification,omitempty"` // When set to **true** and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account. InheritEmailNotificationConfiguration string `json:"inheritEmailNotificationConfiguration,omitempty"` - // When set to **true**, this signer is a bulk recipient and the recipient information is contained in a bulk recipient file. - // - // Note that when this is true the email and name for the recipient becomes bulk@recipient.com and "Bulk Recipient". These fields can not be changed for the bulk recipient. + // Reserved for DocuSign. // IsBulkRecipient string `json:"isBulkRecipient,omitempty"` - // Metadata that indicates if the sender can edit the `isBulkRecipient` property. + // Reserved for DocuSign. IsBulkRecipientMetadata *PropertyMetadata `json:"isBulkRecipientMetadata,omitempty"` - // The witness's last name. + // The recipient's last name. LastName string `json:"lastName,omitempty"` - // Metadata that indicates if the sender can edit the witness's last name. + // Metadata that indicates whether the `lastName` property is editable. Read only. LastNameMetadata *PropertyMetadata `json:"lastNameMetadata,omitempty"` // Reserved for DocuSign. LockedRecipientPhoneAuthEditable string `json:"lockedRecipientPhoneAuthEditable,omitempty"` // Reserved for DocuSign. LockedRecipientSmsEditable string `json:"lockedRecipientSmsEditable,omitempty"` - // The full legal name of the witness. + // The full legal name of the recipient. Maximum Length: 100 characters. + // + // **Note**: You must always set a value for this property in requests, even if `firstName` and `lastName` are set. Name string `json:"name,omitempty"` - // Metadata that indicates if the sender can edit the full legal name of the witness. + // Metadata that indicates whether the `name` property is editable. Read only. NameMetadata *PropertyMetadata `json:"nameMetadata,omitempty"` + // + NotaryID string `json:"notaryId,omitempty"` // A note sent to the recipient in the signing email. // This note is unique to this recipient. // In the user interface, @@ -14992,47 +21540,51 @@ type Witness struct { // Maximum Length: 1000 characters. // Note string `json:"note,omitempty"` - // Metadata that indicates if the sender can edit the note to the recipient. + // Metadata that indicates whether the `note` property is editable. Read only. NoteMetadata *PropertyMetadata `json:"noteMetadata,omitempty"` - // Reserved for DocuSign use. + // Reserved for DocuSign. OfflineAttributes interface{} `json:"offlineAttributes,omitempty"` - // A complex type that contains the following elements: + // When `idCheckConfigurationName` is set to `Phone Auth $`, you use this complex type to provide the recipient authentication method details. It contains the following elements: + // + // * `recipMayProvideNumber`: Boolean. When set to **true**, the recipient can use whatever phone number they choose. + // * `senderProvidedNumbers`: ArrayOfStrings. A list of phone numbers the recipient can use. + // * `recordVoicePrint`: Reserved for DocuSign. + // * `validateRecipProvidedNumber`: Reserved for DocuSign. + // // - // * `recipMayProvideNumber` - Boolean. When set to **true**, the recipient can use whatever phone number they choose. - // * `senderProvidedNumbers` - ArrayOfString. A list of phone numbers the recipient can use. - // * `recordVoicePrint` - Reserved. - // * `validateRecipProvidedNumber` - Reserved. PhoneAuthentication *RecipientPhoneAuthentication `json:"phoneAuthentication,omitempty"` + // The proof file of the recipient. + ProofFile *RecipientProofFile `json:"proofFile,omitempty"` // Reserved for DocuSign. RecipientAttachments []RecipientAttachment `json:"recipientAttachments,omitempty"` - // Information about the recipient's authentication status. + // Information about the recipient's authentication status. Read only. RecipientAuthenticationStatus *AuthenticationStatus `json:"recipientAuthenticationStatus,omitempty"` - // Metadata about the features that are supported for the recipient type. + // Metadata about the features that are supported for the recipient type. Read only. RecipientFeatureMetadata []FeatureAvailableMetadata `json:"recipientFeatureMetadata,omitempty"` - // A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`. + // Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. RecipientID string `json:"recipientId,omitempty"` - // The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. + // The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only. RecipientIDGUID string `json:"recipientIdGuid,omitempty"` // The default signature provider is the DocuSign Electronic signature system. This parameter is used to specify one or more Standards Based Signature (digital signature) providers for the signer to use. [More information.](https://developers.docusign.com/esign-rest-api/guides/standards-based-signatures) RecipientSignatureProviders []RecipientSignatureProvider `json:"recipientSignatureProviders,omitempty"` - // Specifies whether the recipient creates the tabs. + // When set to **true**, specifies that the recipient creates the tabs. RecipientSuppliesTabs string `json:"recipientSuppliesTabs,omitempty"` // The recipient type, as specified by the following values: - // - `agents`: Agent recipients can add name and email information for recipients that appear after the agent in routing order. - // - `carbonCopies`: Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date, or add information to any of the documents. This type of recipient can be used in any routing order. - // - `certifiedDeliveries`: Certified delivery recipients must receive the completed documents for the envelope to be completed. They don't need to sign, initial, date, or add information to any of the documents. - // - `editors`: Editors have the same management and access rights for the envelope as the sender. Editors can add name and email information, add or change the routing order, set authentication options, and can edit signature/initial tabs and data fields for the remaining recipients. - // - `inPersonSigners`: In-person recipients are DocuSign users who act as signing hosts in the same physical location as the signer. + // - `agent`: Agent recipients can add name and email information for recipients that appear after the agent in routing order. + // - `carbonCopy`: Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date, or add information to any of the documents. This type of recipient can be used in any routing order. + // - `certifiedDelivery`: Certified delivery recipients must receive the completed documents for the envelope to be completed. They don't need to sign, initial, date, or add information to any of the documents. + // - `editor`: Editors have the same management and access rights for the envelope as the sender. Editors can add name and email information, add or change the routing order, set authentication options, and can edit signature/initial tabs and data fields for the remaining recipients. + // - `inPersonSigner`: In-person recipients are DocuSign users who act as signing hosts in the same physical location as the signer. // - `intermediaries`: Intermediary recipients can optionally add name and email information for recipients at the same or subsequent level in the routing order. - // - `seals`: Electronic seal recipients represent legal entities. - // - `signers`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope. - // - `witnesses`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope. + // - `seal`: Electronic seal recipients represent legal entities. + // - `signer`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope. + // - `witness`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope. RecipientType string `json:"recipientType,omitempty"` - // Metadata that indicates if the sender can edit the recipient type. + // Metadata that indicates whether the `recipientType` property is editable. Read only. RecipientTypeMetadata *PropertyMetadata `json:"recipientTypeMetadata,omitempty"` // When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. RequireIDLookup string `json:"requireIdLookup,omitempty"` - // Metadata that indicates if the sender can edit the `requireIdLookup` property. + // Metadata that indicates whether the `requireIdLookup` property is editable. Read only. RequireIDLookupMetadata *PropertyMetadata `json:"requireIdLookupMetadata,omitempty"` // When set to **true**, the signer must print, sign, and upload or fax the signed documents to DocuSign. RequireSignOnPaper string `json:"requireSignOnPaper,omitempty"` @@ -15044,210 +21596,277 @@ type Witness struct { // // The signer must be enrolled in the SAFE program to sign with a SAFE certificate. RequireSignerCertificate string `json:"requireSignerCertificate,omitempty"` - // Optional element. Specifies the role name associated with the recipient.

This is required when working with template recipients. + // When set to **true**, the signer is required to upload a new signature, even if they have a pre-adopted signature in their personal DocuSign account. + RequireUploadSignature string `json:"requireUploadSignature,omitempty"` + // Optional element. Specifies the role name associated with the recipient.

This property is required when you are working with template recipients. RoleName string `json:"roleName,omitempty"` // Specifies the routing order of the recipient in the envelope. RoutingOrder string `json:"routingOrder,omitempty"` - // Metadata that indicates if the sender can edit the routing order for the recipient. + // Metadata that indicates whether the `routingOrder` property is editable. Read only. RoutingOrderMetadata *PropertyMetadata `json:"routingOrderMetadata,omitempty"` - // The date and time the envelope was sent. + // The UTC DateTime when the envelope was sent. Read only. SentDateTime string `json:"sentDateTime,omitempty"` // When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab (instead of adopting a signature/initial style or only drawing a signature/initial once). SignInEachLocation string `json:"signInEachLocation,omitempty"` - // Metadata that indicates whether the `signInEachLocation` property is editable. - // + // Metadata that indicates whether the `signInEachLocation` property is editable. Read only. SignInEachLocationMetadata *PropertyMetadata `json:"signInEachLocationMetadata,omitempty"` // Allows the sender to pre-specify the signature name, signature initials and signature font used in the signature stamp for the recipient. // // Used only with recipient types In Person Signers and Signers. - // SignatureInfo *RecipientSignatureInformation `json:"signatureInfo,omitempty"` // Reserved for DocuSign. SignedDateTime string `json:"signedDateTime,omitempty"` - // The id of the signing group of which the recipient is a member, if applicable. + // When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once). SigningGroupID string `json:"signingGroupId,omitempty"` - // Metadata that indicates if the sender can edit the signing group id. + // Metadata that indicates whether the `signingGroupId` property is editable. Read only. SigningGroupIDMetadata *PropertyMetadata `json:"signingGroupIdMetadata,omitempty"` - // The display name for the signing group. + // Optional. The name of the signing group. // // Maximum Length: 100 characters. SigningGroupName string `json:"signingGroupName,omitempty"` // A complex type that contains information about users in the signing group. SigningGroupUsers []UserInfo `json:"signingGroupUsers,omitempty"` - // Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication. + // When `idCheckConfigurationName` is set to `SMS Auth $`, you use this complex type to provide the recipient authentication method details. It contains the element `senderProvidedNumbers`, which is an array of phone numbers that the recipient can use for SMS text authentication. + // // SmsAuthentication *RecipientSMSAuthentication `json:"smsAuthentication,omitempty"` - // Lists the social ID type that can be used for recipient authentication. + // Deprecated. SocialAuthentications []SocialAuthentication `json:"socialAuthentications,omitempty"` - // The status of the item. + // The recipient's status. Read only. + // + // Possible values: + // + // - `autoresponded`: The recipient's email system auto-responded to the email from DocuSign. This status is used in the web console to inform senders about the bounced-back email. This recipient status is only used if **Send-on-behalf-of** is turned off for the account. + // - `completed`: The recipient has completed their actions (signing or other required actions if not a signer) for an envelope. + // - `created`: The recipient is in a draft state. This value is only associated with draft envelopes (envelopes that have a status of `created`). + // - `declined`: The recipient declined to sign the document(s) in the envelope. + // - `delivered`: The recipient has viewed the document(s) in an envelope through the DocuSign signing website. This is not an email delivery of the documents in an envelope. + // - `faxPending`: The recipient has finished signing and the system is waiting for a fax attachment from the recipient before completing their signing step. + // - `sent`: The recipient has been sent an email notification that it is their turn to sign an envelope. + // - `signed`: The recipient has completed (signed) all required tags in an envelope. This is a temporary state during processing, after which the recipient's status automatically switches to `completed`. Status string `json:"status,omitempty"` - // Reserved for DocuSign. + // The code associated with the recipient's status. Read only. StatusCode string `json:"statusCode,omitempty"` - // A list of `signHere` tabs, which can be used to add a visual representation for an electronic seal in a document. + // When set to **true**, email notifications are suppressed for the recipient, and they must access envelopes and documents from their DocuSign inbox. + SuppressEmails string `json:"suppressEmails,omitempty"` + // A list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients. Tabs *Tabs `json:"tabs,omitempty"` // When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. TemplateLocked string `json:"templateLocked,omitempty"` // When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. TemplateRequired string `json:"templateRequired,omitempty"` - // The total number of tabs in the documents. + // The total number of tabs in the documents. Read only. TotalTabCount string `json:"totalTabCount,omitempty"` // The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing. // UserID string `json:"userId,omitempty"` - // The signer whose signature the witness is witnessing. + // The person or party for whom the recipient is a witness. WitnessFor string `json:"witnessFor,omitempty"` - // The GUID for the witness. + // The GUID of the person or party for whom the recipient is a witness. WitnessForGUID string `json:"witnessForGuid,omitempty"` } -type Workspace struct { +type Workflow struct { + // + CurrentWorkflowStepID string `json:"currentWorkflowStepId,omitempty"` + // + WorkflowStatus string `json:"workflowStatus,omitempty"` + // + WorkflowSteps []WorkflowStep `json:"workflowSteps,omitempty"` +} + +// WorkflowStep describes a single step in a workflow. +type WorkflowStep struct { + // Indicates the action to perform. + // + // - `pause_before`: The workflow should pause before the trigger described by `triggerOnItem` is reached. + // + // + // + Action string `json:"action,omitempty"` + // The timestamp of when the workflow step transitioned to `completed` status. + CompletedDate string `json:"completedDate,omitempty"` + // The unique ID of the item being triggered. + ItemID string `json:"itemId,omitempty"` + // The rules for recipient routing. + RecipientRouting *RecipientRouting `json:"recipientRouting,omitempty"` + // The status of the step. One of: + // + // - `inactive` + // - `in_progress` + // - `paused` + // - `pending` + // - `completed` // + // This is a read-only property. + Status string `json:"status,omitempty"` + // The type of item that triggers this workflow step. Currently, only `routing_order`, is the only supported value. + TriggerOnItem string `json:"triggerOnItem,omitempty"` + // The timestamp of when the workflow step transitioned to `in_progress` status. + TriggeredDate string `json:"triggeredDate,omitempty"` + // A unique identifier for this workflow step. + // This value is available from the `currentWorkflowStepId` property of the `workflow` object, + WorkflowStepID string `json:"workflowStepId,omitempty"` +} + +// Workspace is a DocuSign workspace is a collaboration area for sharing files and data. +type Workspace struct { + // The id of the account to bill. BillableAccountID string `json:"billableAccountId,omitempty"` // CallerInformation *WorkspaceUser `json:"callerInformation,omitempty"` // The UTC DateTime when the workspace user authorization was created. Created *time.Time `json:"created,omitempty"` - // + // Details about the user who created the workspace. CreatedByInformation *WorkspaceUser `json:"createdByInformation,omitempty"` // Utc date and time the comment was last updated (can only be done by creator.) LastModified *time.Time `json:"lastModified,omitempty"` - // + // Details about the user who last modified the workspace. LastModifiedByInformation *WorkspaceUser `json:"lastModifiedByInformation,omitempty"` - // + // Information about the settings for the workspace. Settings *WorkspaceSettings `json:"settings,omitempty"` - // The status of the item. + // Indicates the envelope status. Valid values are: + // + // * sent - The envelope is sent to the recipients. + // * created - The envelope is saved as a draft and can be modified and sent later. Status string `json:"status,omitempty"` - // The relative URL that may be used to access the workspace. + // The relative URL for accessing the workspace. WorkspaceBaseURL string `json:"workspaceBaseUrl,omitempty"` // Text describing the purpose of the workspace. WorkspaceDescription string `json:"workspaceDescription,omitempty"` - // Specifies the workspace ID GUID. + // The id of the workspace, always populated. WorkspaceID string `json:"workspaceId,omitempty"` // The name of the workspace. WorkspaceName string `json:"workspaceName,omitempty"` - // The relative URI that may be used to access the workspace. + // The relative URI for accessing the workspace. WorkspaceURI string `json:"workspaceUri,omitempty"` } -// WorkspaceFolderContents provides properties that describe the contents of a workspace folder. +// WorkspaceFolderContents this object's properties describe the contents of a workspace folder. type WorkspaceFolderContents struct { - // The last position in the result set. + // The last index position in the result set. EndPosition string `json:"endPosition,omitempty"` - // The query value can be a folder name or folder ID. The response will only return templates in the specified folder. + // The folder from which to return items. You can enter either the folder name or folder ID. Folder *WorkspaceItem `json:"folder,omitempty"` - // + // A list of workspace items. Items []WorkspaceItem `json:"items,omitempty"` // ParentFolders []WorkspaceItem `json:"parentFolders,omitempty"` - // The number of results returned in this response. Because you can filter which entries are included in the response, this value is always less than or equal to `totalSetSize`. + // The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`. ResultSetSize string `json:"resultSetSize,omitempty"` - // The starting position of the current result set. + // The starting index position of the current result set. StartPosition string `json:"startPosition,omitempty"` - // The total number of items in the search's result set. This value is always greater than or equal to the value of `resultSetSize`. + // The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`. TotalSetSize string `json:"totalSetSize,omitempty"` // The id of the workspace, always populated. WorkspaceID string `json:"workspaceId,omitempty"` } +// WorkspaceItem this object represents an item in a workspace, which can be either a file or folder. type WorkspaceItem struct { // CallerAuthorization *WorkspaceUserAuthorization `json:"callerAuthorization,omitempty"` - // + // If the item is a file, this property specifies the content type of the file. ContentType string `json:"contentType,omitempty"` // The UTC DateTime when the workspace item was created. Created *time.Time `json:"created,omitempty"` - // + // The id of the user who created the workspace item. CreatedByID string `json:"createdById,omitempty"` - // + // Details about the user who created the workspace item. CreatedByInformation *WorkspaceUser `json:"createdByInformation,omitempty"` - // + // The file extension of a file item. Extension string `json:"extension,omitempty"` - // + // The size of the file in bytes. FileSize string `json:"fileSize,omitempty"` - // + // The URI for retrieving the file. FileURI string `json:"fileUri,omitempty"` // A unique ID for the Salesforce object. ID string `json:"id,omitempty"` - // If true, this supersedes need for bit mask permission with workspaceUserAuthorization + // When **true**, the item is public. IsPublic DSBool `json:"isPublic,omitempty"` - // Utc date and time the comment was last updated (can only be done by creator.) + // The UTC date and time that the comment was last updated. + // + // **Note**: This can only be done by the creator. LastModified *time.Time `json:"lastModified,omitempty"` - // Utc date and time the comment was last updated (can only be done by creator) + // The id of the user who last modified the item. LastModifiedByID string `json:"lastModifiedById,omitempty"` - // + // Details about the user who last modified the workspace item. LastModifiedByInformation *WorkspaceUser `json:"lastModifiedByInformation,omitempty"` - // A simple string description of the item, such as a file name or a folder name. + // The name of the file or folder. Name string `json:"name,omitempty"` - // An integer value specifying the number of document pages in the template. + // The number of pages in a file. PageCount string `json:"pageCount,omitempty"` - // The ID of the parent folder. This is the GUID of the parent folder, or the special value 'root' for the root folder. + // The id of the parent folder, or the special value `root` for the root folder. ParentFolderID string `json:"parentFolderId,omitempty"` - // + // The URI of the parent folder. ParentFolderURI string `json:"parentFolderUri,omitempty"` - // + // A 64-byte, Secure Hash Algorithm 256 (SHA256) checksum that the caller computes across the entirety of the original content of a file. DocuSign compares this value to its own computation. If the two values are not equal, the original content and received content are not the same and the upload is refused. Sha256 string `json:"sha256,omitempty"` - // + // The height of the thumbnail image. ThumbHeight string `json:"thumbHeight,omitempty"` - // + // The width of the thumbnail image. ThumbWidth string `json:"thumbWidth,omitempty"` // Thumbnail *Page `json:"thumbnail,omitempty"` // The type of the workspace item. Valid values are file, folder. Type string `json:"type,omitempty"` - // URI containing the user ID. + // A URI containing the user ID. URI string `json:"uri,omitempty"` // UserAuthorization *WorkspaceUserAuthorization `json:"userAuthorization,omitempty"` } -// WorkspaceItemList provides properties that describe the items contained in a workspace. +// WorkspaceItemList is an array of objects that describe the items in a workspace. type WorkspaceItemList struct { - // + // A list of workspace items. Items []WorkspaceItem `json:"items,omitempty"` } -// WorkspaceList provides properties that describe the workspaces avaialble. +// WorkspaceList this object contains a list of available workspaces. type WorkspaceList struct { - // The last position in the result set. + // The last index position in the result set. EndPosition string `json:"endPosition,omitempty"` - // The number of results returned in this response. Because you can filter which entries are included in the response, this value is always less than or equal to `totalSetSize`. + // The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`. ResultSetSize string `json:"resultSetSize,omitempty"` - // The starting position of the current result set. + // The starting index position of the current result set. StartPosition string `json:"startPosition,omitempty"` - // The total number of items in the search's result set. This value is always greater than or equal to the value of `resultSetSize`. + // The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`. TotalSetSize string `json:"totalSetSize,omitempty"` // A list of workspaces. Workspaces []Workspace `json:"workspaces,omitempty"` } +// WorkspaceSettings this object provides information about the settings for the workspace. type WorkspaceSettings struct { - // + // When **true**, commenting on the documents in the workspace is allowed. CommentsAllowed string `json:"commentsAllowed,omitempty"` } -// WorkspaceUser is a workspaceUser representing the user. This property is only returned in response to user specific GET call. +// WorkspaceUser this object represents the workspace user. This property is only returned in response to user specific GET call. type WorkspaceUser struct { - // The account ID associated with the envelope. + // The account ID associated with the workspace user. AccountID string `json:"accountId,omitempty"` - // The name of the account associated with the current workspace user. + // The name of the account that the workspace user belongs to. AccountName string `json:"accountName,omitempty"` - // + // The UTC DateTime when the user joined the workspace. ActiveSince *time.Time `json:"activeSince,omitempty"` // The UTC DateTime when the workspace user was created. Created *time.Time `json:"created,omitempty"` - // + // The id of the user who created this workspace user. CreatedByID string `json:"createdById,omitempty"` - // Filters returned user records by the specified email address. + // The workspace user's email address. Email string `json:"email,omitempty"` // This object describes errors that occur. It is only valid for responses and ignored in requests. ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` - // + // The text of the workspace invitation email message sent to the user. InvitationEmailBlurb string `json:"invitationEmailBlurb,omitempty"` - // + // The subject line of the workspace invitation email message sent to the user. InvitationEmailSubject string `json:"invitationEmailSubject,omitempty"` - // Utc date and time the comment was last updated (can only be done by creator.) + // The UTC DateTime that the workspace user was last modified. LastModified *time.Time `json:"lastModified,omitempty"` - // + // The id of the user who last modified the workspace user. LastModifiedByID string `json:"lastModifiedById,omitempty"` // Filters the results by user status. // You can specify a comma-separated @@ -15259,48 +21878,45 @@ type WorkspaceUser struct { // * Closed // * Disabled Status string `json:"status,omitempty"` - // Type of user: - // - `type_owner` - // - `type_participant` + // Type of the user. Valid values: type_owner, type_participant. Type string `json:"type,omitempty"` - // The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing. - // + // The id of the workspace user. UserID string `json:"userId,omitempty"` - // The name of the user. + // The name of workspace user. UserName string `json:"userName,omitempty"` - // Specifies the workspace ID GUID. + // The id of the workspace. WorkspaceID string `json:"workspaceId,omitempty"` - // The relative URI that may be used to access a workspace user. + // The URL for accessing the workspace user. WorkspaceUserBaseURL string `json:"workspaceUserBaseUrl,omitempty"` - // + // The id of the workspace user. WorkspaceUserID string `json:"workspaceUserId,omitempty"` - // + // The URI for accessing the workspace user. WorkspaceUserURI string `json:"workspaceUserUri,omitempty"` } // WorkspaceUserAuthorization provides properties that describe user authorization to a workspace. type WorkspaceUserAuthorization struct { - // + // When set to **true**, the workspace user can delete items from the workspace. CanDelete DSBool `json:"canDelete,omitempty"` - // + // When set to **true**, the workspace user can move the items in the workspace. CanMove DSBool `json:"canMove,omitempty"` - // + // When set to **true**, the workspace user can create transactions from the workspace. CanTransact DSBool `json:"canTransact,omitempty"` - // + // When set to **true**, the workspace user can view the items in the workspace. CanView DSBool `json:"canView,omitempty"` // The UTC DateTime when the workspace user authorization was created. Created *time.Time `json:"created,omitempty"` - // + // The id of the user who created the workspace user authorization. CreatedByID string `json:"createdById,omitempty"` // This object describes errors that occur. It is only valid for responses and ignored in requests. ErrorDetails *ErrorDetails `json:"errorDetails,omitempty"` - // + // The UTC DateTime when the workspace user authorization was last modified. Modified *time.Time `json:"modified,omitempty"` - // + // The id of the user who last modified the workspace user authorization. ModifiedByID string `json:"modifiedById,omitempty"` - // + // The id of the workspace user. WorkspaceUserID string `json:"workspaceUserId,omitempty"` - // + // An object that provides details about the workspace user. WorkspaceUserInformation *WorkspaceUser `json:"workspaceUserInformation,omitempty"` } @@ -15316,9 +21932,13 @@ type Zip struct { TabPosition TabStyle TabValue + // + AnchorAllowWhiteSpaceInCharacters string `json:"anchorAllowWhiteSpaceInCharacters,omitempty"` + // + AnchorAllowWhiteSpaceInCharactersMetadata *PropertyMetadata `json:"anchorAllowWhiteSpaceInCharactersMetadata,omitempty"` // When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. // - // When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. + // When an envelope is completed the information is only available to the sender through the Form Data link in the DocuSign Console. The information on the downloaded document remains masked by asterisks. // // This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. ConcealValueOnDocument DSBool `json:"concealValueOnDocument,omitempty"` @@ -15342,6 +21962,8 @@ type Zip struct { MaxLength string `json:"maxLength,omitempty"` // Metadata that indicates whether the `maxLength` property is editable. MaxLengthMetadata *PropertyMetadata `json:"maxLengthMetadata,omitempty"` + // + MergeFieldXML string `json:"mergeFieldXml,omitempty"` // The initial value of the tab when it was sent to the recipient. OriginalValue string `json:"originalValue,omitempty"` // Metadata that indicates whether the `originalValue` property is editable. @@ -15370,6 +21992,8 @@ type Zip struct { Shared DSBool `json:"shared,omitempty"` // Metadata that indicates whether the `shared` property is editable. SharedMetadata *PropertyMetadata `json:"sharedMetadata,omitempty"` + // + SmartContractInformation *SmartContractInformation `json:"smartContractInformation,omitempty"` // Metadata that indicates whether the `toolTip` property is editable. ToolTipMetadata *PropertyMetadata `json:"toolTipMetadata,omitempty"` // The text of a tooltip that appears when a user hovers over a form field or tab. diff --git a/v2.1/powerforms/powerforms.go b/v2.1/powerforms/powerforms.go index 377de0e..69fb32e 100644 --- a/v2.1/powerforms/powerforms.go +++ b/v2.1/powerforms/powerforms.go @@ -99,17 +99,17 @@ func (op *DataListOp) ToDate(val time.Time) *DataListOp { return op } -// Create creates a new PowerForm. +// Create creates a new PowerForm // // https://developers.docusign.com/esign-rest-api/reference/powerforms/powerforms/create // // SDK Method PowerForms::createPowerForm -func (s *Service) Create(powerForms *model.PowerForm) *CreateOp { +func (s *Service) Create(powerForm *model.PowerForm) *CreateOp { return &CreateOp{ Credential: s.credential, Method: "POST", Path: "powerforms", - Payload: powerForms, + Payload: powerForm, QueryOpts: make(url.Values), Version: esign.VersionV21, } @@ -304,12 +304,12 @@ func (op *ListSendersOp) StartPosition(val int) *ListSendersOp { // https://developers.docusign.com/esign-rest-api/reference/powerforms/powerforms/update // // SDK Method PowerForms::updatePowerForm -func (s *Service) Update(powerFormID string, powerForms *model.PowerForm) *UpdateOp { +func (s *Service) Update(powerFormID string, powerForm *model.PowerForm) *UpdateOp { return &UpdateOp{ Credential: s.credential, Method: "PUT", Path: strings.Join([]string{"powerforms", powerFormID}, "/"), - Payload: powerForms, + Payload: powerForm, QueryOpts: make(url.Values), Version: esign.VersionV21, } diff --git a/v2.1/signinggroups/signinggroups.go b/v2.1/signinggroups/signinggroups.go index 183cd0b..1282e8b 100644 --- a/v2.1/signinggroups/signinggroups.go +++ b/v2.1/signinggroups/signinggroups.go @@ -8,9 +8,13 @@ // Package signinggroups implements the DocuSign SDK // category SigningGroups. // -// Use the SigningGroup category to manage signing groups that allow you anyone in the group to sign a document. +// Use the Signing Group category to manage signing groups that allow anyone in the group to sign a document. When you send an envelope to a signing group, anyone in the group can open it and sign it with their own signature. // -// The category allows you create the signing group and manage the users in the group. +// This category shows account administrators how to create a signing group and manage the users in the group. +// +// **Note**: To create and manage signing groups, you must be an account administrator. +// +// For more information about this topic, see [Signing Groups](https://support.docusign.com/en/guides/ndse-user-guide-signing-groups). // // Service Api documentation may be found at: // https://developers.docusign.com/esign-rest-api/reference/SigningGroups @@ -237,12 +241,12 @@ func (op *ListOp) IncludeUsers() *ListOp { // https://developers.docusign.com/esign-rest-api/reference/signinggroups/signinggroups/update // // SDK Method SigningGroups::update -func (s *Service) Update(signingGroupID string, signingGroups *model.SigningGroup) *UpdateOp { +func (s *Service) Update(signingGroupID string, signingGroup *model.SigningGroup) *UpdateOp { return &UpdateOp{ Credential: s.credential, Method: "PUT", Path: strings.Join([]string{"signing_groups", signingGroupID}, "/"), - Payload: signingGroups, + Payload: signingGroup, QueryOpts: make(url.Values), Version: esign.VersionV21, } diff --git a/v2.1/templates/templates.go b/v2.1/templates/templates.go index 6004126..4ac32d1 100644 --- a/v2.1/templates/templates.go +++ b/v2.1/templates/templates.go @@ -10,13 +10,13 @@ // // Use the Templates category to manage your account's templates. // -// You can: +// This section shows you how to perform the following tasks: // // * Create, list, get, update, and delete templates. -// * Manage templates' notification and group sharing settings. +// * Manage the notification and group sharing settings for templates. // * Fetch and rotate pages from a document used by a template. // -// Templates can be created programmatically or can be created via the DocuSign web interface and then used by your application. +// You can create templates either programmatically or through the DocuSign web interface and then used by your application. // // Service Api documentation may be found at: // https://developers.docusign.com/esign-rest-api/reference/Templates @@ -245,12 +245,12 @@ func (op *CustomFieldsUpdateOp) Do(ctx context.Context) (*model.CustomFields, er // https://developers.docusign.com/esign-rest-api/reference/templates/templatedocumentfields/create // // SDK Method Templates::createDocumentFields -func (s *Service) DocumentFieldsCreate(documentID string, templateID string, templateDocumentFields *model.DocumentFieldsInformation) *DocumentFieldsCreateOp { +func (s *Service) DocumentFieldsCreate(documentID string, templateID string, documentFieldsInformation *model.DocumentFieldsInformation) *DocumentFieldsCreateOp { return &DocumentFieldsCreateOp{ Credential: s.credential, Method: "POST", Path: strings.Join([]string{"templates", templateID, "documents", documentID, "fields"}, "/"), - Payload: templateDocumentFields, + Payload: documentFieldsInformation, QueryOpts: make(url.Values), Version: esign.VersionV21, } @@ -270,12 +270,12 @@ func (op *DocumentFieldsCreateOp) Do(ctx context.Context) (*model.DocumentFields // https://developers.docusign.com/esign-rest-api/reference/templates/templatedocumentfields/delete // // SDK Method Templates::deleteDocumentFields -func (s *Service) DocumentFieldsDelete(documentID string, templateID string, templateDocumentFields *model.DocumentFieldsInformation) *DocumentFieldsDeleteOp { +func (s *Service) DocumentFieldsDelete(documentID string, templateID string, documentFieldsInformation *model.DocumentFieldsInformation) *DocumentFieldsDeleteOp { return &DocumentFieldsDeleteOp{ Credential: s.credential, Method: "DELETE", Path: strings.Join([]string{"templates", templateID, "documents", documentID, "fields"}, "/"), - Payload: templateDocumentFields, + Payload: documentFieldsInformation, QueryOpts: make(url.Values), Version: esign.VersionV21, } @@ -319,12 +319,12 @@ func (op *DocumentFieldsListOp) Do(ctx context.Context) (*model.DocumentFieldsIn // https://developers.docusign.com/esign-rest-api/reference/templates/templatedocumentfields/update // // SDK Method Templates::updateDocumentFields -func (s *Service) DocumentFieldsUpdate(documentID string, templateID string, templateDocumentFields *model.DocumentFieldsInformation) *DocumentFieldsUpdateOp { +func (s *Service) DocumentFieldsUpdate(documentID string, templateID string, documentFieldsInformation *model.DocumentFieldsInformation) *DocumentFieldsUpdateOp { return &DocumentFieldsUpdateOp{ Credential: s.credential, Method: "PUT", Path: strings.Join([]string{"templates", templateID, "documents", documentID, "fields"}, "/"), - Payload: templateDocumentFields, + Payload: documentFieldsInformation, QueryOpts: make(url.Values), Version: esign.VersionV21, } @@ -447,7 +447,7 @@ func (op *DocumentsGetOp) Do(ctx context.Context) (*esign.Download, error) { return res, ((*esign.Op)(op)).Do(ctx, &res) } -// Encrypt set the call query parameter encrypt +// Encrypt when set to **true**, the PDF bytes returned in the response are encrypted for all the key managers configured on your DocuSign account. You can decrypt the documents by using the Key Manager DecryptDocument API method. For more information about Key Manager, see the DocuSign Security Appliance Installation Guide that your organization received from DocuSign. func (op *DocumentsGetOp) Encrypt() *DocumentsGetOp { if op != nil { op.QueryOpts.Set("encrypt", "true") @@ -455,7 +455,7 @@ func (op *DocumentsGetOp) Encrypt() *DocumentsGetOp { return op } -// ShowChanges set the call query parameter show_changes +// ShowChanges when set to **true**, any document fields that a recipient changed are highlighted in yellow in the returned PDF document, and optional signatures or initials are outlined in red. func (op *DocumentsGetOp) ShowChanges() *DocumentsGetOp { if op != nil { op.QueryOpts.Set("show_changes", "true") @@ -495,7 +495,7 @@ func (op *DocumentsListOp) IncludeTabs(val string) *DocumentsListOp { return op } -// DocumentsUpdate adds a document to a template document. +// DocumentsUpdate updates a template document. // // https://developers.docusign.com/esign-rest-api/reference/templates/templatedocuments/update // @@ -553,7 +553,7 @@ func (op *DocumentsUpdateListOp) Do(ctx context.Context) (*model.TemplateDocumen return res, ((*esign.Op)(op)).Do(ctx, &res) } -// LocksCreate lock a template. +// LocksCreate locks a template. // // https://developers.docusign.com/esign-rest-api/reference/templates/templatelocks/create // @@ -726,7 +726,7 @@ func (op *RecipientTabsListOp) Do(ctx context.Context) (*model.Tabs, error) { return res, ((*esign.Op)(op)).Do(ctx, &res) } -// IncludeAnchorTabLocations when set to **true**, all tabs with anchor tab properties are included in the response. If you do not specify this parameter, the effect is the default behavior (**false**). +// IncludeAnchorTabLocations when set to **true**, all tabs with anchor tab properties are included in the response. The default value is **false**. func (op *RecipientTabsListOp) IncludeAnchorTabLocations() *RecipientTabsListOp { if op != nil { op.QueryOpts.Set("include_anchor_tab_locations", "true") @@ -792,7 +792,9 @@ func (op *RecipientsCreateOp) Do(ctx context.Context) (*model.Recipients, error) return res, ((*esign.Op)(op)).Do(ctx, &res) } -// ResendEnvelope when set to **true**, resends the envelope if the new recipient's routing order is before or the same as the envelope's next recipient. +// ResendEnvelope when set to **true**, resends the envelope to the recipients that you specify in the request body. You use this parameter to resend the envelope to a recipient who deleted the original email notification. +// +// **Note**: Correcting an envelope is a different process. DocuSign always resends an envelope when you correct it, regardless of the value that you enter here. func (op *RecipientsCreateOp) ResendEnvelope() *RecipientsCreateOp { if op != nil { op.QueryOpts.Set("resend_envelope", "true") @@ -890,7 +892,7 @@ func (op *RecipientsListOp) IncludeExtended() *RecipientsListOp { return op } -// IncludeTabs when set to **true**, the tab information associated with the recipient is included in the response. If you do not specify this parameter, the effect is the default behavior (**false**). +// IncludeTabs when set to **true**, the tab information associated with the recipient is included in the response. func (op *RecipientsListOp) IncludeTabs() *RecipientsListOp { if op != nil { op.QueryOpts.Set("include_tabs", "true") @@ -923,7 +925,9 @@ func (op *RecipientsUpdateOp) Do(ctx context.Context) (*model.RecipientsUpdateSu return res, ((*esign.Op)(op)).Do(ctx, &res) } -// ResendEnvelope when set to **true**, resends the envelope if the new recipient's routing order is before or the same as the envelope's next recipient. +// ResendEnvelope when set to **true**, resends the envelope to the recipients that you specify in the request body. You use this parameter to resend the envelope to a recipient who deleted the original email notification. +// +// **Note**: Correcting an envelope is a different process. DocuSign always resends an envelope when you correct it, regardless of the value that you enter here. func (op *RecipientsUpdateOp) ResendEnvelope() *RecipientsUpdateOp { if op != nil { op.QueryOpts.Set("resend_envelope", "true") @@ -931,7 +935,7 @@ func (op *RecipientsUpdateOp) ResendEnvelope() *RecipientsUpdateOp { return op } -// ViewsCreateEdit provides a URL to start an edit view of the Template UI +// ViewsCreateEdit gets a URL for a template edit view. // // https://developers.docusign.com/esign-rest-api/reference/templates/templateviews/createedit // @@ -956,18 +960,18 @@ func (op *ViewsCreateEditOp) Do(ctx context.Context) (*model.ViewURL, error) { return res, ((*esign.Op)(op)).Do(ctx, &res) } -// Create creates a template. +// Create creates one or more templates. // If any uploads[x].Reader is an io.ReadCloser(s), Do() will always close Reader. // // https://developers.docusign.com/esign-rest-api/reference/templates/templates/create // // SDK Method Templates::createTemplate -func (s *Service) Create(templates *model.EnvelopeTemplate, uploads ...*esign.UploadFile) *CreateOp { +func (s *Service) Create(envelopeTemplate *model.EnvelopeTemplate, uploads ...*esign.UploadFile) *CreateOp { return &CreateOp{ Credential: s.credential, Method: "POST", Path: "templates", - Payload: templates, + Payload: envelopeTemplate, Files: uploads, QueryOpts: make(url.Values), Version: esign.VersionV21, @@ -1012,12 +1016,12 @@ func (op *DeleteDocumentPageOp) Do(ctx context.Context) error { // https://developers.docusign.com/esign-rest-api/reference/templates/templates/deletegroupshare // // SDK Method Templates::deleteGroupShare -func (s *Service) DeleteGroupShare(templateID string, templatePart string, groups *model.GroupInformation) *DeleteGroupShareOp { +func (s *Service) DeleteGroupShare(templateID string, templatePart string, groupInformation *model.GroupInformation) *DeleteGroupShareOp { return &DeleteGroupShareOp{ Credential: s.credential, Method: "DELETE", Path: strings.Join([]string{"templates", templateID, templatePart}, "/"), - Payload: groups, + Payload: groupInformation, QueryOpts: make(url.Values), Version: esign.VersionV21, } @@ -1056,14 +1060,15 @@ func (op *GetOp) Do(ctx context.Context) (*model.EnvelopeTemplate, error) { return res, ((*esign.Op)(op)).Do(ctx, &res) } -// Include is a comma-separated list of additional template attributes to include in the response. Valid values are: +// Include is a comma-separated list +// of additional template attributes +// to include in the response. +// Valid values are: // -// - `recipients` -// - `folders` -// - `documents` -// - `custom_fields` -// - `notifications` -// - `powerforms` +// - `powerforms`: Includes information about PowerForms. +// - `tabs`: Includes information about tabs. +// - `documents`: Includes information about documents. +// - `favorite_template_status`: : Includes the template `favoritedByMe` property in the response. **Note**: You can mark a template as a favorite only in eSignature v2.1. func (op *GetOp) Include(val ...string) *GetOp { if op != nil { op.QueryOpts.Set("include", strings.Join(val, ",")) @@ -1232,7 +1237,7 @@ func (op *GetPageImagesOp) StartPosition(val int) *GetPageImagesOp { return op } -// List gets the definition of a template. +// List gets template definitions. // // https://developers.docusign.com/esign-rest-api/reference/templates/templates/list // @@ -1256,7 +1261,7 @@ func (op *ListOp) Do(ctx context.Context) (*model.EnvelopeTemplateResults, error return res, ((*esign.Op)(op)).Do(ctx, &res) } -// Count number of records to return in the cache. +// Count is the number of records to return in the cache. func (op *ListOp) Count(val int) *ListOp { if op != nil { op.QueryOpts.Set("count", fmt.Sprintf("%d", val)) @@ -1264,7 +1269,7 @@ func (op *ListOp) Count(val int) *ListOp { return op } -// CreatedFromDate list templates created on or after this date. +// CreatedFromDate lists templates created on or after this date. func (op *ListOp) CreatedFromDate(val string) *ListOp { if op != nil { op.QueryOpts.Set("created_from_date", val) @@ -1272,7 +1277,7 @@ func (op *ListOp) CreatedFromDate(val string) *ListOp { return op } -// CreatedToDate list templates modified before this date. +// CreatedToDate lists templates modified before this date. func (op *ListOp) CreatedToDate(val string) *ListOp { if op != nil { op.QueryOpts.Set("created_to_date", val) @@ -1280,7 +1285,7 @@ func (op *ListOp) CreatedToDate(val string) *ListOp { return op } -// FolderIds is a comma separated list of folder ID GUIDs. +// FolderIds is a comma-separated list of folder id GUIDs. func (op *ListOp) FolderIds(val ...string) *ListOp { if op != nil { op.QueryOpts.Set("folder_ids", strings.Join(val, ",")) @@ -1314,19 +1319,14 @@ func (op *ListOp) FromDate(val time.Time) *ListOp { // to include in the response. // Valid values are: // -// - `advanced_templates` -// - `custom_fields` -// - `documents` -// - `folders` -// - `notifications` -// - `pathExtended` -// - `powerforms` -// - `recipients` -// - `shared_template_folders` -// -// `pathExtended`: Includes SalesForce configuration data for merge fields -// that can be used to optimize upload template -// by eliminating the need to connect to SalesForce. +// - `powerforms`: Includes details about the PowerForms associated with the templates. +// - `documents`: Includes information about template documents. +// - `folders`: Includes information about the folder that holds the template. +// - `favorite_template_status`: Includes the template `favoritedByMe` property. **Note**: You can mark a template as a favorite only in eSignature v2.1. +// - `advanced_templates`: Includes information about advanced templates. +// - `recipients`: Includes information about template recipients. +// - `custom_fields`: Includes information about template custom fields. +// - `notifications`: Includes information about the notification settings for templates. func (op *ListOp) Include(val ...string) *ListOp { if op != nil { op.QueryOpts.Set("include", strings.Join(val, ",")) @@ -1334,11 +1334,21 @@ func (op *ListOp) Include(val ...string) *ListOp { return op } -// IsDownload when **true**, download the templates listed in `template_ids` as a ZIP file. +// IsDeletedTemplateOnly set the call query parameter is_deleted_template_only +func (op *ListOp) IsDeletedTemplateOnly(val string) *ListOp { + if op != nil { + op.QueryOpts.Set("is_deleted_template_only", val) + } + return op +} + +// IsDownload when set to **true**, downloads the templates listed in `template_ids` as a collection of JSON definitions in a single zip file. // // The `Content-Disposition` header is set in the response. The value of the header provides the filename of the file. // -// Default is **false**. +// The default is **false**. +// +// **Note**: This parameter only works when you specify a list of templates in the `template_ids` parameter. func (op *ListOp) IsDownload(val string) *ListOp { if op != nil { op.QueryOpts.Set("is_download", val) @@ -1346,7 +1356,7 @@ func (op *ListOp) IsDownload(val string) *ListOp { return op } -// ModifiedFromDate list templates modified on or after this date. +// ModifiedFromDate lists templates modified on or after this date. func (op *ListOp) ModifiedFromDate(val time.Time) *ListOp { if op != nil { op.QueryOpts.Set("modified_from_date", val.Format(time.RFC3339)) @@ -1354,7 +1364,7 @@ func (op *ListOp) ModifiedFromDate(val time.Time) *ListOp { return op } -// ModifiedToDate list templates modified before this date. +// ModifiedToDate lists templates modified before this date. func (op *ListOp) ModifiedToDate(val time.Time) *ListOp { if op != nil { op.QueryOpts.Set("modified_to_date", val.Format(time.RFC3339)) @@ -1400,7 +1410,7 @@ func (op *ListOp) SearchFields(val string) *ListOp { return op } -// SearchText is the search text used to search the names of templates. +// SearchText is the search text to use to search the names of templates. func (op *ListOp) SearchText(val string) *ListOp { if op != nil { op.QueryOpts.Set("search_text", val) @@ -1408,7 +1418,7 @@ func (op *ListOp) SearchText(val string) *ListOp { return op } -// SharedByMe if true, the response only includes templates shared by the user. If false, the response only returns template not shared by the user. If not specified, the response is not affected. +// SharedByMe if **true**, the response only includes templates shared by the user. If false, the response only returns template not shared by the user. If not specified, the response is not affected. func (op *ListOp) SharedByMe(val string) *ListOp { if op != nil { op.QueryOpts.Set("shared_by_me", val) @@ -1416,7 +1426,7 @@ func (op *ListOp) SharedByMe(val string) *ListOp { return op } -// StartPosition is the starting index for the first template shown in the response. This must be greater than or equal to 0 (zero). +// StartPosition is the starting zero-based index position for the first template to show in the response. This value must be greater than or equal to `0` (zero). func (op *ListOp) StartPosition(val int) *ListOp { if op != nil { op.QueryOpts.Set("start_position", fmt.Sprintf("%d", val)) @@ -1424,7 +1434,7 @@ func (op *ListOp) StartPosition(val int) *ListOp { return op } -// TemplateIds is a comma-separated list of template IDs to download. This value is valid only when `is_download` is **true**. +// TemplateIds is a comma-separated list of template ids to download. This value is valid only when `is_download` is **true**. func (op *ListOp) TemplateIds(val string) *ListOp { if op != nil { op.QueryOpts.Set("template_ids", val) @@ -1432,7 +1442,9 @@ func (op *ListOp) TemplateIds(val string) *ListOp { return op } -// ToDate end of the search date range. Only returns templates created up to this date/time. If no value is provided, this defaults to the current date. +// ToDate is the end of a search date range in UTC DateTime format. When you use this parameter, only templates created up to this date and time are returned. +// +// **Note**: If this property is null, the value defaults to the current date. func (op *ListOp) ToDate(val time.Time) *ListOp { if op != nil { op.QueryOpts.Set("to_date", val.Format(time.RFC3339)) @@ -1468,7 +1480,7 @@ func (op *ListOp) UserFilter(val string) *ListOp { return op } -// UserID is the user ID. +// UserID is the id of the user. func (op *ListOp) UserID(val string) *ListOp { if op != nil { op.QueryOpts.Set("user_id", val) @@ -1505,12 +1517,12 @@ func (op *RotateDocumentPageOp) Do(ctx context.Context) error { // https://developers.docusign.com/esign-rest-api/reference/templates/templates/update // // SDK Method Templates::update -func (s *Service) Update(templateID string, templates *model.EnvelopeTemplate) *UpdateOp { +func (s *Service) Update(templateID string, envelopeTemplate *model.EnvelopeTemplate) *UpdateOp { return &UpdateOp{ Credential: s.credential, Method: "PUT", Path: strings.Join([]string{"templates", templateID}, "/"), - Payload: templates, + Payload: envelopeTemplate, QueryOpts: make(url.Values), Version: esign.VersionV21, } @@ -1525,17 +1537,17 @@ func (op *UpdateOp) Do(ctx context.Context) (*model.TemplateUpdateSummary, error return res, ((*esign.Op)(op)).Do(ctx, &res) } -// UpdateGroupShare shares a template with a group +// UpdateGroupShare shares a template with a group. // // https://developers.docusign.com/esign-rest-api/reference/templates/templates/updategroupshare // // SDK Method Templates::updateGroupShare -func (s *Service) UpdateGroupShare(templateID string, templatePart string, groups *model.GroupInformation) *UpdateGroupShareOp { +func (s *Service) UpdateGroupShare(templateID string, templatePart string, groupInformation *model.GroupInformation) *UpdateGroupShareOp { return &UpdateGroupShareOp{ Credential: s.credential, Method: "PUT", Path: strings.Join([]string{"templates", templateID, templatePart}, "/"), - Payload: groups, + Payload: groupInformation, QueryOpts: make(url.Values), Version: esign.VersionV21, } diff --git a/v2.1/uncategorized/uncategorized.go b/v2.1/uncategorized/uncategorized.go index e4c50fc..e2ef77d 100644 --- a/v2.1/uncategorized/uncategorized.go +++ b/v2.1/uncategorized/uncategorized.go @@ -25,6 +25,7 @@ package uncategorized // import "github.com/jfcote87/esign/v2.1/uncategorized" import ( "context" + "io" "net/url" "strings" @@ -42,423 +43,2258 @@ func New(cred esign.Credential) *Service { return &Service{credential: cred} } -// CommentsCreateEnvelopeCommentsis uncategorized and subject to change -func (s *Service) CommentsCreateEnvelopeComments(envelopeID string, commentsPublish *model.CommentsPublish) *CommentsCreateEnvelopeCommentsOp { - return &CommentsCreateEnvelopeCommentsOp{ +// AccountSignaturesCreateAccountSignatures adds or updates one or more account signatures. +// This request may include images in multi-part format. +// operation is uncategorized and subject to change. +func (s *Service) AccountSignaturesCreateAccountSignatures(accountSignaturesInformation *model.AccountSignaturesInformation) *AccountSignaturesCreateAccountSignaturesOp { + return &AccountSignaturesCreateAccountSignaturesOp{ + Credential: s.credential, + Method: "POST", + Path: "signatures", + Payload: accountSignaturesInformation, + QueryOpts: make(url.Values), + Version: esign.VersionV21, + } +} + +// AccountSignaturesCreateAccountSignaturesOp implements DocuSign API SDK Uncategorized::createAccountSignatures +type AccountSignaturesCreateAccountSignaturesOp esign.Op + +// Do executes the op. A nil context will return error. +func (op *AccountSignaturesCreateAccountSignaturesOp) Do(ctx context.Context) (*model.AccountSignaturesInformation, error) { + var res *model.AccountSignaturesInformation + return res, ((*esign.Op)(op)).Do(ctx, &res) +} + +// DecodeOnly set the call query parameter decode_only +func (op *AccountSignaturesCreateAccountSignaturesOp) DecodeOnly(val string) *AccountSignaturesCreateAccountSignaturesOp { + if op != nil { + op.QueryOpts.Set("decode_only", val) + } + return op +} + +// AccountSignaturesDeleteAccountSignature close the specified signature by ID. +// operation is uncategorized and subject to change. +func (s *Service) AccountSignaturesDeleteAccountSignature(signatureID string) *AccountSignaturesDeleteAccountSignatureOp { + return &AccountSignaturesDeleteAccountSignatureOp{ + Credential: s.credential, + Method: "DELETE", + Path: strings.Join([]string{"signatures", signatureID}, "/"), + QueryOpts: make(url.Values), + Version: esign.VersionV21, + } +} + +// AccountSignaturesDeleteAccountSignatureOp implements DocuSign API SDK Uncategorized::deleteAccountSignature +type AccountSignaturesDeleteAccountSignatureOp esign.Op + +// Do executes the op. A nil context will return error. +func (op *AccountSignaturesDeleteAccountSignatureOp) Do(ctx context.Context) error { + return ((*esign.Op)(op)).Do(ctx, nil) +} + +// AccountSignaturesDeleteAccountSignatureImage deletes a signature image, initials, or stamp. +// operation is uncategorized and subject to change. +func (s *Service) AccountSignaturesDeleteAccountSignatureImage(imageType string, signatureID string) *AccountSignaturesDeleteAccountSignatureImageOp { + return &AccountSignaturesDeleteAccountSignatureImageOp{ + Credential: s.credential, + Method: "DELETE", + Path: strings.Join([]string{"signatures", signatureID, imageType}, "/"), + QueryOpts: make(url.Values), + Version: esign.VersionV21, + } +} + +// AccountSignaturesDeleteAccountSignatureImageOp implements DocuSign API SDK Uncategorized::deleteAccountSignatureImage +type AccountSignaturesDeleteAccountSignatureImageOp esign.Op + +// Do executes the op. A nil context will return error. +func (op *AccountSignaturesDeleteAccountSignatureImageOp) Do(ctx context.Context) (*model.AccountSignature, error) { + var res *model.AccountSignature + return res, ((*esign.Op)(op)).Do(ctx, &res) +} + +// AccountSignaturesGetAccountSignature returns information about the specified signature. +// operation is uncategorized and subject to change. +func (s *Service) AccountSignaturesGetAccountSignature(signatureID string) *AccountSignaturesGetAccountSignatureOp { + return &AccountSignaturesGetAccountSignatureOp{ + Credential: s.credential, + Method: "GET", + Path: strings.Join([]string{"signatures", signatureID}, "/"), + QueryOpts: make(url.Values), + Version: esign.VersionV21, + } +} + +// AccountSignaturesGetAccountSignatureOp implements DocuSign API SDK Uncategorized::getAccountSignature +type AccountSignaturesGetAccountSignatureOp esign.Op + +// Do executes the op. A nil context will return error. +func (op *AccountSignaturesGetAccountSignatureOp) Do(ctx context.Context) (*model.AccountSignature, error) { + var res *model.AccountSignature + return res, ((*esign.Op)(op)).Do(ctx, &res) +} + +// AccountSignaturesGetAccountSignatureImage returns a signature image, initials, or stamp. +// operation is uncategorized and subject to change. +func (s *Service) AccountSignaturesGetAccountSignatureImage(imageType string, signatureID string) *AccountSignaturesGetAccountSignatureImageOp { + return &AccountSignaturesGetAccountSignatureImageOp{ + Credential: s.credential, + Method: "GET", + Path: strings.Join([]string{"signatures", signatureID, imageType}, "/"), + Accept: "image/gif", + QueryOpts: make(url.Values), + Version: esign.VersionV21, + } +} + +// AccountSignaturesGetAccountSignatureImageOp implements DocuSign API SDK Uncategorized::getAccountSignatureImage +type AccountSignaturesGetAccountSignatureImageOp esign.Op + +// Do executes the op. A nil context will return error. +func (op *AccountSignaturesGetAccountSignatureImageOp) Do(ctx context.Context) (*esign.Download, error) { + var res *esign.Download + return res, ((*esign.Op)(op)).Do(ctx, &res) +} + +// IncludeChrome when **true**, the chrome (or frame containing the added line and identifier) is included with the signature image. +func (op *AccountSignaturesGetAccountSignatureImageOp) IncludeChrome(val string) *AccountSignaturesGetAccountSignatureImageOp { + if op != nil { + op.QueryOpts.Set("include_chrome", val) + } + return op +} + +// AccountSignaturesGetAccountSignatures returns the managed signature definitions for the account +// operation is uncategorized and subject to change. +func (s *Service) AccountSignaturesGetAccountSignatures() *AccountSignaturesGetAccountSignaturesOp { + return &AccountSignaturesGetAccountSignaturesOp{ + Credential: s.credential, + Method: "GET", + Path: "signatures", + QueryOpts: make(url.Values), + Version: esign.VersionV21, + } +} + +// AccountSignaturesGetAccountSignaturesOp implements DocuSign API SDK Uncategorized::getAccountSignatures +type AccountSignaturesGetAccountSignaturesOp esign.Op + +// Do executes the op. A nil context will return error. +func (op *AccountSignaturesGetAccountSignaturesOp) Do(ctx context.Context) (*model.AccountSignaturesInformation, error) { + var res *model.AccountSignaturesInformation + return res, ((*esign.Op)(op)).Do(ctx, &res) +} + +// StampFormat set the call query parameter stamp_format +func (op *AccountSignaturesGetAccountSignaturesOp) StampFormat(val string) *AccountSignaturesGetAccountSignaturesOp { + if op != nil { + op.QueryOpts.Set("stamp_format", val) + } + return op +} + +// StampName set the call query parameter stamp_name +func (op *AccountSignaturesGetAccountSignaturesOp) StampName(val string) *AccountSignaturesGetAccountSignaturesOp { + if op != nil { + op.QueryOpts.Set("stamp_name", val) + } + return op +} + +// StampType set the call query parameter stamp_type +func (op *AccountSignaturesGetAccountSignaturesOp) StampType(val string) *AccountSignaturesGetAccountSignaturesOp { + if op != nil { + op.QueryOpts.Set("stamp_type", val) + } + return op +} + +// AccountSignaturesUpdateAccountSignature updates an account signature. +// +// operation is uncategorized and subject to change. +func (s *Service) AccountSignaturesUpdateAccountSignature(accountSignaturesInformation *model.AccountSignaturesInformation) *AccountSignaturesUpdateAccountSignatureOp { + return &AccountSignaturesUpdateAccountSignatureOp{ + Credential: s.credential, + Method: "PUT", + Path: "signatures", + Payload: accountSignaturesInformation, + QueryOpts: make(url.Values), + Version: esign.VersionV21, + } +} + +// AccountSignaturesUpdateAccountSignatureOp implements DocuSign API SDK Uncategorized::updateAccountSignature +type AccountSignaturesUpdateAccountSignatureOp esign.Op + +// Do executes the op. A nil context will return error. +func (op *AccountSignaturesUpdateAccountSignatureOp) Do(ctx context.Context) (*model.AccountSignaturesInformation, error) { + var res *model.AccountSignaturesInformation + return res, ((*esign.Op)(op)).Do(ctx, &res) +} + +// AccountSignaturesUpdateAccountSignatureByID updates an account signature. +// operation is uncategorized and subject to change. +func (s *Service) AccountSignaturesUpdateAccountSignatureByID(signatureID string, accountSignatureDefinition *model.AccountSignatureDefinition) *AccountSignaturesUpdateAccountSignatureByIDOp { + return &AccountSignaturesUpdateAccountSignatureByIDOp{ + Credential: s.credential, + Method: "PUT", + Path: strings.Join([]string{"signatures", signatureID}, "/"), + Payload: accountSignatureDefinition, + QueryOpts: make(url.Values), + Version: esign.VersionV21, + } +} + +// AccountSignaturesUpdateAccountSignatureByIDOp implements DocuSign API SDK Uncategorized::updateAccountSignatureById +type AccountSignaturesUpdateAccountSignatureByIDOp esign.Op + +// Do executes the op. A nil context will return error. +func (op *AccountSignaturesUpdateAccountSignatureByIDOp) Do(ctx context.Context) (*model.AccountSignature, error) { + var res *model.AccountSignature + return res, ((*esign.Op)(op)).Do(ctx, &res) +} + +// CloseExistingSignature when set to **true**, closes the current signature. +func (op *AccountSignaturesUpdateAccountSignatureByIDOp) CloseExistingSignature(val string) *AccountSignaturesUpdateAccountSignatureByIDOp { + if op != nil { + op.QueryOpts.Set("close_existing_signature", val) + } + return op +} + +// AccountSignaturesUpdateAccountSignatureImage sets a signature image, initials, or stamp. +// If media is an io.ReadCloser, Do() will close media. +// operation is uncategorized and subject to change. +func (s *Service) AccountSignaturesUpdateAccountSignatureImage(imageType string, signatureID string, media io.Reader, mimeType string) *AccountSignaturesUpdateAccountSignatureImageOp { + return &AccountSignaturesUpdateAccountSignatureImageOp{ + Credential: s.credential, + Method: "PUT", + Path: strings.Join([]string{"signatures", signatureID, imageType}, "/"), + Payload: &esign.UploadFile{Reader: media, ContentType: mimeType}, + QueryOpts: make(url.Values), + Version: esign.VersionV21, + } +} + +// AccountSignaturesUpdateAccountSignatureImageOp implements DocuSign API SDK Uncategorized::updateAccountSignatureImage +type AccountSignaturesUpdateAccountSignatureImageOp esign.Op + +// Do executes the op. A nil context will return error. +func (op *AccountSignaturesUpdateAccountSignatureImageOp) Do(ctx context.Context) (*model.AccountSignature, error) { + var res *model.AccountSignature + return res, ((*esign.Op)(op)).Do(ctx, &res) +} + +// TransparentPng set the call query parameter transparent_png +func (op *AccountSignaturesUpdateAccountSignatureImageOp) TransparentPng(val string) *AccountSignaturesUpdateAccountSignatureImageOp { + if op != nil { + op.QueryOpts.Set("transparent_png", val) + } + return op +} + +// AccountsGetAccountSettingsExport retrieves an account settings comparison. +// operation is uncategorized and subject to change. +func (s *Service) AccountsGetAccountSettingsExport(organizationID string, resultID string) *AccountsGetAccountSettingsExportOp { + return &AccountsGetAccountSettingsExportOp{ + Credential: s.credential, + Method: "GET", + Path: strings.Join([]string{"", "v2.1", "organization_exports", organizationID, "account_settings", resultID}, "/"), + QueryOpts: make(url.Values), + Version: esign.VersionV21, + } +} + +// AccountsGetAccountSettingsExportOp implements DocuSign API SDK Uncategorized::getAccountSettingsExport +type AccountsGetAccountSettingsExportOp esign.Op + +// Do executes the op. A nil context will return error. +func (op *AccountsGetAccountSettingsExportOp) Do(ctx context.Context) (*esign.Download, error) { + var res *esign.Download + return res, ((*esign.Op)(op)).Do(ctx, &res) +} + +// AccountsGetEnvelopePurgeConfiguration gets the envelope purge configuration for an account. +// operation is uncategorized and subject to change. +func (s *Service) AccountsGetEnvelopePurgeConfiguration() *AccountsGetEnvelopePurgeConfigurationOp { + return &AccountsGetEnvelopePurgeConfigurationOp{ + Credential: s.credential, + Method: "GET", + Path: "settings/envelope_purge_configuration", + QueryOpts: make(url.Values), + Version: esign.VersionV21, + } +} + +// AccountsGetEnvelopePurgeConfigurationOp implements DocuSign API SDK Uncategorized::getEnvelopePurgeConfiguration +type AccountsGetEnvelopePurgeConfigurationOp esign.Op + +// Do executes the op. A nil context will return error. +func (op *AccountsGetEnvelopePurgeConfigurationOp) Do(ctx context.Context) (*model.EnvelopePurgeConfiguration, error) { + var res *model.EnvelopePurgeConfiguration + return res, ((*esign.Op)(op)).Do(ctx, &res) +} + +// AccountsGetNotificationDefaults gets envelope notification defaults. +// operation is uncategorized and subject to change. +func (s *Service) AccountsGetNotificationDefaults() *AccountsGetNotificationDefaultsOp { + return &AccountsGetNotificationDefaultsOp{ + Credential: s.credential, + Method: "GET", + Path: "settings/notification_defaults", + QueryOpts: make(url.Values), + Version: esign.VersionV21, + } +} + +// AccountsGetNotificationDefaultsOp implements DocuSign API SDK Uncategorized::getNotificationDefaults +type AccountsGetNotificationDefaultsOp esign.Op + +// Do executes the op. A nil context will return error. +func (op *AccountsGetNotificationDefaultsOp) Do(ctx context.Context) (*model.NotificationDefaults, error) { + var res *model.NotificationDefaults + return res, ((*esign.Op)(op)).Do(ctx, &res) +} + +// AccountsUpdateEnvelopePurgeConfiguration sets the envelope purge configuration for an account. +// operation is uncategorized and subject to change. +func (s *Service) AccountsUpdateEnvelopePurgeConfiguration(envelopePurgeConfiguration *model.EnvelopePurgeConfiguration) *AccountsUpdateEnvelopePurgeConfigurationOp { + return &AccountsUpdateEnvelopePurgeConfigurationOp{ + Credential: s.credential, + Method: "PUT", + Path: "settings/envelope_purge_configuration", + Payload: envelopePurgeConfiguration, + QueryOpts: make(url.Values), + Version: esign.VersionV21, + } +} + +// AccountsUpdateEnvelopePurgeConfigurationOp implements DocuSign API SDK Uncategorized::updateEnvelopePurgeConfiguration +type AccountsUpdateEnvelopePurgeConfigurationOp esign.Op + +// Do executes the op. A nil context will return error. +func (op *AccountsUpdateEnvelopePurgeConfigurationOp) Do(ctx context.Context) (*model.EnvelopePurgeConfiguration, error) { + var res *model.EnvelopePurgeConfiguration + return res, ((*esign.Op)(op)).Do(ctx, &res) +} + +// AccountsUpdateNotificationDefaults updates envelope notification default settings. +// operation is uncategorized and subject to change. +func (s *Service) AccountsUpdateNotificationDefaults(notificationDefaults *model.NotificationDefaults) *AccountsUpdateNotificationDefaultsOp { + return &AccountsUpdateNotificationDefaultsOp{ + Credential: s.credential, + Method: "PUT", + Path: "settings/notification_defaults", + Payload: notificationDefaults, + QueryOpts: make(url.Values), + Version: esign.VersionV21, + } +} + +// AccountsUpdateNotificationDefaultsOp implements DocuSign API SDK Uncategorized::updateNotificationDefaults +type AccountsUpdateNotificationDefaultsOp esign.Op + +// Do executes the op. A nil context will return error. +func (op *AccountsUpdateNotificationDefaultsOp) Do(ctx context.Context) (*model.NotificationDefaults, error) { + var res *model.NotificationDefaults + return res, ((*esign.Op)(op)).Do(ctx, &res) +} + +// ApplianceInfoCreateError uploads Kazmon error for Display Appliance. +// If media is an io.ReadCloser, Do() will close media. +// operation is uncategorized and subject to change. +func (s *Service) ApplianceInfoCreateError(media io.Reader, mimeType string) *ApplianceInfoCreateErrorOp { + return &ApplianceInfoCreateErrorOp{ + Credential: s.credential, + Method: "POST", + Path: "/v2.1/display_appliance_info/error", + Payload: &esign.UploadFile{Reader: media, ContentType: mimeType}, + QueryOpts: make(url.Values), + Version: esign.VersionV21, + } +} + +// ApplianceInfoCreateErrorOp implements DocuSign API SDK Uncategorized::createError +type ApplianceInfoCreateErrorOp esign.Op + +// Do executes the op. A nil context will return error. +func (op *ApplianceInfoCreateErrorOp) Do(ctx context.Context) error { + return ((*esign.Op)(op)).Do(ctx, nil) +} + +// ApplianceInfoCreatePageInfo creates page information for Display Appliance. +// If media is an io.ReadCloser, Do() will close media. +// operation is uncategorized and subject to change. +func (s *Service) ApplianceInfoCreatePageInfo(envelopeID string, media io.Reader, mimeType string) *ApplianceInfoCreatePageInfoOp { + return &ApplianceInfoCreatePageInfoOp{ + Credential: s.credential, + Method: "POST", + Path: strings.Join([]string{"envelopes", envelopeID, "display_appliance_info", "page_info"}, "/"), + Payload: &esign.UploadFile{Reader: media, ContentType: mimeType}, + QueryOpts: make(url.Values), + Version: esign.VersionV21, + } +} + +// ApplianceInfoCreatePageInfoOp implements DocuSign API SDK Uncategorized::createPageInfo +type ApplianceInfoCreatePageInfoOp esign.Op + +// Do executes the op. A nil context will return error. +func (op *ApplianceInfoCreatePageInfoOp) Do(ctx context.Context) error { + return ((*esign.Op)(op)).Do(ctx, nil) +} + +// ApplianceInfoCreatePdfBlob adds PDF blobs for Display Appliance. +// If media is an io.ReadCloser, Do() will close media. +// operation is uncategorized and subject to change. +func (s *Service) ApplianceInfoCreatePdfBlob(envelopeID string, media io.Reader, mimeType string) *ApplianceInfoCreatePdfBlobOp { + return &ApplianceInfoCreatePdfBlobOp{ + Credential: s.credential, + Method: "POST", + Path: strings.Join([]string{"envelopes", envelopeID, "display_appliance_info", "pdf_blobs"}, "/"), + Payload: &esign.UploadFile{Reader: media, ContentType: mimeType}, + QueryOpts: make(url.Values), + Version: esign.VersionV21, + } +} + +// ApplianceInfoCreatePdfBlobOp implements DocuSign API SDK Uncategorized::createPdfBlob +type ApplianceInfoCreatePdfBlobOp esign.Op + +// Do executes the op. A nil context will return error. +func (op *ApplianceInfoCreatePdfBlobOp) Do(ctx context.Context) (*model.DisplayAppliancePdf, error) { + var res *model.DisplayAppliancePdf + return res, ((*esign.Op)(op)).Do(ctx, &res) +} + +// ApplianceInfoCreateRedeem returns signing URL for Display Appliance. +// If media is an io.ReadCloser, Do() will close media. +// operation is uncategorized and subject to change. +func (s *Service) ApplianceInfoCreateRedeem(media io.Reader, mimeType string) *ApplianceInfoCreateRedeemOp { + return &ApplianceInfoCreateRedeemOp{ + Credential: s.credential, + Method: "POST", + Path: "/v2.1/display_appliance_info/redeem", + Payload: &esign.UploadFile{Reader: media, ContentType: mimeType}, + QueryOpts: make(url.Values), + Version: esign.VersionV21, + } +} + +// ApplianceInfoCreateRedeemOp implements DocuSign API SDK Uncategorized::createRedeem +type ApplianceInfoCreateRedeemOp esign.Op + +// Do executes the op. A nil context will return error. +func (op *ApplianceInfoCreateRedeemOp) Do(ctx context.Context) (*model.DisplayApplianceInfo, error) { + var res *model.DisplayApplianceInfo + return res, ((*esign.Op)(op)).Do(ctx, &res) +} + +// ApplianceInfoDeleteCustomFields deletes custom fields information for Display Appliance. +// If media is an io.ReadCloser, Do() will close media. +// operation is uncategorized and subject to change. +func (s *Service) ApplianceInfoDeleteCustomFields(envelopeID string, media io.Reader, mimeType string) *ApplianceInfoDeleteCustomFieldsOp { + return &ApplianceInfoDeleteCustomFieldsOp{ + Credential: s.credential, + Method: "POST", + Path: strings.Join([]string{"envelopes", envelopeID, "display_appliance_info", "custom_fields", "delete"}, "/"), + Payload: &esign.UploadFile{Reader: media, ContentType: mimeType}, + QueryOpts: make(url.Values), + Version: esign.VersionV21, + } +} + +// ApplianceInfoDeleteCustomFieldsOp implements DocuSign API SDK Uncategorized::deleteCustomFields +type ApplianceInfoDeleteCustomFieldsOp esign.Op + +// Do executes the op. A nil context will return error. +func (op *ApplianceInfoDeleteCustomFieldsOp) Do(ctx context.Context) error { + return ((*esign.Op)(op)).Do(ctx, nil) +} + +// ApplianceInfoDeleteDocument deletes document information for Display Appliance. +// operation is uncategorized and subject to change. +func (s *Service) ApplianceInfoDeleteDocument(documentID string, envelopeID string) *ApplianceInfoDeleteDocumentOp { + return &ApplianceInfoDeleteDocumentOp{ + Credential: s.credential, + Method: "DELETE", + Path: strings.Join([]string{"envelopes", envelopeID, "display_appliance_info", "document", documentID}, "/"), + QueryOpts: make(url.Values), + Version: esign.VersionV21, + } +} + +// ApplianceInfoDeleteDocumentOp implements DocuSign API SDK Uncategorized::deleteDocument +type ApplianceInfoDeleteDocumentOp esign.Op + +// Do executes the op. A nil context will return error. +func (op *ApplianceInfoDeleteDocumentOp) Do(ctx context.Context) error { + return ((*esign.Op)(op)).Do(ctx, nil) +} + +// ApplianceInfoDeletePageInfo deletes page information for Display Appliance. +// If media is an io.ReadCloser, Do() will close media. +// operation is uncategorized and subject to change. +func (s *Service) ApplianceInfoDeletePageInfo(envelopeID string, media io.Reader, mimeType string) *ApplianceInfoDeletePageInfoOp { + return &ApplianceInfoDeletePageInfoOp{ + Credential: s.credential, + Method: "POST", + Path: strings.Join([]string{"envelopes", envelopeID, "display_appliance_info", "page_info", "delete"}, "/"), + Payload: &esign.UploadFile{Reader: media, ContentType: mimeType}, + QueryOpts: make(url.Values), + Version: esign.VersionV21, + } +} + +// ApplianceInfoDeletePageInfoOp implements DocuSign API SDK Uncategorized::deletePageInfo +type ApplianceInfoDeletePageInfoOp esign.Op + +// Do executes the op. A nil context will return error. +func (op *ApplianceInfoDeletePageInfoOp) Do(ctx context.Context) error { + return ((*esign.Op)(op)).Do(ctx, nil) +} + +// ApplianceInfoDeleteRecipientDeniedDocumentCopy deletes RecipientDeniedDocumentCopy for Display Appliance. +// operation is uncategorized and subject to change. +func (s *Service) ApplianceInfoDeleteRecipientDeniedDocumentCopy(envelopeID string) *ApplianceInfoDeleteRecipientDeniedDocumentCopyOp { + return &ApplianceInfoDeleteRecipientDeniedDocumentCopyOp{ + Credential: s.credential, + Method: "DELETE", + Path: strings.Join([]string{"envelopes", envelopeID, "display_appliance_info", "recipient_denied_copy"}, "/"), + QueryOpts: make(url.Values), + Version: esign.VersionV21, + } +} + +// ApplianceInfoDeleteRecipientDeniedDocumentCopyOp implements DocuSign API SDK Uncategorized::deleteRecipientDeniedDocumentCopy +type ApplianceInfoDeleteRecipientDeniedDocumentCopyOp esign.Op + +// Do executes the op. A nil context will return error. +func (op *ApplianceInfoDeleteRecipientDeniedDocumentCopyOp) Do(ctx context.Context) error { + return ((*esign.Op)(op)).Do(ctx, nil) +} + +// ApplianceInfoDeleteSignerAttachment deletes signer attachment information for Display Appliance. +// operation is uncategorized and subject to change. +func (s *Service) ApplianceInfoDeleteSignerAttachment(envelopeID string) *ApplianceInfoDeleteSignerAttachmentOp { + return &ApplianceInfoDeleteSignerAttachmentOp{ + Credential: s.credential, + Method: "DELETE", + Path: strings.Join([]string{"envelopes", envelopeID, "display_appliance_info", "signer_attachment_info"}, "/"), + QueryOpts: make(url.Values), + Version: esign.VersionV21, + } +} + +// ApplianceInfoDeleteSignerAttachmentOp implements DocuSign API SDK Uncategorized::deleteSignerAttachment +type ApplianceInfoDeleteSignerAttachmentOp esign.Op + +// Do executes the op. A nil context will return error. +func (op *ApplianceInfoDeleteSignerAttachmentOp) Do(ctx context.Context) error { + return ((*esign.Op)(op)).Do(ctx, nil) +} + +// ApplianceInfoGetAccount returns envelope account information for Display Appliance. +// operation is uncategorized and subject to change. +func (s *Service) ApplianceInfoGetAccount(envelopeID string) *ApplianceInfoGetAccountOp { + return &ApplianceInfoGetAccountOp{ + Credential: s.credential, + Method: "GET", + Path: strings.Join([]string{"envelopes", envelopeID, "display_appliance_info", "account_info"}, "/"), + QueryOpts: make(url.Values), + Version: esign.VersionV21, + } +} + +// ApplianceInfoGetAccountOp implements DocuSign API SDK Uncategorized::getAccount +type ApplianceInfoGetAccountOp esign.Op + +// Do executes the op. A nil context will return error. +func (op *ApplianceInfoGetAccountOp) Do(ctx context.Context) (*model.DisplayApplianceAccount, error) { + var res *model.DisplayApplianceAccount + return res, ((*esign.Op)(op)).Do(ctx, &res) +} + +// ApplianceInfoGetApplianceInfo returns envelope and recipient information for Display Appliance. +// operation is uncategorized and subject to change. +func (s *Service) ApplianceInfoGetApplianceInfo(envelopeID string) *ApplianceInfoGetApplianceInfoOp { + return &ApplianceInfoGetApplianceInfoOp{ + Credential: s.credential, + Method: "GET", + Path: strings.Join([]string{"envelopes", envelopeID, "display_appliance_info"}, "/"), + QueryOpts: make(url.Values), + Version: esign.VersionV21, + } +} + +// ApplianceInfoGetApplianceInfoOp implements DocuSign API SDK Uncategorized::getApplianceInfo +type ApplianceInfoGetApplianceInfoOp esign.Op + +// Do executes the op. A nil context will return error. +func (op *ApplianceInfoGetApplianceInfoOp) Do(ctx context.Context) (*model.DisplayApplianceInfo, error) { + var res *model.DisplayApplianceInfo + return res, ((*esign.Op)(op)).Do(ctx, &res) +} + +// ApplianceInfoGetCustomFields return custom fields information for Display Appliance. +// operation is uncategorized and subject to change. +func (s *Service) ApplianceInfoGetCustomFields(envelopeID string) *ApplianceInfoGetCustomFieldsOp { + return &ApplianceInfoGetCustomFieldsOp{ + Credential: s.credential, + Method: "GET", + Path: strings.Join([]string{"envelopes", envelopeID, "display_appliance_info", "custom_fields"}, "/"), + QueryOpts: make(url.Values), + Version: esign.VersionV21, + } +} + +// ApplianceInfoGetCustomFieldsOp implements DocuSign API SDK Uncategorized::getCustomFields +type ApplianceInfoGetCustomFieldsOp esign.Op + +// Do executes the op. A nil context will return error. +func (op *ApplianceInfoGetCustomFieldsOp) Do(ctx context.Context) (*model.DisplayApplianceInfo, error) { + var res *model.DisplayApplianceInfo + return res, ((*esign.Op)(op)).Do(ctx, &res) +} + +// ApplianceInfoGetDateSigned gets date signed information for Display Appliance. +// operation is uncategorized and subject to change. +func (s *Service) ApplianceInfoGetDateSigned(envelopeID string) *ApplianceInfoGetDateSignedOp { + return &ApplianceInfoGetDateSignedOp{ + Credential: s.credential, + Method: "GET", + Path: strings.Join([]string{"envelopes", envelopeID, "display_appliance_info", "date_signed"}, "/"), + QueryOpts: make(url.Values), + Version: esign.VersionV21, + } +} + +// ApplianceInfoGetDateSignedOp implements DocuSign API SDK Uncategorized::getDateSigned +type ApplianceInfoGetDateSignedOp esign.Op + +// Do executes the op. A nil context will return error. +func (op *ApplianceInfoGetDateSignedOp) Do(ctx context.Context) (*model.DisplayApplianceInfo, error) { + var res *model.DisplayApplianceInfo + return res, ((*esign.Op)(op)).Do(ctx, &res) +} + +// ApplianceInfoGetDocumentPages return document pages for Display Appliance. +// operation is uncategorized and subject to change. +func (s *Service) ApplianceInfoGetDocumentPages(envelopeID string) *ApplianceInfoGetDocumentPagesOp { + return &ApplianceInfoGetDocumentPagesOp{ + Credential: s.credential, + Method: "GET", + Path: strings.Join([]string{"envelopes", envelopeID, "display_appliance_info", "document_page_list"}, "/"), + QueryOpts: make(url.Values), + Version: esign.VersionV21, + } +} + +// ApplianceInfoGetDocumentPagesOp implements DocuSign API SDK Uncategorized::getDocumentPages +type ApplianceInfoGetDocumentPagesOp esign.Op + +// Do executes the op. A nil context will return error. +func (op *ApplianceInfoGetDocumentPagesOp) Do(ctx context.Context) (*model.DisplayApplianceInfo, error) { + var res *model.DisplayApplianceInfo + return res, ((*esign.Op)(op)).Do(ctx, &res) +} + +// ApplianceInfoGetDynamicSystemSettings returns document pages for Display Appliance. +// operation is uncategorized and subject to change. +func (s *Service) ApplianceInfoGetDynamicSystemSettings() *ApplianceInfoGetDynamicSystemSettingsOp { + return &ApplianceInfoGetDynamicSystemSettingsOp{ + Credential: s.credential, + Method: "GET", + Path: "display_appliance_info/dynamicsystemsettings", + QueryOpts: make(url.Values), + Version: esign.VersionV21, + } +} + +// ApplianceInfoGetDynamicSystemSettingsOp implements DocuSign API SDK Uncategorized::getDynamicSystemSettings +type ApplianceInfoGetDynamicSystemSettingsOp esign.Op + +// Do executes the op. A nil context will return error. +func (op *ApplianceInfoGetDynamicSystemSettingsOp) Do(ctx context.Context) (*model.DisplayApplianceInfo, error) { + var res *model.DisplayApplianceInfo + return res, ((*esign.Op)(op)).Do(ctx, &res) +} + +// ApplianceInfoGetImage returns images for Display Appliance. +// If media is an io.ReadCloser, Do() will close media. +// operation is uncategorized and subject to change. +func (s *Service) ApplianceInfoGetImage(envelopeID string, media io.Reader, mimeType string) *ApplianceInfoGetImageOp { + return &ApplianceInfoGetImageOp{ + Credential: s.credential, + Method: "POST", + Path: strings.Join([]string{"envelopes", envelopeID, "display_appliance_info", "image"}, "/"), + Payload: &esign.UploadFile{Reader: media, ContentType: mimeType}, + QueryOpts: make(url.Values), + Version: esign.VersionV21, + } +} + +// ApplianceInfoGetImageOp implements DocuSign API SDK Uncategorized::getImage +type ApplianceInfoGetImageOp esign.Op + +// Do executes the op. A nil context will return error. +func (op *ApplianceInfoGetImageOp) Do(ctx context.Context) (*model.DisplayApplianceInfo, error) { + var res *model.DisplayApplianceInfo + return res, ((*esign.Op)(op)).Do(ctx, &res) +} + +// ApplianceInfoGetLocalePolicy returns locale policy information for Display Appliance. +// If media is an io.ReadCloser, Do() will close media. +// operation is uncategorized and subject to change. +func (s *Service) ApplianceInfoGetLocalePolicy(envelopeID string, userID string, media io.Reader, mimeType string) *ApplianceInfoGetLocalePolicyOp { + return &ApplianceInfoGetLocalePolicyOp{ + Credential: s.credential, + Method: "POST", + Path: strings.Join([]string{"envelopes", envelopeID, "display_appliance_info", "localepolicy", userID}, "/"), + Payload: &esign.UploadFile{Reader: media, ContentType: mimeType}, + QueryOpts: make(url.Values), + Version: esign.VersionV21, + } +} + +// ApplianceInfoGetLocalePolicyOp implements DocuSign API SDK Uncategorized::getLocalePolicy +type ApplianceInfoGetLocalePolicyOp esign.Op + +// Do executes the op. A nil context will return error. +func (op *ApplianceInfoGetLocalePolicyOp) Do(ctx context.Context) (*model.DisplayApplianceInfo, error) { + var res *model.DisplayApplianceInfo + return res, ((*esign.Op)(op)).Do(ctx, &res) +} + +// ApplianceInfoGetPdf return PDF for Display Appliance. +// operation is uncategorized and subject to change. +func (s *Service) ApplianceInfoGetPdf(envelopeID string, pdfID string) *ApplianceInfoGetPdfOp { + return &ApplianceInfoGetPdfOp{ + Credential: s.credential, + Method: "GET", + Path: strings.Join([]string{"envelopes", envelopeID, "display_appliance_info", "pdf", pdfID}, "/"), + QueryOpts: make(url.Values), + Version: esign.VersionV21, + } +} + +// ApplianceInfoGetPdfOp implements DocuSign API SDK Uncategorized::getPdf +type ApplianceInfoGetPdfOp esign.Op + +// Do executes the op. A nil context will return error. +func (op *ApplianceInfoGetPdfOp) Do(ctx context.Context) (*model.DisplayAppliancePdf, error) { + var res *model.DisplayAppliancePdf + return res, ((*esign.Op)(op)).Do(ctx, &res) +} + +// ApplianceInfoGetPdfBlob returns PDF blobs for Display Appliance. +// operation is uncategorized and subject to change. +func (s *Service) ApplianceInfoGetPdfBlob(envelopeID string) *ApplianceInfoGetPdfBlobOp { + return &ApplianceInfoGetPdfBlobOp{ + Credential: s.credential, + Method: "GET", + Path: strings.Join([]string{"envelopes", envelopeID, "display_appliance_info", "pdf_blobs"}, "/"), + QueryOpts: make(url.Values), + Version: esign.VersionV21, + } +} + +// ApplianceInfoGetPdfBlobOp implements DocuSign API SDK Uncategorized::getPdfBlob +type ApplianceInfoGetPdfBlobOp esign.Op + +// Do executes the op. A nil context will return error. +func (op *ApplianceInfoGetPdfBlobOp) Do(ctx context.Context) (*model.DisplayAppliancePdf, error) { + var res *model.DisplayAppliancePdf + return res, ((*esign.Op)(op)).Do(ctx, &res) +} + +// ApplianceInfoGetSignerAttachment returns signer attachment information for Display Appliance. +// operation is uncategorized and subject to change. +func (s *Service) ApplianceInfoGetSignerAttachment(envelopeID string) *ApplianceInfoGetSignerAttachmentOp { + return &ApplianceInfoGetSignerAttachmentOp{ + Credential: s.credential, + Method: "GET", + Path: strings.Join([]string{"envelopes", envelopeID, "display_appliance_info", "signer_attachment_info"}, "/"), + QueryOpts: make(url.Values), + Version: esign.VersionV21, + } +} + +// ApplianceInfoGetSignerAttachmentOp implements DocuSign API SDK Uncategorized::getSignerAttachment +type ApplianceInfoGetSignerAttachmentOp esign.Op + +// Do executes the op. A nil context will return error. +func (op *ApplianceInfoGetSignerAttachmentOp) Do(ctx context.Context) (*model.DisplayApplianceSignerAttachment, error) { + var res *model.DisplayApplianceSignerAttachment + return res, ((*esign.Op)(op)).Do(ctx, &res) +} + +// ApplianceInfoGetTemplateInfo returns whether a template was encrypted by Display Appliance. +// If media is an io.ReadCloser, Do() will close media. +// operation is uncategorized and subject to change. +func (s *Service) ApplianceInfoGetTemplateInfo(media io.Reader, mimeType string) *ApplianceInfoGetTemplateInfoOp { + return &ApplianceInfoGetTemplateInfoOp{ + Credential: s.credential, + Method: "POST", + Path: "display_appliance_info/templateInfo", + Payload: &esign.UploadFile{Reader: media, ContentType: mimeType}, + QueryOpts: make(url.Values), + Version: esign.VersionV21, + } +} + +// ApplianceInfoGetTemplateInfoOp implements DocuSign API SDK Uncategorized::getTemplateInfo +type ApplianceInfoGetTemplateInfoOp esign.Op + +// Do executes the op. A nil context will return error. +func (op *ApplianceInfoGetTemplateInfoOp) Do(ctx context.Context) (*model.DisplayApplianceInfo, error) { + var res *model.DisplayApplianceInfo + return res, ((*esign.Op)(op)).Do(ctx, &res) +} + +// ApplianceInfoUpdateDocument updates document information for Display Applianc. +// If media is an io.ReadCloser, Do() will close media. +// operation is uncategorized and subject to change. +func (s *Service) ApplianceInfoUpdateDocument(documentID string, envelopeID string, media io.Reader, mimeType string) *ApplianceInfoUpdateDocumentOp { + return &ApplianceInfoUpdateDocumentOp{ + Credential: s.credential, + Method: "PUT", + Path: strings.Join([]string{"envelopes", envelopeID, "display_appliance_info", "document", documentID}, "/"), + Payload: &esign.UploadFile{Reader: media, ContentType: mimeType}, + QueryOpts: make(url.Values), + Version: esign.VersionV21, + } +} + +// ApplianceInfoUpdateDocumentOp implements DocuSign API SDK Uncategorized::updateDocument +type ApplianceInfoUpdateDocumentOp esign.Op + +// Do executes the op. A nil context will return error. +func (op *ApplianceInfoUpdateDocumentOp) Do(ctx context.Context) error { + return ((*esign.Op)(op)).Do(ctx, nil) +} + +// ApplianceInfoUpdatePageInfo updates page information for Display Appliance. +// If media is an io.ReadCloser, Do() will close media. +// operation is uncategorized and subject to change. +func (s *Service) ApplianceInfoUpdatePageInfo(envelopeID string, media io.Reader, mimeType string) *ApplianceInfoUpdatePageInfoOp { + return &ApplianceInfoUpdatePageInfoOp{ + Credential: s.credential, + Method: "PUT", + Path: strings.Join([]string{"envelopes", envelopeID, "display_appliance_info", "page_info"}, "/"), + Payload: &esign.UploadFile{Reader: media, ContentType: mimeType}, + QueryOpts: make(url.Values), + Version: esign.VersionV21, + } +} + +// ApplianceInfoUpdatePageInfoOp implements DocuSign API SDK Uncategorized::updatePageInfo +type ApplianceInfoUpdatePageInfoOp esign.Op + +// Do executes the op. A nil context will return error. +func (op *ApplianceInfoUpdatePageInfoOp) Do(ctx context.Context) error { + return ((*esign.Op)(op)).Do(ctx, nil) +} + +// ApplianceInfoUpdatePdf sets latest PDF for Display Appliance. +// If media is an io.ReadCloser, Do() will close media. +// operation is uncategorized and subject to change. +func (s *Service) ApplianceInfoUpdatePdf(envelopeID string, media io.Reader, mimeType string) *ApplianceInfoUpdatePdfOp { + return &ApplianceInfoUpdatePdfOp{ + Credential: s.credential, + Method: "PUT", + Path: strings.Join([]string{"envelopes", envelopeID, "display_appliance_info", "pdf"}, "/"), + Payload: &esign.UploadFile{Reader: media, ContentType: mimeType}, + QueryOpts: make(url.Values), + Version: esign.VersionV21, + } +} + +// ApplianceInfoUpdatePdfOp implements DocuSign API SDK Uncategorized::updatePdf +type ApplianceInfoUpdatePdfOp esign.Op + +// Do executes the op. A nil context will return error. +func (op *ApplianceInfoUpdatePdfOp) Do(ctx context.Context) (*model.DisplayAppliancePdf, error) { + var res *model.DisplayAppliancePdf + return res, ((*esign.Op)(op)).Do(ctx, &res) +} + +// ApplianceInfoUpdatePdfBlob updates PDF blobs for Display Appliance. +// If media is an io.ReadCloser, Do() will close media. +// operation is uncategorized and subject to change. +func (s *Service) ApplianceInfoUpdatePdfBlob(envelopeID string, media io.Reader, mimeType string) *ApplianceInfoUpdatePdfBlobOp { + return &ApplianceInfoUpdatePdfBlobOp{ + Credential: s.credential, + Method: "PUT", + Path: strings.Join([]string{"envelopes", envelopeID, "display_appliance_info", "pdf_blobs"}, "/"), + Payload: &esign.UploadFile{Reader: media, ContentType: mimeType}, + QueryOpts: make(url.Values), + Version: esign.VersionV21, + } +} + +// ApplianceInfoUpdatePdfBlobOp implements DocuSign API SDK Uncategorized::updatePdfBlob +type ApplianceInfoUpdatePdfBlobOp esign.Op + +// Do executes the op. A nil context will return error. +func (op *ApplianceInfoUpdatePdfBlobOp) Do(ctx context.Context) error { + return ((*esign.Op)(op)).Do(ctx, nil) +} + +// ApplianceInfoUpdateRecipientDeniedDocumentCopy updates RecipientDeniedDocumentCopy for Display Appliance. +// If media is an io.ReadCloser, Do() will close media. +// operation is uncategorized and subject to change. +func (s *Service) ApplianceInfoUpdateRecipientDeniedDocumentCopy(envelopeID string, media io.Reader, mimeType string) *ApplianceInfoUpdateRecipientDeniedDocumentCopyOp { + return &ApplianceInfoUpdateRecipientDeniedDocumentCopyOp{ + Credential: s.credential, + Method: "PUT", + Path: strings.Join([]string{"envelopes", envelopeID, "display_appliance_info", "recipient_denied_copy"}, "/"), + Payload: &esign.UploadFile{Reader: media, ContentType: mimeType}, + QueryOpts: make(url.Values), + Version: esign.VersionV21, + } +} + +// ApplianceInfoUpdateRecipientDeniedDocumentCopyOp implements DocuSign API SDK Uncategorized::updateRecipientDeniedDocumentCopy +type ApplianceInfoUpdateRecipientDeniedDocumentCopyOp esign.Op + +// Do executes the op. A nil context will return error. +func (op *ApplianceInfoUpdateRecipientDeniedDocumentCopyOp) Do(ctx context.Context) error { + return ((*esign.Op)(op)).Do(ctx, nil) +} + +// BCCEmailArchiveCreate creates a BCC email archive configuration. +// operation is uncategorized and subject to change. +func (s *Service) BCCEmailArchiveCreate(bccEmailArchive *model.BccEmailArchive) *BCCEmailArchiveCreateOp { + return &BCCEmailArchiveCreateOp{ + Credential: s.credential, + Method: "POST", + Path: "settings/bcc_email_archives", + Payload: bccEmailArchive, + QueryOpts: make(url.Values), + Version: esign.VersionV21, + } +} + +// BCCEmailArchiveCreateOp implements DocuSign API SDK Uncategorized::create +type BCCEmailArchiveCreateOp esign.Op + +// Do executes the op. A nil context will return error. +func (op *BCCEmailArchiveCreateOp) Do(ctx context.Context) (*model.BccEmailArchive, error) { + var res *model.BccEmailArchive + return res, ((*esign.Op)(op)).Do(ctx, &res) +} + +// BCCEmailArchiveDelete deletes a BCC email archive configuration. +// operation is uncategorized and subject to change. +func (s *Service) BCCEmailArchiveDelete(bccEmailArchiveID string) *BCCEmailArchiveDeleteOp { + return &BCCEmailArchiveDeleteOp{ + Credential: s.credential, + Method: "DELETE", + Path: strings.Join([]string{"settings", "bcc_email_archives", bccEmailArchiveID}, "/"), + QueryOpts: make(url.Values), + Version: esign.VersionV21, + } +} + +// BCCEmailArchiveDeleteOp implements DocuSign API SDK Uncategorized::delete +type BCCEmailArchiveDeleteOp esign.Op + +// Do executes the op. A nil context will return error. +func (op *BCCEmailArchiveDeleteOp) Do(ctx context.Context) error { + return ((*esign.Op)(op)).Do(ctx, nil) +} + +// BCCEmailArchiveGet gets a BCC email archive configuration and its history. +// operation is uncategorized and subject to change. +func (s *Service) BCCEmailArchiveGet(bccEmailArchiveID string) *BCCEmailArchiveGetOp { + return &BCCEmailArchiveGetOp{ + Credential: s.credential, + Method: "GET", + Path: strings.Join([]string{"settings", "bcc_email_archives", bccEmailArchiveID}, "/"), + QueryOpts: make(url.Values), + Version: esign.VersionV21, + } +} + +// BCCEmailArchiveGetOp implements DocuSign API SDK Uncategorized::get +type BCCEmailArchiveGetOp esign.Op + +// Do executes the op. A nil context will return error. +func (op *BCCEmailArchiveGetOp) Do(ctx context.Context) (*model.BccEmailArchiveHistoryList, error) { + var res *model.BccEmailArchiveHistoryList + return res, ((*esign.Op)(op)).Do(ctx, &res) +} + +// Count (Optional) The maximum number of results (changes) to return. +func (op *BCCEmailArchiveGetOp) Count(val string) *BCCEmailArchiveGetOp { + if op != nil { + op.QueryOpts.Set("count", val) + } + return op +} + +// StartPosition (Optional) The index position within the total result set from which to start returning values. The default value is `0`. +func (op *BCCEmailArchiveGetOp) StartPosition(val string) *BCCEmailArchiveGetOp { + if op != nil { + op.QueryOpts.Set("start_position", val) + } + return op +} + +// BCCEmailArchiveList gets the BCC email archive configurations for an account. +// operation is uncategorized and subject to change. +func (s *Service) BCCEmailArchiveList() *BCCEmailArchiveListOp { + return &BCCEmailArchiveListOp{ + Credential: s.credential, + Method: "GET", + Path: "settings/bcc_email_archives", + QueryOpts: make(url.Values), + Version: esign.VersionV21, + } +} + +// BCCEmailArchiveListOp implements DocuSign API SDK Uncategorized::list +type BCCEmailArchiveListOp esign.Op + +// Do executes the op. A nil context will return error. +func (op *BCCEmailArchiveListOp) Do(ctx context.Context) (*model.BccEmailArchiveList, error) { + var res *model.BccEmailArchiveList + return res, ((*esign.Op)(op)).Do(ctx, &res) +} + +// Count (Optional) The maximum number of results to return. +func (op *BCCEmailArchiveListOp) Count(val string) *BCCEmailArchiveListOp { + if op != nil { + op.QueryOpts.Set("count", val) + } + return op +} + +// StartPosition (Optional) The index position within the total result set from which to start returning values. The default value is `0`. +func (op *BCCEmailArchiveListOp) StartPosition(val string) *BCCEmailArchiveListOp { + if op != nil { + op.QueryOpts.Set("start_position", val) + } + return op +} + +// BillingPlansGetDowngradeRequestBillingInfo returns downgrade plan information for the specified account. +// operation is uncategorized and subject to change. +func (s *Service) BillingPlansGetDowngradeRequestBillingInfo() *BillingPlansGetDowngradeRequestBillingInfoOp { + return &BillingPlansGetDowngradeRequestBillingInfoOp{ + Credential: s.credential, + Method: "GET", + Path: "billing_plan/downgrade", + QueryOpts: make(url.Values), + Version: esign.VersionV21, + } +} + +// BillingPlansGetDowngradeRequestBillingInfoOp implements DocuSign API SDK Uncategorized::getDowngradeRequestBillingInfo +type BillingPlansGetDowngradeRequestBillingInfoOp esign.Op + +// Do executes the op. A nil context will return error. +func (op *BillingPlansGetDowngradeRequestBillingInfoOp) Do(ctx context.Context) (*model.DowngradRequestBillingInfoResponse, error) { + var res *model.DowngradRequestBillingInfoResponse + return res, ((*esign.Op)(op)).Do(ctx, &res) +} + +// BillingPlansUpdateDowngradeAccountBillingPlan queues downgrade billing plan request for an account. +// operation is uncategorized and subject to change. +func (s *Service) BillingPlansUpdateDowngradeAccountBillingPlan(downgradeBillingPlanInformation *model.DowngradeBillingPlanInformation) *BillingPlansUpdateDowngradeAccountBillingPlanOp { + return &BillingPlansUpdateDowngradeAccountBillingPlanOp{ + Credential: s.credential, + Method: "PUT", + Path: "billing_plan/downgrade", + Payload: downgradeBillingPlanInformation, + QueryOpts: make(url.Values), + Version: esign.VersionV21, + } +} + +// BillingPlansUpdateDowngradeAccountBillingPlanOp implements DocuSign API SDK Uncategorized::updateDowngradeAccountBillingPlan +type BillingPlansUpdateDowngradeAccountBillingPlanOp esign.Op + +// Do executes the op. A nil context will return error. +func (op *BillingPlansUpdateDowngradeAccountBillingPlanOp) Do(ctx context.Context) (*model.DowngradePlanUpdateResponse, error) { + var res *model.DowngradePlanUpdateResponse + return res, ((*esign.Op)(op)).Do(ctx, &res) +} + +// BulkSendCreateBulkSendList creates a bulk send list +// operation is uncategorized and subject to change. +func (s *Service) BulkSendCreateBulkSendList(bulkSendingList *model.BulkSendingList) *BulkSendCreateBulkSendListOp { + return &BulkSendCreateBulkSendListOp{ + Credential: s.credential, + Method: "POST", + Path: "bulk_send_lists", + Payload: bulkSendingList, + QueryOpts: make(url.Values), + Version: esign.VersionV21, + } +} + +// BulkSendCreateBulkSendListOp implements DocuSign API SDK Uncategorized::createBulkSendList +type BulkSendCreateBulkSendListOp esign.Op + +// Do executes the op. A nil context will return error. +func (op *BulkSendCreateBulkSendListOp) Do(ctx context.Context) (*model.BulkSendingList, error) { + var res *model.BulkSendingList + return res, ((*esign.Op)(op)).Do(ctx, &res) +} + +// BulkSendCreateBulkSendRequest creates a bulk send request +// operation is uncategorized and subject to change. +func (s *Service) BulkSendCreateBulkSendRequest(bulkSendListID string, bulkSendRequest *model.BulkSendRequest) *BulkSendCreateBulkSendRequestOp { + return &BulkSendCreateBulkSendRequestOp{ + Credential: s.credential, + Method: "POST", + Path: strings.Join([]string{"bulk_send_lists", bulkSendListID, "send"}, "/"), + Payload: bulkSendRequest, + QueryOpts: make(url.Values), + Version: esign.VersionV21, + } +} + +// BulkSendCreateBulkSendRequestOp implements DocuSign API SDK Uncategorized::createBulkSendRequest +type BulkSendCreateBulkSendRequestOp esign.Op + +// Do executes the op. A nil context will return error. +func (op *BulkSendCreateBulkSendRequestOp) Do(ctx context.Context) (*model.BulkSendResponse, error) { + var res *model.BulkSendResponse + return res, ((*esign.Op)(op)).Do(ctx, &res) +} + +// BulkSendCreateBulkSendTestRequest creates a bulk send test +// operation is uncategorized and subject to change. +func (s *Service) BulkSendCreateBulkSendTestRequest(bulkSendListID string, bulkSendRequest *model.BulkSendRequest) *BulkSendCreateBulkSendTestRequestOp { + return &BulkSendCreateBulkSendTestRequestOp{ + Credential: s.credential, + Method: "POST", + Path: strings.Join([]string{"bulk_send_lists", bulkSendListID, "test"}, "/"), + Payload: bulkSendRequest, + QueryOpts: make(url.Values), + Version: esign.VersionV21, + } +} + +// BulkSendCreateBulkSendTestRequestOp implements DocuSign API SDK Uncategorized::createBulkSendTestRequest +type BulkSendCreateBulkSendTestRequestOp esign.Op + +// Do executes the op. A nil context will return error. +func (op *BulkSendCreateBulkSendTestRequestOp) Do(ctx context.Context) (*model.BulkSendTestResponse, error) { + var res *model.BulkSendTestResponse + return res, ((*esign.Op)(op)).Do(ctx, &res) +} + +// BulkSendDeleteBulkSendList deletes a bulk send list +// operation is uncategorized and subject to change. +func (s *Service) BulkSendDeleteBulkSendList(bulkSendListID string) *BulkSendDeleteBulkSendListOp { + return &BulkSendDeleteBulkSendListOp{ + Credential: s.credential, + Method: "DELETE", + Path: strings.Join([]string{"bulk_send_lists", bulkSendListID}, "/"), + QueryOpts: make(url.Values), + Version: esign.VersionV21, + } +} + +// BulkSendDeleteBulkSendListOp implements DocuSign API SDK Uncategorized::deleteBulkSendList +type BulkSendDeleteBulkSendListOp esign.Op + +// Do executes the op. A nil context will return error. +func (op *BulkSendDeleteBulkSendListOp) Do(ctx context.Context) (*model.BulkSendingListSummaries, error) { + var res *model.BulkSendingListSummaries + return res, ((*esign.Op)(op)).Do(ctx, &res) +} + +// BulkSendGetBulkSendBatchStatus gets the status of a specific bulk send batch. +// operation is uncategorized and subject to change. +func (s *Service) BulkSendGetBulkSendBatchStatus(bulkSendBatchID string) *BulkSendGetBulkSendBatchStatusOp { + return &BulkSendGetBulkSendBatchStatusOp{ + Credential: s.credential, + Method: "GET", + Path: strings.Join([]string{"bulk_send_batch", bulkSendBatchID}, "/"), + QueryOpts: make(url.Values), + Version: esign.VersionV21, + } +} + +// BulkSendGetBulkSendBatchStatusOp implements DocuSign API SDK Uncategorized::getBulkSendBatchStatus +type BulkSendGetBulkSendBatchStatusOp esign.Op + +// Do executes the op. A nil context will return error. +func (op *BulkSendGetBulkSendBatchStatusOp) Do(ctx context.Context) (*model.BulkSendBatchStatus, error) { + var res *model.BulkSendBatchStatus + return res, ((*esign.Op)(op)).Do(ctx, &res) +} + +// BulkSendGetBulkSendBatches returns a list of bulk send batch summaries. +// operation is uncategorized and subject to change. +func (s *Service) BulkSendGetBulkSendBatches() *BulkSendGetBulkSendBatchesOp { + return &BulkSendGetBulkSendBatchesOp{ + Credential: s.credential, + Method: "GET", + Path: "bulk_send_batch", + QueryOpts: make(url.Values), + Version: esign.VersionV21, + } +} + +// BulkSendGetBulkSendBatchesOp implements DocuSign API SDK Uncategorized::getBulkSendBatches +type BulkSendGetBulkSendBatchesOp esign.Op + +// Do executes the op. A nil context will return error. +func (op *BulkSendGetBulkSendBatchesOp) Do(ctx context.Context) (*model.BulkSendBatchSummaries, error) { + var res *model.BulkSendBatchSummaries + return res, ((*esign.Op)(op)).Do(ctx, &res) +} + +// BatchIds is a comma-separated list of batch IDs to query. +func (op *BulkSendGetBulkSendBatchesOp) BatchIds(val string) *BulkSendGetBulkSendBatchesOp { + if op != nil { + op.QueryOpts.Set("batch_ids", val) + } + return op +} + +// Count is the number of results to report. Must be a value from 1 to 1000. +// +// Default: 100 +func (op *BulkSendGetBulkSendBatchesOp) Count(val string) *BulkSendGetBulkSendBatchesOp { + if op != nil { + op.QueryOpts.Set("count", val) + } + return op +} + +// StartPosition is the start position for results. Essentially the number of results to skip before collecting them. Must be a value greater than 0. +func (op *BulkSendGetBulkSendBatchesOp) StartPosition(val string) *BulkSendGetBulkSendBatchesOp { + if op != nil { + op.QueryOpts.Set("start_position", val) + } + return op +} + +// Status is the kind of results to collect. Must be one of: +// +// - all +// - failed +// - sent +// - queued +func (op *BulkSendGetBulkSendBatchesOp) Status(val string) *BulkSendGetBulkSendBatchesOp { + if op != nil { + op.QueryOpts.Set("status", val) + } + return op +} + +// BulkSendGetBulkSendList gets a specific bulk send list +// operation is uncategorized and subject to change. +func (s *Service) BulkSendGetBulkSendList(bulkSendListID string) *BulkSendGetBulkSendListOp { + return &BulkSendGetBulkSendListOp{ + Credential: s.credential, + Method: "GET", + Path: strings.Join([]string{"bulk_send_lists", bulkSendListID}, "/"), + QueryOpts: make(url.Values), + Version: esign.VersionV21, + } +} + +// BulkSendGetBulkSendListOp implements DocuSign API SDK Uncategorized::getBulkSendList +type BulkSendGetBulkSendListOp esign.Op + +// Do executes the op. A nil context will return error. +func (op *BulkSendGetBulkSendListOp) Do(ctx context.Context) (*model.BulkSendingList, error) { + var res *model.BulkSendingList + return res, ((*esign.Op)(op)).Do(ctx, &res) +} + +// BulkSendGetBulkSendLists gets bulk send lists +// operation is uncategorized and subject to change. +func (s *Service) BulkSendGetBulkSendLists() *BulkSendGetBulkSendListsOp { + return &BulkSendGetBulkSendListsOp{ + Credential: s.credential, + Method: "GET", + Path: "bulk_send_lists", + QueryOpts: make(url.Values), + Version: esign.VersionV21, + } +} + +// BulkSendGetBulkSendListsOp implements DocuSign API SDK Uncategorized::getBulkSendLists +type BulkSendGetBulkSendListsOp esign.Op + +// Do executes the op. A nil context will return error. +func (op *BulkSendGetBulkSendListsOp) Do(ctx context.Context) (*model.BulkSendingListSummaries, error) { + var res *model.BulkSendingListSummaries + return res, ((*esign.Op)(op)).Do(ctx, &res) +} + +// BulkSendUpdateBulkSendBatchStatus updates a specific bulk send batch status. +// operation is uncategorized and subject to change. +func (s *Service) BulkSendUpdateBulkSendBatchStatus(bulkSendBatchID string, bulkSendBatchRequest *model.BulkSendBatchRequest) *BulkSendUpdateBulkSendBatchStatusOp { + return &BulkSendUpdateBulkSendBatchStatusOp{ + Credential: s.credential, + Method: "PUT", + Path: strings.Join([]string{"bulk_send_batch", bulkSendBatchID}, "/"), + Payload: bulkSendBatchRequest, + QueryOpts: make(url.Values), + Version: esign.VersionV21, + } +} + +// BulkSendUpdateBulkSendBatchStatusOp implements DocuSign API SDK Uncategorized::updateBulkSendBatchStatus +type BulkSendUpdateBulkSendBatchStatusOp esign.Op + +// Do executes the op. A nil context will return error. +func (op *BulkSendUpdateBulkSendBatchStatusOp) Do(ctx context.Context) (*model.BulkSendBatchStatus, error) { + var res *model.BulkSendBatchStatus + return res, ((*esign.Op)(op)).Do(ctx, &res) +} + +// BulkSendUpdateBulkSendList updates a bulk send list +// operation is uncategorized and subject to change. +func (s *Service) BulkSendUpdateBulkSendList(bulkSendListID string, bulkSendingList *model.BulkSendingList) *BulkSendUpdateBulkSendListOp { + return &BulkSendUpdateBulkSendListOp{ + Credential: s.credential, + Method: "PUT", + Path: strings.Join([]string{"bulk_send_lists", bulkSendListID}, "/"), + Payload: bulkSendingList, + QueryOpts: make(url.Values), + Version: esign.VersionV21, + } +} + +// BulkSendUpdateBulkSendListOp implements DocuSign API SDK Uncategorized::updateBulkSendList +type BulkSendUpdateBulkSendListOp esign.Op + +// Do executes the op. A nil context will return error. +func (op *BulkSendUpdateBulkSendListOp) Do(ctx context.Context) (*model.BulkSendingList, error) { + var res *model.BulkSendingList + return res, ((*esign.Op)(op)).Do(ctx, &res) +} + +// CommentsGet gets a PDF transcript of all of the comments in an envelope. +// operation is uncategorized and subject to change. +func (s *Service) CommentsGet(envelopeID string) *CommentsGetOp { + return &CommentsGetOp{ + Credential: s.credential, + Method: "GET", + Path: strings.Join([]string{"envelopes", envelopeID, "comments", "transcript"}, "/"), + Accept: "application/pdf", + QueryOpts: make(url.Values), + Version: esign.VersionV21, + } +} + +// CommentsGetOp implements DocuSign API SDK Uncategorized::getCommentsTranscript +type CommentsGetOp esign.Op + +// Do executes the op. A nil context will return error. +func (op *CommentsGetOp) Do(ctx context.Context) (*esign.Download, error) { + var res *esign.Download + return res, ((*esign.Op)(op)).Do(ctx, &res) +} + +// Encoding (Optional) The encoding to use for the file. +func (op *CommentsGetOp) Encoding(val string) *CommentsGetOp { + if op != nil { + op.QueryOpts.Set("encoding", val) + } + return op +} + +// ConnectSecretDeleteConnectSecret deletes the connect HMAC Secret for specified account. +// operation is uncategorized and subject to change. +func (s *Service) ConnectSecretDeleteConnectSecret(keyID string) *ConnectSecretDeleteConnectSecretOp { + return &ConnectSecretDeleteConnectSecretOp{ + Credential: s.credential, + Method: "DELETE", + Path: strings.Join([]string{"connect", "secret", keyID}, "/"), + QueryOpts: make(url.Values), + Version: esign.VersionV21, + } +} + +// ConnectSecretDeleteConnectSecretOp implements DocuSign API SDK Uncategorized::deleteConnectSecret +type ConnectSecretDeleteConnectSecretOp esign.Op + +// Do executes the op. A nil context will return error. +func (op *ConnectSecretDeleteConnectSecretOp) Do(ctx context.Context) error { + return ((*esign.Op)(op)).Do(ctx, nil) +} + +// DocumentResponsiveHTMLPreviewCreate creates a preview of the responsive version of a document. +// operation is uncategorized and subject to change. +func (s *Service) DocumentResponsiveHTMLPreviewCreate(documentID string, envelopeID string, documentHTMLDefinition *model.DocumentHTMLDefinition) *DocumentResponsiveHTMLPreviewCreateOp { + return &DocumentResponsiveHTMLPreviewCreateOp{ + Credential: s.credential, + Method: "POST", + Path: strings.Join([]string{"envelopes", envelopeID, "documents", documentID, "responsive_html_preview"}, "/"), + Payload: documentHTMLDefinition, + QueryOpts: make(url.Values), + Version: esign.VersionV21, + } +} + +// DocumentResponsiveHTMLPreviewCreateOp implements DocuSign API SDK Uncategorized::createDocumentResponsiveHtmlPreview +type DocumentResponsiveHTMLPreviewCreateOp esign.Op + +// Do executes the op. A nil context will return error. +func (op *DocumentResponsiveHTMLPreviewCreateOp) Do(ctx context.Context) (*model.DocumentHTMLDefinitions, error) { + var res *model.DocumentHTMLDefinitions + return res, ((*esign.Op)(op)).Do(ctx, &res) +} + +// EnvelopeDocumentHTMLDefinitionsGet gets the Original HTML Definition used to +// generate the Responsive HTML for a given document. +// operation is uncategorized and subject to change. +func (s *Service) EnvelopeDocumentHTMLDefinitionsGet(documentID string, envelopeID string) *EnvelopeDocumentHTMLDefinitionsGetOp { + return &EnvelopeDocumentHTMLDefinitionsGetOp{ + Credential: s.credential, + Method: "GET", + Path: strings.Join([]string{"envelopes", envelopeID, "documents", documentID, "html_definitions"}, "/"), + QueryOpts: make(url.Values), + Version: esign.VersionV21, + } +} + +// EnvelopeDocumentHTMLDefinitionsGetOp implements DocuSign API SDK Uncategorized::getEnvelopeDocumentHtmlDefinitions +type EnvelopeDocumentHTMLDefinitionsGetOp esign.Op + +// Do executes the op. A nil context will return error. +func (op *EnvelopeDocumentHTMLDefinitionsGetOp) Do(ctx context.Context) (*model.DocumentHTMLDefinitionOriginals, error) { + var res *model.DocumentHTMLDefinitionOriginals + return res, ((*esign.Op)(op)).Do(ctx, &res) +} + +// EnvelopeDocumentTabsCreate adds the tabs to an envelope document. +// operation is uncategorized and subject to change. +func (s *Service) EnvelopeDocumentTabsCreate(documentID string, envelopeID string, tabs *model.Tabs) *EnvelopeDocumentTabsCreateOp { + return &EnvelopeDocumentTabsCreateOp{ + Credential: s.credential, + Method: "POST", + Path: strings.Join([]string{"envelopes", envelopeID, "documents", documentID, "tabs"}, "/"), + Payload: tabs, + QueryOpts: make(url.Values), + Version: esign.VersionV21, + } +} + +// EnvelopeDocumentTabsCreateOp implements DocuSign API SDK Uncategorized::createDocumentTabs +type EnvelopeDocumentTabsCreateOp esign.Op + +// Do executes the op. A nil context will return error. +func (op *EnvelopeDocumentTabsCreateOp) Do(ctx context.Context) (*model.Tabs, error) { + var res *model.Tabs + return res, ((*esign.Op)(op)).Do(ctx, &res) +} + +// EnvelopeDocumentTabsDelete deletes tabs from an envelope document. +// operation is uncategorized and subject to change. +func (s *Service) EnvelopeDocumentTabsDelete(documentID string, envelopeID string, tabs *model.Tabs) *EnvelopeDocumentTabsDeleteOp { + return &EnvelopeDocumentTabsDeleteOp{ + Credential: s.credential, + Method: "DELETE", + Path: strings.Join([]string{"envelopes", envelopeID, "documents", documentID, "tabs"}, "/"), + Payload: tabs, + QueryOpts: make(url.Values), + Version: esign.VersionV21, + } +} + +// EnvelopeDocumentTabsDeleteOp implements DocuSign API SDK Uncategorized::deleteDocumentTabs +type EnvelopeDocumentTabsDeleteOp esign.Op + +// Do executes the op. A nil context will return error. +func (op *EnvelopeDocumentTabsDeleteOp) Do(ctx context.Context) (*model.Tabs, error) { + var res *model.Tabs + return res, ((*esign.Op)(op)).Do(ctx, &res) +} + +// EnvelopeDocumentTabsUpdate updates the tabs for an envelope document. +// operation is uncategorized and subject to change. +func (s *Service) EnvelopeDocumentTabsUpdate(documentID string, envelopeID string, tabs *model.Tabs) *EnvelopeDocumentTabsUpdateOp { + return &EnvelopeDocumentTabsUpdateOp{ + Credential: s.credential, + Method: "PUT", + Path: strings.Join([]string{"envelopes", envelopeID, "documents", documentID, "tabs"}, "/"), + Payload: tabs, + QueryOpts: make(url.Values), + Version: esign.VersionV21, + } +} + +// EnvelopeDocumentTabsUpdateOp implements DocuSign API SDK Uncategorized::updateDocumentTabs +type EnvelopeDocumentTabsUpdateOp esign.Op + +// Do executes the op. A nil context will return error. +func (op *EnvelopeDocumentTabsUpdateOp) Do(ctx context.Context) (*model.Tabs, error) { + var res *model.Tabs + return res, ((*esign.Op)(op)).Do(ctx, &res) +} + +// EnvelopeHTMLDefinitionsList gets the Original HTML Definition used to generate the Responsive HTML for the envelope. +// operation is uncategorized and subject to change. +func (s *Service) EnvelopeHTMLDefinitionsList(envelopeID string) *EnvelopeHTMLDefinitionsListOp { + return &EnvelopeHTMLDefinitionsListOp{ + Credential: s.credential, + Method: "GET", + Path: strings.Join([]string{"envelopes", envelopeID, "html_definitions"}, "/"), + QueryOpts: make(url.Values), + Version: esign.VersionV21, + } +} + +// EnvelopeHTMLDefinitionsListOp implements DocuSign API SDK Uncategorized::getEnvelopeHtmlDefinitions +type EnvelopeHTMLDefinitionsListOp esign.Op + +// Do executes the op. A nil context will return error. +func (op *EnvelopeHTMLDefinitionsListOp) Do(ctx context.Context) (*model.DocumentHTMLDefinitionOriginals, error) { + var res *model.DocumentHTMLDefinitionOriginals + return res, ((*esign.Op)(op)).Do(ctx, &res) +} + +// EnvelopeRecipientsCreateEnvelopeRecipientPreview creates an envelope recipient preview. +// operation is uncategorized and subject to change. +func (s *Service) EnvelopeRecipientsCreateEnvelopeRecipientPreview(envelopeID string, recipientPreviewRequest *model.RecipientPreviewRequest) *EnvelopeRecipientsCreateEnvelopeRecipientPreviewOp { + return &EnvelopeRecipientsCreateEnvelopeRecipientPreviewOp{ + Credential: s.credential, + Method: "POST", + Path: strings.Join([]string{"envelopes", envelopeID, "views", "recipient_preview"}, "/"), + Payload: recipientPreviewRequest, + QueryOpts: make(url.Values), + Version: esign.VersionV21, + } +} + +// EnvelopeRecipientsCreateEnvelopeRecipientPreviewOp implements DocuSign API SDK Uncategorized::createEnvelopeRecipientPreview +type EnvelopeRecipientsCreateEnvelopeRecipientPreviewOp esign.Op + +// Do executes the op. A nil context will return error. +func (op *EnvelopeRecipientsCreateEnvelopeRecipientPreviewOp) Do(ctx context.Context) (*model.ViewURL, error) { + var res *model.ViewURL + return res, ((*esign.Op)(op)).Do(ctx, &res) +} + +// EnvelopeRecipientsCreateRecipientManualReviewView create the link to the page for manually reviewing IDs. +// If media is an io.ReadCloser, Do() will close media. +// operation is uncategorized and subject to change. +func (s *Service) EnvelopeRecipientsCreateRecipientManualReviewView(envelopeID string, recipientID string, media io.Reader, mimeType string) *EnvelopeRecipientsCreateRecipientManualReviewViewOp { + return &EnvelopeRecipientsCreateRecipientManualReviewViewOp{ + Credential: s.credential, + Method: "POST", + Path: strings.Join([]string{"envelopes", envelopeID, "recipients", recipientID, "views", "identity_manual_review"}, "/"), + Payload: &esign.UploadFile{Reader: media, ContentType: mimeType}, + QueryOpts: make(url.Values), + Version: esign.VersionV21, + } +} + +// EnvelopeRecipientsCreateRecipientManualReviewViewOp implements DocuSign API SDK Uncategorized::createRecipientManualReviewView +type EnvelopeRecipientsCreateRecipientManualReviewViewOp esign.Op + +// Do executes the op. A nil context will return error. +func (op *EnvelopeRecipientsCreateRecipientManualReviewViewOp) Do(ctx context.Context) (*model.ViewURL, error) { + var res *model.ViewURL + return res, ((*esign.Op)(op)).Do(ctx, &res) +} + +// EnvelopeRecipientsCreateRecipientProofFileResourceToken creates a resource token for a sender to request ID Evidence data. +// If media is an io.ReadCloser, Do() will close media. +// operation is uncategorized and subject to change. +func (s *Service) EnvelopeRecipientsCreateRecipientProofFileResourceToken(envelopeID string, recipientID string, media io.Reader, mimeType string) *EnvelopeRecipientsCreateRecipientProofFileResourceTokenOp { + return &EnvelopeRecipientsCreateRecipientProofFileResourceTokenOp{ + Credential: s.credential, + Method: "POST", + Path: strings.Join([]string{"envelopes", envelopeID, "recipients", recipientID, "identity_proof_token"}, "/"), + Payload: &esign.UploadFile{Reader: media, ContentType: mimeType}, + QueryOpts: make(url.Values), + Version: esign.VersionV21, + } +} + +// EnvelopeRecipientsCreateRecipientProofFileResourceTokenOp implements DocuSign API SDK Uncategorized::createRecipientProofFileResourceToken +type EnvelopeRecipientsCreateRecipientProofFileResourceTokenOp esign.Op + +// Do executes the op. A nil context will return error. +func (op *EnvelopeRecipientsCreateRecipientProofFileResourceTokenOp) Do(ctx context.Context) (*model.ProofServiceResourceToken, error) { + var res *model.ProofServiceResourceToken + return res, ((*esign.Op)(op)).Do(ctx, &res) +} + +// EnvelopeTransferRulesCreate creates an envelope transfer rule. +// operation is uncategorized and subject to change. +func (s *Service) EnvelopeTransferRulesCreate(envelopeTransferRuleRequest *model.EnvelopeTransferRuleRequest) *EnvelopeTransferRulesCreateOp { + return &EnvelopeTransferRulesCreateOp{ Credential: s.credential, Method: "POST", - Path: strings.Join([]string{"envelopes", envelopeID, "comments"}, "/"), - Payload: commentsPublish, + Path: "envelopes/transfer_rules", + Payload: envelopeTransferRuleRequest, + QueryOpts: make(url.Values), + Version: esign.VersionV21, + } +} + +// EnvelopeTransferRulesCreateOp implements DocuSign API SDK Uncategorized::create +type EnvelopeTransferRulesCreateOp esign.Op + +// Do executes the op. A nil context will return error. +func (op *EnvelopeTransferRulesCreateOp) Do(ctx context.Context) (*model.EnvelopeTransferRuleInformation, error) { + var res *model.EnvelopeTransferRuleInformation + return res, ((*esign.Op)(op)).Do(ctx, &res) +} + +// EnvelopeTransferRulesDelete deletes an envelope transfer rule. +// operation is uncategorized and subject to change. +func (s *Service) EnvelopeTransferRulesDelete(envelopeTransferRuleID string) *EnvelopeTransferRulesDeleteOp { + return &EnvelopeTransferRulesDeleteOp{ + Credential: s.credential, + Method: "DELETE", + Path: strings.Join([]string{"envelopes", "transfer_rules", envelopeTransferRuleID}, "/"), + QueryOpts: make(url.Values), + Version: esign.VersionV21, + } +} + +// EnvelopeTransferRulesDeleteOp implements DocuSign API SDK Uncategorized::delete +type EnvelopeTransferRulesDeleteOp esign.Op + +// Do executes the op. A nil context will return error. +func (op *EnvelopeTransferRulesDeleteOp) Do(ctx context.Context) error { + return ((*esign.Op)(op)).Do(ctx, nil) +} + +// EnvelopeTransferRulesGet gets envelope transfer rules. +// operation is uncategorized and subject to change. +func (s *Service) EnvelopeTransferRulesGet() *EnvelopeTransferRulesGetOp { + return &EnvelopeTransferRulesGetOp{ + Credential: s.credential, + Method: "GET", + Path: "envelopes/transfer_rules", + QueryOpts: make(url.Values), + Version: esign.VersionV21, + } +} + +// EnvelopeTransferRulesGetOp implements DocuSign API SDK Uncategorized::get +type EnvelopeTransferRulesGetOp esign.Op + +// Do executes the op. A nil context will return error. +func (op *EnvelopeTransferRulesGetOp) Do(ctx context.Context) (*model.EnvelopeTransferRuleInformation, error) { + var res *model.EnvelopeTransferRuleInformation + return res, ((*esign.Op)(op)).Do(ctx, &res) +} + +// Count (Optional) The maximum number of results to return. +func (op *EnvelopeTransferRulesGetOp) Count(val string) *EnvelopeTransferRulesGetOp { + if op != nil { + op.QueryOpts.Set("count", val) + } + return op +} + +// StartPosition (Optional) The position within the total result set from which to start returning values. The value **thumbnail** may be used to return the page image. +func (op *EnvelopeTransferRulesGetOp) StartPosition(val string) *EnvelopeTransferRulesGetOp { + if op != nil { + op.QueryOpts.Set("start_position", val) + } + return op +} + +// EnvelopeTransferRulesUpdate changes the status of multiple envelope transfer rules. +// operation is uncategorized and subject to change. +func (s *Service) EnvelopeTransferRulesUpdate(envelopeTransferRuleInformation *model.EnvelopeTransferRuleInformation) *EnvelopeTransferRulesUpdateOp { + return &EnvelopeTransferRulesUpdateOp{ + Credential: s.credential, + Method: "PUT", + Path: "envelopes/transfer_rules", + Payload: envelopeTransferRuleInformation, + QueryOpts: make(url.Values), + Version: esign.VersionV21, + } +} + +// EnvelopeTransferRulesUpdateOp implements DocuSign API SDK Uncategorized::update +type EnvelopeTransferRulesUpdateOp esign.Op + +// Do executes the op. A nil context will return error. +func (op *EnvelopeTransferRulesUpdateOp) Do(ctx context.Context) (*model.EnvelopeTransferRuleInformation, error) { + var res *model.EnvelopeTransferRuleInformation + return res, ((*esign.Op)(op)).Do(ctx, &res) +} + +// EnvelopeTransferRulesUpdateEnvelopeTransferRule changes the status of an envelope transfer rule. +// operation is uncategorized and subject to change. +func (s *Service) EnvelopeTransferRulesUpdateEnvelopeTransferRule(envelopeTransferRuleID string, envelopeTransferRule *model.EnvelopeTransferRule) *EnvelopeTransferRulesUpdateEnvelopeTransferRuleOp { + return &EnvelopeTransferRulesUpdateEnvelopeTransferRuleOp{ + Credential: s.credential, + Method: "PUT", + Path: strings.Join([]string{"envelopes", "transfer_rules", envelopeTransferRuleID}, "/"), + Payload: envelopeTransferRule, QueryOpts: make(url.Values), Version: esign.VersionV21, } } -// CommentsCreateEnvelopeCommentsOp implements DocuSign API SDK Uncategorized::createEnvelopeComments -type CommentsCreateEnvelopeCommentsOp esign.Op +// EnvelopeTransferRulesUpdateEnvelopeTransferRuleOp implements DocuSign API SDK Uncategorized::updateEnvelopeTransferRule +type EnvelopeTransferRulesUpdateEnvelopeTransferRuleOp esign.Op // Do executes the op. A nil context will return error. -func (op *CommentsCreateEnvelopeCommentsOp) Do(ctx context.Context) (*model.CommentHistoryResult, error) { - var res *model.CommentHistoryResult +func (op *EnvelopeTransferRulesUpdateEnvelopeTransferRuleOp) Do(ctx context.Context) (*model.EnvelopeTransferRule, error) { + var res *model.EnvelopeTransferRule return res, ((*esign.Op)(op)).Do(ctx, &res) } -// CommentsGetis uncategorized and subject to change -func (s *Service) CommentsGet(envelopeID string) *CommentsGetOp { - return &CommentsGetOp{ +// EnvelopeViewsDeleteEnvelopeCorrectView revokes the correction view URL to the Envelope UI. +// operation is uncategorized and subject to change. +func (s *Service) EnvelopeViewsDeleteEnvelopeCorrectView(envelopeID string, correctViewRequest *model.CorrectViewRequest) *EnvelopeViewsDeleteEnvelopeCorrectViewOp { + return &EnvelopeViewsDeleteEnvelopeCorrectViewOp{ + Credential: s.credential, + Method: "DELETE", + Path: strings.Join([]string{"envelopes", envelopeID, "views", "correct"}, "/"), + Payload: correctViewRequest, + QueryOpts: make(url.Values), + Version: esign.VersionV21, + } +} + +// EnvelopeViewsDeleteEnvelopeCorrectViewOp implements DocuSign API SDK Uncategorized::deleteEnvelopeCorrectView +type EnvelopeViewsDeleteEnvelopeCorrectViewOp esign.Op + +// Do executes the op. A nil context will return error. +func (op *EnvelopeViewsDeleteEnvelopeCorrectViewOp) Do(ctx context.Context) error { + return ((*esign.Op)(op)).Do(ctx, nil) +} + +// EnvelopeWorkflowDefinitionDeleteEnvelopeWorkflowDefinition deletes an envelope's workflow definition. +// operation is uncategorized and subject to change. +func (s *Service) EnvelopeWorkflowDefinitionDeleteEnvelopeWorkflowDefinition(envelopeID string) *EnvelopeWorkflowDefinitionDeleteEnvelopeWorkflowDefinitionOp { + return &EnvelopeWorkflowDefinitionDeleteEnvelopeWorkflowDefinitionOp{ + Credential: s.credential, + Method: "DELETE", + Path: strings.Join([]string{"envelopes", envelopeID, "workflow"}, "/"), + QueryOpts: make(url.Values), + Version: esign.VersionV21, + } +} + +// EnvelopeWorkflowDefinitionDeleteEnvelopeWorkflowDefinitionOp implements DocuSign API SDK Uncategorized::deleteEnvelopeWorkflowDefinition +type EnvelopeWorkflowDefinitionDeleteEnvelopeWorkflowDefinitionOp esign.Op + +// Do executes the op. A nil context will return error. +func (op *EnvelopeWorkflowDefinitionDeleteEnvelopeWorkflowDefinitionOp) Do(ctx context.Context) error { + return ((*esign.Op)(op)).Do(ctx, nil) +} + +// EnvelopeWorkflowDefinitionDeleteTemplateWorkflowDefinition deletes a template's workflow definition. +// operation is uncategorized and subject to change. +func (s *Service) EnvelopeWorkflowDefinitionDeleteTemplateWorkflowDefinition(templateID string) *EnvelopeWorkflowDefinitionDeleteTemplateWorkflowDefinitionOp { + return &EnvelopeWorkflowDefinitionDeleteTemplateWorkflowDefinitionOp{ + Credential: s.credential, + Method: "DELETE", + Path: strings.Join([]string{"templates", templateID, "workflow"}, "/"), + QueryOpts: make(url.Values), + Version: esign.VersionV21, + } +} + +// EnvelopeWorkflowDefinitionDeleteTemplateWorkflowDefinitionOp implements DocuSign API SDK Uncategorized::deleteTemplateWorkflowDefinition +type EnvelopeWorkflowDefinitionDeleteTemplateWorkflowDefinitionOp esign.Op + +// Do executes the op. A nil context will return error. +func (op *EnvelopeWorkflowDefinitionDeleteTemplateWorkflowDefinitionOp) Do(ctx context.Context) error { + return ((*esign.Op)(op)).Do(ctx, nil) +} + +// EnvelopeWorkflowDefinitionGetEnvelopeWorkflowDefinition gets an envelope's workflow definition. +// operation is uncategorized and subject to change. +func (s *Service) EnvelopeWorkflowDefinitionGetEnvelopeWorkflowDefinition(envelopeID string) *EnvelopeWorkflowDefinitionGetEnvelopeWorkflowDefinitionOp { + return &EnvelopeWorkflowDefinitionGetEnvelopeWorkflowDefinitionOp{ Credential: s.credential, Method: "GET", - Path: strings.Join([]string{"envelopes", envelopeID, "comments", "transcript"}, "/"), - Accept: "application/pdf", + Path: strings.Join([]string{"envelopes", envelopeID, "workflow"}, "/"), QueryOpts: make(url.Values), Version: esign.VersionV21, } } -// CommentsGetOp implements DocuSign API SDK Uncategorized::getCommentsTranscript -type CommentsGetOp esign.Op +// EnvelopeWorkflowDefinitionGetEnvelopeWorkflowDefinitionOp implements DocuSign API SDK Uncategorized::getEnvelopeWorkflowDefinition +type EnvelopeWorkflowDefinitionGetEnvelopeWorkflowDefinitionOp esign.Op // Do executes the op. A nil context will return error. -func (op *CommentsGetOp) Do(ctx context.Context) (*esign.Download, error) { - var res *esign.Download +func (op *EnvelopeWorkflowDefinitionGetEnvelopeWorkflowDefinitionOp) Do(ctx context.Context) (*model.Workflow, error) { + var res *model.Workflow return res, ((*esign.Op)(op)).Do(ctx, &res) } -// Encoding set the call query parameter encoding -func (op *CommentsGetOp) Encoding(val string) *CommentsGetOp { - if op != nil { - op.QueryOpts.Set("encoding", val) +// EnvelopeWorkflowDefinitionGetTemplateWorkflowDefinition gets template's workflow definition. +// operation is uncategorized and subject to change. +func (s *Service) EnvelopeWorkflowDefinitionGetTemplateWorkflowDefinition(templateID string) *EnvelopeWorkflowDefinitionGetTemplateWorkflowDefinitionOp { + return &EnvelopeWorkflowDefinitionGetTemplateWorkflowDefinitionOp{ + Credential: s.credential, + Method: "GET", + Path: strings.Join([]string{"templates", templateID, "workflow"}, "/"), + QueryOpts: make(url.Values), + Version: esign.VersionV21, } - return op } -// DocumentResponsiveHTMLPreviewCreateis uncategorized and subject to change -func (s *Service) DocumentResponsiveHTMLPreviewCreate(documentID string, envelopeID string, documentHTMLDefinition *model.DocumentHTMLDefinition) *DocumentResponsiveHTMLPreviewCreateOp { - return &DocumentResponsiveHTMLPreviewCreateOp{ +// EnvelopeWorkflowDefinitionGetTemplateWorkflowDefinitionOp implements DocuSign API SDK Uncategorized::getTemplateWorkflowDefinition +type EnvelopeWorkflowDefinitionGetTemplateWorkflowDefinitionOp esign.Op + +// Do executes the op. A nil context will return error. +func (op *EnvelopeWorkflowDefinitionGetTemplateWorkflowDefinitionOp) Do(ctx context.Context) (*model.Workflow, error) { + var res *model.Workflow + return res, ((*esign.Op)(op)).Do(ctx, &res) +} + +// EnvelopeWorkflowDefinitionUpdateEnvelopeWorkflowDefinition updates an envelope's workflow definition. +// operation is uncategorized and subject to change. +func (s *Service) EnvelopeWorkflowDefinitionUpdateEnvelopeWorkflowDefinition(envelopeID string, workflow *model.Workflow) *EnvelopeWorkflowDefinitionUpdateEnvelopeWorkflowDefinitionOp { + return &EnvelopeWorkflowDefinitionUpdateEnvelopeWorkflowDefinitionOp{ Credential: s.credential, - Method: "POST", - Path: strings.Join([]string{"envelopes", envelopeID, "documents", documentID, "responsive_html_preview"}, "/"), - Payload: documentHTMLDefinition, + Method: "PUT", + Path: strings.Join([]string{"envelopes", envelopeID, "workflow"}, "/"), + Payload: workflow, QueryOpts: make(url.Values), Version: esign.VersionV21, } } -// DocumentResponsiveHTMLPreviewCreateOp implements DocuSign API SDK Uncategorized::createDocumentResponsiveHtmlPreview -type DocumentResponsiveHTMLPreviewCreateOp esign.Op +// EnvelopeWorkflowDefinitionUpdateEnvelopeWorkflowDefinitionOp implements DocuSign API SDK Uncategorized::updateEnvelopeWorkflowDefinition +type EnvelopeWorkflowDefinitionUpdateEnvelopeWorkflowDefinitionOp esign.Op // Do executes the op. A nil context will return error. -func (op *DocumentResponsiveHTMLPreviewCreateOp) Do(ctx context.Context) (*model.DocumentHTMLDefinitions, error) { - var res *model.DocumentHTMLDefinitions +func (op *EnvelopeWorkflowDefinitionUpdateEnvelopeWorkflowDefinitionOp) Do(ctx context.Context) (*model.Workflow, error) { + var res *model.Workflow return res, ((*esign.Op)(op)).Do(ctx, &res) } -// EnvelopeDocumentHTMLDefinitionsGetis uncategorized and subject to change -func (s *Service) EnvelopeDocumentHTMLDefinitionsGet(documentID string, envelopeID string) *EnvelopeDocumentHTMLDefinitionsGetOp { - return &EnvelopeDocumentHTMLDefinitionsGetOp{ +// EnvelopeWorkflowDefinitionUpdateTemplateWorkflowDefinition update a template's workflow definiton. +// operation is uncategorized and subject to change. +func (s *Service) EnvelopeWorkflowDefinitionUpdateTemplateWorkflowDefinition(templateID string, workflow *model.Workflow) *EnvelopeWorkflowDefinitionUpdateTemplateWorkflowDefinitionOp { + return &EnvelopeWorkflowDefinitionUpdateTemplateWorkflowDefinitionOp{ Credential: s.credential, - Method: "GET", - Path: strings.Join([]string{"envelopes", envelopeID, "documents", documentID, "html_definitions"}, "/"), + Method: "PUT", + Path: strings.Join([]string{"templates", templateID, "workflow"}, "/"), + Payload: workflow, QueryOpts: make(url.Values), Version: esign.VersionV21, } } -// EnvelopeDocumentHTMLDefinitionsGetOp implements DocuSign API SDK Uncategorized::getEnvelopeDocumentHtmlDefinitions -type EnvelopeDocumentHTMLDefinitionsGetOp esign.Op +// EnvelopeWorkflowDefinitionUpdateTemplateWorkflowDefinitionOp implements DocuSign API SDK Uncategorized::updateTemplateWorkflowDefinition +type EnvelopeWorkflowDefinitionUpdateTemplateWorkflowDefinitionOp esign.Op // Do executes the op. A nil context will return error. -func (op *EnvelopeDocumentHTMLDefinitionsGetOp) Do(ctx context.Context) (*model.DocumentHTMLDefinitionOriginals, error) { - var res *model.DocumentHTMLDefinitionOriginals +func (op *EnvelopeWorkflowDefinitionUpdateTemplateWorkflowDefinitionOp) Do(ctx context.Context) (*model.Workflow, error) { + var res *model.Workflow return res, ((*esign.Op)(op)).Do(ctx, &res) } -// EnvelopeDocumentTabsCreateDocumentTabsis uncategorized and subject to change -func (s *Service) EnvelopeDocumentTabsCreateDocumentTabs(documentID string, envelopeID string, templateRecipientTabs *model.Tabs) *EnvelopeDocumentTabsCreateDocumentTabsOp { - return &EnvelopeDocumentTabsCreateDocumentTabsOp{ +// FavoriteTemplatesGetFavoriteTemplates retrieves the list of favorited templates for this caller. +// operation is uncategorized and subject to change. +func (s *Service) FavoriteTemplatesGetFavoriteTemplates() *FavoriteTemplatesGetFavoriteTemplatesOp { + return &FavoriteTemplatesGetFavoriteTemplatesOp{ Credential: s.credential, - Method: "POST", - Path: strings.Join([]string{"envelopes", envelopeID, "documents", documentID, "tabs"}, "/"), - Payload: templateRecipientTabs, + Method: "GET", + Path: "favorite_templates", QueryOpts: make(url.Values), Version: esign.VersionV21, } } -// EnvelopeDocumentTabsCreateDocumentTabsOp implements DocuSign API SDK Uncategorized::createDocumentTabs -type EnvelopeDocumentTabsCreateDocumentTabsOp esign.Op +// FavoriteTemplatesGetFavoriteTemplatesOp implements DocuSign API SDK Uncategorized::getFavoriteTemplates +type FavoriteTemplatesGetFavoriteTemplatesOp esign.Op // Do executes the op. A nil context will return error. -func (op *EnvelopeDocumentTabsCreateDocumentTabsOp) Do(ctx context.Context) (*model.Tabs, error) { - var res *model.Tabs +func (op *FavoriteTemplatesGetFavoriteTemplatesOp) Do(ctx context.Context) (*model.FavoriteTemplatesInfo, error) { + var res *model.FavoriteTemplatesInfo return res, ((*esign.Op)(op)).Do(ctx, &res) } -// EnvelopeDocumentTabsDeleteDocumentTabsis uncategorized and subject to change -func (s *Service) EnvelopeDocumentTabsDeleteDocumentTabs(documentID string, envelopeID string, templateRecipientTabs *model.Tabs) *EnvelopeDocumentTabsDeleteDocumentTabsOp { - return &EnvelopeDocumentTabsDeleteDocumentTabsOp{ +// FavoriteTemplatesUnFavoriteTemplate unfavorites a template. +// operation is uncategorized and subject to change. +func (s *Service) FavoriteTemplatesUnFavoriteTemplate(favoriteTemplatesInfo *model.FavoriteTemplatesInfo) *FavoriteTemplatesUnFavoriteTemplateOp { + return &FavoriteTemplatesUnFavoriteTemplateOp{ Credential: s.credential, Method: "DELETE", - Path: strings.Join([]string{"envelopes", envelopeID, "documents", documentID, "tabs"}, "/"), - Payload: templateRecipientTabs, + Path: "favorite_templates", + Payload: favoriteTemplatesInfo, QueryOpts: make(url.Values), Version: esign.VersionV21, } } -// EnvelopeDocumentTabsDeleteDocumentTabsOp implements DocuSign API SDK Uncategorized::deleteDocumentTabs -type EnvelopeDocumentTabsDeleteDocumentTabsOp esign.Op +// FavoriteTemplatesUnFavoriteTemplateOp implements DocuSign API SDK Uncategorized::unFavoriteTemplate +type FavoriteTemplatesUnFavoriteTemplateOp esign.Op // Do executes the op. A nil context will return error. -func (op *EnvelopeDocumentTabsDeleteDocumentTabsOp) Do(ctx context.Context) (*model.Tabs, error) { - var res *model.Tabs +func (op *FavoriteTemplatesUnFavoriteTemplateOp) Do(ctx context.Context) (*model.FavoriteTemplatesInfo, error) { + var res *model.FavoriteTemplatesInfo return res, ((*esign.Op)(op)).Do(ctx, &res) } -// EnvelopeDocumentTabsUpdateDocumentTabsis uncategorized and subject to change -func (s *Service) EnvelopeDocumentTabsUpdateDocumentTabs(documentID string, envelopeID string, templateRecipientTabs *model.Tabs) *EnvelopeDocumentTabsUpdateDocumentTabsOp { - return &EnvelopeDocumentTabsUpdateDocumentTabsOp{ +// FavoriteTemplatesUpdateFavoriteTemplate sets a template as a favorite. +// +// operation is uncategorized and subject to change. +func (s *Service) FavoriteTemplatesUpdateFavoriteTemplate(favoriteTemplatesInfo *model.FavoriteTemplatesInfo) *FavoriteTemplatesUpdateFavoriteTemplateOp { + return &FavoriteTemplatesUpdateFavoriteTemplateOp{ Credential: s.credential, Method: "PUT", - Path: strings.Join([]string{"envelopes", envelopeID, "documents", documentID, "tabs"}, "/"), - Payload: templateRecipientTabs, + Path: "favorite_templates", + Payload: favoriteTemplatesInfo, QueryOpts: make(url.Values), Version: esign.VersionV21, } } -// EnvelopeDocumentTabsUpdateDocumentTabsOp implements DocuSign API SDK Uncategorized::updateDocumentTabs -type EnvelopeDocumentTabsUpdateDocumentTabsOp esign.Op +// FavoriteTemplatesUpdateFavoriteTemplateOp implements DocuSign API SDK Uncategorized::updateFavoriteTemplate +type FavoriteTemplatesUpdateFavoriteTemplateOp esign.Op // Do executes the op. A nil context will return error. -func (op *EnvelopeDocumentTabsUpdateDocumentTabsOp) Do(ctx context.Context) (*model.Tabs, error) { - var res *model.Tabs +func (op *FavoriteTemplatesUpdateFavoriteTemplateOp) Do(ctx context.Context) (*model.FavoriteTemplatesInfo, error) { + var res *model.FavoriteTemplatesInfo return res, ((*esign.Op)(op)).Do(ctx, &res) } -// EnvelopeHTMLDefinitionsListis uncategorized and subject to change -func (s *Service) EnvelopeHTMLDefinitionsList(envelopeID string) *EnvelopeHTMLDefinitionsListOp { - return &EnvelopeHTMLDefinitionsListOp{ +// NotaryCreateNotary registers the current user as a notary. +// operation is uncategorized and subject to change. +func (s *Service) NotaryCreateNotary(notary *model.Notary) *NotaryCreateNotaryOp { + return &NotaryCreateNotaryOp{ Credential: s.credential, - Method: "GET", - Path: strings.Join([]string{"envelopes", envelopeID, "html_definitions"}, "/"), + Method: "POST", + Path: "/v2.1/current_user/notary", + Payload: notary, QueryOpts: make(url.Values), Version: esign.VersionV21, } } -// EnvelopeHTMLDefinitionsListOp implements DocuSign API SDK Uncategorized::getEnvelopeHtmlDefinitions -type EnvelopeHTMLDefinitionsListOp esign.Op +// NotaryCreateNotaryOp implements DocuSign API SDK Uncategorized::createNotary +type NotaryCreateNotaryOp esign.Op // Do executes the op. A nil context will return error. -func (op *EnvelopeHTMLDefinitionsListOp) Do(ctx context.Context) (*model.DocumentHTMLDefinitionOriginals, error) { - var res *model.DocumentHTMLDefinitionOriginals +func (op *NotaryCreateNotaryOp) Do(ctx context.Context) (*model.Notary, error) { + var res *model.Notary return res, ((*esign.Op)(op)).Do(ctx, &res) } -// EnvelopePurgeConfigurationGetEnvelopePurgeConfigurationis uncategorized and subject to change -func (s *Service) EnvelopePurgeConfigurationGetEnvelopePurgeConfiguration() *EnvelopePurgeConfigurationGetEnvelopePurgeConfigurationOp { - return &EnvelopePurgeConfigurationGetEnvelopePurgeConfigurationOp{ +// NotaryGetNotary gets settings for a notary user. +// operation is uncategorized and subject to change. +func (s *Service) NotaryGetNotary() *NotaryGetNotaryOp { + return &NotaryGetNotaryOp{ Credential: s.credential, Method: "GET", - Path: "settings/envelope_purge_configuration", + Path: "/v2.1/current_user/notary", QueryOpts: make(url.Values), Version: esign.VersionV21, } } -// EnvelopePurgeConfigurationGetEnvelopePurgeConfigurationOp implements DocuSign API SDK Uncategorized::getEnvelopePurgeConfiguration -type EnvelopePurgeConfigurationGetEnvelopePurgeConfigurationOp esign.Op +// NotaryGetNotaryOp implements DocuSign API SDK Uncategorized::getNotary +type NotaryGetNotaryOp esign.Op // Do executes the op. A nil context will return error. -func (op *EnvelopePurgeConfigurationGetEnvelopePurgeConfigurationOp) Do(ctx context.Context) (*model.EnvelopePurgeConfiguration, error) { - var res *model.EnvelopePurgeConfiguration +func (op *NotaryGetNotaryOp) Do(ctx context.Context) (*model.NotaryResult, error) { + var res *model.NotaryResult return res, ((*esign.Op)(op)).Do(ctx, &res) } -// EnvelopePurgeConfigurationUpdateEnvelopePurgeConfigurationis uncategorized and subject to change -func (s *Service) EnvelopePurgeConfigurationUpdateEnvelopePurgeConfiguration(envelopePurgeConfiguration *model.EnvelopePurgeConfiguration) *EnvelopePurgeConfigurationUpdateEnvelopePurgeConfigurationOp { - return &EnvelopePurgeConfigurationUpdateEnvelopePurgeConfigurationOp{ +// IncludeJurisdictions if **true**, the response will include a `jurisdiction` property that contains an array of all supported jurisdictions for the current user. +func (op *NotaryGetNotaryOp) IncludeJurisdictions(val string) *NotaryGetNotaryOp { + if op != nil { + op.QueryOpts.Set("include_jurisdictions", val) + } + return op +} + +// NotaryUpdateNotary updates notary information for the current user. +// operation is uncategorized and subject to change. +func (s *Service) NotaryUpdateNotary(notary *model.Notary) *NotaryUpdateNotaryOp { + return &NotaryUpdateNotaryOp{ Credential: s.credential, Method: "PUT", - Path: "settings/envelope_purge_configuration", - Payload: envelopePurgeConfiguration, + Path: "/v2.1/current_user/notary", + Payload: notary, QueryOpts: make(url.Values), Version: esign.VersionV21, } } -// EnvelopePurgeConfigurationUpdateEnvelopePurgeConfigurationOp implements DocuSign API SDK Uncategorized::updateEnvelopePurgeConfiguration -type EnvelopePurgeConfigurationUpdateEnvelopePurgeConfigurationOp esign.Op +// NotaryUpdateNotaryOp implements DocuSign API SDK Uncategorized::updateNotary +type NotaryUpdateNotaryOp esign.Op // Do executes the op. A nil context will return error. -func (op *EnvelopePurgeConfigurationUpdateEnvelopePurgeConfigurationOp) Do(ctx context.Context) (*model.EnvelopePurgeConfiguration, error) { - var res *model.EnvelopePurgeConfiguration +func (op *NotaryUpdateNotaryOp) Do(ctx context.Context) (*model.Notary, error) { + var res *model.Notary return res, ((*esign.Op)(op)).Do(ctx, &res) } -// EnvelopeTransferRulesCreateEnvelopeTransferRulesis uncategorized and subject to change -func (s *Service) EnvelopeTransferRulesCreateEnvelopeTransferRules(envelopeTransferRuleRequest *model.EnvelopeTransferRuleRequest) *EnvelopeTransferRulesCreateEnvelopeTransferRulesOp { - return &EnvelopeTransferRulesCreateEnvelopeTransferRulesOp{ +// NotaryJurisdictionCreateNotaryJurisdictions creates a jurisdiction object. +// operation is uncategorized and subject to change. +func (s *Service) NotaryJurisdictionCreateNotaryJurisdictions(notaryJurisdiction *model.NotaryJurisdiction) *NotaryJurisdictionCreateNotaryJurisdictionsOp { + return &NotaryJurisdictionCreateNotaryJurisdictionsOp{ Credential: s.credential, Method: "POST", - Path: "envelopes/transfer_rules", - Payload: envelopeTransferRuleRequest, + Path: "/v2.1/current_user/notary/jurisdictions", + Payload: notaryJurisdiction, QueryOpts: make(url.Values), Version: esign.VersionV21, } } -// EnvelopeTransferRulesCreateEnvelopeTransferRulesOp implements DocuSign API SDK Uncategorized::createEnvelopeTransferRules -type EnvelopeTransferRulesCreateEnvelopeTransferRulesOp esign.Op +// NotaryJurisdictionCreateNotaryJurisdictionsOp implements DocuSign API SDK Uncategorized::createNotaryJurisdictions +type NotaryJurisdictionCreateNotaryJurisdictionsOp esign.Op // Do executes the op. A nil context will return error. -func (op *EnvelopeTransferRulesCreateEnvelopeTransferRulesOp) Do(ctx context.Context) (*model.EnvelopeTransferRuleInformation, error) { - var res *model.EnvelopeTransferRuleInformation +func (op *NotaryJurisdictionCreateNotaryJurisdictionsOp) Do(ctx context.Context) (*model.NotaryJurisdiction, error) { + var res *model.NotaryJurisdiction return res, ((*esign.Op)(op)).Do(ctx, &res) } -// EnvelopeTransferRulesDeleteEnvelopeTransferRulesis uncategorized and subject to change -func (s *Service) EnvelopeTransferRulesDeleteEnvelopeTransferRules(envelopeTransferRuleID string) *EnvelopeTransferRulesDeleteEnvelopeTransferRulesOp { - return &EnvelopeTransferRulesDeleteEnvelopeTransferRulesOp{ +// NotaryJurisdictionDeleteNotaryJurisdiction deletes the specified jurisdiction. +// operation is uncategorized and subject to change. +func (s *Service) NotaryJurisdictionDeleteNotaryJurisdiction(jurisdictionID string) *NotaryJurisdictionDeleteNotaryJurisdictionOp { + return &NotaryJurisdictionDeleteNotaryJurisdictionOp{ Credential: s.credential, Method: "DELETE", - Path: strings.Join([]string{"envelopes", "transfer_rules", envelopeTransferRuleID}, "/"), + Path: strings.Join([]string{"", "v2.1", "current_user", "notary", "jurisdictions", jurisdictionID}, "/"), QueryOpts: make(url.Values), Version: esign.VersionV21, } } -// EnvelopeTransferRulesDeleteEnvelopeTransferRulesOp implements DocuSign API SDK Uncategorized::deleteEnvelopeTransferRules -type EnvelopeTransferRulesDeleteEnvelopeTransferRulesOp esign.Op +// NotaryJurisdictionDeleteNotaryJurisdictionOp implements DocuSign API SDK Uncategorized::deleteNotaryJurisdiction +type NotaryJurisdictionDeleteNotaryJurisdictionOp esign.Op // Do executes the op. A nil context will return error. -func (op *EnvelopeTransferRulesDeleteEnvelopeTransferRulesOp) Do(ctx context.Context) error { +func (op *NotaryJurisdictionDeleteNotaryJurisdictionOp) Do(ctx context.Context) error { return ((*esign.Op)(op)).Do(ctx, nil) } -// EnvelopeTransferRulesGetEnvelopeTransferRulesis uncategorized and subject to change -func (s *Service) EnvelopeTransferRulesGetEnvelopeTransferRules() *EnvelopeTransferRulesGetEnvelopeTransferRulesOp { - return &EnvelopeTransferRulesGetEnvelopeTransferRulesOp{ +// NotaryJurisdictionGetNotaryJurisdiction gets a jurisdiction object for the current user. The user must be a notary. +// operation is uncategorized and subject to change. +func (s *Service) NotaryJurisdictionGetNotaryJurisdiction(jurisdictionID string) *NotaryJurisdictionGetNotaryJurisdictionOp { + return &NotaryJurisdictionGetNotaryJurisdictionOp{ Credential: s.credential, Method: "GET", - Path: "envelopes/transfer_rules", + Path: strings.Join([]string{"", "v2.1", "current_user", "notary", "jurisdictions", jurisdictionID}, "/"), QueryOpts: make(url.Values), Version: esign.VersionV21, } } -// EnvelopeTransferRulesGetEnvelopeTransferRulesOp implements DocuSign API SDK Uncategorized::getEnvelopeTransferRules -type EnvelopeTransferRulesGetEnvelopeTransferRulesOp esign.Op +// NotaryJurisdictionGetNotaryJurisdictionOp implements DocuSign API SDK Uncategorized::getNotaryJurisdiction +type NotaryJurisdictionGetNotaryJurisdictionOp esign.Op // Do executes the op. A nil context will return error. -func (op *EnvelopeTransferRulesGetEnvelopeTransferRulesOp) Do(ctx context.Context) (*model.EnvelopeTransferRuleInformation, error) { - var res *model.EnvelopeTransferRuleInformation +func (op *NotaryJurisdictionGetNotaryJurisdictionOp) Do(ctx context.Context) (*model.NotaryJurisdiction, error) { + var res *model.NotaryJurisdiction return res, ((*esign.Op)(op)).Do(ctx, &res) } -// Count is the maximum number of results to return. -func (op *EnvelopeTransferRulesGetEnvelopeTransferRulesOp) Count(val string) *EnvelopeTransferRulesGetEnvelopeTransferRulesOp { - if op != nil { - op.QueryOpts.Set("count", val) +// NotaryJurisdictionGetNotaryJurisdictions returns a list of jurisdictions that the notary is registered in. +// operation is uncategorized and subject to change. +func (s *Service) NotaryJurisdictionGetNotaryJurisdictions() *NotaryJurisdictionGetNotaryJurisdictionsOp { + return &NotaryJurisdictionGetNotaryJurisdictionsOp{ + Credential: s.credential, + Method: "GET", + Path: "/v2.1/current_user/notary/jurisdictions", + QueryOpts: make(url.Values), + Version: esign.VersionV21, } - return op } -// StartPosition is the position within the total result set from which to start returning values. The value **thumbnail** may be used to return the page image. -func (op *EnvelopeTransferRulesGetEnvelopeTransferRulesOp) StartPosition(val string) *EnvelopeTransferRulesGetEnvelopeTransferRulesOp { - if op != nil { - op.QueryOpts.Set("start_position", val) - } - return op +// NotaryJurisdictionGetNotaryJurisdictionsOp implements DocuSign API SDK Uncategorized::getNotaryJurisdictions +type NotaryJurisdictionGetNotaryJurisdictionsOp esign.Op + +// Do executes the op. A nil context will return error. +func (op *NotaryJurisdictionGetNotaryJurisdictionsOp) Do(ctx context.Context) (*model.NotaryJurisdictionList, error) { + var res *model.NotaryJurisdictionList + return res, ((*esign.Op)(op)).Do(ctx, &res) } -// EnvelopeTransferRulesUpdateEnvelopeTransferRuleis uncategorized and subject to change -func (s *Service) EnvelopeTransferRulesUpdateEnvelopeTransferRule(envelopeTransferRuleID string, envelopeTransferRule *model.EnvelopeTransferRule) *EnvelopeTransferRulesUpdateEnvelopeTransferRuleOp { - return &EnvelopeTransferRulesUpdateEnvelopeTransferRuleOp{ +// NotaryJurisdictionUpdateNotaryJurisdiction updates the jurisdiction information about a notary. +// operation is uncategorized and subject to change. +func (s *Service) NotaryJurisdictionUpdateNotaryJurisdiction(jurisdictionID string, notaryJurisdiction *model.NotaryJurisdiction) *NotaryJurisdictionUpdateNotaryJurisdictionOp { + return &NotaryJurisdictionUpdateNotaryJurisdictionOp{ Credential: s.credential, Method: "PUT", - Path: strings.Join([]string{"envelopes", "transfer_rules", envelopeTransferRuleID}, "/"), - Payload: envelopeTransferRule, + Path: strings.Join([]string{"", "v2.1", "current_user", "notary", "jurisdictions", jurisdictionID}, "/"), + Payload: notaryJurisdiction, QueryOpts: make(url.Values), Version: esign.VersionV21, } } -// EnvelopeTransferRulesUpdateEnvelopeTransferRuleOp implements DocuSign API SDK Uncategorized::updateEnvelopeTransferRule -type EnvelopeTransferRulesUpdateEnvelopeTransferRuleOp esign.Op +// NotaryJurisdictionUpdateNotaryJurisdictionOp implements DocuSign API SDK Uncategorized::updateNotaryJurisdiction +type NotaryJurisdictionUpdateNotaryJurisdictionOp esign.Op // Do executes the op. A nil context will return error. -func (op *EnvelopeTransferRulesUpdateEnvelopeTransferRuleOp) Do(ctx context.Context) (*model.EnvelopeTransferRule, error) { - var res *model.EnvelopeTransferRule +func (op *NotaryJurisdictionUpdateNotaryJurisdictionOp) Do(ctx context.Context) (*model.NotaryJurisdiction, error) { + var res *model.NotaryJurisdiction return res, ((*esign.Op)(op)).Do(ctx, &res) } -// EnvelopeTransferRulesUpdateEnvelopeTransferRulesis uncategorized and subject to change -func (s *Service) EnvelopeTransferRulesUpdateEnvelopeTransferRules(envelopeTransferRules *model.EnvelopeTransferRuleInformation) *EnvelopeTransferRulesUpdateEnvelopeTransferRulesOp { - return &EnvelopeTransferRulesUpdateEnvelopeTransferRulesOp{ +// ReportsCreateReportInProductCreate creates a customized report. +// operation is uncategorized and subject to change. +func (s *Service) ReportsCreateReportInProductCreate(reportInProductRunRequest *model.ReportInProductRunRequest) *ReportsCreateReportInProductCreateOp { + return &ReportsCreateReportInProductCreateOp{ Credential: s.credential, - Method: "PUT", - Path: "envelopes/transfer_rules", - Payload: envelopeTransferRules, + Method: "POST", + Path: "reports", + Payload: reportInProductRunRequest, QueryOpts: make(url.Values), Version: esign.VersionV21, } } -// EnvelopeTransferRulesUpdateEnvelopeTransferRulesOp implements DocuSign API SDK Uncategorized::updateEnvelopeTransferRules -type EnvelopeTransferRulesUpdateEnvelopeTransferRulesOp esign.Op +// ReportsCreateReportInProductCreateOp implements DocuSign API SDK Uncategorized::createReportInProductCreate +type ReportsCreateReportInProductCreateOp esign.Op // Do executes the op. A nil context will return error. -func (op *EnvelopeTransferRulesUpdateEnvelopeTransferRulesOp) Do(ctx context.Context) (*model.EnvelopeTransferRuleInformation, error) { - var res *model.EnvelopeTransferRuleInformation +func (op *ReportsCreateReportInProductCreateOp) Do(ctx context.Context) (*model.ReportInProductSaveResponse, error) { + var res *model.ReportInProductSaveResponse return res, ((*esign.Op)(op)).Do(ctx, &res) } -// EnvelopeViewsCreateEnvelopeRecipientPreviewis uncategorized and subject to change -func (s *Service) EnvelopeViewsCreateEnvelopeRecipientPreview(envelopeID string, recipientPreviewRequest *model.RecipientPreviewRequest) *EnvelopeViewsCreateEnvelopeRecipientPreviewOp { - return &EnvelopeViewsCreateEnvelopeRecipientPreviewOp{ +// ReportsDeleteReportInProduct removes a customized report. +// operation is uncategorized and subject to change. +func (s *Service) ReportsDeleteReportInProduct(iD string) *ReportsDeleteReportInProductOp { + return &ReportsDeleteReportInProductOp{ Credential: s.credential, - Method: "POST", - Path: strings.Join([]string{"envelopes", envelopeID, "views", "recipient_preview"}, "/"), - Payload: recipientPreviewRequest, + Method: "DELETE", + Path: strings.Join([]string{"reports", iD}, "/"), QueryOpts: make(url.Values), Version: esign.VersionV21, } } -// EnvelopeViewsCreateEnvelopeRecipientPreviewOp implements DocuSign API SDK Uncategorized::createEnvelopeRecipientPreview -type EnvelopeViewsCreateEnvelopeRecipientPreviewOp esign.Op +// ReportsDeleteReportInProductOp implements DocuSign API SDK Uncategorized::deleteReportInProduct +type ReportsDeleteReportInProductOp esign.Op // Do executes the op. A nil context will return error. -func (op *EnvelopeViewsCreateEnvelopeRecipientPreviewOp) Do(ctx context.Context) (*model.ViewURL, error) { - var res *model.ViewURL +func (op *ReportsDeleteReportInProductOp) Do(ctx context.Context) (*model.ReportInProductSaveResponse, error) { + var res *model.ReportInProductSaveResponse return res, ((*esign.Op)(op)).Do(ctx, &res) } -// EnvelopeViewsCreateTemplateRecipientPreviewis uncategorized and subject to change -func (s *Service) EnvelopeViewsCreateTemplateRecipientPreview(templateID string, recipientPreviewRequest *model.RecipientPreviewRequest) *EnvelopeViewsCreateTemplateRecipientPreviewOp { - return &EnvelopeViewsCreateTemplateRecipientPreviewOp{ +// ReportsGetReportInProduct gets the specified report. +// operation is uncategorized and subject to change. +func (s *Service) ReportsGetReportInProduct(iD string) *ReportsGetReportInProductOp { + return &ReportsGetReportInProductOp{ Credential: s.credential, - Method: "POST", - Path: strings.Join([]string{"templates", templateID, "views", "recipient_preview"}, "/"), - Payload: recipientPreviewRequest, + Method: "GET", + Path: strings.Join([]string{"reports", iD}, "/"), QueryOpts: make(url.Values), Version: esign.VersionV21, } } -// EnvelopeViewsCreateTemplateRecipientPreviewOp implements DocuSign API SDK Uncategorized::createTemplateRecipientPreview -type EnvelopeViewsCreateTemplateRecipientPreviewOp esign.Op +// ReportsGetReportInProductOp implements DocuSign API SDK Uncategorized::getReportInProduct +type ReportsGetReportInProductOp esign.Op // Do executes the op. A nil context will return error. -func (op *EnvelopeViewsCreateTemplateRecipientPreviewOp) Do(ctx context.Context) (*model.ViewURL, error) { - var res *model.ViewURL +func (op *ReportsGetReportInProductOp) Do(ctx context.Context) (*model.ReportInProductGet, error) { + var res *model.ReportInProductGet return res, ((*esign.Op)(op)).Do(ctx, &res) } -// NotificationDefaultsGetNotificationDefaultsis uncategorized and subject to change -func (s *Service) NotificationDefaultsGetNotificationDefaults() *NotificationDefaultsGetNotificationDefaultsOp { - return &NotificationDefaultsGetNotificationDefaultsOp{ +// ReportsGetReportInProductList gets the descriptors for all of +// an account's active reports (for listings). +// operation is uncategorized and subject to change. +func (s *Service) ReportsGetReportInProductList() *ReportsGetReportInProductListOp { + return &ReportsGetReportInProductListOp{ Credential: s.credential, Method: "GET", - Path: "settings/notification_defaults", + Path: "reports", QueryOpts: make(url.Values), Version: esign.VersionV21, } } -// NotificationDefaultsGetNotificationDefaultsOp implements DocuSign API SDK Uncategorized::getNotificationDefaults -type NotificationDefaultsGetNotificationDefaultsOp esign.Op +// ReportsGetReportInProductListOp implements DocuSign API SDK Uncategorized::getReportInProductList +type ReportsGetReportInProductListOp esign.Op // Do executes the op. A nil context will return error. -func (op *NotificationDefaultsGetNotificationDefaultsOp) Do(ctx context.Context) (*model.NotificationDefaults, error) { - var res *model.NotificationDefaults +func (op *ReportsGetReportInProductListOp) Do(ctx context.Context) (*model.ReportInProductList, error) { + var res *model.ReportInProductList return res, ((*esign.Op)(op)).Do(ctx, &res) } -// NotificationDefaultsUpdateNotificationDefaultsis uncategorized and subject to change -func (s *Service) NotificationDefaultsUpdateNotificationDefaults(notificationDefaults *model.NotificationDefaults) *NotificationDefaultsUpdateNotificationDefaultsOp { - return &NotificationDefaultsUpdateNotificationDefaultsOp{ +// ReportsUpdateReportInProductRunResults returns the result set from running the specified report. +// operation is uncategorized and subject to change. +func (s *Service) ReportsUpdateReportInProductRunResults(reportInProductRunRequest *model.ReportInProductRunRequest) *ReportsUpdateReportInProductRunResultsOp { + return &ReportsUpdateReportInProductRunResultsOp{ Credential: s.credential, Method: "PUT", - Path: "settings/notification_defaults", - Payload: notificationDefaults, + Path: "reports/report_results", + Payload: reportInProductRunRequest, QueryOpts: make(url.Values), Version: esign.VersionV21, } } -// NotificationDefaultsUpdateNotificationDefaultsOp implements DocuSign API SDK Uncategorized::updateNotificationDefaults -type NotificationDefaultsUpdateNotificationDefaultsOp esign.Op +// ReportsUpdateReportInProductRunResultsOp implements DocuSign API SDK Uncategorized::updateReportInProductRunResults +type ReportsUpdateReportInProductRunResultsOp esign.Op // Do executes the op. A nil context will return error. -func (op *NotificationDefaultsUpdateNotificationDefaultsOp) Do(ctx context.Context) (*model.NotificationDefaults, error) { - var res *model.NotificationDefaults +func (op *ReportsUpdateReportInProductRunResultsOp) Do(ctx context.Context) (*model.ReportInProductRunResponse, error) { + var res *model.ReportInProductRunResponse + return res, ((*esign.Op)(op)).Do(ctx, &res) +} + +// ReportsUpdateReportInProductSave saves a customized report. +// operation is uncategorized and subject to change. +func (s *Service) ReportsUpdateReportInProductSave(iD string, reportInProductRunRequest *model.ReportInProductRunRequest) *ReportsUpdateReportInProductSaveOp { + return &ReportsUpdateReportInProductSaveOp{ + Credential: s.credential, + Method: "PUT", + Path: strings.Join([]string{"reports", iD}, "/"), + Payload: reportInProductRunRequest, + QueryOpts: make(url.Values), + Version: esign.VersionV21, + } +} + +// ReportsUpdateReportInProductSaveOp implements DocuSign API SDK Uncategorized::updateReportInProductSave +type ReportsUpdateReportInProductSaveOp esign.Op + +// Do executes the op. A nil context will return error. +func (op *ReportsUpdateReportInProductSaveOp) Do(ctx context.Context) (*model.ReportInProductSaveResponse, error) { + var res *model.ReportInProductSaveResponse return res, ((*esign.Op)(op)).Do(ctx, &res) } -// ResponsiveHTMLPreviewCreateis uncategorized and subject to change +// ReportsUpdateReportResultsCsv returns the specified report as a CSV string. +// operation is uncategorized and subject to change. +func (s *Service) ReportsUpdateReportResultsCsv(reportInProductCsvRunRequest *model.ReportInProductCsvRunRequest) *ReportsUpdateReportResultsCsvOp { + return &ReportsUpdateReportResultsCsvOp{ + Credential: s.credential, + Method: "PUT", + Path: "reports/report_results_csv", + Payload: reportInProductCsvRunRequest, + QueryOpts: make(url.Values), + Version: esign.VersionV21, + } +} + +// ReportsUpdateReportResultsCsvOp implements DocuSign API SDK Uncategorized::updateReportResultsCsv +type ReportsUpdateReportResultsCsvOp esign.Op + +// Do executes the op. A nil context will return error. +func (op *ReportsUpdateReportResultsCsvOp) Do(ctx context.Context) error { + return ((*esign.Op)(op)).Do(ctx, nil) +} + +// ResponsiveHTMLPreviewCreate creates a preview of the responsive versions of all of the documents in an envelope. +// operation is uncategorized and subject to change. func (s *Service) ResponsiveHTMLPreviewCreate(envelopeID string, documentHTMLDefinition *model.DocumentHTMLDefinition) *ResponsiveHTMLPreviewCreateOp { return &ResponsiveHTMLPreviewCreateOp{ Credential: s.credential, @@ -479,7 +2315,51 @@ func (op *ResponsiveHTMLPreviewCreateOp) Do(ctx context.Context) (*model.Documen return res, ((*esign.Op)(op)).Do(ctx, &res) } -// TemplateDocumentHTMLDefinitionsListis uncategorized and subject to change +// TabsBlobGetTabsBlob gets encrypted tabs for envelope. +// operation is uncategorized and subject to change. +func (s *Service) TabsBlobGetTabsBlob(envelopeID string) *TabsBlobGetTabsBlobOp { + return &TabsBlobGetTabsBlobOp{ + Credential: s.credential, + Method: "GET", + Path: strings.Join([]string{"envelopes", envelopeID, "tabs_blob"}, "/"), + QueryOpts: make(url.Values), + Version: esign.VersionV21, + } +} + +// TabsBlobGetTabsBlobOp implements DocuSign API SDK Uncategorized::getTabsBlob +type TabsBlobGetTabsBlobOp esign.Op + +// Do executes the op. A nil context will return error. +func (op *TabsBlobGetTabsBlobOp) Do(ctx context.Context) (*esign.Download, error) { + var res *esign.Download + return res, ((*esign.Op)(op)).Do(ctx, &res) +} + +// TabsBlobPutTabsBlob updates encrypted tabs for envelope. +// If media is an io.ReadCloser, Do() will close media. +// operation is uncategorized and subject to change. +func (s *Service) TabsBlobPutTabsBlob(envelopeID string, media io.Reader, mimeType string) *TabsBlobPutTabsBlobOp { + return &TabsBlobPutTabsBlobOp{ + Credential: s.credential, + Method: "PUT", + Path: strings.Join([]string{"envelopes", envelopeID, "tabs_blob"}, "/"), + Payload: &esign.UploadFile{Reader: media, ContentType: mimeType}, + QueryOpts: make(url.Values), + Version: esign.VersionV21, + } +} + +// TabsBlobPutTabsBlobOp implements DocuSign API SDK Uncategorized::putTabsBlob +type TabsBlobPutTabsBlobOp esign.Op + +// Do executes the op. A nil context will return error. +func (op *TabsBlobPutTabsBlobOp) Do(ctx context.Context) error { + return ((*esign.Op)(op)).Do(ctx, nil) +} + +// TemplateDocumentHTMLDefinitionsList gets the Original HTML Definition used to generate the Responsive HTML for a given document in a template. +// operation is uncategorized and subject to change. func (s *Service) TemplateDocumentHTMLDefinitionsList(documentID string, templateID string) *TemplateDocumentHTMLDefinitionsListOp { return &TemplateDocumentHTMLDefinitionsListOp{ Credential: s.credential, @@ -499,7 +2379,8 @@ func (op *TemplateDocumentHTMLDefinitionsListOp) Do(ctx context.Context) (*model return res, ((*esign.Op)(op)).Do(ctx, &res) } -// TemplateDocumentResponsiveHTMLPreviewCreateis uncategorized and subject to change +// TemplateDocumentResponsiveHTMLPreviewCreate creates a preview of the responsive version of a template document. +// operation is uncategorized and subject to change. func (s *Service) TemplateDocumentResponsiveHTMLPreviewCreate(documentID string, templateID string, documentHTMLDefinition *model.DocumentHTMLDefinition) *TemplateDocumentResponsiveHTMLPreviewCreateOp { return &TemplateDocumentResponsiveHTMLPreviewCreateOp{ Credential: s.credential, @@ -520,10 +2401,10 @@ func (op *TemplateDocumentResponsiveHTMLPreviewCreateOp) Do(ctx context.Context) return res, ((*esign.Op)(op)).Do(ctx, &res) } -// TemplateDocumentTabsCreateTemplateDocumentTabs create Template Document Tabs +// TemplateDocumentTabsCreate create Template Document Tabs // operation is uncategorized and subject to change. -func (s *Service) TemplateDocumentTabsCreateTemplateDocumentTabs(documentID string, templateID string, templateTabs *model.TemplateTabs) *TemplateDocumentTabsCreateTemplateDocumentTabsOp { - return &TemplateDocumentTabsCreateTemplateDocumentTabsOp{ +func (s *Service) TemplateDocumentTabsCreate(documentID string, templateID string, templateTabs *model.TemplateTabs) *TemplateDocumentTabsCreateOp { + return &TemplateDocumentTabsCreateOp{ Credential: s.credential, Method: "POST", Path: strings.Join([]string{"templates", templateID, "documents", documentID, "tabs"}, "/"), @@ -533,18 +2414,19 @@ func (s *Service) TemplateDocumentTabsCreateTemplateDocumentTabs(documentID stri } } -// TemplateDocumentTabsCreateTemplateDocumentTabsOp implements DocuSign API SDK Uncategorized::createTemplateDocumentTabs -type TemplateDocumentTabsCreateTemplateDocumentTabsOp esign.Op +// TemplateDocumentTabsCreateOp implements DocuSign API SDK Uncategorized::postDocumentTabs +type TemplateDocumentTabsCreateOp esign.Op // Do executes the op. A nil context will return error. -func (op *TemplateDocumentTabsCreateTemplateDocumentTabsOp) Do(ctx context.Context) (*model.Tabs, error) { +func (op *TemplateDocumentTabsCreateOp) Do(ctx context.Context) (*model.Tabs, error) { var res *model.Tabs return res, ((*esign.Op)(op)).Do(ctx, &res) } -// TemplateDocumentTabsDeleteTemplateDocumentTabsis uncategorized and subject to change -func (s *Service) TemplateDocumentTabsDeleteTemplateDocumentTabs(documentID string, templateID string, templateTabs *model.TemplateTabs) *TemplateDocumentTabsDeleteTemplateDocumentTabsOp { - return &TemplateDocumentTabsDeleteTemplateDocumentTabsOp{ +// TemplateDocumentTabsDelete deletes tabs from an envelope document. +// operation is uncategorized and subject to change. +func (s *Service) TemplateDocumentTabsDelete(documentID string, templateID string, templateTabs *model.TemplateTabs) *TemplateDocumentTabsDeleteOp { + return &TemplateDocumentTabsDeleteOp{ Credential: s.credential, Method: "DELETE", Path: strings.Join([]string{"templates", templateID, "documents", documentID, "tabs"}, "/"), @@ -554,18 +2436,19 @@ func (s *Service) TemplateDocumentTabsDeleteTemplateDocumentTabs(documentID stri } } -// TemplateDocumentTabsDeleteTemplateDocumentTabsOp implements DocuSign API SDK Uncategorized::deleteTemplateDocumentTabs -type TemplateDocumentTabsDeleteTemplateDocumentTabsOp esign.Op +// TemplateDocumentTabsDeleteOp implements DocuSign API SDK Uncategorized::deleteDocumentTabs +type TemplateDocumentTabsDeleteOp esign.Op // Do executes the op. A nil context will return error. -func (op *TemplateDocumentTabsDeleteTemplateDocumentTabsOp) Do(ctx context.Context) (*model.Tabs, error) { +func (op *TemplateDocumentTabsDeleteOp) Do(ctx context.Context) (*model.Tabs, error) { var res *model.Tabs return res, ((*esign.Op)(op)).Do(ctx, &res) } -// TemplateDocumentTabsUpdateTemplateDocumentTabsis uncategorized and subject to change -func (s *Service) TemplateDocumentTabsUpdateTemplateDocumentTabs(documentID string, templateID string, templateTabs *model.TemplateTabs) *TemplateDocumentTabsUpdateTemplateDocumentTabsOp { - return &TemplateDocumentTabsUpdateTemplateDocumentTabsOp{ +// TemplateDocumentTabsUpdate updates the tabs for a template. +// operation is uncategorized and subject to change. +func (s *Service) TemplateDocumentTabsUpdate(documentID string, templateID string, templateTabs *model.TemplateTabs) *TemplateDocumentTabsUpdateOp { + return &TemplateDocumentTabsUpdateOp{ Credential: s.credential, Method: "PUT", Path: strings.Join([]string{"templates", templateID, "documents", documentID, "tabs"}, "/"), @@ -575,16 +2458,17 @@ func (s *Service) TemplateDocumentTabsUpdateTemplateDocumentTabs(documentID stri } } -// TemplateDocumentTabsUpdateTemplateDocumentTabsOp implements DocuSign API SDK Uncategorized::updateTemplateDocumentTabs -type TemplateDocumentTabsUpdateTemplateDocumentTabsOp esign.Op +// TemplateDocumentTabsUpdateOp implements DocuSign API SDK Uncategorized::putDocumentTabs +type TemplateDocumentTabsUpdateOp esign.Op // Do executes the op. A nil context will return error. -func (op *TemplateDocumentTabsUpdateTemplateDocumentTabsOp) Do(ctx context.Context) (*model.Tabs, error) { +func (op *TemplateDocumentTabsUpdateOp) Do(ctx context.Context) (*model.Tabs, error) { var res *model.Tabs return res, ((*esign.Op)(op)).Do(ctx, &res) } -// TemplateHTMLDefinitionsListis uncategorized and subject to change +// TemplateHTMLDefinitionsList gets the Original HTML Definition used to generate the Responsive HTML for the template. +// operation is uncategorized and subject to change. func (s *Service) TemplateHTMLDefinitionsList(templateID string) *TemplateHTMLDefinitionsListOp { return &TemplateHTMLDefinitionsListOp{ Credential: s.credential, @@ -604,7 +2488,30 @@ func (op *TemplateHTMLDefinitionsListOp) Do(ctx context.Context) (*model.Documen return res, ((*esign.Op)(op)).Do(ctx, &res) } -// TemplateResponsiveHTMLPreviewCreateis uncategorized and subject to change +// TemplateRecipientsCreateTemplateRecipientPreview creates a template recipient preview. +// operation is uncategorized and subject to change. +func (s *Service) TemplateRecipientsCreateTemplateRecipientPreview(templateID string, recipientPreviewRequest *model.RecipientPreviewRequest) *TemplateRecipientsCreateTemplateRecipientPreviewOp { + return &TemplateRecipientsCreateTemplateRecipientPreviewOp{ + Credential: s.credential, + Method: "POST", + Path: strings.Join([]string{"templates", templateID, "views", "recipient_preview"}, "/"), + Payload: recipientPreviewRequest, + QueryOpts: make(url.Values), + Version: esign.VersionV21, + } +} + +// TemplateRecipientsCreateTemplateRecipientPreviewOp implements DocuSign API SDK Uncategorized::createTemplateRecipientPreview +type TemplateRecipientsCreateTemplateRecipientPreviewOp esign.Op + +// Do executes the op. A nil context will return error. +func (op *TemplateRecipientsCreateTemplateRecipientPreviewOp) Do(ctx context.Context) (*model.ViewURL, error) { + var res *model.ViewURL + return res, ((*esign.Op)(op)).Do(ctx, &res) +} + +// TemplateResponsiveHTMLPreviewCreate creates a preview of the responsive versions of all of the documents associated with a template. +// operation is uncategorized and subject to change. func (s *Service) TemplateResponsiveHTMLPreviewCreate(templateID string, documentHTMLDefinition *model.DocumentHTMLDefinition) *TemplateResponsiveHTMLPreviewCreateOp { return &TemplateResponsiveHTMLPreviewCreateOp{ Credential: s.credential, diff --git a/v2.1/usergroups/usergroups.go b/v2.1/usergroups/usergroups.go index 27f9bda..44833b8 100644 --- a/v2.1/usergroups/usergroups.go +++ b/v2.1/usergroups/usergroups.go @@ -49,7 +49,7 @@ func New(cred esign.Credential) *Service { return &Service{credential: cred} } -// GroupBrandsDelete deletes brand information from the requested group. +// GroupBrandsDelete deletes brand information from a group. // // https://developers.docusign.com/esign-rest-api/reference/usergroups/groupbrands/delete // @@ -74,8 +74,7 @@ func (op *GroupBrandsDeleteOp) Do(ctx context.Context) (*model.BrandsResponse, e return res, ((*esign.Op)(op)).Do(ctx, &res) } -// GroupBrandsGet gets group brand ID Information. -// +// GroupBrandsGet gets the brand information for a group. // // https://developers.docusign.com/esign-rest-api/reference/usergroups/groupbrands/get // @@ -99,7 +98,7 @@ func (op *GroupBrandsGetOp) Do(ctx context.Context) (*model.BrandsResponse, erro return res, ((*esign.Op)(op)).Do(ctx, &res) } -// GroupBrandsUpdate adds group brand ID information to a group. +// GroupBrandsUpdate adds an existing brand to a group. // // https://developers.docusign.com/esign-rest-api/reference/usergroups/groupbrands/update // @@ -219,12 +218,12 @@ func (op *GroupUsersUpdateOp) Do(ctx context.Context) (*model.UsersResponse, err // https://developers.docusign.com/esign-rest-api/reference/usergroups/groups/create // // SDK Method UserGroups::createGroups -func (s *Service) GroupsCreate(groups *model.GroupInformation) *GroupsCreateOp { +func (s *Service) GroupsCreate(groupInformation *model.GroupInformation) *GroupsCreateOp { return &GroupsCreateOp{ Credential: s.credential, Method: "POST", Path: "groups", - Payload: groups, + Payload: groupInformation, QueryOpts: make(url.Values), Version: esign.VersionV21, } @@ -244,12 +243,12 @@ func (op *GroupsCreateOp) Do(ctx context.Context) (*model.GroupInformation, erro // https://developers.docusign.com/esign-rest-api/reference/usergroups/groups/delete // // SDK Method UserGroups::deleteGroups -func (s *Service) GroupsDelete(groups *model.GroupInformation) *GroupsDeleteOp { +func (s *Service) GroupsDelete(groupInformation *model.GroupInformation) *GroupsDeleteOp { return &GroupsDeleteOp{ Credential: s.credential, Method: "DELETE", Path: "groups", - Payload: groups, + Payload: groupInformation, QueryOpts: make(url.Values), Version: esign.VersionV21, } @@ -333,12 +332,12 @@ func (op *GroupsListOp) StartPosition(val int) *GroupsListOp { // https://developers.docusign.com/esign-rest-api/reference/usergroups/groups/update // // SDK Method UserGroups::updateGroups -func (s *Service) GroupsUpdate(groups *model.GroupInformation) *GroupsUpdateOp { +func (s *Service) GroupsUpdate(groupInformation *model.GroupInformation) *GroupsUpdateOp { return &GroupsUpdateOp{ Credential: s.credential, Method: "PUT", Path: "groups", - Payload: groups, + Payload: groupInformation, QueryOpts: make(url.Values), Version: esign.VersionV21, } diff --git a/v2.1/users/users.go b/v2.1/users/users.go index e4dc076..d922923 100644 --- a/v2.1/users/users.go +++ b/v2.1/users/users.go @@ -51,7 +51,7 @@ func New(cred esign.Credential) *Service { return &Service{credential: cred} } -// ContactsCreate imports multiple new contacts into the contacts collection from CSV, JSON, or XML (based on content type). +// ContactsCreate imports new contacts into a contacts list. // // https://developers.docusign.com/esign-rest-api/reference/users/contacts/create // @@ -76,7 +76,7 @@ func (op *ContactsCreateOp) Do(ctx context.Context) (*model.ContactUpdateRespons return res, ((*esign.Op)(op)).Do(ctx, &res) } -// ContactsDelete replaces a particular contact associated with an account for the DocuSign service. +// ContactsDelete deletes a contact. // // https://developers.docusign.com/esign-rest-api/reference/users/contacts/delete // @@ -100,7 +100,7 @@ func (op *ContactsDeleteOp) Do(ctx context.Context) (*model.ContactUpdateRespons return res, ((*esign.Op)(op)).Do(ctx, &res) } -// ContactsDeleteList delete contacts associated with an account for the DocuSign service. +// ContactsDeleteList deletes multiple contacts from an account. // // https://developers.docusign.com/esign-rest-api/reference/users/contacts/deletelist // @@ -125,7 +125,7 @@ func (op *ContactsDeleteListOp) Do(ctx context.Context) (*model.ContactUpdateRes return res, ((*esign.Op)(op)).Do(ctx, &res) } -// ContactsGet gets a particular contact associated with the user's account. +// ContactsGet gets one or more contacts. // // https://developers.docusign.com/esign-rest-api/reference/users/contacts/get // @@ -149,7 +149,10 @@ func (op *ContactsGetOp) Do(ctx context.Context) (*model.ContactGetResponse, err return res, ((*esign.Op)(op)).Do(ctx, &res) } -// CloudProvider set the call query parameter cloud_provider +// CloudProvider (Optional) The cloud provider from which to retrieve the contacts. Valid values are: +// +// - `rooms` +// - `docusignCore` (default) func (op *ContactsGetOp) CloudProvider(val string) *ContactsGetOp { if op != nil { op.QueryOpts.Set("cloud_provider", val) @@ -157,7 +160,7 @@ func (op *ContactsGetOp) CloudProvider(val string) *ContactsGetOp { return op } -// ContactsUpdate replaces contacts associated with an account for the DocuSign service. +// ContactsUpdate updates one or more contacts. // // https://developers.docusign.com/esign-rest-api/reference/users/contacts/update // @@ -187,12 +190,12 @@ func (op *ContactsUpdateOp) Do(ctx context.Context) (*model.ContactUpdateRespons // https://developers.docusign.com/esign-rest-api/reference/users/usercustomsettings/delete // // SDK Method Users::deleteCustomSettings -func (s *Service) CustomSettingsDelete(userID string, userCustomSettings *model.CustomSettingsInformation) *CustomSettingsDeleteOp { +func (s *Service) CustomSettingsDelete(userID string, customSettingsInformation *model.CustomSettingsInformation) *CustomSettingsDeleteOp { return &CustomSettingsDeleteOp{ Credential: s.credential, Method: "DELETE", Path: strings.Join([]string{"users", userID, "custom_settings"}, "/"), - Payload: userCustomSettings, + Payload: customSettingsInformation, QueryOpts: make(url.Values), Version: esign.VersionV21, } @@ -236,12 +239,12 @@ func (op *CustomSettingsListOp) Do(ctx context.Context) (*model.CustomSettingsIn // https://developers.docusign.com/esign-rest-api/reference/users/usercustomsettings/update // // SDK Method Users::updateCustomSettings -func (s *Service) CustomSettingsUpdate(userID string, userCustomSettings *model.CustomSettingsInformation) *CustomSettingsUpdateOp { +func (s *Service) CustomSettingsUpdate(userID string, customSettingsInformation *model.CustomSettingsInformation) *CustomSettingsUpdateOp { return &CustomSettingsUpdateOp{ Credential: s.credential, Method: "PUT", Path: strings.Join([]string{"users", userID, "custom_settings"}, "/"), - Payload: userCustomSettings, + Payload: customSettingsInformation, QueryOpts: make(url.Values), Version: esign.VersionV21, } @@ -285,12 +288,12 @@ func (op *ProfilesGetOp) Do(ctx context.Context) (*model.UserProfile, error) { // https://developers.docusign.com/esign-rest-api/reference/users/userprofiles/update // // SDK Method Users::updateProfile -func (s *Service) ProfilesUpdate(userID string, userProfiles *model.UserProfile) *ProfilesUpdateOp { +func (s *Service) ProfilesUpdate(userID string, userProfile *model.UserProfile) *ProfilesUpdateOp { return &ProfilesUpdateOp{ Credential: s.credential, Method: "PUT", Path: strings.Join([]string{"users", userID, "profile"}, "/"), - Payload: userProfiles, + Payload: userProfile, QueryOpts: make(url.Values), Version: esign.VersionV21, } @@ -427,7 +430,7 @@ func (op *SignaturesGetImageOp) Do(ctx context.Context) (*esign.Download, error) return res, ((*esign.Op)(op)).Do(ctx, &res) } -// IncludeChrome set the call query parameter include_chrome +// IncludeChrome when **true**, the chrome (or frame containing the added line and identifier) is included with the signature image. func (op *SignaturesGetImageOp) IncludeChrome() *SignaturesGetImageOp { if op != nil { op.QueryOpts.Set("include_chrome", "true") @@ -435,7 +438,7 @@ func (op *SignaturesGetImageOp) IncludeChrome() *SignaturesGetImageOp { return op } -// SignaturesList retrieves a list of user signature definitions for a specified user. +// SignaturesList retrieves a list of signature definitions for a user. // // https://developers.docusign.com/esign-rest-api/reference/users/usersignatures/list // @@ -459,7 +462,11 @@ func (op *SignaturesListOp) Do(ctx context.Context) (*model.UserSignaturesInform return res, ((*esign.Op)(op)).Do(ctx, &res) } -// StampType set the call query parameter stamp_type +// StampType is the type of stamps to return. Valid values are: +// +// - `signature`: Returns information about signature images only. This is the default value. +// - `stamp`: Returns information about eHanko and custom stamps only. +// - null func (op *SignaturesListOp) StampType(val string) *SignaturesListOp { if op != nil { op.QueryOpts.Set("stamp_type", val) @@ -609,7 +616,7 @@ func (op *DeleteOp) Do(ctx context.Context) (*model.UsersResponse, error) { return res, ((*esign.Op)(op)).Do(ctx, &res) } -// Delete iD of the user to delete. +// Delete iD of the user to delete. This parameter takes a comma-separated list of values in the format: `Groups,PermissionSet,SigningGroupsEmail`. func (op *DeleteOp) Delete(val string) *DeleteOp { if op != nil { op.QueryOpts.Set("delete", val) @@ -705,7 +712,7 @@ func (op *GetProfileImageOp) Do(ctx context.Context) (*esign.Download, error) { return res, ((*esign.Op)(op)).Do(ctx, &res) } -// Encoding set the call query parameter encoding +// Encoding reserved for DocuSign. func (op *GetProfileImageOp) Encoding(val string) *GetProfileImageOp { if op != nil { op.QueryOpts.Set("encoding", val) @@ -769,7 +776,7 @@ func (op *ListOp) AdditionalInfo() *ListOp { return op } -// Count number of records to return. The number must be greater than 0 and less than or equal to 100. +// Count is the number of records to return. This number must be greater than `0` and less than or equal to `100`. func (op *ListOp) Count(val int) *ListOp { if op != nil { op.QueryOpts.Set("count", fmt.Sprintf("%d", val)) @@ -777,7 +784,9 @@ func (op *ListOp) Count(val int) *ListOp { return op } -// Email reserved for DocuSign. +// Email filters results based on the email address associated with the user that you want to return. +// +// **Note**: You can use either this parameter or the `email_substring` parameter, but not both. For older accounts, this parameter might return multiple users who are associated with a single email address. func (op *ListOp) Email(val string) *ListOp { if op != nil { op.QueryOpts.Set("email", val) @@ -785,7 +794,9 @@ func (op *ListOp) Email(val string) *ListOp { return op } -// EmailSubstring reserved for DocuSign. +// EmailSubstring filters results based on a fragment of an email address. For example, you could enter `gmail` to return all users who have Gmail addresses. +// +// **Note**: You do not use a wildcard character with this parameter. You can use either this parameter or the `email` parameter, but not both. func (op *ListOp) EmailSubstring(val string) *ListOp { if op != nil { op.QueryOpts.Set("email_substring", val) @@ -793,7 +804,7 @@ func (op *ListOp) EmailSubstring(val string) *ListOp { return op } -// GroupID filters returned user records by one or more group IDs. +// GroupID filters results based on one or more group IDs. func (op *ListOp) GroupID(val string) *ListOp { if op != nil { op.QueryOpts.Set("group_id", val) @@ -801,7 +812,7 @@ func (op *ListOp) GroupID(val string) *ListOp { return op } -// IncludeUsersettingsForCsv return the `userSettings` object data in CSV format. +// IncludeUsersettingsForCsv when set to **true**, the response includes the `userSettings` object data in CSV format. func (op *ListOp) IncludeUsersettingsForCsv() *ListOp { if op != nil { op.QueryOpts.Set("include_usersettings_for_csv", "true") @@ -809,7 +820,7 @@ func (op *ListOp) IncludeUsersettingsForCsv() *ListOp { return op } -// LoginStatus return the login status of each user. +// LoginStatus when set to **true**, the response includes the login status of each user. func (op *ListOp) LoginStatus(val string) *ListOp { if op != nil { op.QueryOpts.Set("login_status", val) @@ -833,13 +844,13 @@ func (op *ListOp) StartPosition(val int) *ListOp { return op } -// Status filters the user records by account status. One of: +// Status filters results by user account status. Possible values are: // -// * ActivationRequired -// * ActivationSent -// * Active -// * Closed -// * Disabled +// * `ActivationRequired` +// * `ActivationSent` +// * `Active` +// * `Closed` +// * `Disabled` func (op *ListOp) Status(val ...string) *ListOp { if op != nil { op.QueryOpts.Set("status", strings.Join(val, ",")) @@ -847,7 +858,9 @@ func (op *ListOp) Status(val ...string) *ListOp { return op } -// UserNameSubstring filters returned user records by full user name or a substring of user name. +// UserNameSubstring filters results based on a full or partial user name. +// +// **Note**: When you enter a partial user name, you do not use a wildcard character. func (op *ListOp) UserNameSubstring(val string) *ListOp { if op != nil { op.QueryOpts.Set("user_name_substring", val) @@ -860,12 +873,12 @@ func (op *ListOp) UserNameSubstring(val string) *ListOp { // https://developers.docusign.com/esign-rest-api/reference/users/users/update // // SDK Method Users::updateUser -func (s *Service) Update(userID string, users *model.UserInformation) *UpdateOp { +func (s *Service) Update(userID string, userInformation *model.UserInformation) *UpdateOp { return &UpdateOp{ Credential: s.credential, Method: "PUT", Path: strings.Join([]string{"users", userID}, "/"), - Payload: users, + Payload: userInformation, QueryOpts: make(url.Values), Version: esign.VersionV21, } @@ -880,7 +893,7 @@ func (op *UpdateOp) Do(ctx context.Context) (*model.UserInformation, error) { return res, ((*esign.Op)(op)).Do(ctx, &res) } -// UpdateList change one or more user in the specified account. +// UpdateList changes one or more users in the specified account. // // https://developers.docusign.com/esign-rest-api/reference/users/users/updatelist // diff --git a/v2.1/workspaces/workspaces.go b/v2.1/workspaces/workspaces.go index 03f34d7..715827c 100644 --- a/v2.1/workspaces/workspaces.go +++ b/v2.1/workspaces/workspaces.go @@ -8,7 +8,18 @@ // Package workspaces implements the DocuSign SDK // category Workspaces. // -// Workspaces creation and management. +// A workspace is a collaborative space for sharing documents and managing workflows. A workspace has a single owner who must be a DocuSign user. The owner can invite others to the workspace as collaborators. Individuals who are not DocuSign users must create a DocuSign account to join a workspace as a collaborator. +// +// You can create an envelope directly from a workspace. +// +// Workspaces store the following information: +// +// - **Files**: Files uploaded to a workspace for storage or reuse. +// - **Documents**: A document is a component of a transaction, template, or workspace. When a file is added to a transaction, template, or workspace, it is copied as a document. Each document in a workspace has a single owner. +// - **Templates**: A set of documents that you can use to create a transaction or a workspace. +// - **Transactions**: A transaction is a series of workflow events related to one or more documents. These events route the documents to one or more individuals for the purposes of doing business. Each transaction has a single owner (the sender). +// +// **Note**: Documents in a template are not individually listed as files. // // Service Api documentation may be found at: // https://developers.docusign.com/esign-rest-api/reference/Workspaces @@ -70,7 +81,7 @@ func (op *ItemsCreateFIleOp) Do(ctx context.Context) (*model.WorkspaceItem, erro return res, ((*esign.Op)(op)).Do(ctx, &res) } -// ItemsDeleteFolderItems deletes workspace one or more specific files/folders from the given folder or root. +// ItemsDeleteFolderItems deletes files or sub-folders from a workspace. // // https://developers.docusign.com/esign-rest-api/reference/workspaces/workspaceitems/deletefolderitems // @@ -94,7 +105,7 @@ func (op *ItemsDeleteFolderItemsOp) Do(ctx context.Context) error { return ((*esign.Op)(op)).Do(ctx, nil) } -// ItemsGetFile get Workspace File +// ItemsGetFile gets a workspace file // // https://developers.docusign.com/esign-rest-api/reference/workspaces/workspaceitems/getfile // @@ -118,7 +129,7 @@ func (op *ItemsGetFileOp) Do(ctx context.Context) (*esign.Download, error) { return res, ((*esign.Op)(op)).Do(ctx, &res) } -// IsDownload when set to **true**, the Content-Disposition header is set in the response. The value of the header provides the filename of the file. Default is **false**. +// IsDownload when set to **true**, the `Content-Disposition` header is set in the response. The value of the header provides the filename of the file. The default is **false**. func (op *ItemsGetFileOp) IsDownload() *ItemsGetFileOp { if op != nil { op.QueryOpts.Set("is_download", "true") @@ -126,7 +137,7 @@ func (op *ItemsGetFileOp) IsDownload() *ItemsGetFileOp { return op } -// PdfVersion when set to **true** the file returned as a PDF. +// PdfVersion when set to **true** the file is returned in PDF format. func (op *ItemsGetFileOp) PdfVersion() *ItemsGetFileOp { if op != nil { op.QueryOpts.Set("pdf_version", "true") @@ -158,7 +169,7 @@ func (op *ItemsListFilePagesOp) Do(ctx context.Context) (*model.PageImages, erro return res, ((*esign.Op)(op)).Do(ctx, &res) } -// Count is the maximum number of results to return. +// Count is the maximum number of results to be returned by this request. func (op *ItemsListFilePagesOp) Count(val int) *ItemsListFilePagesOp { if op != nil { op.QueryOpts.Set("count", fmt.Sprintf("%d", val)) @@ -198,7 +209,7 @@ func (op *ItemsListFilePagesOp) StartPosition(val int) *ItemsListFilePagesOp { return op } -// ItemsListFolderItems list Workspace Folder Contents +// ItemsListFolderItems list workspace folder contents // // https://developers.docusign.com/esign-rest-api/reference/workspaces/workspaceitems/listfolderitems // @@ -222,7 +233,7 @@ func (op *ItemsListFolderItemsOp) Do(ctx context.Context) (*model.WorkspaceFolde return res, ((*esign.Op)(op)).Do(ctx, &res) } -// Count is the maximum number of results to return. +// Count is the maximum number of results to be returned by this request. func (op *ItemsListFolderItemsOp) Count(val int) *ItemsListFolderItemsOp { if op != nil { op.QueryOpts.Set("count", fmt.Sprintf("%d", val)) @@ -230,7 +241,7 @@ func (op *ItemsListFolderItemsOp) Count(val int) *ItemsListFolderItemsOp { return op } -// IncludeFiles when set to **true**, file information is returned in the response along with folder information. The default is **false**. +// IncludeFiles when set to **true**, the response includes file information (in addition to folder information). The default is **false**. func (op *ItemsListFolderItemsOp) IncludeFiles() *ItemsListFolderItemsOp { if op != nil { op.QueryOpts.Set("include_files", "true") @@ -238,7 +249,7 @@ func (op *ItemsListFolderItemsOp) IncludeFiles() *ItemsListFolderItemsOp { return op } -// IncludeSubFolders when set to **true**, information about the sub-folders of the current folder is returned. The default is **false**. +// IncludeSubFolders when set to **true**, the response includes information about the sub-folders of the current folder. The default is **false**. func (op *ItemsListFolderItemsOp) IncludeSubFolders() *ItemsListFolderItemsOp { if op != nil { op.QueryOpts.Set("include_sub_folders", "true") @@ -246,7 +257,7 @@ func (op *ItemsListFolderItemsOp) IncludeSubFolders() *ItemsListFolderItemsOp { return op } -// IncludeThumbnails when set to **true**, thumbnails are returned as part of the response. The default is **false**. +// IncludeThumbnails when set to **true**, the response returns thumbnails. The default is **false**. func (op *ItemsListFolderItemsOp) IncludeThumbnails() *ItemsListFolderItemsOp { if op != nil { op.QueryOpts.Set("include_thumbnails", "true") @@ -254,7 +265,7 @@ func (op *ItemsListFolderItemsOp) IncludeThumbnails() *ItemsListFolderItemsOp { return op } -// IncludeUserDetail set to **true** to return extended details about the user. The default is **false**. +// IncludeUserDetail when set to **true**, the response includes extended details about the user. The default is **false**. func (op *ItemsListFolderItemsOp) IncludeUserDetail() *ItemsListFolderItemsOp { if op != nil { op.QueryOpts.Set("include_user_detail", "true") @@ -270,7 +281,7 @@ func (op *ItemsListFolderItemsOp) StartPosition(val int) *ItemsListFolderItemsOp return op } -// WorkspaceUserID if set, then the results are filtered to those associated with the specified userId. +// WorkspaceUserID if set, the response only includes results associated with the `userId` that you specify. func (op *ItemsListFolderItemsOp) WorkspaceUserID(val string) *ItemsListFolderItemsOp { if op != nil { op.QueryOpts.Set("workspace_user_id", val) @@ -278,7 +289,7 @@ func (op *ItemsListFolderItemsOp) WorkspaceUserID(val string) *ItemsListFolderIt return op } -// ItemsUpdateFile update Workspace File Metadata +// ItemsUpdateFile update workspace file or folder metadata // If media is an io.ReadCloser, Do() will close media. // // https://developers.docusign.com/esign-rest-api/reference/workspaces/workspaceitems/updatefile @@ -309,12 +320,12 @@ func (op *ItemsUpdateFileOp) Do(ctx context.Context) (*model.WorkspaceItem, erro // https://developers.docusign.com/esign-rest-api/reference/workspaces/workspaces/create // // SDK Method Workspaces::createWorkspace -func (s *Service) Create(workspaces *model.Workspace) *CreateOp { +func (s *Service) Create(workspace *model.Workspace) *CreateOp { return &CreateOp{ Credential: s.credential, Method: "POST", Path: "workspaces", - Payload: workspaces, + Payload: workspace, QueryOpts: make(url.Values), Version: esign.VersionV21, } @@ -406,12 +417,12 @@ func (op *ListOp) Do(ctx context.Context) (*model.WorkspaceList, error) { // https://developers.docusign.com/esign-rest-api/reference/workspaces/workspaces/update // // SDK Method Workspaces::updateWorkspace -func (s *Service) Update(workspaceID string, workspaces *model.Workspace) *UpdateOp { +func (s *Service) Update(workspaceID string, workspace *model.Workspace) *UpdateOp { return &UpdateOp{ Credential: s.credential, Method: "PUT", Path: strings.Join([]string{"workspaces", workspaceID}, "/"), - Payload: workspaces, + Payload: workspace, QueryOpts: make(url.Values), Version: esign.VersionV21, } diff --git a/v2/model/model.go b/v2/model/model.go index 055ea07..53899b1 100644 --- a/v2/model/model.go +++ b/v2/model/model.go @@ -1096,7 +1096,7 @@ type Approve struct { // - Size72 FontSize string `json:"fontSize,omitempty"` // Height of the tab in pixels. - Height int32 `json:"height,omitempty"` + Height string `json:"height,omitempty"` // When set to **true**, the information in the tab is italic. Italic string `json:"italic,omitempty"` // @@ -1104,7 +1104,7 @@ type Approve struct { // When set to **true**, the information in the tab is underlined. Underline string `json:"underline,omitempty"` // Width of the tab in pixels. - Width int32 `json:"width,omitempty"` + Width string `json:"width,omitempty"` } // Attachment contains information about an attachment. @@ -2255,7 +2255,7 @@ type Company struct { // Tooltip string `json:"tooltip,omitempty"` // Width of the tab in pixels. - Width int32 `json:"width,omitempty"` + Width string `json:"width,omitempty"` } type CompleteSignHashResponse struct { @@ -2796,7 +2796,7 @@ type Date struct { // A regular expressionn used to validate input for the tab. ValidationPattern string `json:"validationPattern,omitempty"` // Width of the tab in pixels. - Width int32 `json:"width,omitempty"` + Width string `json:"width,omitempty"` } // DateSigned is a tab that displays the date that the recipient signed the @@ -2890,7 +2890,7 @@ type Decline struct { // - Size72 FontSize string `json:"fontSize,omitempty"` // Height of the tab in pixels. - Height int32 `json:"height,omitempty"` + Height string `json:"height,omitempty"` // When set to **true**, the information in the tab is italic. Italic string `json:"italic,omitempty"` // @@ -2898,7 +2898,7 @@ type Decline struct { // When set to **true**, the information in the tab is underlined. Underline string `json:"underline,omitempty"` // Width of the tab in pixels. - Width int32 `json:"width,omitempty"` + Width string `json:"width,omitempty"` } type DiagnosticsSettingsInformation struct { @@ -3454,7 +3454,7 @@ type Email struct { // A regular expressionn used to validate input for the tab. ValidationPattern string `json:"validationPattern,omitempty"` // Width of the tab in pixels. - Width int32 `json:"width,omitempty"` + Width string `json:"width,omitempty"` } // EmailAddress is a tab that displays the recipient's email as entered in the @@ -4904,7 +4904,7 @@ type FormulaTab struct { // A regular expressionn used to validate input for the tab. ValidationPattern string `json:"validationPattern,omitempty"` // Width of the tab in pixels. - Width int32 `json:"width,omitempty"` + Width string `json:"width,omitempty"` } // FullName is a tab that displays the recipient's full name. @@ -5592,7 +5592,7 @@ type List struct { // When set to **true**, the information in the tab is underlined. Underline string `json:"underline,omitempty"` // Width of the tab in pixels. - Width int32 `json:"width,omitempty"` + Width string `json:"width,omitempty"` } type ListCustomField struct { @@ -6163,13 +6163,13 @@ type Note struct { TabStyle TabValue // Height of the tab in pixels. - Height int32 `json:"height,omitempty"` + Height string `json:"height,omitempty"` // When set to **true**, this custom tab is shared. Shared DSBool `json:"shared,omitempty"` // Tooltip string `json:"tooltip,omitempty"` // Width of the tab in pixels. - Width int32 `json:"width,omitempty"` + Width string `json:"width,omitempty"` } // Notification is a complex element that specifies the notification options for the envelope. It consists of: @@ -6270,7 +6270,7 @@ type Number struct { // A regular expressionn used to validate input for the tab. ValidationPattern string `json:"validationPattern,omitempty"` // Width of the tab in pixels. - Width int32 `json:"width,omitempty"` + Width string `json:"width,omitempty"` } type OauthAccess struct { @@ -7923,7 +7923,7 @@ type SSN struct { // A regular expressionn used to validate input for the tab. ValidationPattern string `json:"validationPattern,omitempty"` // Width of the tab in pixels. - Width int32 `json:"width,omitempty"` + Width string `json:"width,omitempty"` } type Ssn4InformationInput struct { @@ -9073,7 +9073,7 @@ type Text struct { // Formula string `json:"formula,omitempty"` // Height of the tab in pixels. - Height int32 `json:"height,omitempty"` + Height string `json:"height,omitempty"` // When set to **true**, sets this as a payment tab. Can only be used with Text, Number, Formula, or List tabs. The value of the tab must be a number. IsPaymentAmount DSBool `json:"isPaymentAmount,omitempty"` // When set to **true**, the signer cannot change the data of the custom tab. @@ -9103,7 +9103,7 @@ type Text struct { // A regular expressionn used to validate input for the tab. ValidationPattern string `json:"validationPattern,omitempty"` // Width of the tab in pixels. - Width int32 `json:"width,omitempty"` + Width string `json:"width,omitempty"` } type TextCustomField struct { @@ -9158,7 +9158,7 @@ type Title struct { // Tooltip string `json:"tooltip,omitempty"` // Width of the tab in pixels. - Width int32 `json:"width,omitempty"` + Width string `json:"width,omitempty"` } type TspHealthCheckRequest struct { @@ -9647,7 +9647,7 @@ type View struct { // ButtonText string `json:"buttonText,omitempty"` // Height of the tab in pixels. - Height int32 `json:"height,omitempty"` + Height string `json:"height,omitempty"` // When set to **true**, the signer is required to fill out this tab Required TabRequired `json:"required,omitempty"` // @@ -9655,7 +9655,7 @@ type View struct { // Tooltip string `json:"tooltip,omitempty"` // Width of the tab in pixels. - Width int32 `json:"width,omitempty"` + Width string `json:"width,omitempty"` } type ViewURL struct { @@ -9956,7 +9956,7 @@ type Zip struct { // A regular expressionn used to validate input for the tab. ValidationPattern string `json:"validationPattern,omitempty"` // Width of the tab in pixels. - Width int32 `json:"width,omitempty"` + Width string `json:"width,omitempty"` } // GetTabValues returns a NameValue list of all entry tabs